unisat-dev-docs

Collection Indexer API

Collection Indexer API provides read-only collection indexing endpoints for collection status, collection details, holders, address collection summaries, and collection item ownership. It is separate from marketplace listing and order APIs.

👉 View Swagger UI


đź“‘ Table of Contents

Route Summary
GET /v1/collection-indexer/collection/status Get collection indexer height and collection count
GET /v1/collection-indexer/collection/(collectionId)/info Get collection supply and holder summary
GET /v1/collection-indexer/collection/(collectionId)/holders List collection holders and item counts
GET /v1/collection-indexer/address/(address)/collection/list List collections owned by an address
GET /v1/collection-indexer/collection/(collectionId)/items List indexed items in a collection
GET /v1/collection-indexer/address/(address)/collection/(collectionId)/summary Get an address’s ownership summary for a collection
GET /v1/collection-indexer/address/(address)/collection/(collectionId)/items List collection items owned by an address
GET /v1/collection-indexer/inscription/(inscriptionId)/collection/list List collections containing an inscription

Collection Indexer

Get collection indexer height and collection count

Method: GET
Path: /v1/collection-indexer/collection/status
Swagger Link: View in Swagger UI

Description

Returns newest chain height, last handled indexer height, and total indexed collections. Use it to check freshness before reading collection metadata, holder lists, address collection summaries, or item ownership; this indexer is separate from marketplace listing and order state.

Response (200)

Default Response


Get collection supply and holder summary

Method: GET
Path: /v1/collection-indexer/collection/{collectionId}/info
Swagger Link: View in Swagger UI

Description

Returns a collection’s indexed height, holder count, and total item count, optionally at a specified height. Use it for lightweight collection detail headers or historical snapshots; marketplace floor, listings, and order activity are not included.

Parameters

Response (200)

Default Response


List collection holders and item counts

Method: GET
Path: /v1/collection-indexer/collection/{collectionId}/holders
Swagger Link: View in Swagger UI

Description

Returns paginated holder addresses and item counts for a collection, optionally at a specified height. Use it for holder distribution views and ownership analytics; it reflects indexed ownership only and does not include marketplace listing state.

Parameters

Response (200)

Default Response


List collections owned by an address

Method: GET
Path: /v1/collection-indexer/address/{address}/collection/list
Swagger Link: View in Swagger UI

Description

Returns paginated collection summaries for an address, including owned item count, collection name, icon inscription and URL, content type, supply, collection id, description, and social links. Use it for wallet collection portfolios; it does not report listing or order availability.

Parameters

Response (200)

Default Response


List indexed items in a collection

Method: GET
Path: /v1/collection-indexer/collection/{collectionId}/items
Swagger Link: View in Swagger UI

Description

Returns paginated collection item records with inscription id and number, item and inscription names, content metadata, indexed height, holder count, and collection totals. Use it for collection item grids or metadata backfills; content bodies may be untrusted and should be rendered safely.

Parameters

Response (200)

Default Response


Get an address’s ownership summary for a collection

Method: GET
Path: /v1/collection-indexer/address/{address}/collection/{collectionId}/summary
Swagger Link: View in Swagger UI

Description

Returns the address’s item count plus collection name, icon, supply, collection id, description, and social links for one collection. Use it for wallet collection detail cards or ownership verification; marketplace order state and listing prices are not included.

Parameters

Response (200)

Default Response


List collection items owned by an address

Method: GET
Path: /v1/collection-indexer/address/{address}/collection/{collectionId}/items
Swagger Link: View in Swagger UI

Description

Returns paginated item records that an address owns within a collection, including inscription id and number, item name, content metadata, indexed height, and collection totals. Use it for wallet item galleries; ownership can change with new transfers, so recheck before signing or listing transactions.

Parameters

Response (200)

Default Response


List collections containing an inscription

Method: GET
Path: /v1/collection-indexer/inscription/{inscriptionId}/collection/list
Swagger Link: View in Swagger UI

Description

Returns collection summaries associated with an inscription, including name, icon, supply, collection id, description, and social links. Use it to map an inscription to curated collection contexts; inscription ids or numbers may resolve differently across networks, so match the request to the intended chain.

Parameters

Response (200)

Default Response