Class CollectionService

constructor

• new CollectionService(httpRequest): CollectionService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns CollectionService

ReadonlyhttpRequest

deleteCollection

• deleteCollection(contractAddress): CancelablePromise<void>

• Delete a collection Delete a collection in the Marketplace API. This will stop the process of indexing this ERC721 contract.

  Parameters

  • contractAddress: string

  Returns CancelablePromise<void>

  void

  Throws

  ApiError

getCollection

• getCollection(contractAddress): CancelablePromise<GetCollectionResponse>

• Get Collection data Retrieve information about a specific collection using the contract address. Can be called for any Cometh indexed collection.

  Parameters

  • contractAddress: string

  Returns CancelablePromise<GetCollectionResponse>

  GetCollectionResponse Collection information

  Throws

  ApiError

getCollectionAttributes

• getCollectionAttributes(contractAddress): CancelablePromise<CollectionAttributes>

• Retrieve the collection attributes by contract address Retrieve all the existing permutations of the trait types and values for a collection. Can be called for any Cometh indexed collection.

  Parameters

  • contractAddress: string

  Returns CancelablePromise<CollectionAttributes>

  CollectionAttributes Successful operation

  Throws

  ApiError

getCollectionProgress

• getCollectionProgress(contractAddress): CancelablePromise<GetCollectionProgressResponse>

• Retrieve the collection progress by contract address Retrieve the block number of the last indexed block for a collection as well as related data.

  Parameters

  • contractAddress: string

  Returns CancelablePromise<GetCollectionProgressResponse>

  GetCollectionProgressResponse Successful operation

  Throws

  ApiError

refreshCollectionMetadata

• refreshCollectionMetadata(contractAddress): CancelablePromise<RefreshCollectionMetadataResponse>

• Refreshes the metadata of the specified collection Queue jobs to refresh the metadata of all the NFTs of the specified collection. If there are many assets in the collection, this might take a while.

  Parameters

  • contractAddress: string

  Returns CancelablePromise<RefreshCollectionMetadataResponse>

  RefreshCollectionMetadataResponse Metadata refresh initiated successfully

  Throws

  ApiError

registerCollection

• registerCollection(requestBody): CancelablePromise<Collection>

• Register a new collection Register a new collection in the Marketplace API. This will start the process of indexing this ERC721 contract.

  Parameters

  • requestBody: NewCollection

  Returns CancelablePromise<Collection>

  Collection Successful operation

  Throws

  ApiError

searchCollections

• searchCollections(requestBody): CancelablePromise<PaginatedCollections>

• Retrieve all collections Retrieve all collections that were indexed for your project in the Marketplace API.

  Parameters

  • requestBody: SearchCollectionsRequest

  Returns CancelablePromise<PaginatedCollections>

  PaginatedCollections Successful operation

  Throws

  ApiError

updateCollection

• updateCollection(contractAddress, requestBody): CancelablePromise<Collection>

• Update a collection Update a collection in the Marketplace API. Only given fields will be updated.

  Parameters

  • contractAddress: string
  • requestBody: CollectionUpdates

  Returns CancelablePromise<Collection>

  Collection Collection information

  Throws

  ApiError