DeFi Data

Endpointhttps://web3.binance.com/build

Get DeFi Positions

Query DeFi positions for one or more wallet addresses across the supported chains. Returns protocol-level position summaries with token breakdowns. Optionally filter by specific chains via binanceChainIds; when omitted, positions across all supported chains are returned. Position coverage is wider than the protocol list used by data queries and transaction building — see Supported Chains & Protocols for the difference.

POST

/api/v1/defi/data/position/list

https://web3.binance.com/build

Get DeFi Positions › Authorization

This is a signed endpoint and a signature must be included in the request headers.Learn more about how to generate a valid signature in the Authentication.

Get DeFi Positions › Headers

X-OC-APIKEY

string · required

API Key issued by Binance Web3 API for authentication.

Example: your-api-key-here

X-OC-TIMESTAMP

string · required

Current UTC time in ISO 8601 format with milliseconds, e.g. 2026-05-11T10:08:57.715Z.

Example: 2026-05-11T10:08:57.715Z

X-OC-SIGN

string · required

Request signature (Base64-encoded).

Example: Base64EncodedSignature==

X-OC-RECV-WINDOW

integer · int64

Allowed time deviation in milliseconds (default: 5000, max: 60000).

Example: 5000

X-OC-NONCE

string

Unique request identifier for anti-replay; falls back to X-OC-SIGN if omitted.

Example: unique-nonce-string

Get DeFi Positions › Request Body

addresses

string[] · maxItems: 3 · required

Wallet addresses to query positions for. Up to 3 addresses per request (server-side configured and subject to change); the limit is shared across chains — a multi-chain query consumes the same 3-address budget.

Example: ["0x66faa5ded68cc83a71bc172fb03c17a6bcb32f7a"]

binanceChainIds

string[]

Optional chain filter. When set, only positions on the specified chains are returned; when omitted, positions across all supported chains are returned. See Supported Chains & Protocols for the supported chain ID values — unsupported values are rejected with 40001.

Example: ["56"]

forceRefresh

boolean

Force a cache bypass and re-read the latest on-chain state. Defaults to false (serves cached data). Set to true right after a redeem / claim to see the updated position immediately — the cache otherwise lags by a short window.

Example: true

Get DeFi Positions › Responses

DeFi positions returned successfully.

code

integer · int32

Business status code. 0 indicates success.

Example: 0

msg

string

Human-readable status message.

Example: success

object

Aggregated DeFi positions response.

totalValue

string

Total value of all DeFi positions of all queried addresses (USD). Same raw precision as addressTotalValue.

Example: 5000.50123456

object[]

Address-level position summaries.

Address-level aggregation. Groups the protocol-level position summaries of one wallet address.

address

string

Wallet address.

Example: 0x66faa5ded68cc83a71bc172fb03c17a6bcb32f7a

addressTotalValue

string

Total DeFi position value of this address across all chains (USD). Same raw precision as the position values.

Example: 26.70787419

object[]

Protocol-level position summaries of this address.

Protocol-level position summary for one address on one chain. `binanceChainId` + `defiProtocolId` uniquely identify a protocol on a chain.

binanceChainId

string

Binance chain ID. Plain numeric string for EVM chains (e.g. "56" = BNB Smart Chain); non-EVM chains use a CT_-prefixed string (e.g. "CT_501" = Solana), consistent with the Trading / Transaction APIs. See Supported Chains & Protocols for the supported values.

Example: 56

defiProtocolId

string

Protocol identifier consistent with POST /api/v1/defi/data/protocol/list. Use this value when calling investment/list, transaction endpoints, etc.

Example: helio

protocolName

string

Protocol display name.

Example: Lista DAO

protocolTotalValue

string

Total position value in this protocol (USD).

Example: 26.70787419

object[]

Pools with positions in this protocol.

A pool containing position collections.

bnPoolId

string

Pool identifier (0x + 64-char hex).

Example: 0xd4e9b3f0fbb5129bf893f01df339935185b5ad22492fac093f391753389a8656

poolCa

string

Pool contract address.

Example: 0x3662d86220BE5BEA975BE9Fd8aB3d6b5D4FB4163

poolType

string

Pool type. Complete value set: Lending (supply/borrow market), Staked (native staking), Yield (yield vault / receipt token), Deposit (fixed deposit), Rewards (reward claims, e.g. PancakeSwap Infinity), Liquidity Pool (AMM / concentrated liquidity), Farming (MasterChef farming), Locked (locked staking with unlock time), Vesting (vesting schedule). Treat unknown values as generic display.

Example: Liquidity Pool

object[]

A collection of positions grouped under the same underlying asset.

positionCollectionId

string

Collection unique identifier (64-char hex, no 0x prefix).

Example: 85dab74a61426fa11f02a234d5e4462c7cc62249875c212f2dbfa09a927b8097

positionCollectionDetail

object | null

Collection metadata. Null when the collection has no metadata. Fields are null when not applicable.

positionCollectionTotalValue

string

Total value of all positions in this collection (USD).

Example: 10.51121227

object[]

List of positions in this collection.

A single DeFi position with underlying asset and token breakdown.

