Query user's position list based on protocol#

Description: This API provides the user's asset position list based on a specific protocol.

Request URL#

POST https://www.okx.com/api/v5/defi/user/asset/platform/detail

Request parameter#

Parameter name	Description	Parameter type	Required	Data type
analysisPlatformId	protocol ID	Request body	Yes	String
walletAddressList	user address list	Request body	Yes	Array
>chainId	public chain ID	Request body	Yes	String
>walletAddress	user wallet address	Request body	Yes	String

Response parameters#

Parameter name	Description	Data type
networkHoldVoList	user positions under a specific network	Array
>network	network name	String
>chainId	public chain ID	String
>investTokenBalanceVoList	position list	Array
>>investType	investment type: 1. Save; 2. Pool; 3. Farm; 4. Vaults; 5. Stake	String
>>>tokenSymbol	asset name	String
>>>tokenLogo	asset logo	String
>>>coinAmount	invested asset amount	String
>>>currencyAmount	invested amount in USD	String
>>>tokenPrecision	token precision	String
>>>tokenAddress	token address	String
>>>network	network	String
>>totalValue	total position value in USD	String
>platformName	protocol name	String
>analysisPlatformId	protocol ID	String
>platformLogo	protocol logo	String
>platformUrl	protocol Url	String

DeFi API

Query user's position list

DeFi API

Query user's position list based on product

Request example#

shell

curl --location 'https://www.okx.com/api/v5/defi/user/asset/platform/detail' \
--header 'OK-ACCESS-KEY: 9c****77' \
--header 'OK-ACCESS-PASSPHRASE: p****d' \
--header 'Content-Type: application/json' \
--data '{
    "analysisPlatformId": 260, 
    "accountIdInfoList": [
        {
            "walletAddressList": [
                {
                    "chainId": 42161,  
                    "walletAddress": "0x7f429edeff8afc7bb3a2cf7db832fc86f6fa99da"
                }
            ]
        }
    ]
}'

Response example#

200

{
    "code": 0,
    "msg": "",
    "error_code": "0",
    "error_message": "",
    "detailMsg": "",
    "data": {
        "walletIdPlatformDetailList": [
            {
                "networkHoldVoList": [
                    {
                        "network": "Arbitrum One",
                        "chainId": 42161,
                        "investTokenBalanceVoList": [
                            {
                                "investType": 5,
                                "assetsTokenList": [
                                    {
                                        "tokenSymbol": "ETH",
                                        "tokenLogo": "https://static.coinall.ltd/cdn/wallet/logo/ETH-20220328.png",
                                        "coinAmount": "0.000044133940644863",
                                        "currencyAmount": "0.11722724912266575471",
                                        "tokenPrecision": 18,
                                        "tokenAddress": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
                                        "network": "ARB"
                                    }
                                ],
                                "rewardDefiTokenInfo": [],
                                "totalValue": "0.11722724912266575471"
                            }
                        ],
                        "availableRewards": [],
                        "airDropRewardInfo": []
                    }
                ],
                "accountId": "278c58bb-5958-4301-a5b6-d670e1d9837f"
            }
        ],
        "platformName": "ether.fi",
        "analysisPlatformId": 260,
        "platformLogo": "https://static.coinall.ltd/cdn/invest/platform/EtherFi.png",
        "platformUrl": "https://www.ether.fi/"
    }
}

DeFi API

Query user's position list

DeFi API

Query user's position list based on product