Wallet API

Investment Product Search#

This is the first step in the DeFi investment workflow. When a user wants to find DeFi investment opportunities, use this endpoint to search for available investment products by token name (e.g. "USDC", "ETH"). The response includes investment product ID, name, protocol, APY, TVL, and other information. Once you have the investmentId, you can call /product/detail to retrieve details, or call /product/detail/prepare to prepare transaction parameters.

URL: POST /api/v6/defi/product/search

Request Parameters#

FieldTypeRequiredExplanation
tokenKeywordListArrayYesToken keyword list (e.g. ["USDC", "ETH"])
platformKeywordListArrayNoPlatform keyword list (e.g. ["AAVE V3"])
pageNumIntegerNoPage number, minimum 1; current fixed pageSize=20
chainIndexStringNoChain ID (e.g. 1=ETH, 56=BSC, etc.)
productGroupStringNoInvestment type filter, default SINGLE_EARN; includes: SINGLE_EARN, DEX_POOL, LENDING

Request Examples#

Example 1: Search USDC Token Only#

Json
{
    "tokenKeywordList": ["USDC"],
    "pageNum": 1
}

Example 2: Search Multiple Tokens + Specified Chain#

Json
{
    "tokenKeywordList": ["USDC", "ETH"],
    "chainIndex": "1",
    "pageNum": 1
}

Example 3: Search + Filter by Protocol + Investment Type#

Json
{
    "tokenKeywordList": ["USDC"],
    "platformKeywordList": ["Aave"],
    "productGroup": "SINGLE_EARN",
    "pageNum": 1
}
Json
{
    "tokenKeywordList": ["USDC"],
    "platformKeywordList": ["Uniswap"],
    "productGroup": "DEX_POOL",
    "pageNum": 1
}
Json
{
    "tokenKeywordList": ["USDC"],
    "platformKeywordList": ["AAVE V3"],
    "productGroup": "LENDING",
    "pageNum": 1
}

Example 4: Search Multi-Chain Data#

Json
{
    "tokenKeywordList": ["USDT"],
    "pageNum": 1
}

Response Parameters#

FieldTypeExplanation
totalIntegerTotal count
listArrayProduct list
> investmentIdStringInvestment product ID
> nameStringInvestment product name
> platformNameStringProtocol name
> rateStringAPY
> tvlStringTVL
> chainIndexStringChain ID
> detailPathStringDetail page path
> feeRateBigDecimalFee rate
> productGroupStringInvestment product type

Response Example#

Search USDC + Protocol Aave

Json
{
    "code": 0,
    "msg": "",
    "data": {
        "total": 8,
        "list": [
            {
                "investmentId": 9502,
                "name": "USDC",
                "platformName": "Aave V3",
                "rate": "0.02140",
                "tvl": "3423591587.48413",
                "detailPath": null,
                "feeRate": null,
                "productGroup": "SINGLE_EARN",
                "chainIndex": "1"
            },
            {
                "investmentId": 378532533,
                "name": "USDC",
                "platformName": "Aave V3",
                "rate": "0.02590",
                "tvl": "370145418.65238",
                "detailPath": null,
                "feeRate": null,
                "productGroup": "SINGLE_EARN",
                "chainIndex": "8453"
            },
            {
                "investmentId": 124,
                "name": "USDC",
                "platformName": "Aave V3",
                "rate": "0.03510",
                "tvl": "100947767.28590",
                "detailPath": null,
                "feeRate": null,
                "productGroup": "SINGLE_EARN",
                "chainIndex": "43114"
            }
        ]
    }
}

The actual response returns 8 results; only the first 3 are shown here. rate is in decimal format (0.02140 = 2.14%), and tvl is in USD.