positionId

string

Unique position identifier (64-char hex, no 0x prefix).

Example: dbc71cba52420db0021821a240a3901df566fbcda97b663402ec7d52308f0e29

underlyingAssetName

string

Display name of the underlying asset (e.g. "USDT-USDC", "lisUSD").

Example: USDT-USDC

underlyingAssetId

string

Underlying asset identifier (64-char hex, no 0x prefix). Hashed from the pool and underlying token addresses.

Example: e73d51bced063d9e7bd5d799e51752ffb7bc6fbfa579ce41164d0dbd9cc13a4b

assetType

string | null

Asset structure type. Null for a regular position; locked for a locked position (e.g. locked staking — check unlockTime on positionDetail); farming for a MasterChef-style farming position (rewards accrue under the farming_reward token group).

Example: locked

investmentIds

string[]

Related investment IDs (64-char hex, no 0x prefix). Use with POST /api/v1/defi/data/investment/detail. Usually a single entry; a position can relate to several investments when the pool stacks products on top of each other (e.g. a farming position wraps the underlying LP investment plus its incentive product, or a staked vault layers a receipt token over the base deposit). When there are several, query each with investment/detail and pick by the action you want to perform — redeeming the principal uses the base investment, claiming farming incentives uses the incentive one.

Example: ["b3e50a2dd4aab008d3410dae2a383fe5216346fb613bb1bef9b1822fe47c742a"]

positionDetail

object | null

Position-level metadata. Present for concentrated-liquidity / locked / farming positions; null otherwise. Fields are null when not applicable to the position type.

positionValue

string

Total position value in USD (sum of all token values; may be negative for borrow positions).

Example: 10.51121227

object

Token breakdown grouped by role. Keys: supply (supplied assets), borrow (borrowed assets, lending positions), reward (claimable rewards), farming_reward (MasterChef farming incentives). A key is absent when the position has no tokens in that role.

Example: {"supply":[{"tokenAddress":"0x55d398326f99059fF775485246999027B3197955","tokenSymbol":"USDT","tokenAmount":"1000.5","tokenValue":"1000.6"}],"reward":[{"tokenAddress":"0x0e09fabb73bd3ade0a17ecc321fd13a19e81ce82","tokenSymbol":"Cake","tokenAmount":"12.3","tokenValue":"45.6"}]}

Token breakdown grouped by role. Keys: `supply` (supplied assets), `borrow` (borrowed assets, lending positions), `reward` (claimable rewards), `farming_reward` (MasterChef farming incentives). A key is absent when the position has no tokens in that role.

object[]

Token balance information within a position.

tokenAddress

string

Token contract address. The native-asset sentinel 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee (40 es) for native coins.

Example: 0x55d398326f99059fF775485246999027B3197955

tokenName

string

Token name.

Example: Tether USDt

tokenSymbol

string

Token symbol.

Example: USDT

tokenAmount

string

Human-readable token amount (NOT the smallest unit).

Example: 10.514497309269952983

tokenPrice

string

Current token price in USD.

Example: 0.9996875708132666

tokenValue

string

Token value in USD (amount × price).

Example: 10.51121227

tokenDecimals

string

Token decimals (string).

Example: 18

object[]

Token balance information within a position.

tokenAddress

string

Token contract address. The native-asset sentinel 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee (40 es) for native coins.

Example: 0x55d398326f99059fF775485246999027B3197955

tokenName

string

Token name.

Example: Tether USDt

tokenSymbol

string

Token symbol.

Example: USDT

tokenAmount

string

Human-readable token amount (NOT the smallest unit).

Example: 10.514497309269952983

tokenPrice

string

Current token price in USD.

Example: 0.9996875708132666

tokenValue

string

Token value in USD (amount × price).

Example: 10.51121227

tokenDecimals

string

Token decimals (string).

Example: 18

object[]

Token balance information within a position.

tokenAddress

string

Token contract address. The native-asset sentinel 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee (40 es) for native coins.

Example: 0x55d398326f99059fF775485246999027B3197955

tokenName

string

Token name.

Example: Tether USDt

tokenSymbol

string

Token symbol.

Example: USDT

tokenAmount

string

Human-readable token amount (NOT the smallest unit).

Example: 10.514497309269952983

tokenPrice

string

Current token price in USD.

Example: 0.9996875708132666

tokenValue

string

Token value in USD (amount × price).

Example: 10.51121227

tokenDecimals

string

Token decimals (string).

Example: 18

object[]

Token balance information within a position.

tokenAddress

string

Token contract address. The native-asset sentinel 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee (40 es) for native coins.

Example: 0x55d398326f99059fF775485246999027B3197955

tokenName

string

Token name.

Example: Tether USDt

tokenSymbol

string

Token symbol.

Example: USDT

tokenAmount

string

Human-readable token amount (NOT the smallest unit).

Example: 10.514497309269952983

tokenPrice

string

Current token price in USD.

Example: 0.9996875708132666

tokenValue

string

Token value in USD (amount × price).

Example: 10.51121227

tokenDecimals

string

Token decimals (string).

Example: 18

poolDetail

object | null

