Query product list#
Description: This API allows you to query a paginated list of investment products based on specified criteria.
Request URL#
POST https://web3.okx.com/api/v5/defi/explore/product/list
Request parameters#
| Parameter | Description | Location | Required | Data type |
|---|---|---|---|---|
| simplifyInvestType | Query investment product types (100: Stablecoin, 101: Single, 102: Multi, 103: Vaults) | Request body | Yes | String |
| network | Query network name (refer to here) | Request body | Yes | String |
| poolVersion | Pool version (default to V2, distinguishing between V2 and V3) | Request body | No | String |
| platformIds | Platform ID list (refer to here) | Request body | No | Array[String] |
| sort | Sorting criteria | Request body | No | Struct |
| >orders | Order-based sorting criteria | Request body | No | Array[Struct] |
| >>direction | Sorting direction: (ascending - ASC, descending - DESC) | Request body | No | String |
| >>property | Property name for sorting results (sortable fields: Total Value Locked - TVL, APY Rate - RATE) | Request body | No | String |
| tokenIds | Token ID list (refer to here) | Request body | No | Array[String] |
| offset | Paginated offset | Request body | No | String |
| limit | Paginated limit | Request body | Yes | String |
Response Parameters#
| Parameter | Description | Data type |
|---|---|---|
| investmentId | Investment product ID | String |
| investmentName | Investment product name | String |
| chainId | Blockchain ID | String |
| rate | Yield rate | String |
| investType | Investment product type: 1. Saving; 2. Liquidity Pool; 3. Farming; 4. Vaults; 5. Staking | String |
| platformName | Platform name | String |
| platformId | Platform ID | String |
| rateType | Yield rate calculation type: 0: APY; 1: APR | String |
| tvl | Total Value Locked | String |
| underlyingToken | Underlying token for staking | Struct |
| >isBaseToken | Whether the underlying token is the base token of the network | Boolean |
| >tokenContract | Smart contract address of the underlying token | String |
| >tokenSymbol | Symbol of the underlying token | String |
| total | Total count based on the query criteria | String |
Request example#
shell
curl --location 'https://web3.okx.com/api/v5/defi/explore/product/list' \
--header 'OK-ACCESS-KEY: 4b****53' \
--header 'OK-ACCESS-PASSPHRASE: p****d' \
--header 'Content-Type: application/json' \
--data '{
"network":"ETH",
"offset":"0",
"limit":"10",
"sort": {
"orders":[
{
"direction":"DESC",
"property":"TVL"
}
]
},
"platformIds": ["89"]
}'
Response example#
200
{
"code": 0,
"msg": "",
"data": {
"investments": [
{
"investmentId": "21033",
"investmentName": "DAI",
"chainId": "1",
"rate": "0.04879",
"investType": "4",
"platformName": "MakerDAO",
"platformId": "89",
"poolVersion": "1",
"rateType": "0",
"tvl": "1211124903.92264",
"underlyingToken": [
{
"tokenSymbol": "DAI",
"tokenAddress": "0x6b175474e89094c44da98b954eedeac495271d0f",
"isBaseToken": false
}
]
}
],
"total": "1"
}
}