This is the API for collections. Currently, it only indexes a single whitelisted collection.
👉 View Swagger UI
| Route | Summary |
|---|---|
| GET /v1/collection-indexer/collection/status | Return the overall information of the collection service |
| GET /v1/collection-indexer/collection/{collectionId}/info | Return the details of the specified collection |
| GET /v1/collection-indexer/collection/{collectionId}/holders | Return the owner information of a specific collection |
| GET /v1/collection-indexer/address/{address}/collection/list | Return the collection summary for the specified address. |
| GET /v1/collection-indexer/collection/{collectionId}/items | Return the list of inscriptions for a specific collection. |
| GET /v1/collection-indexer/address/{address}/collection/{collectionId}/summary | Return the summary of a specific collection for the designated address. |
| GET /v1/collection-indexer/address/{address}/collection/{collectionId}/items | Get the list of inscriptions for a specific collection at a designated address. |
| GET /v1/collection-indexer/inscription/{inscriptionId}/collection/list | Get inscription collection list |
Method: GET
Path: /v1/collection-indexer/collection/status
Swagger Link: View in Swagger UI
Returns the latest height of the collection indexer, the last handled height, and the total number of collections.
code (number):msg (string):data (object):
newestHeight (number):lastHandledHeight (number):totalCollection (number):Method: GET
Path: /v1/collection-indexer/collection/{collectionId}/info
Swagger Link: View in Swagger UI
Returns the details of a specific collection, including its name, icon, supply, description, and social media links.
height (query) :collectionId (path) (required):code (number):msg (string):data (object):
height (number):holders (number):totalItems (number):Method: GET
Path: /v1/collection-indexer/collection/{collectionId}/holders
Swagger Link: View in Swagger UI
Returns the list of addresses that hold items from a specific collection, along with the count of items each address holds.
height (query) :start (query) (required):limit (query) (required):collectionId (path) (required):code (number):msg (string):data (object):
total (number):list (array):
address (string):count (number):Method: GET
Path: /v1/collection-indexer/address/{address}/collection/list
Swagger Link: View in Swagger UI
Returns the summary of all collections that the specified address holds, including collection name, icon, supply, and social media links.
height (query) :start (query) (required):limit (query) (required):address (path) (required):code (number):msg (string):data (object):
total (number):list (array):
count (number):name (string):iconInscription (string):iconUrl (string):iconContentType (string):supply (string):collectionId (string):desc (string):twitter (string):discord (string):website (string):Method: GET
Path: /v1/collection-indexer/collection/{collectionId}/items
Swagger Link: View in Swagger UI
Returns the list of inscriptions that belong to a specific collection, including details such as inscription ID, name, content type, and height.
height (query) :start (query) (required):limit (query) (required):collectionId (path) (required):code (number):msg (string):data (object):
total (number):list (array):
inscriptionId (string):collectionId (string):collectionItemName (string):inscriptionIndex (number):inscriptionNumber (number):inscriptionName (string):contentBody (string):contentLength (number):contentType (string):height (number):holders (number):totalItems (number):Method: GET
Path: /v1/collection-indexer/address/{address}/collection/{collectionId}/summary
Swagger Link: View in Swagger UI
Returns the summary of a specific collection for a designated address, including collection name, icon, supply, description, and social media links.
height (query) :address (path) (required):collectionId (path) (required):code (number):msg (string):data (object):
count (number):name (string):iconInscription (string):iconUrl (string):iconContentType (string):supply (string):collectionId (string):desc (string):twitter (string):discord (string):website (string):Method: GET
Path: /v1/collection-indexer/address/{address}/collection/{collectionId}/items
Swagger Link: View in Swagger UI
Returns the list of inscriptions that belong to a specific collection at a designated address, including details such as inscription ID, name,
height (query) :start (query) (required):limit (query) (required):address (path) (required):collectionId (path) (required):code (number):msg (string):data (object):
total (number):list (array):
inscriptionId (string):collectionId (string):collectionItemName (string):inscriptionIndex (number):inscriptionNumber (number):inscriptionName (string):contentBody (string):contentLength (number):contentType (string):height (number):holders (number):totalItems (number):Method: GET
Path: /v1/collection-indexer/inscription/{inscriptionId}/collection/list
Swagger Link: View in Swagger UI
Returns the list of collections that a specific inscription belongs to, including collection name, icon, supply, and social media links.
inscriptionId (path) (required):code (number):msg (string):data (object):
total (number):list (array):
name (string):iconInscription (string):iconUrl (string):iconContentType (string):supply (string):collectionId (string):desc (string):twitter (string):discord (string):website (string):