Query product details#

Description: This API provides the details of a specified investment product when you input the search criteria.

Request URL#

GET https://www.okx.com/api/v5/defi/explore/product/detail

Request parameters#

Parameter name	Description	Parameter type	Required	Data type
investmentId	Investment ID	Query parameter	Yes	String
investmentCategory	Subscription type: (e.g., 0: Default type; 1: BRC-20)	Query parameter	No	String

Response parameters#

Parameter name	Description	Data type
investmentId	Investment ID	String
investmentName	Investment name	String
chainId	Blockchain ID	String
rate	Rate of return	String
investType	Investment type: 1. Save; 2. Pool; 3. Farm; 4. Vaults; 5. Stake	String
platformName	Platform name	String
platformId	Platform ID	String
analysisPlatformId	Platform ID for receiving reward bonus	String
rateType	Rate of eeturn calculation type: 0: APY; 1: APR	String
tvl	Total value locked	String
underlyingToken	Staked token	Struct
>isBaseToken	Whether the staked token is a base token on the mainnet	Boolean
>tokenContract	Smart contract address of the staked token	String
>tokenSymbol	Token symbol of the staked token	String
isInvestable	Whether it is investable	String
utilizationRate	Utilization rate	String
earnedToken	Earned tokens	Struct
>isBaseToken	Whether the earned token is a base token on the mainnet	Boolean
>tokenContract	Smart contract address of the earned token	String
>tokenSymbol	Token symbol of the earned token	String
lpToken	LP token	Struct
>isBaseToken	Whether the LP token is a base token on the mainnet	Boolean
>tokenContract	Smart contract address of the LP token	String
>tokenSymbol	Token symbol of the LP token	String

Request example#

shell

curl --location 'https://www.okx.com/api/v5/defi/explore/product/detail?investmentId=21010' \
--header 'OK-ACCESS-KEY: 4b****53' \
--header 'OK-ACCESS-PASSPHRASE: p****d'

Response example#

200

{
    "code": 0,
    "msg": "",
    "data": {
        "investmentId": "120",
        "investmentName": "jEUR",
        "chainId": "137",
        "rate": "0.01129",
        "investType": "1",
        "platformName": "Aave V3",
        "platformId": "24",
        "analysisPlatformId": "10",
        "rateType": "0",
        "tvl": "51350.92499",
        "underlyingToken": [
            {
                "tokenSymbol": "jEUR",
                "tokenAddress": "0x4e3decbb3645551b8a19f0ea1678079fcb33fb4c",
                "isBaseToken": false
            }
        ],
        "isInvestable": false,
        "earnedToken": [
            {
                "tokenSymbol": "jEUR",
                "tokenAddress": "0x4e3decbb3645551b8a19f0ea1678079fcb33fb4c",
                "isBaseToken": false
            }
        ],
        "lpToken": [
            {
                "tokenSymbol": "aPolJEUR",
                "tokenAddress": "0x6533afac2e7bccb20dca161449a13a32d391fb00",
                "isBaseToken": false
            }
        ],
        "utilizationRate": "0.76862"
    }
}