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
| 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 |
Method: GET
Path: /v1/indexer/inscription/info/{inscriptionId}
Swagger Link: View in Swagger UI
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.
inscriptionId (path, string) (required): Inscription id, or an inscription number accepted by this endpoint.Successful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
address (string):offset (integer):inscriptionIndex (integer):inscriptionId (string):inscriptionNumber (integer):hasPointer (boolean):hasParent (boolean):hasDeligate (boolean):hasMetaProtocal (boolean):hasContentEncoding (boolean):pointer (integer):parent (string):deligate (string):metaprotocol (string):metadata (string):contentEncoding (string):contentType (string):contentLength (integer):height (integer):timestamp (integer):inSatoshi (integer):outSatoshi (integer):brc20 (object): Only BRC20 transfer have this value
amt (string):decimal (string):lim (string):max (string):minted (string):op (string):tick (string):to (string):Invalid API Key
Method: GET
Path: /v1/indexer/inscription/content/{inscriptionId}
Swagger Link: View in Swagger UI
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.
inscriptionId (path, string) (required): Inscription id, or an inscription number accepted by this endpoint.Successful operation
Invalid API Key
Method: GET
Path: /v1/indexer/inscription/events
Swagger Link: View in Swagger UI
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.
start (query, integer) (required): Start blockheightend (query, integer) (required): End blockheight (0 represents the inclusion of mempool data.)cursor (query, integer) (required): Start offsetsize (query, integer) (required): Number of items returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
cursor (integer):total (integer):detail (array):
isTransfer (boolean): false: a mint event; true: a transfer eventinscriptionId (string):inscriptionNumber (integer):address (string): current addresscontentBody (string): only present when it’s a mint eventcontentType (string): only present when it’s a mint eventinSatoshi (integer): total input satoshi in txoutSatoshi (integer): total output satoshi in txpkScript (string):satoshi (integer): satoshi in inscriptiontimestamp (integer): block timestamptxid (string): inscription genesis txidi (integer): inscription genesis voutvout (integer): tx voutsequence (integer):height (integer):txidx (integer): tx index in blockInvalid API Key
Method: GET
Path: /v1/indexer/address/{address}/inscription-data
Swagger Link: View in Swagger UI
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.
address (path, string) (required): Addresscursor (query, integer) (required): Start offsetsize (query, integer) (required): Number of items returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
cursor (integer):total (integer):totalConfirmed (integer):totalUnconfirmed (integer):totalUnconfirmedSpend (integer):inscription (array):
address (string):offset (integer):inscriptionIndex (integer):inscriptionId (string):inscriptionNumber (integer):hasPointer (boolean):hasParent (boolean):hasDeligate (boolean):hasMetaProtocal (boolean):hasContentEncoding (boolean):pointer (integer):parent (string):deligate (string):metaprotocol (string):metadata (string):contentEncoding (string):contentType (string):contentLength (integer):height (integer):timestamp (integer):inSatoshi (integer):outSatoshi (integer):brc20 (object): Only BRC20 transfer have this value
amt (string):decimal (string):lim (string):max (string):minted (string):op (string):tick (string):to (string):Invalid API Key
Method: GET
Path: /v1/indexer/address/{address}/inscription-utxo-data
Swagger Link: View in Swagger UI
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.
address (path, string) (required): Addresscursor (query, integer) (required): Start offsetsize (query, integer) (required): Number of items returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
cursor (integer):total (integer):totalConfirmed (integer):totalUnconfirmed (integer):totalUnconfirmedSpend (integer):utxo (array):Invalid API Key
Method: GET
Path: /v1/indexer/address/{address}/abandon-nft-utxo-data
Swagger Link: View in Swagger UI
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.
address (path, string) (required): Addresscursor (query, integer) (required): Start offsetsize (query, integer) (required): Number of items returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
cursor (integer):total (integer):totalConfirmed (integer):totalUnconfirmed (integer):totalUnconfirmedSpend (integer):utxo (array):
balance (integer): example: 10000cursor (integer): example: 0nftMintCount (integer): example: 1nftTransferCount (integer): example: 0total (integer): example: 1utxo (array):Invalid API Key
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:
/inscription-utxo-data now only returns active inscription UTXOs (excluding abandoned ones)/abandon-nft-utxo-data returns UTXOs for abandoned inscriptionsIf you have any questions about this change, please contact the UniSat developer support team.
Method: GET
Path: /v1/indexer/utxo-nft-offset/{txid}/{index}
Swagger Link: View in Swagger UI
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.
txid (path, string) (required): Transaction id of the UTXO, encoded as a 64-character hexadecimal string.index (path, integer) (required): Transaction output index (vout) of the UTXO.Successful operation
code (integer (int32)): enum: 0, -1msg (string): example: "ok"data (array): Up to 10 inscription offsets, measured in satoshis from the start of the UTXO. A value of 0 means the first satoshi is already inscribed and must not be reused for a BRC-20 deploy, mint, or transfer inscription.; example: [0,546]Invalid API Key