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
| 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 |
Method: GET
Path: /v1/indexer/runes/status
Swagger Link: View in Swagger UI
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.
successful operation
code (integer): example: 0msg (string): example: ""data (object):
bestHeight (integer):runes (integer): example: 100minimumRune (string): example: "AAAAAAAAAAAA"halvingBlockCount (integer): example: 100
Method: GET
Path: /v1/indexer/runes/info-list
Swagger Link: View in Swagger UI
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.
rune (query, string): Search by spaced Rune name, for example DOG•GO•TO•THE•MOON.; example: "DOG•GO•TO•THE•MOON"sort (query, string): by (holders/transactions/timestamp); example: "timestamp"complete (query, string): complete type(yes/no); example: "no"start (query, integer): default=0; example: 0limit (query, integer): required,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):
runeid (string): example: "2583283:1333"rune (string): example: "UNCOMMONGOODS"spacedRune (string): example: "UNCOMMON•GOODS"number (integer (uint64)): example: 0height (integer (uint64)): example: 2583283txidx (integer (uint64)): example: 1333timestamp (integer): example: 1623423423divisibility (integer (uint8)): example: 2symbol (string (Option<char>)): example: "G"etching (string): example: "7cd19fef13aa2924d4446b1a86c1904e02e46d16630370bc6de86f769692e242"premine (string): example: "10000"terms (object):
amount (string): example: "1000000"cap (string): example: "234000"heightStart (integer): example: 245000heightEnd (integer): example: 2480000offsetStart (integer): example: nulloffsetEnd (integer): example: nullmints (string): example: "500"burned (string (u128)): example: "1000"holders (integer): example: 1000transactions (integer): example: 1000supply (string): example: "500010000"start (integer):end (integer):mintable (boolean):remaining (string):Method: GET
Path: /v1/indexer/runes/{runeid}/info
Swagger Link: View in Swagger UI
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.
runeid (path, string) (required): Rune id in block:tx format, for example 840000:3.successful operation
code (integer): example: 0msg (string): example: ""data (object):
runeid (string): example: "2583283:1333"rune (string): example: "UNCOMMONGOODS"spacedRune (string): example: "UNCOMMON•GOODS"number (integer (uint64)): example: 0height (integer (uint64)): example: 2583283txidx (integer (uint64)): example: 1333timestamp (integer): example: 1623423423divisibility (integer (uint8)): example: 2symbol (string (Option<char>)): example: "G"etching (string): example: "7cd19fef13aa2924d4446b1a86c1904e02e46d16630370bc6de86f769692e242"premine (string): example: "10000"terms (object):
amount (string): example: "1000000"cap (string): example: "234000"heightStart (integer): example: 245000heightEnd (integer): example: 2480000offsetStart (integer): example: nulloffsetEnd (integer): example: nullmints (string): example: "500"burned (string (u128)): example: "1000"holders (integer): example: 1000transactions (integer): example: 1000supply (string): example: "500010000"start (integer):end (integer):mintable (boolean):remaining (string):Method: GET
Path: /v1/indexer/runes/{runeid}/holders
Swagger Link: View in Swagger UI
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.
runeid (path, string) (required): Rune id in block:tx format, for example 840000:3.start (query, integer): Start offsetlimit (query, integer): Number of inscriptions returnedsuccessful 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/address/{address}/runes/balance-list
Swagger Link: View in Swagger UI
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.
address (path, string) (required): Bitcoin address.start (query, integer): Start offsetlimit (query, integer): Number of items returnedsuccessful operation
code (integer): example: 0msg (string): example: ""data (object):
start (integer):total (integer):detail (array):
amount (string): example: "10000"runeid (string): example: "2584327:44"rune (string): example: "AAAAAAAAAAAAAB"spacedRune (string): example: "AAAAA•AAA•AAAAA•B"symbol (string): example: "G"divisibility (integer): example: 0Method: GET
Path: /v1/indexer/address/{address}/runes/{runeid}/balance
Swagger Link: View in Swagger UI
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.
address (path, string) (required): Bitcoin address.runeid (path, string) (required): Rune id in block:tx format, for example 840000:3.successful operation
code (integer): example: 0msg (string): example: ""data (object):
amount (string): example: "10000"runeid (string): example: "2584327:44"rune (string): example: "AAAAAAAAAAAAAB"spacedRune (string): example: "AAAAA•AAA•AAAAA•B"symbol (string): example: "G"divisibility (integer): example: 0Method: GET
Path: /v1/indexer/runes/utxo/{txid}/{index}/balance
Swagger Link: View in Swagger UI
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.
txid (path, string) (required):index (path, string) (required):successful operation
code (integer): example: 0msg (string): example: ""data (array):
amount (string): example: "10000"runeid (string): example: "2584327:44"rune (string): example: "AAAAAAAAAAAAAB"spacedRune (string): example: "AAAAA•AAA•AAAAA•B"symbol (string): example: "G"divisibility (integer): example: 0Method: GET
Path: /v1/indexer/address/{address}/runes/{runeid}/utxo
Swagger Link: View in Swagger UI
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.
address (path, string) (required):runeid (path, string) (required): Rune id in block:tx format, for example 840000:3.start (query, integer): default=0; example: 0limit (query, integer): required,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: 0runes (array):
amount (string): example: "10000"runeid (string): example: "2584327:44"rune (string): example: "AAAAAAAAAAAAAB"spacedRune (string): example: "AAAAA•AAA•AAAAA•B"symbol (string): example: "G"divisibility (integer): example: 0Method: GET
Path: /v1/indexer/runes/event
Swagger Link: View in Swagger UI
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.
rune (query, string): Filter by runetype (query, string): Filter by history type; enum: etch, mint, burn, receive, sendaddress (query, string): Filter by addressheight (query, integer): Filter by block heighttxid (query, string): Filter by txstart (query, integer): Start offsetlimit (query, integer): Number of inscriptions returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
detail (array):
type (string): enum: etch, mint, burn, send, receiveaddress (string):amount (string):height (integer):txidx (integer):txid (string):timestamp (integer):rune (string):runeid (string):start (integer):total (integer):Invalid API Key