Wallet API

Check Inscriptions on UTXO#

  • Query the quantity and detailed information of Runes, BRC-20, ARC-20, and Ordinals NFT assets on a specific UTXO on the Bitcoin chain.

  • Query the quantity and detailed information of BRC-20 assets on a specific UTXO on the Fractal Bitcoin chain.

Request Path#

GET https://www.okx.com/api/v5/wallet/utxo/utxo-detail

Request Parameters#

ParameterTypeRequiredDescription
chainIndexStringYesUnique identifier for the chain
txHashStringYesTransaction hash corresponding to the UTXO
voutIndexStringYesIdentifies which output position the UTXO is in; together with txHash, uniquely maps to a specific UTXO

Response Parameters#

ParameterTypeDescription
addressStringAddress
txhashStringTransaction hash corresponding to the UTXO
voutIndexStringIdentifies which output position the UTXO is in; together with txhash, uniquely maps to a specific UTXO
unresolvedArrayLists protocols that have not completed block parsing, making it uncertain if the UTXO contains corresponding assets
utxoStatusStringUTXO Status
pending: Pending
confirmed: Confirmed
Not found : Not found
btcAssetsArrayDetailed inscription assets on the current UTXO, with a maximum of 1,000 entries per asset
>protocolStringProtocol type
1:BRC-20
2:ARC-20
3:Runes
4:ordi_nft
>tokenAmountStringThe quantity of transferable token assets on the UTXO
>eventTypeStringThe specific transaction event for BRC-20
>decimalStringPrecision; returns empty if not available
>symbolStringToken name; returns empty if not available
>inscriptionNumberStringOn-chain minting number inscriptions_number
>nftIdStringUnique identifier of the NFT, txhash+i+0, applicable only for Ordinals protocol (i.e., BRC-20 and Ordinals NFT assets)
>nftOffsetStringNFT location offset, indicating where the inscription is positioned on the UTXO, applicable only for Ordinals protocol (i.e., BRC-20 and Ordinals NFT assets)

Request Example#

shell

Response Example#

200
{
    "code": "0",
    "msg": "success",
    "data": [
        {
            "addresses": [
                "bc1p8qfrmxdlmynr076uu28vlszxavwujwe7dus0r8y9thrnp5lgfh6qu2ctrr"
            ],
            "txHash": "cd7b77b068142ee1b099a360aeb287b5e02d4603a4523cb12d18cbd58aa47985",
            "voutIndex": "0",
            "utxoStatus":"confirmed" ,
            "unresolved": [],
            "btcAssets": [
                {
                    "protocol": "4",
                    "tokenAmount": "",
                    "eventType": "",
                    "decimal": "0",
                    "symbol": "",
                    "inscriptionNumber": "11896131",
                    "nftId": "0b7c063d14d73cdb83e3454643fc1e4a3701bd5dc2f9550e5ab303247a68f7cai0",
                    "nftOffset": "0"
                }
            ]
        }
    ]
}