unisat-dev-docs

BRC-20 API

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


đź“‘ Table of Contents

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

BRC20 Indexer

Get Classic BRC-20 indexer height and ticker total

Method: GET
Path: /v1/indexer/brc20/bestheight
Swagger Link: View in Swagger UI

Description

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.

Response (200)

Successful operation

Response (401)

Invalid API Key


List indexed Classic BRC-20 tickers

Method: GET
Path: /v1/indexer/brc20/list
Swagger Link: View in Swagger UI

Description

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.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


Search Classic BRC-20 ticker status and mint progress

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

Description

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.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


Get Classic BRC-20 ticker deployment and supply info

Method: GET
Path: /v1/indexer/brc20/{ticker}/info
Swagger Link: View in Swagger UI

Description

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.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key

Notes

image

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");
}

image


List Classic BRC-20 holders and balances for a ticker

Method: GET
Path: /v1/indexer/brc20/{ticker}/holders
Swagger Link: View in Swagger UI

Description

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.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


List Classic BRC-20 history events for a ticker

Method: GET
Path: /v1/indexer/brc20/{ticker}/history
Swagger Link: View in Swagger UI

Description

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.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


Get Classic BRC-20 ticker events in a transaction

Method: GET
Path: /v1/indexer/brc20/{ticker}/tx/{txid}/history
Swagger Link: View in Swagger UI

Description

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.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


List Classic BRC-20 events indexed at a block height

Method: GET
Path: /v1/indexer/brc20/history-by-height/{height}
Swagger Link: View in Swagger UI

Description

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.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


List an address’s Classic BRC-20 token balances

Method: GET
Path: /v1/indexer/address/{address}/brc20/summary
Swagger Link: View in Swagger UI

Description

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.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key

Notes

Each ticker includes two types of balances:


List an address’s Classic BRC-20 balances at a height

Method: GET
Path: /v1/indexer/address/{address}/brc20/summary-by-height/{height}
Swagger Link: View in Swagger UI

Description

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.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


Get an address’s Classic BRC-20 balance details for a ticker

Method: GET
Path: /v1/indexer/address/{address}/brc20/{ticker}/info
Swagger Link: View in Swagger UI

Description

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.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


List all Classic BRC-20 history events for an address

Method: GET
Path: /v1/indexer/address/{address}/brc20/history
Swagger Link: View in Swagger UI

Description

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.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


List an address’s Classic BRC-20 history for a ticker

Method: GET
Path: /v1/indexer/address/{address}/brc20/{ticker}/history
Swagger Link: View in Swagger UI

Description

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.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


List transferable Classic BRC-20 inscriptions for an address

Method: GET
Path: /v1/indexer/address/{address}/brc20/{ticker}/transferable-inscriptions
Swagger Link: View in Swagger UI

Description

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.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


List Classic BRC-20 module history for a module inscription

Method: GET
Path: /v1/indexer/brc20-module/{module}/history
Swagger Link: View in Swagger UI

Description

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.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


List Classic BRC-20 module withdrawal history

Method: GET
Path: /v1/indexer/brc20-module/withdraw-history
Swagger Link: View in Swagger UI

Description

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.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key