Overview
This API provides a comprehensive list of a user's asset holdings across all supported platforms in the Web3 ecosystem.
API Endpoint
POST https://web3.okx.com/api/v5/defi/user/asset/platform/list
Request Parameters
| Parameter Name | Description | Parameter Type | Required | Data Type |
|---|---|---|---|---|
| walletAddressList | List of user wallet addresses | Request Body | Yes | Array |
| >chainId | Public blockchain ID | Request Body | Yes | String |
| >walletAddress | User wallet address | Request Body | Yes | String |
Response Parameters
| Parameter Name | Description | Data Type |
|---|---|---|
| walletIdPlatformList | Position list corresponding to address set | Array |
| >platformList | Holdings list for one address | String |
| >platformName | Platform name | String |
| >analysisPlatformId | Protocol ID | String |
| >platformLogo | Platform logo URL | String |
| >currencyAmount | USD-denominated position amount | String |
| >isSupportInvest | Whether OKX DeFi supports | String |
| >platformUrl | Platform link | String |
| >networkBalanceVoList | Holdings list by network | Array |
| >>network | Network name | String |
| >>networkLogo | Network logo URL | String |
| >>chainId | Chain ID | String |
| >>currencyAmount | USD-denominated position amount | String |
| >investmentCount | Count of invested products | String |
Usage Examples
👉 See real-world API integration examples
FAQ Section
Q1: What chains are supported by this API?
A1: The API supports all major EVM-compatible chains including Ethereum, BSC, Polygon, and others specified by their chainId.
Q2: How frequently is the holdings data updated?
A2: Data is refreshed in near real-time, typically with less than 5-minute latency.
Q3: What's the maximum number of wallet addresses I can query at once?
A3: The current limit is 50 wallet addresses per API call.
Q4: How do I interpret the currencyAmount values?
A4: All amounts are denominated in USD using current market rates.
Q5: Can I get historical holdings data through this API?
A5: No, this API only provides current snapshot data. Historical data requires separate endpoints.