unisat-dev-docs

BRC-20 API

BRC-20 API is a RESTful API for BRC-20 token data indexing and querying. It provides endpoints to retrieve information about BRC-20 tokens, including their status, holders, history, and more.

👉 View Swagger UI

📑 Table of Contents

Route	Summary
GET /v1/indexer/brc20/bestheight	Get the best block height of BRC20 data
GET /v1/indexer/brc20/list	Get the tiker list of BRC20 token.
GET /v1/indexer/brc20/status	Get the status of BRC20 list.
GET /v1/indexer/brc20/{ticker}/info	Get the infomation of BRC20 by ticker
GET /v1/indexer/brc20/{ticker}/holders	Get the holders of BRC20 by ticker.
GET /v1/indexer/brc20/{ticker}/history	Get the full history of BRC20 by ticker.
GET /v1/indexer/brc20/{ticker}/tx/{txid}/history	Get the full history of BRC20 by address.
GET /v1/indexer/brc20/history-by-height/{height}	Get the tiker list of BRC20 token by height.
GET /v1/indexer/address/{address}/brc20/summary	Get the BRC20 token summary by address.
GET /v1/indexer/address/{address}/brc20/summary-by-height/{height}	Get the BRC20 token summary by address and height.
GET /v1/indexer/address/{address}/brc20/{ticker}/info	Get the BRC20 token info by address and ticker.
GET /v1/indexer/address/{address}/brc20/history	Get the full history of BRC20 by address.
GET /v1/indexer/address/{address}/brc20/{ticker}/history	Get the full history of BRC20 by address and ticker.
GET /v1/indexer/address/{address}/brc20/{ticker}/transferable-inscriptions	Get the transferable inscriptions list of BRC20 by address.
GET /v1/indexer/brc20-module/{module}/history	Get the history of BRC20 Module by address.
GET /v1/indexer/brc20-module/withdraw-history	Get the withdraw history of BRC20.

BRC-20

Get the best block height of BRC20 data

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

Description

Get the best block height of BRC20 data. This value will be consistent with the latest block height a short time after the block has been confirmed.

Response (200)

Get the tiker list of BRC20 token.

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

Description

Get the tiker list of BRC20 token.

Parameters

start (query) (required): Start offset
limit (query) (required): Number of inscriptions returned

Response (200)

Get the status of BRC20 list.

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

Description

Obtain BRC20 list status

Parameters

start (query) (required): Start offset
limit (query) (required): Number of inscriptions returned
sort (query) : sort by (holders/deploy/minted/transactions)
complete (query) : filter by (completed or not)

Response (200)

Get the infomation of BRC20 by ticker

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

Description

Get the infomation of BRC20 by ticker.

Parameters

ticker (path) (required): Token ticker

Response (200)

Notes

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

Get the holders of BRC20 by ticker.

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

Description

Get the holders of BRC20 by ticker.

Parameters

ticker (path) (required): Token ticker
start (query) (required): Start offset
limit (query) (required): Number of returned

Response (200)

Get the full history of BRC20 by ticker.

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

Description

Get the full history of BRC20.

Parameters

ticker (path) (required): Token ticker
type (query) (required): Filter by history type
height (query) (required): Block height
start (query) (required): Start offset
limit (query) (required): Number of inscriptions returned

Response (200)

Get the full history of BRC20 by address.

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

Description

Get the full history of BRC20 by address.

Parameters

ticker (path) (required): Token ticker
txid (path) (required): txid
type (query) (required): Filter by history type
start (query) (required): Start offset
limit (query) (required): Number of inscriptions returned

Response (200)

Get the tiker list of BRC20 token by height.

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

Description

Get the tiker list of BRC20 token.

Parameters

height (path) (required): Block Height
start (query) (required): Start offset
limit (query) (required): Number of inscriptions returned

Response (200)

Get the BRC20 token summary by address.

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

Description

Obtain BRC20 token summary by address, including available balance, transferable balance

Parameters

address (path) (required): Address
start (query) (required): Start offset
limit (query) (required): Number of inscriptions returned
tick_filter (query) : Filter by tick type (8 Filter ticks with selfMint set to false, 16 Filter ticks with selfMint set to true, 24 Return all ticks regardless of selfMint.)
exclude_zero (query) : Exclude zero balance

Response (200)

Notes

Each ticker includes two types of balances:

transferableBalance: The balance already inscribed as TRANSFER inscriptions
availableBalance: The balance can be inscribed as TRANSFER inscriptions
overallBalance = transferableBalance+availableBalance

Get the BRC20 token summary by address and height.

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

Description

Obtain BRC20 token summary by address, including available balance, transferable balance

Parameters

address (path) (required): Address
height (path) (required): Block Height
start (query) (required): Start offset
limit (query) (required): Number of inscriptions returned

Response (200)

Get the BRC20 token info by address and ticker.

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

Description

Obtain BRC20 token infomation by address, including available balance, transferable balance, number of transferable inscriptions, the first few Inscriptions, etc.

Parameters

address (path) (required): Address
ticker (path) (required): Token ticker

Response (200)

Get the full history of BRC20 by address.

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

Description

Get the full history of BRC20 by address.

Parameters

address (path) (required): Address
start (query) (required): Start offset
limit (query) (required): Number of inscriptions returned

Response (200)

Get the full history of BRC20 by address and ticker.

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

Description

Get the full history of BRC20 by address.

Parameters

address (path) (required): Address
ticker (path) (required): Token ticker
type (query) (required): Filter by history type
start (query) (required): Start offset
limit (query) (required): Number of inscriptions returned

Response (200)

Get the transferable inscriptions list of BRC20 by address.

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

Description

Get the transferable inscriptions list of BRC20 by address.

Parameters

address (path) (required): Address
ticker (path) (required): Token ticker
start (query) (required): Start offset
limit (query) (required): Number of inscriptions returned

Response (200)

Get the history of BRC20 Module by address.

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

Description

Get the history of BRC20 Module.

Parameters

module (path) (required): Address
start (query) (required): Start height
end (query) (required): End height
cursor (query) (required): Start Offset
size (query) (required): Number of events returned

Response (200)

Get the withdraw history of BRC20.

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