钱包 API

查询特定代币#

查询地址下指定代币的余额。

请求路径#

POST https://www.okx.com/api/v5/wallet/asset/token-balances-by-address

请求参数#

ParameterTypeRequiredDescription
addressStringYes地址
tokenAddressesArrayYes代币合约地址列表,查询指定代币余额。上限是 20
>chainIndexStringYes链唯一标识
>tokenAddressStringYes代币地址。
1:传""代表查询对应链的主链币。
2:传具体的代币合约地址,代表查询对应的代币。
3:不同铭文代币按如下格式入参:
FBRC-20: 使用 fbtc_fbrc20_name,如 fbtc_fbrc20_babymusk
BRC-20: 使用 btc-brc20-tick(name),如 btc-brc20-ordi
Runes: 使用 btc-runesMain-tickId,如 btc-runesMain-840000:2
SRC-20:使用 btc-src20-name,如 btc-src20-utxo
filterStringNo0: 过滤风险空投币
1: 不过滤风险空投币
默认过滤

响应参数#

ParameterTypeDescription
tokenAssetsArray代币余额列表
>chainIndexString链唯一标识
>tokenAddressString代币地址。为空 "" 代表返回结果是相关链,主链币的数据
>addressString地址
>symbolString代币简称
>balanceString代币数量
>rawBalanceString代币的原始数量。更多的链即将被支持。对于不支持的链,该字段为空。
>tokenPriceString币种单价价值,以美元计价
>tokenTypeString代币类型:
1:token
2:铭文
>transferAmountStringBRC-20、FBRC-20 等铭文资产可直接转账、交易的余额数量,一般称为可转余额。
>availableAmountStringBRC-20、FBRC-20 等铭文资产需要完成铭刻操作才可以交易、转账的数量,一般称为可用余额或者待铭刻余额。
>isRiskTokenBooleantrue: 命中风险空投币
false: 未命中风险空投币

请求示例#

shell
curl --location --request POST 'https://www.okx.com/api/v5/wallet/asset/token-balances-by-address' \
--header 'Content-Type: application/json' \
--header 'OK-ACCESS-PROJECT: 86af********d1bc' \
--header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \
--header 'OK-ACCESS-SIGN: leaV********3uw=' \
--header 'OK-ACCESS-PASSPHRASE: 1****6' \
--header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' \
--data-raw '{
    "address":"0x50c476a139aab23fdaf9bca12614cdd54a4244e3",
    "tokenAddresses": [
        {
            "chainIndex": "1",
            "tokenAddress": ""
        }
    ]
}'

响应示例#

200
{
    "code": "0",
    "msg": "success",
    "data": [
        {
            "tokenAssets": [
                {
                    "chainIndex": "1",
                    "tokenAddress": "",
                    "symbol": "eth",
                    "balance": "0",
                    "tokenPrice": "3640.43",
                    "tokenType": "1",
                    "isRiskToken": false,
                    "transferAmount": "0",
                    "availableAmount": "0",
                    "rawBalance": "",
                    "address": ""
                }
            ]
        }
    ]
}