v1

latestOpenAPI 3.0.2CC0 1.0 Universal2026-07-17128129208.3 KB

blockchain

Retrieve unspent boxes by an associated token id

get/blockchain/box/unspent/byTokenId/{tokenId}

Path parameters

tokenIdstring base16 required

Base16-encoded 32 byte modifier id

Example:3ab9da11fc216660e974842cc3b7705e62ebb9e0bf5ff78e53f9cd40abadd117

id of the token

Query parameters

offsetinteger

amount of elements to skip from the start

limitinteger

amount of elements to retrieve

sortDirectionstring

desc = new boxes first ; asc = old boxes first

includeUnconfirmedboolean

if true include unconfirmed transactions from mempool

excludeMempoolSpentboolean

if true exclude spent inputs from mempool

Response

unspent boxes associated with wanted token

boxIdstring base16

Base16-encoded transaction box id bytes. Should be 32 bytes long

valueinteger required

Amount of Ergo token

ergoTreestring base16 required

Base16-encoded ergo tree bytes

creationHeightinteger required

Height the output was created at

additionalRegistersRegisters required

Ergo box registers

transactionIdstring base16

Base16-encoded transaction id bytes

indexinteger

Index in the transaction outputs

addressstring required

Encoded Ergo Address

spentTransactionIdstring base16 required

Base16-encoded 32 byte modifier id

spendingHeightinteger nullable required

The height the box was spent at

inclusionHeightinteger required

The height the transaction containing the box was included in a block at

globalIndexinteger required

Global index of the output in the blockchain

Example response

[
  {
    "boxId": "1ab9da11fc216660e974842cc3b7705e62ebb9e0bf5ff78e53f9cd40abadd117",
    "value": 147,
    "ergoTree": "0008cd0336100ef59ced80ba5f89c4178ebd57b6c1dd0f3d135ee1db9f62fc634d637041",
    "creationHeight": 9149,
    "assets": [
      {
        "tokenId": "4ab9da11fc216660e974842cc3b7705e62ebb9e0bf5ff78e53f9cd40abadd117",
        "amount": 1000
      }
    ],
    "additionalRegisters": {
      "R4": "100204a00b08cd0336100ef59ced80ba5f89c4178ebd57b6c1dd0f3d135ee1db9f62fc634d637041ea02d192a39a8cc7a70173007301"
    },
    "transactionId": "2ab9da11fc216660e974842cc3b7705e62ebb9e0bf5ff78e53f9cd40abadd117",
    "address": "3WwbzW6u8hKWBcL1W7kNVMr25s2UHfSBnYtwSHvrRQt7DdPuoXrt",
    "spentTransactionId": "3ab9da11fc216660e974842cc3b7705e62ebb9e0bf5ff78e53f9cd40abadd117",
    "spendingHeight": 147,
    "inclusionHeight": 147,
    "spendingProof": {
      "proofBytes": "4ab9da11fc216660e974842cc3b7705e62ebb9e0bf5ff78e53f9cd40abadd1173ab9da11fc216660e974842cc3b7705e62ebb9e0bf5ff78e53f9cd40abadd1173ab9da11fc216660e974842cc3b7705e62ebb9e0bf5ff78e53f9cd40abadd117",
      "extension": {
        "1": "a2aed72ff1b139f35d1ad2938cb44c9848a34d4dcfd6d8ab717ebde40a7304f2541cf628ffc8b5c496e6161eba3f169c6dd440704b1719e0"
      }
    },
    "globalIndex": 83927
  }
]