unisat-dev-docs

Alkanes Indexer API

The Alkanes Indexer API is developed by the UniSat team, providing a simplified and developer-friendly interface based on the official Alkanes indexer (kungfuflex/alkanes). It is built on specific versions of metashrew and alkanes-rs to ensure compatibility and consistency. We welcome feedback and suggestions for improvement.

👉 View Swagger UI


đź“‘ Table of Contents

Route Summary
GET /v1/indexer/alkanes/status Get Alkanes indexer status, indexed height, and asset count
GET /v1/indexer/alkanes/info-list List indexed Alkanes assets across tokens, NFTs, and collections
GET /v1/indexer/alkanes/(alkaneid)/info Get metadata for one Alkane asset by alkaneid
GET /v1/indexer/alkanes/token-list List fungible Alkanes tokens with supply and holder metadata
GET /v1/indexer/alkanes/(alkaneid)/holders List holders and balances for an Alkane asset
GET /v1/indexer/alkanes/(alkaneid)/collection-items List NFT or child assets that belong to an Alkane collection
GET /v1/indexer/alkanes/(alkaneid)/contract-events List contract execution events for an Alkane over a block range
GET /v1/indexer/alkanes/utxo/(txid)/(index)/balance Get all Alkane balances attached to a specific UTXO
GET /v1/indexer/address/(address)/alkanes/(alkaneid)/utxo List an address’s UTXOs that carry a specific Alkane
GET /v1/indexer/address/(address)/alkanes/token-list List fungible Alkanes tokens held by an address
GET /v1/indexer/address/(address)/alkanes/collection-list List Alkane collections associated with an address
GET /v1/indexer/address/(address)/alkanes/(alkaneid)/collection-items List an address’s items from a specific Alkane collection
GET /v1/indexer/address/(address)/alkanes/(alkaneid)/transfer-history List an address’s transfer history for a specific Alkane

Indexer-Alkanes

Get Alkanes indexer status, indexed height, and asset count

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

Description

Returns the current Alkanes indexer progress and runtime versions, including indexed block height, total tracked Alkane assets, metashrew version, and alkanes-rs version.

Response (200)

successful operation

Notes

This endpoint is used to monitor the indexer’s sync status.


List indexed Alkanes assets across tokens, NFTs, and collections

Method: GET
Path: /v1/indexer/alkanes/info-list
Swagger Link: View in Swagger UI

Description

Returns a paginated catalog of Alkane asset metadata. Use it for global discovery across asset types, with optional type filtering and sorting by creation time or alkaneid.

Parameters

Response (200)

successful operation


Get metadata for one Alkane asset by alkaneid

Method: GET
Path: /v1/indexer/alkanes/{alkaneid}/info
Swagger Link: View in Swagger UI

Description

Returns the asset type and type-specific metadata for a single Alkane, such as token supply fields, NFT content fields, or collection supply and holder counts.

Parameters

Response (200)

successful operation


List fungible Alkanes tokens with supply and holder metadata

Method: GET
Path: /v1/indexer/alkanes/token-list
Swagger Link: View in Swagger UI

Description

Returns token-type Alkanes only, including token name, symbol, divisibility, supply, mint progress, and holder count. Supports lookup by alkaneid or name and sorted pagination.

Parameters

Response (200)

successful operation


List holders and balances for an Alkane asset

Method: GET
Path: /v1/indexer/alkanes/{alkaneid}/holders
Swagger Link: View in Swagger UI

Description

Returns paginated holder addresses and their indexed amount for the selected Alkane. Use it to inspect token distribution or collection ownership concentration.

Parameters

Response (200)

successful operation


List NFT or child assets that belong to an Alkane collection

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

Description

Returns paginated Alkane item metadata for a collection, including each item’s asset type and NFT or token details when available.

Parameters

Response (200)

successful operation


List contract execution events for an Alkane over a block range

Method: GET
Path: /v1/indexer/alkanes/{alkaneid}/contract-events
Swagger Link: View in Swagger UI

Description

Returns indexed contract events with caller, opcode, fuel, inputs, execution status, block height, txid, and vout. Use it to audit contract activity within a bounded height range.

Parameters

Response (200)

successful operation


Get all Alkane balances attached to a specific UTXO

Method: GET
Path: /v1/indexer/alkanes/utxo/{txid}/{index}/balance
Swagger Link: View in Swagger UI

Description

Returns the Alkane assets and amounts indexed on one transaction output, with token, NFT, or collection metadata attached when available.

Parameters

Response (200)

successful operation


List an address’s UTXOs that carry a specific Alkane

Method: GET
Path: /v1/indexer/address/{address}/alkanes/{alkaneid}/utxo
Swagger Link: View in Swagger UI

Description

Returns spendable transaction outputs for an address that contain the selected Alkane, including satoshi value, scriptPubKey, confirmations, and indexed Alkane balances on each UTXO.

Parameters

Response (200)

successful operation


List fungible Alkanes tokens held by an address

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

Description

Returns token assets associated with an address, including each token’s metadata and paginated list context. Use it for wallet asset discovery before querying per-token UTXOs or transfer history.

Parameters

Response (200)

successful operation


List Alkane collections associated with an address

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

Description

Returns collection-type Alkane metadata indexed for an address, including collection name, supply, mint progress, and holder count when available.

Parameters

Response (200)

successful operation


List an address’s items from a specific Alkane collection

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

Description

Returns collection item metadata scoped to one address, useful for showing which NFTs or child assets from a collection are held by that wallet.

Parameters

Response (200)

successful operation


List an address’s transfer history for a specific Alkane

Method: GET
Path: /v1/indexer/address/{address}/alkanes/{alkaneid}/transfer-history
Swagger Link: View in Swagger UI

Description

Returns indexed transfer records with block height, txid, transfer type, subtype, address, and amount. Use it to build an address-level activity view over a bounded height range.

Parameters

Response (200)

successful operation