Pool-level metadata. Fields are null when not applicable to the pool type (e.g. tickSpacing/hooks only for concentrated-liquidity pools).

timestamp

integer · int64

Server timestamp in milliseconds.

Example: 1748601600000

success

boolean

Whether the request succeeded (mirrors code == 0).

Example: true

POST/api/v1/defi/data/position/list

curl --request POST \
  --url https://web3.binance.com/build/api/v1/defi/data/position/list \
  --header 'Content-Type: application/json' \
  --header 'X-OC-APIKEY: <string>' \
  --header 'X-OC-SIGN: <string>' \
  --header 'X-OC-TIMESTAMP: <string>' \
  --data '
{
  "addresses": [
    "0x66faa5ded68cc83a71bc172fb03c17a6bcb32f7a"
  ]
}
'

Example Request Body

{
  "addresses": [
    "0x66faa5ded68cc83a71bc172fb03c17a6bcb32f7a"
  ]
}

json

Example Responses

{
  "code": 0,
  "msg": "success",
  "data": {
    "totalValue": "5000.50123456",
    "addressList": [
      {
        "address": "0x66faa5ded68cc83a71bc172fb03c17a6bcb32f7a",
        "addressTotalValue": "26.70787419",
        "protocolList": [
          {
            "binanceChainId": "56",
            "defiProtocolId": "helio",
            "protocolName": "Lista DAO",
            "protocolTotalValue": "26.70787419",
            "poolList": [
              {
                "bnPoolId": "0xd4e9b3f0fbb5129bf893f01df339935185b5ad22492fac093f391753389a8656",
                "poolCa": "0x3662d86220BE5BEA975BE9Fd8aB3d6b5D4FB4163",
                "poolType": "Liquidity Pool",
                "positionCollectionList": [
                  {
                    "positionCollectionId": "85dab74a61426fa11f02a234d5e4462c7cc62249875c212f2dbfa09a927b8097",
                    "positionCollectionDetail": {
                      "collectionIndex": "0x00000000000000000000000055d398326f99059ff775485246999027b3197955",
                      "collectionDisplayName": null,
                      "healthFactor": "1.85"
                    },
                    "positionCollectionTotalValue": "10.51121227",
                    "positionList": [
                      {
                        "positionId": "dbc71cba52420db0021821a240a3901df566fbcda97b663402ec7d52308f0e29",
                        "underlyingAssetName": "USDT-USDC",
                        "underlyingAssetId": "e73d51bced063d9e7bd5d799e51752ffb7bc6fbfa579ce41164d0dbd9cc13a4b",
                        "assetType": "locked",
                        "investmentIds": [
                          "b3e50a2dd4aab008d3410dae2a383fe5216346fb613bb1bef9b1822fe47c742a"
                        ],
                        "positionDetail": {
                          "positionIndex": "6993078",
                          "nftId": "#6993078",
                          "unlockTime": "1787744768",
                          "unlockTimeReached": false,
                          "tickLower": "-60",
                          "tickUpper": "40",
                          "active": true,
                          "proofs": {
                            "0x0e09fabb73bd3ade0a17ecc321fd13a19e81ce82": [
                              "0xb0477ce01ce3dcfc137ab44d91af37f5ed3f468421d2d2e44941dd5a8bf44aa4"
                            ]
                          },
                          "stakeState": "active",
                          "claimTypes": [
                            "LP_FEE",
                            "REWARD_INVESTMENT"
                          ],
                          "redemptionId": "redem-abc123",
                          "userStakeAccount": "5vUt9pxBK9KaaHm19okrwSuP2vUU71Nm7ScsBiSqsW1s"
                        },
                        "positionValue": "10.51121227",
                        "tokenList": {
                          "supply": [
                            {
                              "tokenAddress": "0x55d398326f99059fF775485246999027B3197955",
                              "tokenSymbol": "USDT",
                              "tokenAmount": "1000.5",
                              "tokenValue": "1000.6"
                            }
                          ],
                          "reward": [
                            {
                              "tokenAddress": "0x0e09fabb73bd3ade0a17ecc321fd13a19e81ce82",
                              "tokenSymbol": "Cake",
                              "tokenAmount": "12.3",
                              "tokenValue": "45.6"
                            }
                          ]
                        }
                      }
                    ]
                  }
                ],
                "poolDetail": {
                  "expiry": 1748601600,
                  "feeTier": "500",
                  "lpFee": "330",
                  "tickSpacing": "50",
                  "isDynamicFee": true,
                  "hookFee": "2800",
                  "tick": "59683",
                  "hooks": "0xdfdfb2c5a717ab00b370e883021f20c2fbaed277",
                  "swapProtocolFee": "300",
                  "parameters": "0x0000000000000000000000000000000000000000000000000000000000320040",
                  "fee": "2500",
                  "spokeName": null,
                  "reserveCount": null,
                  "vaultName": null
                }
              }
            ]
          }
        ]
      }
    ]
  },
  "timestamp": 1748601600000,
  "success": true
}

json

application/json

List DeFi Protocols

List supported DeFi protocols with optional filtering by chain and investment type. Results are paginated and sortable.

