unisat-dev-docs

Runes Indexer API

Runes Indexer API is a RESTful API for indexing and querying Bitcoin Runes data. It provides endpoints for Runes status, Rune list/search, Rune metadata, holders, address balances, and transferable Rune UTXOs.

👉 View Swagger UI


đź“‘ Table of Contents

Route Summary
GET /v1/indexer/runes/status Get Runes indexer status and minimum rune state
GET /v1/indexer/runes/info-list Search and list Rune metadata entries
GET /v1/indexer/runes/(runeid)/info Get detailed metadata for a Rune
GET /v1/indexer/runes/(runeid)/holders List holders for a Rune
GET /v1/indexer/address/(address)/runes/balance-list List all Rune balances for an address
GET /v1/indexer/address/(address)/runes/(runeid)/balance Get an address’s balance for one Rune
GET /v1/indexer/runes/utxo/(txid)/(index)/balance Get Rune balances carried by a specific UTXO
GET /v1/indexer/address/(address)/runes/(runeid)/utxo List an address’s transferable UTXOs for one Rune
GET /v1/indexer/runes/event Search Rune etch, mint, burn, send, and receive events

Runes Indexer

Get Runes indexer status and minimum rune state

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

Description

Returns the latest indexed height, total rune count, current minimum rune, and halving block count. Use it to check Runes indexer freshness before reading rune metadata, holder lists, balances, UTXOs, or event history; data may lag new confirmations.

Response (200)

successful operation

Notes

image


Search and list Rune metadata entries

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

Description

Returns paginated Rune entries with rune id, raw and spaced names, divisibility, symbol, etching transaction, premine, terms, mints, burned amount, holders, transactions, supply, mintability, and remaining amount. Use it for Rune discovery, filtering, and ranking; spaced names may contain bullet separators.

Parameters

Response (200)

successful operation


Get detailed metadata for a Rune

Method: GET
Path: /v1/indexer/runes/{runeid}/info
Swagger Link: View in Swagger UI

Description

Returns one Rune entry by block:tx rune id, including names, symbol, divisibility, etching transaction, premine, mint terms, supply, burned amount, holder and transaction counts, mintability, and remaining supply. Use it for Rune detail pages and validation before balance or holder queries.

Parameters

Response (200)

successful operation


List holders for a Rune

Method: GET
Path: /v1/indexer/runes/{runeid}/holders
Swagger Link: View in Swagger UI

Description

Returns holder addresses and Rune amounts for a specific block:tx rune id with pagination totals. Use it for holder distribution and ownership analysis; amounts are indexed token balances and do not authorize transfers or UTXO spends.

Parameters

Response (200)

successful operation


List all Rune balances for an address

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

Description

Returns paginated Rune balances held by an address, including rune id, raw and spaced names, symbol, divisibility, and amount. Use it for wallet portfolio displays or account audits; balances are indexer-derived and should be reconciled with UTXOs before spending.

Parameters

Response (200)

successful operation


Get an address’s balance for one Rune

Method: GET
Path: /v1/indexer/address/{address}/runes/{runeid}/balance
Swagger Link: View in Swagger UI

Description

Returns the indexed amount and Rune identity fields for one address and block:tx rune id. Use it for single-token wallet views or pre-transfer checks; spend construction must still inspect Rune UTXOs and current mempool state.

Parameters

Response (200)

successful operation


Get Rune balances carried by a specific UTXO

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

Description

Returns all Rune balances associated with one transaction output, including rune id, names, symbol, divisibility, and amount. Use it for coin selection diagnostics or validating a Rune-bearing UTXO; callers must confirm the UTXO is still unspent before spending.

Parameters

Response (200)

successful operation


List an address’s transferable UTXOs for one Rune

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

Description

Returns UTXOs for an address that carry the selected Rune, including address, satoshi value, script, outpoint, and embedded Rune balances. Use it to prepare transfer candidates; revalidate ownership, dust policy, and mempool state before signing or broadcasting.

Parameters

Response (200)

successful operation


Search Rune etch, mint, burn, send, and receive events

Method: GET
Path: /v1/indexer/runes/event
Swagger Link: View in Swagger UI

Description

Returns paginated Rune events with type, address, amount, height, transaction index, txid, timestamp, raw rune name, and rune id. Use it for activity feeds, compliance exports, or block and transaction investigations; results are read-only indexer events and may lag recent confirmations.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key