介绍

获取特定代币余额#

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

请求路径#

POST https://web3.okx.com/api/v5/dex/balance/token-balances-by-address

请求参数#

Parameter	Type	Required	Description
address	String	是	地址
tokenContractAddresses	Array	是	代币合约地址列表，查询指定代币余额。上限是 20
>chainIndex	String	是	链唯一标识。(如`1`代表Ethereum。更多可查看这里。)
>tokenContractAddress	String	是	代币地址。 `1`：传""代表查询对应链的主链币。 `2`：传具体的代币合约地址，代表查询对应的代币。
excludeRiskToken	String	否	是否过滤风险空投代币和貔貅盘代币。默认过滤。 `0`: 过滤 `1`: 不过滤对于貔貅盘代币，目前只支持 `ETH`、`BSC`、`SOL`、`BASE` 四条链，更多的链即将被支持。

响应参数#

Parameter	Type	Description
tokenAssets	Array	代币余额列表
>chainIndex	String	链唯一标识
>tokenContractAddress	String	代币地址。为空 "" 代表返回结果是相关链，主链币的数据
>address	String	地址
>symbol	String	代币简称
>balance	String	代币数量
>rawBalance	String	代币的原始数量。对于不支持的链，该字段为空。更多的链即将被支持。
>tokenPrice	String	币种单价价值，以美元计价
>isRiskToken	Boolean	`true`：命中风险空投代币和貔貅盘代币 `false`：未命中风险空投代币和貔貅盘代币

获取资产明细

错误码

请求示例#

shell

curl --location --request POST 'https://web3.okx.com/api/v5/dex/balance/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",
    "tokenContractAddresses": [
        {
            "chainIndex": "1",
            "tokenContractAddress": ""
        }
    ]
}'

响应示例#

200

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

获取资产明细

错误码