POST

/api/v1/defi/data/protocol/list

https://web3.binance.com/build

List DeFi Protocols › Authorization

This is a signed endpoint and a signature must be included in the request headers.Learn more about how to generate a valid signature in the Authentication.

List DeFi Protocols › Headers

X-OC-APIKEY

string · required

API Key issued by Binance Web3 API for authentication.

Example: your-api-key-here

X-OC-TIMESTAMP

string · required

Current UTC time in ISO 8601 format with milliseconds, e.g. 2026-05-11T10:08:57.715Z.

Example: 2026-05-11T10:08:57.715Z

X-OC-SIGN

string · required

Request signature (Base64-encoded).

Example: Base64EncodedSignature==

X-OC-RECV-WINDOW

integer · int64

Allowed time deviation in milliseconds (default: 5000, max: 60000).

Example: 5000

X-OC-NONCE

string

Unique request identifier for anti-replay; falls back to X-OC-SIGN if omitted.

Example: unique-nonce-string

List DeFi Protocols › Request Body

binanceChainId

string

One of the supported chains — see Supported Chains & Protocols for the supported chain ID values. Chains outside this whitelist are rejected with 40001. When omitted (or blank), results span all supported chains.

Example: 56

investType

string · enum

Filter by investment type. Known values: Earn, LiquidityPool.

Enum values:

Earn

LiquidityPool

Example: Earn

sortField

string

Field to sort by. Only two values are accepted: tvl, apy. Note: sorting by APY uses apy (the server-side field name), even though the response exposes apyBps / apyDisplay. Other values are not supported.

Example: tvl

sortDirection

string · enum

Sort direction.

Enum values:

ASC

DESC

Example: DESC

page

integer · min: 1

Page number (1-based).

Example: 1

Default: 1

size

integer · min: 1 · max: 200

Page size. Max: 200.

Example: 20

Default: 200

List DeFi Protocols › Responses

Protocol list returned successfully.

code

integer · int32

Business status code. 0 indicates success.

Example: 0

msg

string

Human-readable status message.

Example: success

object

Paginated protocol list result.

page

integer

Current page number (1-based).

Example: 1

size

integer

Page size.

Example: 20

total

integer · int64

Total number of records.

Example: 10

object[]

Protocols for the current page.

DeFi protocol summary (list item).

defiProtocolId

string

DeFi protocol identifier.

Example: pancakeswap3

protocolName

string

Protocol display name.

Example: PancakeSwap V3

protocolLogo

string

Protocol logo image URL (full URL; quote as-is).

Example: https://bin.bnbstatic.com/image/admin_mgs_image_upload/20250228/pancakeswap-logo.png

tvl

string

Total value locked in the protocol (USD). String, raw precision from the data source.

Example: 1250000.5

apyBps

integer · int64

Highest APY across the protocol's investments, in basis points (1 bps = 0.01%). Integer value — use this for sorting / comparing / filtering, never the raw decimal.

Example: 1235

apyDisplay

string

Pre-formatted, human-readable APY string for display (e.g. "12.35%"). Quote as-is; do not re-compute or transform.

Example: 12.35%

investType

string[]

Investment types supported by this protocol — an array here (a protocol may support several). Note: the investment-level investType (in investment list/detail) is a single string. Known values: Earn, LiquidityPool.

Example: ["Earn","LiquidityPool"]

supportedChains

string[]

Supported Binance chain IDs.

Example: ["56","1","CT_501"]

timestamp

integer · int64

Server timestamp in milliseconds.

Example: 1748601600000

success

boolean

Whether the request succeeded (mirrors code == 0).

Example: true

POST/api/v1/defi/data/protocol/list

curl --request POST \
  --url https://web3.binance.com/build/api/v1/defi/data/protocol/list \
  --header 'Content-Type: application/json' \
  --header 'X-OC-APIKEY: <string>' \
  --header 'X-OC-SIGN: <string>' \
  --header 'X-OC-TIMESTAMP: <string>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "code": 0,
  "msg": "success",
  "data": {
    "page": 1,
    "size": 20,
    "total": 10,
    "list": [
      {
        "defiProtocolId": "pancakeswap3",
        "protocolName": "PancakeSwap V3",
        "protocolLogo": "https://bin.bnbstatic.com/image/admin_mgs_image_upload/20250228/pancakeswap-logo.png",
        "tvl": "1250000.5",
        "apyBps": 1235,
        "apyDisplay": "12.35%",
        "investType": [
          "Earn",
          "LiquidityPool"
        ],
        "supportedChains": [
          "56",
          "1",
          "CT_501"
        ]
      }
    ]
  },
  "timestamp": 1748601600000,
  "success": true
}

json

application/json

Get Protocol Detail

Get detailed information for a specific DeFi protocol, including description, highlights, CertiK security scores, team, fundraising, social links, and FAQ.

POST

/api/v1/defi/data/protocol/detail

https://web3.binance.com/build

Get Protocol Detail › Authorization

This is a signed endpoint and a signature must be included in the request headers.Learn more about how to generate a valid signature in the Authentication.

Get Protocol Detail › Headers

