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
| 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 |
Method: GET
Path: /v1/indexer/alkanes/status
Swagger Link: View in Swagger UI
Returns the current Alkanes indexer progress and runtime versions, including indexed block height, total tracked Alkane assets, metashrew version, and alkanes-rs version.
successful operation
code (integer): example: 0msg (string): example: ""data (object):
bestHeight (integer):alkanes (integer): example: 100metashrewVersion (string):alkanesRsVersion (string):This endpoint is used to monitor the indexer’s sync status.
alkanes indicates the total number of recognized Alkanes currently indexed by the system.bestHeight represents the current height the indexer has processed. This value may lag behind the actual blockchain height. If bestHeight remains significantly behind the blockchain tip, it may indicate a synchronization issue, and the indexed data might be outdated.
metashrewVersion The metashrewVersion field indicates the version of the Metashrew indexer being used.
For more details, refer to the repository: https://github.com/sandshrewmetaprotocols/metashrew.
alkanesRsVersion The alkanesRsVersion field indicates the version of the alkanes-rs indexer in use.
For more information, refer to the repository: https://github.com/kungfuflex/alkanes-rs.Method: GET
Path: /v1/indexer/alkanes/info-list
Swagger Link: View in Swagger UI
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.
type (query, string): search by type,optional; enum: token, collection, nft, contractsortBy (query, string): sort by timestamp, alkaneid, default=timestamp; enum: timestamp, alkaneid; default: timestamporder (query, string): sort order,optional,default=asc; enum: asc, desc; default: ascstart (query, integer): default=0; example: 0limit (query, integer): min=1,max=500,default=10; example: 10successful operation
code (integer): example: 0msg (string): example: ""data (object):
total (integer): example: 3045start (integer): example: 0detail (array):
alkaneid (string): example: "2583283:1333"height (integer (uint64)): example: 2583283txid (string):timestamp (integer):type (string):logo (string):tokenData (object):
name (string): example: "MyToken"symbol (string): example: "MTK"divisibility (integer): example: 0totalSupply (string): example: "1000000"maxSupply (string): example: "1000000"premine (string): example: "100000"perMint (string): example: "1000"cap (string): example: "10000000"minted (string): example: "500000"mintable (boolean):holders (integer): example: 100nftData (object):
name (string): example: "MyNFT"attributes (object):contentType (string):contentUrl (string):collectionId (string):collectionData (object):
name (string): example: "MyCollection"totalSupply (string): example: "1000"maxSupply (string): example: "1000"minted (integer):holders (integer):Method: GET
Path: /v1/indexer/alkanes/{alkaneid}/info
Swagger Link: View in Swagger UI
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.
alkaneid (path, string) (required): Alkane id in block:tx format, for example 2:1.successful operation
code (integer): example: 0msg (string): example: ""data (object):
alkaneid (string): example: "2583283:1333"height (integer (uint64)): example: 2583283txid (string):timestamp (integer):type (string):logo (string):tokenData (object):
name (string): example: "MyToken"symbol (string): example: "MTK"divisibility (integer): example: 0totalSupply (string): example: "1000000"maxSupply (string): example: "1000000"premine (string): example: "100000"perMint (string): example: "1000"cap (string): example: "10000000"minted (string): example: "500000"mintable (boolean):holders (integer): example: 100nftData (object):
name (string): example: "MyNFT"attributes (object):contentType (string):contentUrl (string):collectionId (string):collectionData (object):
name (string): example: "MyCollection"totalSupply (string): example: "1000"maxSupply (string): example: "1000"minted (integer):holders (integer):Method: GET
Path: /v1/indexer/alkanes/token-list
Swagger Link: View in Swagger UI
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.
alkaneid (query, string): search by alkaneid; example: "2:1"name (query, string): search by namesortBy (query, string): sort by timestamp, alkaneid, default=timestamp; enum: timestamp, alkaneid; default: timestamporder (query, string): sort order,optional,default=asc; enum: asc, desc; default: ascstart (query, integer): default=0; example: 0limit (query, integer): min=1,max=500,default=10; example: 10successful operation
code (integer): example: 0msg (string): example: ""data (object):
total (integer): example: 3045start (integer): example: 0detail (array):
alkaneid (string): example: "2583283:1333"height (integer (uint64)): example: 2583283txid (string):timestamp (integer):type (string):logo (string):tokenData (object):
name (string): example: "MyToken"symbol (string): example: "MTK"divisibility (integer): example: 0totalSupply (string): example: "1000000"maxSupply (string): example: "1000000"premine (string): example: "100000"perMint (string): example: "1000"cap (string): example: "10000000"minted (string): example: "500000"mintable (boolean):holders (integer): example: 100nftData (object):
name (string): example: "MyNFT"attributes (object):contentType (string):contentUrl (string):collectionId (string):collectionData (object):
name (string): example: "MyCollection"totalSupply (string): example: "1000"maxSupply (string): example: "1000"minted (integer):holders (integer):Method: GET
Path: /v1/indexer/alkanes/{alkaneid}/holders
Swagger Link: View in Swagger UI
Returns paginated holder addresses and their indexed amount for the selected Alkane. Use it to inspect token distribution or collection ownership concentration.
alkaneid (path, string) (required): Alkane id in block:tx format, for example 2:1.start (query, integer): Start offsetlimit (query, integer): min=1,max=500,default=10successful operation
code (integer): example: 0msg (string): example: ""data (object):
total (integer): example: 1start (integer): example: 0detail (array):
address (string):amount (string): example: "10000"Method: GET
Path: /v1/indexer/alkanes/{alkaneid}/collection-items
Swagger Link: View in Swagger UI
Returns paginated Alkane item metadata for a collection, including each item’s asset type and NFT or token details when available.
alkaneid (path, string) (required):start (query, integer): default=0; example: 0limit (query, integer): min=1,max=500,default=10; example: 10successful operation
code (integer): example: 0msg (string): example: ""data (object):
total (integer):start (integer):detail (array):
alkaneid (string): example: "2583283:1333"height (integer (uint64)): example: 2583283txid (string):timestamp (integer):type (string):logo (string):tokenData (object):
name (string): example: "MyToken"symbol (string): example: "MTK"divisibility (integer): example: 0totalSupply (string): example: "1000000"maxSupply (string): example: "1000000"premine (string): example: "100000"perMint (string): example: "1000"cap (string): example: "10000000"minted (string): example: "500000"mintable (boolean):holders (integer): example: 100nftData (object):
name (string): example: "MyNFT"attributes (object):contentType (string):contentUrl (string):collectionId (string):collectionData (object):
name (string): example: "MyCollection"totalSupply (string): example: "1000"maxSupply (string): example: "1000"minted (integer):holders (integer):Method: GET
Path: /v1/indexer/alkanes/{alkaneid}/contract-events
Swagger Link: View in Swagger UI
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.
alkaneid (path, string) (required):fromHeight (query, integer) (required): search by from heighttoHeight (query, integer) (required): search by to heightstart (query, integer): default=0; example: 0limit (query, integer): min=1,max=500,default=10; example: 10successful operation
code (integer): example: 0msg (string): example: ""data (object):
total (integer):start (integer):detail (array):
alkaneid (string):caller (string):type (string):opcode (string):fuel (string):inputs (array):status (string):height (integer):txid (string):vout (integer):Method: GET
Path: /v1/indexer/alkanes/utxo/{txid}/{index}/balance
Swagger Link: View in Swagger UI
Returns the Alkane assets and amounts indexed on one transaction output, with token, NFT, or collection metadata attached when available.
txid (path, string) (required):index (path, string) (required):successful operation
code (integer): example: 0msg (string): example: ""data (array):
alkaneid (string):amount (string):type (string): enum: token, collection, nft, contract; example: "token"logo (string):tokenData (object):
name (string): example: "MyToken"symbol (string): example: "MTK"divisibility (integer): example: 0totalSupply (string): example: "1000000"maxSupply (string): example: "1000000"premine (string): example: "100000"perMint (string): example: "1000"cap (string): example: "10000000"minted (string): example: "500000"mintable (boolean):holders (integer): example: 100nftData (object):
name (string): example: "MyNFT"attributes (object):contentType (string):contentUrl (string):collectionId (string):collectionData (object):
name (string): example: "MyCollection"totalSupply (string): example: "1000"maxSupply (string): example: "1000"minted (integer):holders (integer):Method: GET
Path: /v1/indexer/address/{address}/alkanes/{alkaneid}/utxo
Swagger Link: View in Swagger UI
Returns spendable transaction outputs for an address that contain the selected Alkane, including satoshi value, scriptPubKey, confirmations, and indexed Alkane balances on each UTXO.
address (path, string) (required):alkaneid (path, string) (required):start (query, integer): default=0; example: 0limit (query, integer): min=1,max=500,default=10; example: 10successful operation
code (integer): example: 0msg (string): example: ""data (object):
start (integer):total (integer):utxo (array):
address (string):satoshi (integer): example: 10000scriptPk (string):txid (string):vout (integer): example: 0confirmations (integer):alkanes (array):
alkaneid (string):amount (string):type (string): enum: token, collection, nft, contract; example: "token"logo (string):tokenData (object):
name (string): example: "MyToken"symbol (string): example: "MTK"divisibility (integer): example: 0totalSupply (string): example: "1000000"maxSupply (string): example: "1000000"premine (string): example: "100000"perMint (string): example: "1000"cap (string): example: "10000000"minted (string): example: "500000"mintable (boolean):holders (integer): example: 100nftData (object):
name (string): example: "MyNFT"attributes (object):contentType (string):contentUrl (string):collectionId (string):collectionData (object):
name (string): example: "MyCollection"totalSupply (string): example: "1000"maxSupply (string): example: "1000"minted (integer):holders (integer):Method: GET
Path: /v1/indexer/address/{address}/alkanes/token-list
Swagger Link: View in Swagger UI
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.
address (path, string) (required):start (query, integer): default=0; example: 0limit (query, integer): min=1,max=500,default=10; example: 10successful operation
code (integer): example: 0msg (string): example: ""data (object):
total (integer): example: 3045start (integer): example: 0detail (array):
alkaneid (string): example: "2583283:1333"height (integer (uint64)): example: 2583283txid (string):timestamp (integer):type (string):logo (string):tokenData (object):
name (string): example: "MyToken"symbol (string): example: "MTK"divisibility (integer): example: 0totalSupply (string): example: "1000000"maxSupply (string): example: "1000000"premine (string): example: "100000"perMint (string): example: "1000"cap (string): example: "10000000"minted (string): example: "500000"mintable (boolean):holders (integer): example: 100nftData (object):
name (string): example: "MyNFT"attributes (object):contentType (string):contentUrl (string):collectionId (string):collectionData (object):
name (string): example: "MyCollection"totalSupply (string): example: "1000"maxSupply (string): example: "1000"minted (integer):holders (integer):Method: GET
Path: /v1/indexer/address/{address}/alkanes/collection-list
Swagger Link: View in Swagger UI
Returns collection-type Alkane metadata indexed for an address, including collection name, supply, mint progress, and holder count when available.
address (path, string) (required):start (query, integer): default=0; example: 0limit (query, integer): min=1,max=500,default=10; example: 10successful operation
code (integer): example: 0msg (string): example: ""data (object):
total (integer): example: 3045start (integer): example: 0detail (array):
alkaneid (string): example: "2583283:1333"height (integer (uint64)): example: 2583283txid (string):timestamp (integer):type (string):logo (string):tokenData (object):
name (string): example: "MyToken"symbol (string): example: "MTK"divisibility (integer): example: 0totalSupply (string): example: "1000000"maxSupply (string): example: "1000000"premine (string): example: "100000"perMint (string): example: "1000"cap (string): example: "10000000"minted (string): example: "500000"mintable (boolean):holders (integer): example: 100nftData (object):
name (string): example: "MyNFT"attributes (object):contentType (string):contentUrl (string):collectionId (string):collectionData (object):
name (string): example: "MyCollection"totalSupply (string): example: "1000"maxSupply (string): example: "1000"minted (integer):holders (integer):Method: GET
Path: /v1/indexer/address/{address}/alkanes/{alkaneid}/collection-items
Swagger Link: View in Swagger UI
Returns collection item metadata scoped to one address, useful for showing which NFTs or child assets from a collection are held by that wallet.
address (path, string) (required):alkaneid (path, string) (required):start (query, integer): default=0; example: 0limit (query, integer): min=1,max=500,default=10; example: 10successful operation
code (integer): example: 0msg (string): example: ""data (object):
total (integer): example: 3045start (integer): example: 0detail (array):
alkaneid (string): example: "2583283:1333"height (integer (uint64)): example: 2583283txid (string):timestamp (integer):type (string):logo (string):tokenData (object):
name (string): example: "MyToken"symbol (string): example: "MTK"divisibility (integer): example: 0totalSupply (string): example: "1000000"maxSupply (string): example: "1000000"premine (string): example: "100000"perMint (string): example: "1000"cap (string): example: "10000000"minted (string): example: "500000"mintable (boolean):holders (integer): example: 100nftData (object):
name (string): example: "MyNFT"attributes (object):contentType (string):contentUrl (string):collectionId (string):collectionData (object):
name (string): example: "MyCollection"totalSupply (string): example: "1000"maxSupply (string): example: "1000"minted (integer):holders (integer):Method: GET
Path: /v1/indexer/address/{address}/alkanes/{alkaneid}/transfer-history
Swagger Link: View in Swagger UI
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.
address (path, string) (required):alkaneid (path, string) (required):fromHeight (query, integer) (required): search by from heighttoHeight (query, integer) (required): search by to heightstart (query, integer): default=0; example: 0limit (query, integer): min=1,max=500,default=10; example: 10successful operation
code (integer): example: 0msg (string): example: ""data (object):
total (integer): example: 3045start (integer): example: 0detail (array):
height (integer):txid (string):type (string):subType (string):alkaneid (string):address (string):amount (string): example: "10000"