unisat-dev-docs

Inscription Indexer API

Inscription Indexer API is a RESTful API for accessing and managing inscriptions on the Bitcoin blockchain. It provides endpoints to retrieve information about inscriptions, including their status, metadata, and associated transactions.

👉 View Swagger UI


đź“‘ Table of Contents

Route Summary
GET /v1/indexer/inscription/info/(inscriptionId) Get inscription metadata by id or number
GET /v1/indexer/inscription/content/(inscriptionId) Fetch raw inscription content by id or number
GET /v1/indexer/inscription/events List inscription mint and transfer events by block range
GET /v1/indexer/address/(address)/inscription-data List inscriptions currently associated with an address
GET /v1/indexer/address/(address)/inscription-utxo-data List inscription-bearing UTXOs for an address
GET /v1/indexer/address/(address)/abandon-nft-utxo-data List abandoned NFT-style inscription UTXOs for an address
GET /v1/indexer/utxo-nft-offset/(txid)/(index) Check UTXO inscription offsets before creating a BRC-20 inscription

Inscription Indexer

Get inscription metadata by id or number

Method: GET
Path: /v1/indexer/inscription/info/{inscriptionId}
Swagger Link: View in Swagger UI

Description

Returns inscription owner, number, content metadata, parent and delegate flags, metaprotocol fields, BRC-20 payload when present, and current UTXO context. Use either an inscription id or inscription number; verify network and confirmation state before relying on ownership-sensitive results.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


Fetch raw inscription content by id or number

Method: GET
Path: /v1/indexer/inscription/content/{inscriptionId}
Swagger Link: View in Swagger UI

Description

Streams the inscription content body for rendering, preview, or archival workflows. The identifier may be an inscription id or inscription number where supported; callers should trust the returned content type from inscription metadata and avoid executing untrusted content directly.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


List inscription mint and transfer events by block range

Method: GET
Path: /v1/indexer/inscription/events
Swagger Link: View in Swagger UI

Description

Returns paginated inscription events with transfer flag, inscription id and number, address, content fields for mint events, transaction data, satoshi value, timestamp, and block metadata. Use it for indexer backfills, activity feeds, or monitoring; end=0 may include mempool-visible data that is not final.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


List inscriptions currently associated with an address

Method: GET
Path: /v1/indexer/address/{address}/inscription-data
Swagger Link: View in Swagger UI

Description

Returns paginated inscription metadata for an address with confirmed and unconfirmed totals, spend-pending counts, content metadata, optional BRC-20 payload, and UTXO context. Use it for wallet galleries and ownership views; unconfirmed and unconfirmed-spend values require extra caution before spending.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


List inscription-bearing UTXOs for an address

Method: GET
Path: /v1/indexer/address/{address}/inscription-utxo-data
Swagger Link: View in Swagger UI

Description

Returns paginated UTXO records that carry inscriptions for an address, along with confirmed, unconfirmed, and unconfirmed-spend totals. Use it to prepare wallet coin selection or inscription transfer screens; always revalidate UTXO ownership and mempool status before signing.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key


List abandoned NFT-style inscription UTXOs for an address

Method: GET
Path: /v1/indexer/address/{address}/abandon-nft-utxo-data
Swagger Link: View in Swagger UI

Description

Returns abandoned inscription UTXO candidates with balance, counts, pagination, and UTXO details for an address. Use it for cleanup or wallet diagnostics; because these are spend-related candidates, verify current chain and mempool state before constructing any transaction.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key

Notes

Background:

In previous versions, the inscription-utxo-data endpoint returned all inscription UTXOs. After a recent upgrade, UTXOs corresponding to “abandoned inscriptions” are now filtered out for efficiency.

What are abandoned inscriptions?

These inscriptions do not carry BRC20 assets and account for a large proportion of the index. To improve efficiency and reduce unnecessary data, they are now excluded from the normal inscription list.

How to access abandoned inscription UTXOs? If you still need access to these UTXOs, please use the new /abandon-nft-utxo-data endpoint. This endpoint specifically returns UTXOs for abandoned inscriptions as defined above.

Summary:

If you have any questions about this change, please contact the UniSat developer support team.


Check UTXO inscription offsets before creating a BRC-20 inscription

Method: GET
Path: /v1/indexer/utxo-nft-offset/{txid}/{index}
Swagger Link: View in Swagger UI

Description

Returns the satoshi offsets of inscriptions recorded in the specified UTXO. Use this endpoint as a preflight check before creating any BRC-20 protocol inscription, including deploy, mint, and transfer. If the returned array contains 0, the first satoshi of the UTXO has already been inscribed; inscribing a BRC-20 operation on that satoshi would be a reinscription and the resulting BRC-20 operation would be invalid. In that case, select another UTXO or change the transaction construction. Stripped inscription records are included because a historical inscription on the satoshi must still be considered when preventing duplicate-satoshi inscription. At most the first 10 offsets are returned, in index order.

Parameters

Response (200)

Successful operation

Response (401)

Invalid API Key