X-OC-APIKEY

string · required

API Key issued by Binance Web3 API for authentication.

Example: your-api-key-here

X-OC-TIMESTAMP

string · required

Current UTC time in ISO 8601 format with milliseconds, e.g. 2026-05-11T10:08:57.715Z.

Example: 2026-05-11T10:08:57.715Z

X-OC-SIGN

string · required

Request signature (Base64-encoded).

Example: Base64EncodedSignature==

X-OC-RECV-WINDOW

integer · int64

Allowed time deviation in milliseconds (default: 5000, max: 60000).

Example: 5000

X-OC-NONCE

string

Unique request identifier for anti-replay; falls back to X-OC-SIGN if omitted.

Example: unique-nonce-string

Get Protocol Detail › Request Body

defiProtocolId

string · required

DeFi protocol identifier.

Example: pancakeswap3

Get Protocol Detail › Responses

Protocol detail returned successfully.

code

integer · int32

Business status code. 0 indicates success.

Example: 0

msg

string

Human-readable status message.

Example: success

object

DeFi protocol detail.

defiProtocolId

string

DeFi protocol identifier.

Example: pancakeswap3

protocolName

string

Protocol display name.

Example: PancakeSwap

protocolLogo

string

Protocol logo image URL (full URL under https://bin.bnbstatic.com).

Example: https://bin.bnbstatic.com/image/admin_mgs_image_upload/20250527/06ab0ee1-8382-4416-9395-15446112b09b.png

description

string

Protocol description (already translated; quote as-is).

Example: PancakeSwap is a decentralized exchange (DEX) built on BNB Chain that utilizes an automated market making (AMM) system.

websiteUrl

string

Official website URL.

Example: https://pancakeswap.finance/

investType

string[]

Example: ["LiquidityPool"]

supportedChains

string[]

Supported Binance chain IDs.

Example: ["56","1","CT_501"]

tvl

string

Total value locked (USD). String, raw precision from the data source.

Example: 290233074

tags

string[]

Protocol tags / categories.

Example: ["DeFi","DEX"]

founded

string

Founding year (YYYY).

Example: 2020

fdv

string

Fully diluted valuation.

Example: 510239911.86046

totalFunding

string | null

Total funding raised. Null when not disclosed.

Example: null

object

Protocol social media links.

x

string | null

X (Twitter) profile URL. Null when not available.

Example: https://x.com/pancakeswap

discord

string | null

Discord invite URL. Null when not available.

Example: null

github

string | null

GitHub organization URL. Null when not available.

Example: https://github.com/pancakeswap

linkedin

string | null

LinkedIn company URL. Null when not available.

Example: https://www.linkedin.com/company/pancakeswap/

telegram

string | null

Telegram channel URL. Null when not available.

Example: null

gitbook

string | null

GitBook documentation URL. Empty string or null when not available.

Example:

website

string

Official website URL.

Example: https://pancakeswap.finance/

object[]

Team members.

Protocol team member.

name

string

Member name.

Example: Henry Cavill

role

string

Member role / title.

Example: CEO

twitter

string | null

Member's X (Twitter) handle URL. Null when not available.

Example: https://x.com/0xchefjackson

linkedin

string | null

Member's LinkedIn URL. Null when not available.

Example: https://www.linkedin.com/in/henry-cavill-6b6ab6229/

bio

string | null

Member biography. Null when not available.

Example: null

object[]

Fundraising history.

Fundraising round.

round

string

Round name (e.g. "Strategic").

Example: Strategic

amount

string | null

Amount raised. Null when not disclosed.

Example: null

date

string

Round date.

Example: 2022-06-06

investors

string[]

Investor names.

Example: ["YZi Labs"]

securityScore

string

Overall CertiK security score.

Example: 92.33

object

CertiK six-dimension security scores.

codeSecurity

string

Code security score.

Example: 95.47

fundamentalHealth

string

Fundamental health score.

Example: 76.7

operationalResilience

string

Operational resilience score.

Example: 94.96

communityTrust

string

Community trust score.

Example: 98

governanceStrength

string

Governance strength score.

Example: 98

marketStability

string

Market stability score.

Example: 96

highlights

string[]

Protocol highlights (already translated; quote as-is).

Example: ["Project has security audits","Code repo health is in excellent condition"]

object[]

FAQ entries (question and answer text, already translated).

FAQ entry.

title

string

FAQ question text (already translated; quote as-is).

Example: How are rewards accrued from providing liquidity on Pancakeswap V3?

answer

string

FAQ answer text (already translated; quote as-is). May contain line-break markup <Br/> and paragraph-gap markup <Gap/> — interpret them as line / paragraph breaks.

Example: • Rewards come from trading fees collected on swaps within your liquidity price range.<Br/>• Fees accumulate and increase your liquidity position value.<Br/>• Fees are accrued only when the market is trading within the range set by you.

timestamp

integer · int64

Server timestamp in milliseconds.

Example: 1748601600000

success

boolean

Whether the request succeeded (mirrors code == 0).

Example: true

POST/api/v1/defi/data/protocol/detail

curl --request POST \
  --url https://web3.binance.com/build/api/v1/defi/data/protocol/detail \
  --header 'Content-Type: application/json' \
  --header 'X-OC-APIKEY: <string>' \
  --header 'X-OC-SIGN: <string>' \
  --header 'X-OC-TIMESTAMP: <string>' \
  --data '
{
  "defiProtocolId": "pancakeswap3"
}
'

Example Request Body

{
  "defiProtocolId": "pancakeswap3"
}

json

Example Responses

{
  "code": 0,
  "msg": "success",
  "data": {
    "defiProtocolId": "pancakeswap3",
    "protocolName": "PancakeSwap",
    "protocolLogo": "https://bin.bnbstatic.com/image/admin_mgs_image_upload/20250527/06ab0ee1-8382-4416-9395-15446112b09b.png",
    "description": "PancakeSwap is a decentralized exchange (DEX) built on BNB Chain that utilizes an automated market making (AMM) system.",
    "websiteUrl": "https://pancakeswap.finance/",
    "investType": [
      "LiquidityPool"
    ],
    "supportedChains": [
      "56",
      "1",
      "CT_501"
    ],
    "tvl": "290233074",
    "tags": [
      "DeFi",
      "DEX"
    ],
    "founded": "2020",
    "fdv": "510239911.86046",
    "totalFunding": null,
    "socialLinks": {
      "x": "https://x.com/pancakeswap",
      "discord": null,
      "github": "https://github.com/pancakeswap",
      "linkedin": "https://www.linkedin.com/company/pancakeswap/",
      "telegram": null,
      "gitbook": "",
      "website": "https://pancakeswap.finance/"
    },
    "team": [
      {
        "name": "Henry Cavill",
        "role": "CEO",
        "twitter": "https://x.com/0xchefjackson",
        "linkedin": "https://www.linkedin.com/in/henry-cavill-6b6ab6229/",
        "bio": null
      }
    ],
    "fundRaising": [
      {
        "round": "Strategic",
        "amount": null,
        "date": "2022-06-06",
        "investors": [
          "YZi Labs"
        ]
      }
    ],
    "securityScore": "92.33",
    "dimensionScores": {
      "codeSecurity": "95.47",
      "fundamentalHealth": "76.7",
      "operationalResilience": "94.96",
      "communityTrust": "98",
      "governanceStrength": "98",
      "marketStability": "96"
    },
    "highlights": [
      "Project has security audits",
      "Code repo health is in excellent condition"
    ],
    "faq": [
      {
        "title": "How are rewards accrued from providing liquidity on Pancakeswap V3?",
        "answer": "• Rewards come from trading fees collected on swaps within your liquidity price range.<Br/>• Fees accumulate and increase your liquidity position value.<Br/>• Fees are accrued only when the market is trading within the range set by you."
      }
    ]
  },
  "timestamp": 1748601600000,
  "success": true
}

json

application/json

List DeFi Investments

List available DeFi investment products. Filter by protocol, chain, investment type, or contract address. Results are paginated and sortable.

POST

/api/v1/defi/data/investment/list

https://web3.binance.com/build

List DeFi Investments › Authorization

This is a signed endpoint and a signature must be included in the request headers.Learn more about how to generate a valid signature in the Authentication.

List DeFi Investments › Headers

X-OC-APIKEY

string · required

API Key issued by Binance Web3 API for authentication.

Example: your-api-key-here

X-OC-TIMESTAMP

string · required

Current UTC time in ISO 8601 format with milliseconds, e.g. 2026-05-11T10:08:57.715Z.

Example: 2026-05-11T10:08:57.715Z

X-OC-SIGN

string · required

Request signature (Base64-encoded).

Example: Base64EncodedSignature==

X-OC-RECV-WINDOW

integer · int64

Allowed time deviation in milliseconds (default: 5000, max: 60000).

Example: 5000

X-OC-NONCE

string

Unique request identifier for anti-replay; falls back to X-OC-SIGN if omitted.

Example: unique-nonce-string

List DeFi Investments › Request Body

investType

string · enum · required

Filter by investment type. Required. Known values: Earn, LiquidityPool.

Enum values:

Earn

LiquidityPool

Example: Earn

defiProtocolId

string

Filter by DeFi protocol ID.

Example: pancakeswap3

tokenAddressList

string[]

Filter by token addresses. When this field is provided, binanceChainId is required — the same address can be a different token on different chains; omitting the chain returns 40001.

Example: ["0x55d398326f99059fF775485246999027B3197955"]

binanceChainId

string

Example: 56

sortField

string

Example: tvl

sortDirection

string · enum

Sort direction.

Enum values:

ASC

DESC

Example: DESC

page

integer · min: 1

Page number (1-based).

Example: 1

Default: 1

size

integer · min: 1 · max: 100

Page size. Max: 100.

Example: 20

Default: 20

List DeFi Investments › Responses

Investment list returned successfully.

code

integer · int32

Business status code. 0 indicates success.

Example: 0

msg

string

Human-readable status message.

Example: success

object

Paginated investment list result.

page

integer

Current page number (1-based).

Example: 1

size

integer

Page size.

Example: 20

total

integer · int64

Total number of records.

Example: 290

object[]

Investments for the current page.

DeFi investment product summary (list item).

binanceChainId

string

Binance chain ID.

Example: 56

defiProtocolId

string

Parent DeFi protocol identifier.

Example: pancakeswap3

protocolName

string

Protocol display name.

Example: PancakeSwap V3

investmentId

string

Investment product identifier (64-char hex, no 0x prefix). Same format as the investmentIds returned by POST /api/v1/defi/data/position/list and accepted by the transaction build endpoints.

Example: fc546857d03bf5f7ca15d01c564c8430599f6fd8ec3c2dda0119b8a7e7e793e8

investmentName

string

Investment display name.

Example: USDT-MarsCoin

investType

string

Investment type of this product — a single string here (each product has exactly one). Note: the protocol-level investType (in protocol list/detail) is an array. Known values: Earn, LiquidityPool.

Example: LiquidityPool

apyType

string

Rate yield type. Known values: APY, APR.

Example: APR

apyBps

integer · int64

Annual percentage yield in basis points (1 bps = 0.01%). Integer value — use this for sorting / comparing / filtering, never the raw decimal.

Example: 156265

apyDisplay

string

Pre-formatted, human-readable APY string for display (e.g. "1,562.65%"). Quote as-is; do not re-compute or transform.

Example: 1,562.65%

tvl

string

Total value locked in this investment (USD). String, raw precision from the data source.

Example: 352489.87

timestamp

integer · int64

Server timestamp in milliseconds.

Example: 1748601600000

success

boolean

Whether the request succeeded (mirrors code == 0).

Example: true

POST/api/v1/defi/data/investment/list

curl --request POST \
  --url https://web3.binance.com/build/api/v1/defi/data/investment/list \
  --header 'Content-Type: application/json' \
  --header 'X-OC-APIKEY: <string>' \
  --header 'X-OC-SIGN: <string>' \
  --header 'X-OC-TIMESTAMP: <string>' \
  --data '
{
  "investType": "Earn"
}
'

Example Request Body

{
  "investType": "Earn"
}

json

Example Responses

{
  "code": 0,
  "msg": "success",
  "data": {
    "page": 1,
    "size": 20,
    "total": 290,
    "list": [
      {
        "binanceChainId": "56",
        "defiProtocolId": "pancakeswap3",
        "protocolName": "PancakeSwap V3",
        "investmentId": "fc546857d03bf5f7ca15d01c564c8430599f6fd8ec3c2dda0119b8a7e7e793e8",
        "investmentName": "USDT-MarsCoin",
        "investType": "LiquidityPool",
        "apyType": "APR",
        "apyBps": 156265,
        "apyDisplay": "1,562.65%",
        "tvl": "352489.87"
      }
    ]
  },
  "timestamp": 1748601600000,
  "success": true
}

json

application/json

Get Investment Detail

Get detailed information for a specific DeFi investment product, including APY, TVL, supported tokens (asset / reward / LP / borrow), pool address, fee rate, and investability.

POST

/api/v1/defi/data/investment/detail

https://web3.binance.com/build

Get Investment Detail › Authorization

This is a signed endpoint and a signature must be included in the request headers.Learn more about how to generate a valid signature in the Authentication.

Get Investment Detail › Headers

X-OC-APIKEY

string · required

API Key issued by Binance Web3 API for authentication.

Example: your-api-key-here

X-OC-TIMESTAMP

string · required

Current UTC time in ISO 8601 format with milliseconds, e.g. 2026-05-11T10:08:57.715Z.

Example: 2026-05-11T10:08:57.715Z

X-OC-SIGN

string · required

Request signature (Base64-encoded).

Example: Base64EncodedSignature==

X-OC-RECV-WINDOW

integer · int64

Allowed time deviation in milliseconds (default: 5000, max: 60000).

Example: 5000

X-OC-NONCE

string

Unique request identifier for anti-replay; falls back to X-OC-SIGN if omitted.

Example: unique-nonce-string

Get Investment Detail › Request Body

investmentId

string · required

Investment product identifier (64-char hex, no 0x prefix). Same format as the investmentIds returned by POST /api/v1/defi/data/position/list.

Example: fc546857d03bf5f7ca15d01c564c8430599f6fd8ec3c2dda0119b8a7e7e793e8

Get Investment Detail › Responses

Investment detail returned successfully.

code

integer · int32

Business status code. 0 indicates success.

Example: 0

msg

string

Human-readable status message.

Example: success

object

DeFi investment product detail.

binanceChainId

string

Binance chain ID.

Example: 56

defiProtocolId

string

Parent DeFi protocol identifier.

Example: pancakeswap3

protocolName

string

Protocol display name.

Example: PancakeSwap V3

protocolLogo

string

Protocol logo image URL (full URL; quote as-is).

Example: https://bin.bnbstatic.com/image/admin_mgs_image_upload/20250228/pancakeswap-logo.png

investmentId

string

Investment product identifier (64-char hex, no 0x prefix). Same format as the investmentIds returned by POST /api/v1/defi/data/position/list and accepted by the transaction build endpoints.

Example: fc546857d03bf5f7ca15d01c564c8430599f6fd8ec3c2dda0119b8a7e7e793e8

investmentName

string

Investment display name.

Example: USDT-MarsCoin

investType

string

Investment type of this product — a single string here (each product has exactly one). Note: the protocol-level investType (in protocol list/detail) is an array. Known values: Earn, LiquidityPool.

Example: LiquidityPool

investable

boolean

Whether this investment is currently investable.

Example: true

apyBps

integer · int64

Annual percentage yield in basis points (1 bps = 0.01%). Integer value — use this for sorting / comparing / filtering, never the raw decimal.

Example: 156265

apyDisplay

string

Pre-formatted, human-readable APY string for display (e.g. "1,562.65%"). Quote as-is; do not re-compute or transform.

Example: 1,562.65%

apyType

string

Rate yield type. Known values: APY, APR.

Example: APR

tvl

string

Total value locked (USD). String, raw precision from the data source.

Example: 500000.5

poolAddress

string

Pool / strategy contract address.

Example: 0x87870Bca3F3fF67225794148012b73643B78Ed36

feeRate

string

Fee rate string (e.g. "0.001" = 0.1%).

Example: 0.001

object[]

Tokens to supply / deposit.

Token in an investment product.

tokenAddress

string

Token contract address. The native-asset sentinel for native coins.

Example: 0x55d398326f99059fF775485246999027B3197955

tokenName

string

Token name.

Example: Tether USD

tokenSymbol

string

Token symbol.

Example: USDT

object[]

Reward tokens.

Token in an investment product.

tokenAddress

string

Token contract address. The native-asset sentinel for native coins.

Example: 0x55d398326f99059fF775485246999027B3197955

tokenName

string

Token name.

Example: Tether USD

tokenSymbol

string

Token symbol.

Example: USDT

object[]

LP tokens (for liquidity positions).

Token in an investment product.

tokenAddress

string

Token contract address. The native-asset sentinel for native coins.

Example: 0x55d398326f99059fF775485246999027B3197955

tokenName

string

Token name.

Example: Tether USD

tokenSymbol

string

Token symbol.

Example: USDT

object[]

Borrow tokens (for lending borrow positions).

Token in an investment product.

tokenAddress

string

Token contract address. The native-asset sentinel for native coins.

Example: 0x55d398326f99059fF775485246999027B3197955

tokenName

string

Token name.

Example: Tether USD

tokenSymbol

string

Token symbol.

Example: USDT

timestamp

integer · int64

Server timestamp in milliseconds.

Example: 1748601600000

success

boolean

Whether the request succeeded (mirrors code == 0).

Example: true

POST/api/v1/defi/data/investment/detail

curl --request POST \
  --url https://web3.binance.com/build/api/v1/defi/data/investment/detail \
  --header 'Content-Type: application/json' \
  --header 'X-OC-APIKEY: <string>' \
  --header 'X-OC-SIGN: <string>' \
  --header 'X-OC-TIMESTAMP: <string>' \
  --data '
{
  "investmentId": "fc546857d03bf5f7ca15d01c564c8430599f6fd8ec3c2dda0119b8a7e7e793e8"
}
'

Example Request Body

{
  "investmentId": "fc546857d03bf5f7ca15d01c564c8430599f6fd8ec3c2dda0119b8a7e7e793e8"
}

json

Example Responses

{
  "code": 0,
  "msg": "success",
  "data": {
    "binanceChainId": "56",
    "defiProtocolId": "pancakeswap3",
    "protocolName": "PancakeSwap V3",
    "protocolLogo": "https://bin.bnbstatic.com/image/admin_mgs_image_upload/20250228/pancakeswap-logo.png",
    "investmentId": "fc546857d03bf5f7ca15d01c564c8430599f6fd8ec3c2dda0119b8a7e7e793e8",
    "investmentName": "USDT-MarsCoin",
    "investType": "LiquidityPool",
    "investable": true,
    "apyBps": 156265,
    "apyDisplay": "1,562.65%",
    "apyType": "APR",
    "tvl": "500000.5",
    "poolAddress": "0x87870Bca3F3fF67225794148012b73643B78Ed36",
    "feeRate": "0.001",
    "assetTokenList": [
      {
        "tokenAddress": "0x55d398326f99059fF775485246999027B3197955",
        "tokenName": "Tether USD",
        "tokenSymbol": "USDT"
      }
    ],
    "rewardTokenList": [
      {
        "tokenAddress": "0x55d398326f99059fF775485246999027B3197955",
        "tokenName": "Tether USD",
        "tokenSymbol": "USDT"
      }
    ],
    "lpTokenList": [
      {
        "tokenAddress": "0x55d398326f99059fF775485246999027B3197955",
        "tokenName": "Tether USD",
        "tokenSymbol": "USDT"
      }
    ],
    "borrowTokenList": [
      {
        "tokenAddress": "0x55d398326f99059fF775485246999027B3197955",
        "tokenName": "Tether USD",
        "tokenSymbol": "USDT"
      }
    ]
  },
  "timestamp": 1748601600000,
  "success": true
}

json

application/json