BRC-20 API is a RESTful API for classic BRC-20 token data indexing and querying. It provides endpoints to retrieve information about classic BRC-20 tokens, including their status, holders, history, and more. Use these endpoints for classic BRC-20 tickers such as ordi. Do not use these endpoints for BRC20-Prog 6-character tickers; use /v1/indexer/brc20-prog/* endpoints for BRC20-Prog data.
👉 View Swagger UI
| Route | Summary |
|---|---|
GET /v1/indexer/brc20/bestheight |
Get Classic BRC-20 indexer height and ticker total |
GET /v1/indexer/brc20/list |
List indexed Classic BRC-20 tickers |
GET /v1/indexer/brc20/status |
Search Classic BRC-20 ticker status and mint progress |
GET /v1/indexer/brc20/(ticker)/info |
Get Classic BRC-20 ticker deployment and supply info |
GET /v1/indexer/brc20/(ticker)/holders |
List Classic BRC-20 holders and balances for a ticker |
GET /v1/indexer/brc20/(ticker)/history |
List Classic BRC-20 history events for a ticker |
GET /v1/indexer/brc20/(ticker)/tx/(txid)/history |
Get Classic BRC-20 ticker events in a transaction |
GET /v1/indexer/brc20/history-by-height/(height) |
List Classic BRC-20 events indexed at a block height |
GET /v1/indexer/address/(address)/brc20/summary |
List an address’s Classic BRC-20 token balances |
GET /v1/indexer/address/(address)/brc20/summary-by-height/(height) |
List an address’s Classic BRC-20 balances at a height |
GET /v1/indexer/address/(address)/brc20/(ticker)/info |
Get an address’s Classic BRC-20 balance details for a ticker |
GET /v1/indexer/address/(address)/brc20/history |
List all Classic BRC-20 history events for an address |
GET /v1/indexer/address/(address)/brc20/(ticker)/history |
List an address’s Classic BRC-20 history for a ticker |
GET /v1/indexer/address/(address)/brc20/(ticker)/transferable-inscriptions |
List transferable Classic BRC-20 inscriptions for an address |
GET /v1/indexer/brc20-module/(module)/history |
List Classic BRC-20 module history for a module inscription |
GET /v1/indexer/brc20-module/withdraw-history |
List Classic BRC-20 module withdrawal history |
Method: GET
Path: /v1/indexer/brc20/bestheight
Swagger Link: View in Swagger UI
Returns the latest indexed block height, block hash, block timestamp, and total Classic BRC-20 ticker count. Use it to check indexer freshness before reading token status, holders, history, or address balances; data may lag the chain tip and should not be used for BRC20-Prog 6-character tickers.
Successful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
height (integer): best block height of brc20blockid (string): best block id of brc20timestamp (integer): timestamp of best blocktotal (integer): total number of brc20 tickersInvalid API Key
Method: GET
Path: /v1/indexer/brc20/list
Swagger Link: View in Swagger UI
Returns a paginated ticker list with total count and start offset for Classic BRC-20 discovery. Use these tickers with the Classic BRC-20 info, holder, history, and address-balance endpoints; route BRC20-Prog 6-character tickers to the brc20-prog API instead.
start (query, integer) (required): Start offsetlimit (query, integer) (required): Number of inscriptions returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
detail (object):start (integer):total (integer):Invalid API Key
Method: GET
Path: /v1/indexer/brc20/status
Swagger Link: View in Swagger UI
Returns indexed Classic BRC-20 ticker status records including deployment metadata, minted supply, holder and history counts, and completion state. Use sort and completion filters for token discovery or ranking; balances are indexer-derived and may change as new blocks are processed.
start (query, integer) (required): Start offsetlimit (query, integer) (required): Number of inscriptions returnedsort (query, string): sort by (holders/deploy/minted/transactions); enum: holders, deploy, minted, transactionscomplete (query, string): filter by (completed or not); enum: yes, noSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
height (integer):start (integer):total (integer):detail (array):
ticker (string):creator (string):totalMinted (string):confirmedMinted (string):confirmedMinted1h (string):confirmedMinted24h (string):completeBlocktime (integer):completeHeight (integer):inscriptionNumberEnd (integer):inscriptionNumberStart (integer):minted (string):mintTimes (integer):historyCount (integer):holdersCount (integer):txid (string):deployHeight (integer):deployBlocktime (integer):inscriptionId (string):inscriptionNumber (integer):max (string):decimal (integer):limit (string):Invalid API Key
Method: GET
Path: /v1/indexer/brc20/{ticker}/info
Swagger Link: View in Swagger UI
Returns deployment inscription, creator, max supply, mint limit, decimals, minted amounts, holder count, and related history counts for one Classic BRC-20 ticker. Use this before showing token detail pages or validating ticker-level context; 6-character BRC20-Prog tickers are intentionally out of scope.
ticker (path, string) (required): Classic BRC-20 ticker, such as ordi. Use brc20-prog endpoints for 6-character BRC20-Prog tickers.Successful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
ticker (string):creator (string):totalMinted (string):confirmedMinted (string):confirmedMinted1h (string):confirmedMinted24h (string):completeBlocktime (integer):completeHeight (integer):inscriptionNumberEnd (integer):inscriptionNumberStart (integer):minted (string):mintTimes (integer):historyCount (integer):holdersCount (integer):txid (string):deployHeight (integer):deployBlocktime (integer):inscriptionId (string):inscriptionNumber (integer):max (string):decimal (integer):limit (string):Invalid API Key

Due to the inability to transmit special characters on the router, for tickers containing special characters, please use the hexadecimal encoding format.
export function stringToHex(stringToEncode: string) {
return Buffer.from(stringToEncode).toString("hex");
}

Method: GET
Path: /v1/indexer/brc20/{ticker}/holders
Swagger Link: View in Swagger UI
Returns holder addresses with overall, transferable, and available balances for the selected Classic BRC-20 ticker. Use it for holder distribution views or balance audits; values are indexed token balances and do not authorize transfers or create inscriptions.
ticker (path, string) (required): Classic BRC-20 ticker, such as ordi. Use brc20-prog endpoints for 6-character BRC20-Prog tickers.start (query, integer) (required): Start offsetlimit (query, integer) (required): Number of returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
detail (array):
address (string):availableBalance (string):overallBalance (string):transferableBalance (string):start (integer):total (integer):Invalid API Key
Method: GET
Path: /v1/indexer/brc20/{ticker}/history
Swagger Link: View in Swagger UI
Returns deploy, mint, transfer-inscription, send, and receive events with inscription, transaction, balance, height, and validity fields. Use it for token activity feeds or reconciliation at a height; invalid or unconfirmed protocol actions should be interpreted according to the returned validity and indexer state.
ticker (path, string) (required): Classic BRC-20 ticker, such as ordi. Use brc20-prog endpoints for 6-character BRC20-Prog tickers.type (query, string) (required): Filter by history type; enum: inscribe-deploy, inscribe-mint, inscribe-transfer, transfer, send, receiveheight (query, integer) (required): Block heightstart (query, integer) (required): Start offsetlimit (query, integer) (required): Number of inscriptions returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
detail (array):
valid (boolean):type (string):from (string):to (string):amount (string):overallBalance (string):availableBalance (string):transferBalance (string):inscriptionId (string):inscriptionNumber (integer):height (integer):blockhash (string):blocktime (integer):txIdx (integer):txid (string):satoshi (integer):offset (integer):start (integer):total (integer):Invalid API Key
Method: GET
Path: /v1/indexer/brc20/{ticker}/tx/{txid}/history
Swagger Link: View in Swagger UI
Returns ticker-specific history events found in a transaction, including event type, inscription id, amount, counterparties, balances, and validity. Use it to explain how a transaction affected a Classic BRC-20 ticker; always treat returned balances as indexed results rather than spend authorization.
ticker (path, string) (required): Classic BRC-20 ticker, such as ordi. Use brc20-prog endpoints for 6-character BRC20-Prog tickers.txid (path, string) (required): txidtype (query, string) (required): Filter by history type; enum: inscribe-deploy, inscribe-mint, inscribe-transfer, transfer, send, receivestart (query, integer) (required): Start offsetlimit (query, integer) (required): Number of inscriptions returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
detail (array):
valid (boolean):type (string):from (string):to (string):amount (string):overallBalance (string):availableBalance (string):transferBalance (string):inscriptionId (string):inscriptionNumber (integer):height (integer):blockhash (string):blocktime (integer):txIdx (integer):txid (string):satoshi (integer):offset (integer):start (integer):total (integer):Invalid API Key
Method: GET
Path: /v1/indexer/brc20/history-by-height/{height}
Swagger Link: View in Swagger UI
Returns paginated Classic BRC-20 history events for a specific block height with ticker, transaction, inscription, amount, and validity details. Use it for block-level indexing audits or backfills; results represent the indexer’s view of confirmed protocol events at that height.
height (path, integer) (required): Block Heightstart (query, integer) (required): Start offsetlimit (query, integer) (required): Number of inscriptions returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
height (number):total (integer):start (integer):detail (array):
valid (boolean):type (string):from (string):to (string):amount (string):overallBalance (string):availableBalance (string):transferBalance (string):inscriptionId (string):inscriptionNumber (integer):height (integer):blockhash (string):blocktime (integer):txIdx (integer):txid (string):satoshi (integer):offset (integer):Invalid API Key
Method: GET
Path: /v1/indexer/address/{address}/brc20/summary
Swagger Link: View in Swagger UI
Returns paginated Classic BRC-20 balance summaries for an address, including ticker, indexed height, total count, overall balance, transferable balance, and available balance. Use tick_filter to separate 4-, 5-, or 6-character Classic BRC-20 namespaces when needed; use brc20-prog endpoints for BRC20-Prog semantics.
address (path, string) (required): Addressstart (query, integer) (required): Start offsetlimit (query, integer) (required): Number of inscriptions returnedtick_filter (query, string): -> filter by tick type 8 - Returns only 4-character BRC20 tokens 16 - Returns only 5-character BRC20 tokens 32 - Returns only 6-character BRC20 tokens 24 - Returns 4 and 5-character BRC20 tokens (bitwise combination 8 |
16) 56 - Returns 4, 5, and 6-character BRC20 tokens (bitwise combination 8 | 16 | 32); enum: 8, 16, 24, 32, 56 |
exclude_zero (query, boolean): Exclude zero balanceSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
height (integer):start (integer):total (integer):detail (array):
ticker (string):overallBalance (string):transferableBalance (string):availableBalance (string):Invalid API Key
Each ticker includes two types of balances:
Method: GET
Path: /v1/indexer/address/{address}/brc20/summary-by-height/{height}
Swagger Link: View in Swagger UI
Returns the address’s indexed Classic BRC-20 balance summaries as of a specific block height, including ticker, overall, transferable, and available balances. Use it for historical portfolio snapshots or reconciliation; balances are read-only indexer state and may differ from current spendability.
address (path, string) (required): Addressheight (path, string) (required): Block Heightstart (query, integer) (required): Start offsetlimit (query, integer) (required): Number of inscriptions returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
height (integer):start (integer):total (integer):detail (array):
ticker (string):overallBalance (string):transferableBalance (string):availableBalance (string):Invalid API Key
Method: GET
Path: /v1/indexer/address/{address}/brc20/{ticker}/info
Swagger Link: View in Swagger UI
Returns one address’s overall, available, safe, unsafe, and transferable balances for a Classic BRC-20 ticker, plus related transfer inscriptions and history counts. Use it before building transfer flows or balance displays; this endpoint only reports indexed state and does not guarantee UTXO spend safety.
address (path, string) (required): Addressticker (path, string) (required): Classic BRC-20 ticker, such as ordi. Use brc20-prog endpoints for 6-character BRC20-Prog tickers.Successful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
ticker (string):overallBalance (string):availableBalance (string):availableBalanceSafe (string):availableBalanceUnSafe (string):transferableBalance (string):historyCount (integer):historyInscriptions (array):
confirmations (integer):data (object):
amt (string):decimal (string):lim (string):max (string):minted (string):op (string):tick (string):to (string):inscriptionId (string):inscriptionNumber (integer):transferableCount (integer):transferableInscriptions (array):
confirmations (integer):data (object):
amt (string):decimal (string):lim (string):max (string):minted (string):op (string):tick (string):to (string):inscriptionId (string):inscriptionNumber (integer):Invalid API Key
Method: GET
Path: /v1/indexer/address/{address}/brc20/history
Swagger Link: View in Swagger UI
Returns paginated Classic BRC-20 events involving an address across tickers, including event type, amount, counterparties, transaction, inscription, and balance fields. Use it for wallet activity timelines and audits; events are indexer-derived and should be checked for validity before user-facing accounting.
address (path, string) (required): Addressstart (query, integer) (required): Start offsetlimit (query, integer) (required): Number of inscriptions returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
detail (array):
valid (boolean):type (string):from (string):to (string):amount (string):overallBalance (string):availableBalance (string):transferBalance (string):inscriptionId (string):inscriptionNumber (integer):height (integer):blockhash (string):blocktime (integer):txIdx (integer):txid (string):satoshi (integer):offset (integer):start (integer):total (integer):Invalid API Key
Method: GET
Path: /v1/indexer/address/{address}/brc20/{ticker}/history
Swagger Link: View in Swagger UI
Returns ticker-specific Classic BRC-20 events for an address with event type, transaction, inscription, amount, balance, height, and validity fields. Use it to explain wallet balance changes for one ticker; read the validity flag and confirmation context before treating events as final.
address (path, string) (required): Addressticker (path, string) (required): Classic BRC-20 ticker, such as ordi. Use brc20-prog endpoints for 6-character BRC20-Prog tickers.type (query, string) (required): Filter by history type; enum: inscribe-deploy, inscribe-mint, inscribe-transfer, transfer, send, receivestart (query, integer) (required): Start offsetlimit (query, integer) (required): Number of inscriptions returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
detail (array):
valid (boolean):type (string):from (string):to (string):amount (string):overallBalance (string):availableBalance (string):transferBalance (string):inscriptionId (string):inscriptionNumber (integer):height (integer):blockhash (string):blocktime (integer):txIdx (integer):txid (string):satoshi (integer):offset (integer):start (integer):total (integer):Invalid API Key
Method: GET
Path: /v1/indexer/address/{address}/brc20/{ticker}/transferable-inscriptions
Swagger Link: View in Swagger UI
Returns unused transferable inscriptions for a Classic BRC-20 ticker with inscription id, inscription number, satoshi value, confirmations, and transfer amount payload. Use it to select candidate transfer inscriptions; callers must still validate UTXO ownership, confirmation policy, and signing context before spending.
address (path, string) (required): Addressticker (path, string) (required): Classic BRC-20 ticker, such as ordi. Use brc20-prog endpoints for 6-character BRC20-Prog tickers.start (query, integer) (required): Start offsetlimit (query, integer) (required): Number of inscriptions returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
detail (object):
inscriptionNumber (integer):inscriptionId (string):satoshi (integer):confirmations (integer):data (object):
op (string):tick (string):lim (string):amt (string):decimal (string):start (integer):total (integer):Invalid API Key
Method: GET
Path: /v1/indexer/brc20-module/{module}/history
Swagger Link: View in Swagger UI
Returns module-related Classic BRC-20 events across a height range, including inscription, satpoint, address, amount, validity, and block metadata. Use it to inspect module deposit or movement workflows; this is an indexer audit view and does not submit withdrawals or transfers.
module (path, string) (required): Addressstart (query, integer) (required): Start heightend (query, integer) (required): End heightcursor (query, integer) (required): Start Offsetsize (query, integer) (required): Number of events returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
detail (array):
type (string):valid (boolean):txid (string):idx (number):vout (number):offset (integer):inscriptionNumber (integer):inscriptionId (string):contentType (string):contentBody (string):oldSatPoint (string):newSatPoint (string):from (string):to (string):satoshi (integer):data (object):
tick (string):amount (string):height (integer):txidx (integer):blockhash (string):blocktime (integer):start (integer):total (integer):Invalid API Key
Method: GET
Path: /v1/indexer/brc20-module/withdraw-history
Swagger Link: View in Swagger UI
Returns withdrawal-related module events within a height range, including inscription, satpoint, address, token amount, transaction, validity, and block metadata. Use it for module withdrawal monitoring and reconciliation; this endpoint is read-only and never creates, signs, or broadcasts withdrawals.
start (query, integer) (required): Start heightend (query, integer) (required): End heightcursor (query, integer) (required): Start Offsetsize (query, integer) (required): Number of events returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
detail (array):
type (string):valid (boolean):txid (string):idx (number):vout (number):offset (integer):inscriptionNumber (integer):inscriptionId (string):contentType (string):contentBody (string):oldSatPoint (string):newSatPoint (string):from (string):to (string):satoshi (integer):data (object):
tick (string):amount (string):height (integer):txidx (integer):blockhash (string):blocktime (integer):start (integer):total (integer):Invalid API Key