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 info by inscriptionId
GET /v1/indexer/inscription/content/{inscriptionId} Get inscription content info by inscriptionId
GET /v1/indexer/inscription/events Get inscription events
GET /v1/indexer/address/{address}/inscription-data Get inscription UTXO list by address
GET /v1/indexer/address/{address}/inscription-utxo-data Get inscription UTXO list by address
GET /v1/indexer/address/{address}/abandon-nft-utxo-data Get abandon nft UTXO list by address

Inscriptions

Get inscription info by inscriptionId

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

Parameters

Response (200)


Get inscription content info by inscriptionId

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

Parameters

Response (200)


Get inscription events

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

Parameters

Response (200)


Get inscription UTXO list by address

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

Parameters

Response (200)


Get inscription UTXO list by address

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

Description

Returns the list of inscription UTXOs for the given address. Note: In previous versions, this endpoint returned all inscription UTXOs. After a recent upgrade, UTXOs corresponding to “abandoned inscriptions” are now filtered out.

Abandoned inscriptions refer to:

These inscriptions do not carry BRC20 assets and account for a large proportion of the index. To improve efficiency, they are now excluded from the normal inscription list. If you still need access to these UTXOs, please use the /abandon-nft-utxo-data endpoint.

Parameters

Response (200)


Get abandon nft UTXO list by address

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

Description

Returns the list of UTXOs for “abandoned inscriptions” for the given address.

Abandoned inscriptions are defined as:

These inscriptions do not carry BRC20 assets and are excluded from the normal /inscription-utxo-data results. Use this endpoint if you specifically need to access these UTXOs.

Parameters

Response (200)

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.