Skip to main content

API

fetch_entity​

Fetches a single entity by its id.

fetch_entity(id: string): Promise<Entity>

type Entity = {
  contractAddress: string;
  defaultURI: string;
  description: string;
  id: string;
  name: string;
  owner: string;
  entityId: string;
  subscriptionBalance: string;
  subscriptionPrice: string;
  thumbnail: string;
  verifier: string;
};

fetch_entity_collections​

Fetches all collections of an entity.

fetch_entity_collections(id: string): Promise<EntityCollection[]>

type EntityCollection = {
  address: string;
  balance: string;
  collectionId: string;
  collectionURIs: string;
  controller: string;
  dynamic: string;
  free: boolean;
  id: string;
  mintLimit: string;
  mintPrice: string;
  mintType: string;
  mintedCount: string;
  entityId: string;
  protocolBalance: string;
  protocolWithdrawnAmount: string;
  royalty: string;
  templateId: string;
  totalSupply: string;
  totalWithdrawnAmount: string;
  verifier: string;
  whitelisted: string;
  witdrawnAmount: string;
  template: {
    id: string;
    uri: string;
    templateId: string;
    category: string;
  };
};

fetch_entity_collection​

Fetches a single collection of an entity.

fetch_entity_collection(id: string): Promise<EntityCollection>

type EntityCollection = {
  address: string;
  balance: string;
  collectionId: string;
  collectionURIs: string;
  controller: string;
  dynamic: string;
  free: boolean;
  id: string;
  mintLimit: string;
  mintPrice: string;
  mintType: string;
  mintedCount: string;
  entityId: string;
  protocolBalance: string;
  protocolWithdrawnAmount: string;
  royalty: string;
  templateId: string;
  totalSupply: string;
  totalWithdrawnAmount: string;
  verifier: string;
  whitelisted: string;
  witdrawnAmount: string;
  template: {
    id: string;
    uri: string;
    templateId: string;
    category: string;
  };
};

fetch_all_entities​

Fetches all entities.

fetch_all_entities(): Promise<Entities>

type Entities = {
  allEntities: Entity[];
};

fetch_quark_owner​

Fetches the owner of a quark.

fetch_quark_owner(id: string): Promise<Owner>

type Owner = {
  id: string;
  quarks: {
    collectionId: string;
    contractAddress: string;
    id: string;
    immutableUri: string;
    isLocked: boolean;
    entityId: string;
    templateId: string;
    tokenId: string;
    subscriptions: {
      asset: string;
      id: string;
    }[];
  };
};

fetch_token​

Fetches a single token by its id.

fetch_token(id: string): Promise<Token>

type Token = {
  tokenId: string;
  templateId: string;
  entityId: string;
  isLocked: boolean;
  immutableUri: string;
  id: string;
  contractAddress: string;
  collectionId: string;
  subscriptions: {
    asset: string;
  }[];
};

fetch_templates​

Fetches all templates.

fetch_templates(): Promise<Templates>

type Templates = {
  uri: string;
  templateId: string;
  price: string;
  mintedCount: string;
  id: string;
  category: string;
}[];

fetch_collections_balance​

Fetches the balance of all collections.

fetch_collections_balance(): Promise<CollectionsBalance>

type CollectionsBalance = {
  address: string;
  balance: string;
  protocolBalance: string;
  protocolWithdrawnAmount: string;
  totalWithdrawnAmount: string;
  royalty: string;
}[];

fetch_contracts​

Fetches all live contracts.

fetch_contracts(): Promise<Contracts>

type Contracts = {
  id: string;
  controller: string;
  imported: string;
  registry: string;
  subscriber: string;
  template: string;
};

fetch_controller​

Fetches controller contract.

fetch_controller(): Promise<Controller>

type Controller = {
  id: string;
  template: string;
  subscriber: string;
  royalty: string;
  registry: string;
  authorizedWithdrawal: string;
}[];

fetch_implementation​

Fetches implementations.

 fetch_implementation(): Promise<Implementations>

 type Implementations = {
  id: string;
  address: string;
}[];

fetch_imported_collections​

Fetches imported collections.

fetch_imported_collections(): Promise<ImportedCollections>

type ImportedCollections = {
  id: string;
  importedCollections: {
    id: string;
    collectionId: string;
    entityId: string;
    templateId: string;
  }[];
}[];

fetch_registry​

Fetches registry contract.

fetch_registry(): Promise<Registry>

type Registry = {
  id: string;
  subscriber: string;
  controller: string;
};

fetch_subscriber​

Fetches subscriber contract.

fetch_subscriber(): Promise<Subscriber>

type Subscriber = {
  id: string;
  royalty: string;
  registry: string;
  protocolBalance: string;
  importedContracts: string;
  controller: string;
};