DeFi Transaction

Endpointhttps://web3.binance.com/build

Build DeFi Deposit Transaction

Build the unsigned transaction calldata for a DeFi deposit / stake. Returns an ordered dataList (typically [APPROVE, DEPOSIT], or [DEPOSIT] when the allowance is already sufficient) for the caller to sign and broadcast. The caller does NOT pass binanceChainId — the service resolves it from investmentId. Set simulate=true to also receive a preview (projected balance change, estimated gas, and lending health-factor change) without broadcasting.

POST

/api/v1/defi/transaction/deposit

https://web3.binance.com/build

Build DeFi Deposit Transaction › 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.

Build DeFi Deposit Transaction › 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

Build DeFi Deposit Transaction › Request Body

address

string · required

User wallet address (the signer / sender).

Example: 0x1234567890123456789012345678901234567890

investmentId

string · required

Investment product ID (chain-agnostic). The service resolves the chain from this ID.

Example: 10ab3e25d9f0b72f1f912b5d611f825bec495a74f2e1b25d8bba5fd2e56fb283

object · required

A (tokenAddress, amount) pair. amount is a human-readable decimal string (NOT the token's smallest unit); the service converts it according to the token's decimals. For the native asset use the sentinel 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee (40 es).

A `(tokenAddress, amount)` pair. `amount` is a human-readable decimal string (NOT the token's smallest unit); the service converts it according to the token's decimals. For the native asset use the sentinel `0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee` (40 `e`s).

tokenAddress

string · required

Token contract address; the native-asset sentinel for the native coin.

Example: 0x55d398326f99059fF775485246999027B3197955

amount

string · required

Human-readable amount as a decimal string, e.g. "1.5", "100".

Example: 100

simulate

boolean

When true, the response also includes a preview object. Default false. If the simulated transaction reverts, the request returns 40485 for a specific classified revert reason or 40484 for any other revert (see Error Codes).

Example: true

Build DeFi Deposit Transaction › Responses

Deposit transaction calldata returned successfully.

code

integer · int32

Business status code. 0 indicates success.

Example: 0

msg

string

Human-readable status message.

Example: success

object

Unified response of the five build endpoints (deposit / redeem / lp-add / lp-remove / claim). dataList is ordered: APPROVE items come first, the main action follows — sign and broadcast each item in order. preview is non-null only when the request set simulate=true. redeemDelayDays is populated only by /transaction/redeem.

Unified response of the five build endpoints (deposit / redeem / lp-add / lp-remove / claim). `dataList` is ordered: APPROVE items come first, the main action follows — sign and broadcast each item in order. `preview` is non-null only when the request set `simulate=true`. `redeemDelayDays` is populated only by `/transaction/redeem`.

object[]

Ordered unsigned transactions; APPROVE precedes the main action.

A single unsigned transaction to sign and broadcast. The dataList is ordered: APPROVE items precede the main action. The shape depends on the chain family. EVM chains: return to / value (hex) and hex calldata in data. The list may contain an ERC-20 APPROVE item followed by the main action — sign and broadcast each in order. Solana (binanceChainId = "CT_501"): returns a base64-serialized wire transaction in data. The compute-budget fee is injected server-side for every action, so do not add ComputeBudget or priority-fee instructions yourself (see Integration Flow). to and value are null (Solana has no EVM to / value concept). The list is always exactly one item and never contains APPROVE (Solana has no ERC-20 allowance concept). Sign it as a Solana VersionedTransaction. Number-format conventions for this object: on EVM chains value is a 0x-prefixed hex string; gasLimit, gasPrice, maxPriorityFeePerGas, and maxFeePerGas are decimal strings. Mixed hex/decimal within the same object is by design (it mirrors the on-chain transaction fields); always parse gas fields with base-10 and value with base-16. On Solana value is null; gasLimit is the compute-unit limit and gasPrice is the per-compute-unit micro-lamport fee (both decimal strings). EIP-1559 and legacy gas fields (EVM): on BSC build responses populate maxFeePerGas and maxPriorityFeePerGas; gasPrice is null. Other supported EVM chains may populate either set — use the 1559 fields when present and fall back to gasPrice when it carries a value. The nullable markers below are retained so the schema also describes legacy-only chains. maxPriorityFeePerGas and maxFeePerGas are null on Solana.

callDataType

string · enum

Action kind of this item:

APPROVE — ERC-20 approval (EVM only), must be signed/broadcast and confirmed before the main action. Never returned for Solana.
DEPOSIT / REDEEM / LP_ADD / LP_REMOVE / CLAIM — the main action. LP_ADD / LP_REMOVE are the LP add / remove legs (the same build path as deposit / redeem for liquidity-pool investments; the kind reflects the on-chain action, not the entry endpoint).

Enum values:

APPROVE

DEPOSIT

REDEEM

LP_ADD

LP_REMOVE

CLAIM

Example: DEPOSIT

from

string

User wallet address (the signer / sender). EIP-55 checksummed on EVM chains — normalize with to_checksum_address before signing if your signer requires it. On Solana this is the base58 fee-payer public key.

Example: 0x1234567890123456789012345678901234567890

to

string | null

Target contract address. EIP-55 checksummed on EVM chains, same format as from. Non-null on EVM; null on Solana (Solana expresses the target program inside the serialized transaction in data, not here).

Example: 0x87870Bca3F3fF67225794148012b73643B78Ed36

value

string | null

Native-asset value as a 0x-prefixed hex string. Non-null on EVM; null on Solana.

Example: 0x0

data

string

Serialized transaction data. On EVM chains a 0x-prefixed hex calldata string. On Solana a base64-serialized wire transaction (compute-budget fee injected server-side for every action).

Example: 0xa9059cbb…

gasLimit

string | null

Suggested gas limit on EVM (decimal string, gas units). On Solana it is the estimated compute-unit consumption; the transaction's actual compute-unit limit set on-chain is roughly 1.2× this value. null when estimation fails.

Example: 200000

gasPrice

string | null

Legacy gas price on EVM, decimal string. null on EIP-1559 chains such as BSC (use maxFeePerGas / maxPriorityFeePerGas instead). On Solana this is the per-compute-unit fee in micro-lamports (decimal string).

Example: 3000000000

maxPriorityFeePerGas

string | null

EIP-1559 priority fee in wei (decimal string). null on non-1559 EVM chains and on Solana.

Example: 1000000000

maxFeePerGas

string | null

EIP-1559 max fee per gas in wei (decimal string). null on non-1559 EVM chains and on Solana.

Example: 3000000000

object

Simulation result returned by the build endpoints when simulate=true. Includes whether the action is expected to succeed, the projected balance change, the estimated network fee, and — for lending protocols — the health-factor change. balanceChange, feeAndContract, healthFactor, and warnings each have a fixed structure (see below); the number of entries and some inner values vary by protocol.

Simulation result returned by the build endpoints when `simulate=true`. Includes whether the action is expected to succeed, the projected balance change, the estimated network fee, and — for lending protocols — the health-factor change. `balanceChange`, `feeAndContract`, `healthFactor`, and `warnings` each have a fixed structure (see below); the number of entries and some inner values vary by protocol.

success

boolean

Whether the simulated transaction is expected to succeed on-chain.

Example: true

object[]

Signed token balance deltas from the simulation. Each entry has tokenType, tokenSymbol, tokenAddress, tokenDecimals, amount (positive = received, negative = spent), valueUsd, and an optional tokenId.

tokenType

string

Token role / type tag from the simulation.

Example: TOKEN

tokenSymbol

string

Token symbol.

Example: USDT

tokenAddress

string

Token contract address.

Example: 0xdac17f958d2ee523a2206206994597c13d831ec7

tokenDecimals

string

Token decimals.

Example: 18

amount

string

Signed delta (positive = received, negative = spent).

Example: -1000

valueUsd

string

USD value of the delta.

Example: 1000.00

tokenId

string

Optional NFT / position token ID when applicable.

Example: 123456

object

Estimated network fee and the contract the action interacts with. Contains estimatedNetworkFee and interactWith.

Example: {"estimatedNetworkFee":{"amount":"0.000003056787","tokenSymbol":"BNB","valueUsd":"0.002002","rentFeeAmount":null,"rentFeeValueUsd":null,"priorityFeeAmount":null},"interactWith":{"address":"0xae05cd22df81871bc7cc2a04becfb516bfe332c8"}}

Estimated network fee and the contract the action interacts with. Contains `estimatedNetworkFee` and `interactWith`.

object

Estimated gas cost for the action. Fields may be null when estimation is not available (e.g. a failed simulation).

Estimated gas cost for the action. Fields may be `null` when estimation is not available (e.g. a failed simulation).

amount

string | null

Estimated gas fee in the fee-paying native coin (human-readable). On Solana this may be null even when fee estimation succeeded — use valueUsd as the reliable figure when amount is absent.

Example: 0.000003056787

tokenSymbol

string

Symbol of the fee-paying token (native coin, e.g. BNB).

Example: BNB

valueUsd

string | null

USD value of the estimated fee.

Example: 0.002002

rentFeeAmount

string | null

Solana storage / rent fee portion (human-readable). null on EVM chains; only populated on Solana when the action creates an account (e.g. a first-time ATA).

Example: null

rentFeeValueUsd

string | null

USD value of the Solana rent fee. null on EVM chains; Solana-only.

Example: null

priorityFeeAmount

string | null

Solana priority fee portion (human-readable). null on EVM chains; Solana-only.

Example: null

object

The contract the action interacts with.

address

string

Target contract address.

Example: 0xae05cd22df81871bc7cc2a04becfb516bfe332c8

object

Lending health-factor change. Contains before / after values for lending protocols (e.g. Aave / Venus); null for non-lending protocols or when health factor is unavailable.

Example: {"before":"1.85","after":"1.35"}

Lending health-factor change. Contains `before` / `after` values for lending protocols (e.g. Aave / Venus); `null` for non-lending protocols or when health factor is unavailable.

before

string | null

Health factor before this transaction. Null when unavailable.

Example: 1.85

after

string | null

Health factor after this transaction. Null when unavailable.

Example: 1.35

object[]

Non-blocking risk warnings. Empty array when there are no warnings.

A single non-blocking risk warning.

code

string

Warning code. Known values: HEALTH_FACTOR_WARNING, HEALTH_FACTOR_DANGER, HIGH_SLIPPAGE, DELAYED_REDEMPTION, LP_OUT_OF_RANGE. Branch on code for control flow; display message as-is.

Example: HEALTH_FACTOR_WARNING

level

string

Severity level — INFO / WARN / DANGER.

Example: WARN

message

string

Human-readable warning text.

Example: Health factor will drop below 1.5 after this transaction.

errorMessage

string

Error message when the simulated transaction is expected to fail.

Example: insufficient balance

redeemDelayDays

string[]

Redeem waiting period as a [min, max] day pair of decimal strings. Populated only by /transaction/redeem; null on the other build endpoints or when unavailable. Interpretation: [] (empty) = instant, no waiting period; ["7","7"] = fixed 7 days; ["7","10"] = 7–10 days. The wait starts after the redeem transaction is confirmed on-chain. Protocols with a waiting period include Lista (helio), Aster (astherus), and the Solana staking protocols (sol_staking, marinadefinance, renzo, solayer, jito, jupiter, fragmetric), which range from 2 to 30 days. Delays are configured in seconds server-side and rounded up to whole days.

Example: ["7","10"]

timestamp

integer · int64

Server timestamp in milliseconds.

Example: 1748601600000

success

boolean

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

Example: true

POST/api/v1/defi/transaction/deposit

curl --request POST \
  --url https://web3.binance.com/build/api/v1/defi/transaction/deposit \
  --header 'Content-Type: application/json' \
  --header 'X-OC-APIKEY: <string>' \
  --header 'X-OC-SIGN: <string>' \
  --header 'X-OC-TIMESTAMP: <string>' \
  --data '
{
  "address": "0x1234567890123456789012345678901234567890",
  "investmentId": "10ab3e25d9f0b72f1f912b5d611f825bec495a74f2e1b25d8bba5fd2e56fb283",
  "token": {
    "tokenAddress": "0x55d398326f99059fF775485246999027B3197955",
    "amount": "100"
  }
}
'

Example Request Body

{
  "address": "0x1234567890123456789012345678901234567890",
  "investmentId": "10ab3e25d9f0b72f1f912b5d611f825bec495a74f2e1b25d8bba5fd2e56fb283",
  "token": {
    "tokenAddress": "0x55d398326f99059fF775485246999027B3197955",
    "amount": "100"
  }
}

json

Example Responses

{
  "code": 0,
  "msg": "success",
  "data": {
    "dataList": [
      {
        "callDataType": "APPROVE",
        "from": "0x1234567890123456789012345678901234567890",
        "to": "0xdac17f958d2ee523a2206206994597c13d831ec7",
        "value": "0x0",
        "data": "0x095ea7b300000000000000000000000087870bca3f3ff67225794148012b73643b78ed3600000000000000000000000000000000000000000000000000000000000fffff",
        "gasLimit": "50000",
        "gasPrice": null,
        "maxPriorityFeePerGas": "1000000000",
        "maxFeePerGas": "3000000000"
      },
      {
        "callDataType": "DEPOSIT",
        "from": "0x1234567890123456789012345678901234567890",
        "to": "0x87870Bca3F3fF67225794148012b73643B78Ed36",
        "value": "0x0",
        "data": "0xa9059cbb000000000000000000000000dead00000000000000000000000000000000dead00000000000000000000000000000000000000000000000000000000000000000a",
        "gasLimit": "200000",
        "gasPrice": null,
        "maxPriorityFeePerGas": "1000000000",
        "maxFeePerGas": "3000000000"
      }
    ],
    "preview": {
      "success": true,
      "balanceChange": [
        {
          "tokenType": "TOKEN",
          "tokenSymbol": "USDT",
          "tokenAddress": "0x55d398326f99059fF775485246999027B3197955",
          "tokenDecimals": "18",
          "amount": "-1000",
          "valueUsd": "1000.00"
        },
        {
          "tokenType": "TOKEN",
          "tokenSymbol": "aBUSD",
          "tokenAddress": "0x6d8981847eb3cc2234179d0f0e72f6be6e0950a4",
          "tokenDecimals": "18",
          "amount": "999.99",
          "valueUsd": "999.99"
        }
      ],
      "feeAndContract": {
        "estimatedNetworkFee": {
          "amount": "0.000003056787",
          "tokenSymbol": "BNB",
          "valueUsd": "0.002002",
          "rentFeeAmount": null,
          "rentFeeValueUsd": null,
          "priorityFeeAmount": null
        },
        "interactWith": {
          "address": "0x87870Bca3F3fF67225794148012b73643B78Ed36"
        }
      },
      "healthFactor": {
        "before": "1.85",
        "after": "1.35"
      },
      "warnings": [
        {
          "code": "HEALTH_FACTOR_WARNING",
          "level": "WARN",
          "message": "Health factor will drop from 1.85 to 1.35 after this transaction."
        }
      ]
    }
  },
  "timestamp": 1748601600000,
  "success": true
}

json

application/json

Build DeFi Redeem Transaction

Build the unsigned transaction calldata for a DeFi redeem / withdraw. Returns an ordered dataList (typically [REDEEM] or [APPROVE, REDEEM]). Redeem amount is decided by exactly one of ratio or token (mutually exclusive): - ratio omitted / blank → exact-amount redeem: the amount comes from token (tokenAddress + amount); the position is not queried. token is required in this mode (omitting token, or leaving amount blank, is rejected with 40001, Parameter error; both ratio and token absent is also rejected with 40001).

ratio present → proportional redeem: must parse as a decimal in (0, 1]. The service queries the user's on-chain position under investmentId and scales each token's amount by ratio (floored to the token's decimals). ratio="1" is a full (max) redeem. In this mode token is ignored — the output tokens and amounts are derived from the position.

slippageBps is the slippage tolerance in basis points (e.g. 300 = 3%). The caller does NOT pass binanceChainId — resolved from investmentId. Set simulate=true to also receive preview. The response also carries redeemDelayDays — the redeem waiting period as a [min, max] day pair (e.g. ["7","10"] = 7–10 days, [] = instant). The wait starts after the redeem tx is confirmed on-chain. See the redeemDelayDays field on DefiTxResponse.

POST

/api/v1/defi/transaction/redeem

https://web3.binance.com/build

Build DeFi Redeem Transaction › 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.

Build DeFi Redeem Transaction › 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

Build DeFi Redeem Transaction › Request Body

address

string · required

User wallet address (the signer / sender).

Example: 0x1234567890123456789012345678901234567890

investmentId

string · required

Investment product ID (chain-agnostic). The service resolves the chain from this ID.

Example: 10ab3e25d9f0b72f1f912b5d611f825bec495a74f2e1b25d8bba5fd2e56fb283

object

tokenAddress

string · required

Token contract address; the native-asset sentinel for the native coin.

Example: 0x55d398326f99059fF775485246999027B3197955

amount

string · required

Human-readable amount as a decimal string, e.g. "1.5", "100".

Example: 100

ratio

string

Redeem ratio, mutually exclusive with token. Omitted / blank → exact-amount redeem via token (tokenAddress + amount, position not queried). Present → must parse as a decimal in (0, 1]; the service queries the on-chain position under investmentId and scales each token amount by ratio (floored to decimals). "1" = full (max) redeem; in this mode token is ignored.

Example: 1

slippageBps

string

Slippage tolerance in basis points (e.g. 300 = 3%).

Example: 300

stakeAccounts

array | null

Base58 stake account address(es) — the account(s) to deactivate. Required for Solana native staking (sol_staking) redeem only; the whole stake account is redeemed and token / ratio are ignored in this mode. Passing stakeAccounts for any other protocol (EVM chains, LP, or other Solana protocols) is a parameter error. This release supports exactly one element (length at most 1).

Example: ["5vUt9pxBK9KaaHm19okrwSuP2vUU71Nm7ScsBiSqsW1s"]

positionAddress

string | null

Base58 position PDA for Jupiter Lend Borrow (jupiter, surface lend_borrow_supply) redeem — one vault may hold several positions for the same address, so the caller must name which to withdraw. Take it from position/list's positionDetail.positionIndex. Required for a Lend Borrow redeem; token / ratio still decide the amount to withdraw. Passing positionAddress for any other protocol is a parameter error.

Example: 3FK34GHWK9SsoEjV7E3cHHWz5hNXufcfwnQaY7pyh5V1

simulate

boolean

When true, the response also includes a preview object. Default false. If the simulated transaction reverts, the request returns an error code instead of a 200 with preview.success=false: 40485 when the redeem amount exceeds the current position, 40484 for any other revert (see Error Codes).

Example: true

Build DeFi Redeem Transaction › Responses

Redeem transaction calldata returned successfully.

code

integer · int32

Business status code. 0 indicates success.

Example: 0

msg

string

Human-readable status message.

Example: success

object

object[]

Ordered unsigned transactions; APPROVE precedes the main action.

callDataType

string · enum

Action kind of this item:

APPROVE — ERC-20 approval (EVM only), must be signed/broadcast and confirmed before the main action. Never returned for Solana.
DEPOSIT / REDEEM / LP_ADD / LP_REMOVE / CLAIM — the main action. LP_ADD / LP_REMOVE are the LP add / remove legs (the same build path as deposit / redeem for liquidity-pool investments; the kind reflects the on-chain action, not the entry endpoint).

Enum values:

APPROVE

DEPOSIT

REDEEM

LP_ADD

LP_REMOVE

CLAIM

Example: DEPOSIT

from

string

Example: 0x1234567890123456789012345678901234567890

to

string | null

Example: 0x87870Bca3F3fF67225794148012b73643B78Ed36

value

string | null

Native-asset value as a 0x-prefixed hex string. Non-null on EVM; null on Solana.

Example: 0x0

data

string

Serialized transaction data. On EVM chains a 0x-prefixed hex calldata string. On Solana a base64-serialized wire transaction (compute-budget fee injected server-side for every action).

Example: 0xa9059cbb…

gasLimit

string | null

Example: 200000

gasPrice

string | null

Example: 3000000000

maxPriorityFeePerGas

string | null

EIP-1559 priority fee in wei (decimal string). null on non-1559 EVM chains and on Solana.

Example: 1000000000

maxFeePerGas

string | null

EIP-1559 max fee per gas in wei (decimal string). null on non-1559 EVM chains and on Solana.

Example: 3000000000

object

success

boolean

Whether the simulated transaction is expected to succeed on-chain.

Example: true

object[]

tokenType

string

Token role / type tag from the simulation.

Example: TOKEN

tokenSymbol

string

Token symbol.

Example: USDT

tokenAddress

string

Token contract address.

Example: 0xdac17f958d2ee523a2206206994597c13d831ec7

tokenDecimals

string

Token decimals.

Example: 18

amount

string

Signed delta (positive = received, negative = spent).

Example: -1000

valueUsd

string

USD value of the delta.

Example: 1000.00

tokenId

string

Optional NFT / position token ID when applicable.

Example: 123456

object

Estimated network fee and the contract the action interacts with. Contains estimatedNetworkFee and interactWith.

Estimated network fee and the contract the action interacts with. Contains `estimatedNetworkFee` and `interactWith`.

object

Estimated gas cost for the action. Fields may be null when estimation is not available (e.g. a failed simulation).

Estimated gas cost for the action. Fields may be `null` when estimation is not available (e.g. a failed simulation).

amount

string | null

Estimated gas fee in the fee-paying native coin (human-readable). On Solana this may be null even when fee estimation succeeded — use valueUsd as the reliable figure when amount is absent.

Example: 0.000003056787

tokenSymbol

string

Symbol of the fee-paying token (native coin, e.g. BNB).

Example: BNB

valueUsd

string | null

USD value of the estimated fee.

Example: 0.002002

rentFeeAmount

string | null

Solana storage / rent fee portion (human-readable). null on EVM chains; only populated on Solana when the action creates an account (e.g. a first-time ATA).

Example: null

rentFeeValueUsd

string | null

USD value of the Solana rent fee. null on EVM chains; Solana-only.

Example: null

priorityFeeAmount

string | null

Solana priority fee portion (human-readable). null on EVM chains; Solana-only.

Example: null

object

The contract the action interacts with.

address

string

Target contract address.

Example: 0xae05cd22df81871bc7cc2a04becfb516bfe332c8

object

Lending health-factor change. Contains before / after values for lending protocols (e.g. Aave / Venus); null for non-lending protocols or when health factor is unavailable.

Example: {"before":"1.85","after":"1.35"}

Lending health-factor change. Contains `before` / `after` values for lending protocols (e.g. Aave / Venus); `null` for non-lending protocols or when health factor is unavailable.

before

string | null

Health factor before this transaction. Null when unavailable.

Example: 1.85

after

string | null

Health factor after this transaction. Null when unavailable.

Example: 1.35

object[]

Non-blocking risk warnings. Empty array when there are no warnings.

A single non-blocking risk warning.

code

string

Warning code. Known values: HEALTH_FACTOR_WARNING, HEALTH_FACTOR_DANGER, HIGH_SLIPPAGE, DELAYED_REDEMPTION, LP_OUT_OF_RANGE. Branch on code for control flow; display message as-is.

Example: HEALTH_FACTOR_WARNING

level

string

Severity level — INFO / WARN / DANGER.

Example: WARN

message

string

Human-readable warning text.

Example: Health factor will drop below 1.5 after this transaction.

errorMessage

string

Error message when the simulated transaction is expected to fail.

Example: insufficient balance

redeemDelayDays

string[]

Example: ["7","10"]

timestamp

integer · int64

Server timestamp in milliseconds.

Example: 1748601600000

success

boolean

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

Example: true

POST/api/v1/defi/transaction/redeem

curl --request POST \
  --url https://web3.binance.com/build/api/v1/defi/transaction/redeem \
  --header 'Content-Type: application/json' \
  --header 'X-OC-APIKEY: <string>' \
  --header 'X-OC-SIGN: <string>' \
  --header 'X-OC-TIMESTAMP: <string>' \
  --data '
{
  "address": "0x1234567890123456789012345678901234567890",
  "investmentId": "10ab3e25d9f0b72f1f912b5d611f825bec495a74f2e1b25d8bba5fd2e56fb283"
}
'

Example Request Body

{
  "address": "0x1234567890123456789012345678901234567890",
  "investmentId": "10ab3e25d9f0b72f1f912b5d611f825bec495a74f2e1b25d8bba5fd2e56fb283"
}

json

Example Responses

{
  "code": 0,
  "msg": "success",
  "data": {
    "dataList": [
      {
        "callDataType": "REDEEM",
        "from": "0x1234567890123456789012345678901234567890",
        "to": "0x87870Bca3F3fF67225794148012b73643B78Ed36",
        "value": "0x0",
        "data": "0x1a3204a30000000000000000000000000000000000000000000000000000000000000001",
        "gasLimit": "180000",
        "gasPrice": null,
        "maxPriorityFeePerGas": "1000000000",
        "maxFeePerGas": "3000000000"
      }
    ],
    "redeemDelayDays": [
      "7",
      "10"
    ],
    "preview": {
      "success": true,
      "balanceChange": [
        {
          "tokenType": "TOKEN",
          "tokenSymbol": "aBUSD",
          "tokenAddress": "0x6d8981847eb3cc2234179d0f0e72f6be6e0950a4",
          "tokenDecimals": "18",
          "amount": "999.99",
          "valueUsd": "999.99"
        }
      ],
      "feeAndContract": {
        "estimatedNetworkFee": {
          "amount": "0.000003056787",
          "tokenSymbol": "BNB",
          "valueUsd": "0.002002",
          "rentFeeAmount": null,
          "rentFeeValueUsd": null,
          "priorityFeeAmount": null
        },
        "interactWith": {
          "address": "0x87870Bca3F3fF67225794148012b73643B78Ed36"
        }
      },
      "healthFactor": {
        "before": "1.85",
        "after": "1.35"
      },
      "warnings": [
        {
          "code": "HEALTH_FACTOR_WARNING",
          "level": "WARN",
          "message": "Health factor will drop from 1.85 to 1.35 after this transaction."
        }
      ]
    }
  },
  "timestamp": 1748601600000,
  "success": true
}

json

application/json

Build LP Add Transaction

Build the unsigned transaction calldata for adding liquidity. tokenList supports multiple tokens. Returns an ordered dataList (typically [APPROVE, LP_ADD]). Tick range source (provide exactly one group):

nftId — append to an existing LP position (reuses its range).
priceRange — percentage band (e.g. "5" = ±5%) for a new position.
tickLower + tickUpper — explicit raw int24 pair for a new position. Rules:

If more than one group is supplied, only the highest-priority one above is used and the others are silently ignored (priority: nftId > priceRange > explicit tick pair).
If none is supplied, the request is rejected (40453).
tickLower / tickUpper are raw int24 values and MUST be aligned to the pool's tickSpacing, otherwise the request is rejected (40453).
The caller does NOT pass binanceChainId — resolved from investmentId.

POST

/api/v1/defi/transaction/lp-add

https://web3.binance.com/build

Build LP Add Transaction › 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.

Build LP Add Transaction › 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

Build LP Add Transaction › Request Body

address

string · required

User wallet address (the signer / sender).

Example: 0x1234567890123456789012345678901234567890

investmentId

string · required

LP investment product ID (chain-agnostic).

Example: 6a3522eee3f2fc4fa9cc1273603429ba95ebd9ff4d33fad8a14d39b9a0a6ce3a

object[] · required

Tokens to supply. Two tokens for a standard LP add.

Example: [{"tokenAddress":"0x55d398326f99059fF775485246999027B3197955","amount":"10"},{"tokenAddress":"0xf1686b0b45114bcec963b139344a54cefae09a58","amount":"20"}]

tokenAddress

string · required

Token contract address; the native-asset sentinel for the native coin.

Example: 0x55d398326f99059fF775485246999027B3197955

amount

string · required

Human-readable amount as a decimal string, e.g. "1.5", "100".

Example: 100

tickLower

string

Lower tick bound (raw int24) for a new position. MUST be aligned to the pool's tickSpacing. Pick exactly one tick-range source: tickLower+tickUpper, priceRange, or nftId (to append to an existing position). If several are supplied, the lowest-priority ones are ignored (priority: nftId > priceRange > explicit tick pair).

Example: -100

tickUpper

string

Upper tick bound (raw int24) for a new position. MUST be aligned to the pool's tickSpacing. See tickLower for the pick-exactly-one rule.

Example: 100

priceRange

string

Price range as a percentage (e.g. "5" = ±5%) for a new position. Alternative to tickLower+tickUpper; see tickLower for the pick-exactly-one rule.

Example: 5

nftId

string

LP NFT token ID, decimal string (e.g. "7225901" or "#7225901"). Required when appending to an existing position (reuses its range); omit for a new position. Highest-priority tick-range source — see tickLower for the pick-exactly-one rule. The # prefix returned by the position list may be passed as-is — the service strips it automatically.

Example: 123456

slippageBps

string

Slippage tolerance for the LP leg, in basis points (e.g. 300 = 3%).

Example: 300

simulate

boolean

Example: true

Build LP Add Transaction › Responses

LP add transaction calldata returned successfully.

code

integer · int32

Business status code. 0 indicates success.

Example: 0

msg

string

Human-readable status message.

Example: success

object

object[]

Ordered unsigned transactions; APPROVE precedes the main action.

callDataType

string · enum

Action kind of this item:

APPROVE — ERC-20 approval (EVM only), must be signed/broadcast and confirmed before the main action. Never returned for Solana.
DEPOSIT / REDEEM / LP_ADD / LP_REMOVE / CLAIM — the main action. LP_ADD / LP_REMOVE are the LP add / remove legs (the same build path as deposit / redeem for liquidity-pool investments; the kind reflects the on-chain action, not the entry endpoint).

Enum values:

APPROVE

DEPOSIT

REDEEM

LP_ADD

LP_REMOVE

CLAIM

Example: DEPOSIT

from

string

Example: 0x1234567890123456789012345678901234567890

to

string | null

Example: 0x87870Bca3F3fF67225794148012b73643B78Ed36

value

string | null

Native-asset value as a 0x-prefixed hex string. Non-null on EVM; null on Solana.

Example: 0x0

data

string

Serialized transaction data. On EVM chains a 0x-prefixed hex calldata string. On Solana a base64-serialized wire transaction (compute-budget fee injected server-side for every action).

Example: 0xa9059cbb…

gasLimit

string | null

Example: 200000

gasPrice

string | null

Example: 3000000000

maxPriorityFeePerGas

string | null

EIP-1559 priority fee in wei (decimal string). null on non-1559 EVM chains and on Solana.

Example: 1000000000

maxFeePerGas

string | null

EIP-1559 max fee per gas in wei (decimal string). null on non-1559 EVM chains and on Solana.

Example: 3000000000

object

success

boolean

Whether the simulated transaction is expected to succeed on-chain.

Example: true

object[]

tokenType

string

Token role / type tag from the simulation.

Example: TOKEN

tokenSymbol

string

Token symbol.

Example: USDT

tokenAddress

string

Token contract address.

Example: 0xdac17f958d2ee523a2206206994597c13d831ec7

tokenDecimals

string

Token decimals.

Example: 18

amount

string

Signed delta (positive = received, negative = spent).

Example: -1000

valueUsd

string

USD value of the delta.

Example: 1000.00

tokenId

string

Optional NFT / position token ID when applicable.

Example: 123456

object

Estimated network fee and the contract the action interacts with. Contains estimatedNetworkFee and interactWith.

Estimated network fee and the contract the action interacts with. Contains `estimatedNetworkFee` and `interactWith`.

object

Estimated gas cost for the action. Fields may be null when estimation is not available (e.g. a failed simulation).

Estimated gas cost for the action. Fields may be `null` when estimation is not available (e.g. a failed simulation).

amount

string | null

Estimated gas fee in the fee-paying native coin (human-readable). On Solana this may be null even when fee estimation succeeded — use valueUsd as the reliable figure when amount is absent.

Example: 0.000003056787

tokenSymbol

string

Symbol of the fee-paying token (native coin, e.g. BNB).

Example: BNB

valueUsd

string | null

USD value of the estimated fee.

Example: 0.002002

rentFeeAmount

string | null

Solana storage / rent fee portion (human-readable). null on EVM chains; only populated on Solana when the action creates an account (e.g. a first-time ATA).

Example: null

rentFeeValueUsd

string | null

USD value of the Solana rent fee. null on EVM chains; Solana-only.

Example: null

priorityFeeAmount

string | null

Solana priority fee portion (human-readable). null on EVM chains; Solana-only.

Example: null

object

The contract the action interacts with.

address

string

Target contract address.

Example: 0xae05cd22df81871bc7cc2a04becfb516bfe332c8

object

Lending health-factor change. Contains before / after values for lending protocols (e.g. Aave / Venus); null for non-lending protocols or when health factor is unavailable.

Example: {"before":"1.85","after":"1.35"}

Lending health-factor change. Contains `before` / `after` values for lending protocols (e.g. Aave / Venus); `null` for non-lending protocols or when health factor is unavailable.

before

string | null

Health factor before this transaction. Null when unavailable.

Example: 1.85

after

string | null

Health factor after this transaction. Null when unavailable.

Example: 1.35

object[]

Non-blocking risk warnings. Empty array when there are no warnings.

A single non-blocking risk warning.

code

string

Warning code. Known values: HEALTH_FACTOR_WARNING, HEALTH_FACTOR_DANGER, HIGH_SLIPPAGE, DELAYED_REDEMPTION, LP_OUT_OF_RANGE. Branch on code for control flow; display message as-is.

Example: HEALTH_FACTOR_WARNING

level

string

Severity level — INFO / WARN / DANGER.

Example: WARN

message

string

Human-readable warning text.

Example: Health factor will drop below 1.5 after this transaction.

errorMessage

string

Error message when the simulated transaction is expected to fail.

Example: insufficient balance

redeemDelayDays

string[]

Example: ["7","10"]

timestamp

integer · int64

Server timestamp in milliseconds.

Example: 1748601600000

success

boolean

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

Example: true

POST/api/v1/defi/transaction/lp-add

curl --request POST \
  --url https://web3.binance.com/build/api/v1/defi/transaction/lp-add \
  --header 'Content-Type: application/json' \
  --header 'X-OC-APIKEY: <string>' \
  --header 'X-OC-SIGN: <string>' \
  --header 'X-OC-TIMESTAMP: <string>' \
  --data '
{
  "address": "0x1234567890123456789012345678901234567890",
  "investmentId": "6a3522eee3f2fc4fa9cc1273603429ba95ebd9ff4d33fad8a14d39b9a0a6ce3a",
  "tokenList": [
    {
      "tokenAddress": "0x55d398326f99059fF775485246999027B3197955",
      "amount": "10"
    },
    {
      "tokenAddress": "0xf1686b0b45114bcec963b139344a54cefae09a58",
      "amount": "20"
    }
  ]
}
'

Example Request Body

{
  "address": "0x1234567890123456789012345678901234567890",
  "investmentId": "6a3522eee3f2fc4fa9cc1273603429ba95ebd9ff4d33fad8a14d39b9a0a6ce3a",
  "tokenList": [
    {
      "tokenAddress": "0x55d398326f99059fF775485246999027B3197955",
      "amount": "10"
    },
    {
      "tokenAddress": "0xf1686b0b45114bcec963b139344a54cefae09a58",
      "amount": "20"
    }
  ]
}

json

Example Responses

{
  "code": 0,
  "msg": "success",
  "data": {
    "dataList": [
      {
        "callDataType": "APPROVE",
        "from": "0x1234567890123456789012345678901234567890",
        "to": "0x55d398326f99059fF775485246999027B3197955",
        "value": "0x0",
        "data": "0x095ea7b30000000000000000000000003662d86220be5bea975be9fd8ab3d6b5d4fb4163000000000000000000000000000000000000000000000000000000000000ffff",
        "gasLimit": "50000",
        "gasPrice": null,
        "maxPriorityFeePerGas": "1000000000",
        "maxFeePerGas": "3000000000"
      },
      {
        "callDataType": "LP_ADD",
        "from": "0x1234567890123456789012345678901234567890",
        "to": "0x3662d86220BE5BEA975BE9Fd8aB3d6b5D4FB4163",
        "value": "0x0",
        "data": "0x88cc36350000000000000000000000000000000000000000000000000000000000000064",
        "gasLimit": "250000",
        "gasPrice": null,
        "maxPriorityFeePerGas": "1000000000",
        "maxFeePerGas": "3000000000"
      }
    ],
    "preview": {
      "success": true,
      "balanceChange": [
        {
          "tokenType": "TOKEN",
          "tokenSymbol": "USDT",
          "tokenAddress": "0x55d398326f99059fF775485246999027B3197955",
          "tokenDecimals": "18",
          "amount": "-1.5",
          "valueUsd": "450.00"
        },
        {
          "tokenType": "TOKEN",
          "tokenSymbol": "BUSD",
          "tokenAddress": "0x4eCbB006EdcB9B984c0D4b5c6Fd1d5C1f12f9dE9",
          "tokenDecimals": "18",
          "amount": "-451.5",
          "valueUsd": "451.50"
        },
        {
          "tokenType": "NFT",
          "tokenSymbol": null,
          "tokenAddress": "0x3662d86220BE5BEA975BE9Fd8aB3d6b5D4FB4163",
          "tokenDecimals": null,
          "amount": "1",
          "valueUsd": null,
          "tokenId": "123456"
        }
      ],
      "feeAndContract": {
        "estimatedNetworkFee": {
          "amount": "0.000004120834",
          "tokenSymbol": "BNB",
          "valueUsd": "0.002701",
          "rentFeeAmount": null,
          "rentFeeValueUsd": null,
          "priorityFeeAmount": null
        },
        "interactWith": {
          "address": "0x3662d86220BE5BEA975BE9Fd8aB3d6b5D4FB4163"
        }
      },
      "healthFactor": null,
      "warnings": []
    }
  },
  "timestamp": 1748601600000,
  "success": true
}

json

application/json

Calculate LP Add Paired Amounts

Given a single input token, calculate the paired token amount needed for an LP add. This is a pure computation endpoint — it does not touch the chain and does not deduct any fee. Use it before /transaction/lp-add to size the paired token when only one side is supplied. Tick range source rules are the same as /lp-add — provide exactly one group: nftId (existing position), priceRange, or tickLower+tickUpper.

If more than one group is supplied, only the highest-priority one is used and the others are silently ignored (priority: nftId > priceRange > explicit tick pair).
If none is supplied, the request is rejected.
The caller does NOT pass binanceChainId — resolved from investmentId.

POST

/api/v1/defi/transaction/lp-add/calculate

https://web3.binance.com/build

Calculate LP Add Paired Amounts › 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.

Calculate LP Add Paired Amounts › 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

Calculate LP Add Paired Amounts › Request Body

address

string · required

User wallet address.

Example: 0x1234567890123456789012345678901234567890

investmentId

string · required

LP investment product ID (chain-agnostic).

Example: 6a3522eee3f2fc4fa9cc1273603429ba95ebd9ff4d33fad8a14d39b9a0a6ce3a

object · required

tokenAddress

string · required

Token contract address; the native-asset sentinel for the native coin.

Example: 0x55d398326f99059fF775485246999027B3197955

amount

string · required

Human-readable amount as a decimal string, e.g. "1.5", "100".

Example: 100

tickLower

string

Lower tick bound (raw int24), aligned to the pool's tickSpacing.

Example: -100

tickUpper

string

Upper tick bound (raw int24), aligned to the pool's tickSpacing.

Example: 100

priceRange

string

Price range as a percentage (e.g. "5" = ±5%).

Example: 5

nftId

string

Required when calculating for an existing LP position.

Example: 123456

Calculate LP Add Paired Amounts › Responses

Paired token amounts returned successfully.

code

integer · int32

Business status code. 0 indicates success.

Example: 0

msg

string

Human-readable status message.

Example: success

object

Result of /transaction/lp-add/calculate. Returns the paired token amounts derived from the single input token. This endpoint is pure computation — it does not touch the chain and does not deduct any fee.

Result of `/transaction/lp-add/calculate`. Returns the paired token amounts derived from the single input token. This endpoint is pure computation — it does not touch the chain and does not deduct any fee.

inputTokenAmount

string

Echo of the input token amount (human-readable).

Example: 10

pairedTokenAddress

string

The paired token contract address derived from the investment.

Example: 0xf1686b0b45114bcec963b139344a54cefae09a58

pairedTokenAmount

string

Calculated paired token amount (human-readable).

Example: 20

timestamp

integer · int64

Server timestamp in milliseconds.

Example: 1748601600000

success

boolean

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

Example: true

POST/api/v1/defi/transaction/lp-add/calculate

curl --request POST \
  --url https://web3.binance.com/build/api/v1/defi/transaction/lp-add/calculate \
  --header 'Content-Type: application/json' \
  --header 'X-OC-APIKEY: <string>' \
  --header 'X-OC-SIGN: <string>' \
  --header 'X-OC-TIMESTAMP: <string>' \
  --data '
{
  "address": "0x1234567890123456789012345678901234567890",
  "investmentId": "6a3522eee3f2fc4fa9cc1273603429ba95ebd9ff4d33fad8a14d39b9a0a6ce3a",
  "inputToken": {
    "tokenAddress": "0x55d398326f99059fF775485246999027B3197955",
    "amount": "100"
  }
}
'

Example Request Body

{
  "address": "0x1234567890123456789012345678901234567890",
  "investmentId": "6a3522eee3f2fc4fa9cc1273603429ba95ebd9ff4d33fad8a14d39b9a0a6ce3a",
  "inputToken": {
    "tokenAddress": "0x55d398326f99059fF775485246999027B3197955",
    "amount": "100"
  }
}

json

Example Responses

{
  "code": 0,
  "msg": "success",
  "data": {
    "inputTokenAmount": "10",
    "pairedTokenAddress": "0xf1686b0b45114bcec963b139344a54cefae09a58",
    "pairedTokenAmount": "20"
  },
  "timestamp": 1748601600000,
  "success": true
}

json

application/json

Build LP Remove Transaction

Build the unsigned transaction calldata for removing liquidity. Removal is by nftId + ratio (range (0, 1]) — no tokenList is needed; the per-token amounts are derived from the on-chain position. Returns an ordered dataList (typically [LP_REMOVE]). slippageBps is the LP-leg slippage tolerance in basis points. The caller does NOT pass binanceChainId — resolved from investmentId.

POST

/api/v1/defi/transaction/lp-remove

https://web3.binance.com/build

Build LP Remove Transaction › 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.

Build LP Remove Transaction › 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

Build LP Remove Transaction › Request Body

address

string · required

User wallet address (the signer / sender).

Example: 0x1234567890123456789012345678901234567890

investmentId

string · required

LP investment product ID (chain-agnostic).

Example: 6a3522eee3f2fc4fa9cc1273603429ba95ebd9ff4d33fad8a14d39b9a0a6ce3a

nftId

string · required

LP NFT token ID identifying the position to remove, decimal string (e.g. "7225901" or "#7225901"). The # prefix returned by the position list may be passed as-is — the service strips it automatically.

Example: 123456

ratio

string · required

Removal ratio in the range (0, 1] as a decimal string (e.g. "0.04", "1").

Example: 1

slippageBps

string

Slippage tolerance for the LP leg, in basis points (e.g. 300 = 3%).

Example: 300

simulate

boolean

Example: true

Build LP Remove Transaction › Responses

LP remove transaction calldata returned successfully.

code

integer · int32

Business status code. 0 indicates success.

Example: 0

msg

string

Human-readable status message.

Example: success

object

object[]

Ordered unsigned transactions; APPROVE precedes the main action.

callDataType

string · enum

Action kind of this item:

APPROVE — ERC-20 approval (EVM only), must be signed/broadcast and confirmed before the main action. Never returned for Solana.
DEPOSIT / REDEEM / LP_ADD / LP_REMOVE / CLAIM — the main action. LP_ADD / LP_REMOVE are the LP add / remove legs (the same build path as deposit / redeem for liquidity-pool investments; the kind reflects the on-chain action, not the entry endpoint).

Enum values:

APPROVE

DEPOSIT

REDEEM

LP_ADD

LP_REMOVE

CLAIM

Example: DEPOSIT

from

string

Example: 0x1234567890123456789012345678901234567890

to

string | null

Example: 0x87870Bca3F3fF67225794148012b73643B78Ed36

value

string | null

Native-asset value as a 0x-prefixed hex string. Non-null on EVM; null on Solana.

Example: 0x0

data

string

Serialized transaction data. On EVM chains a 0x-prefixed hex calldata string. On Solana a base64-serialized wire transaction (compute-budget fee injected server-side for every action).

Example: 0xa9059cbb…

gasLimit

string | null

Example: 200000

gasPrice

string | null

Example: 3000000000

maxPriorityFeePerGas

string | null

EIP-1559 priority fee in wei (decimal string). null on non-1559 EVM chains and on Solana.

Example: 1000000000

maxFeePerGas

string | null

EIP-1559 max fee per gas in wei (decimal string). null on non-1559 EVM chains and on Solana.

Example: 3000000000

object

success

boolean

Whether the simulated transaction is expected to succeed on-chain.

Example: true

object[]

tokenType

string

Token role / type tag from the simulation.

Example: TOKEN

tokenSymbol

string

Token symbol.

Example: USDT

tokenAddress

string

Token contract address.

Example: 0xdac17f958d2ee523a2206206994597c13d831ec7

tokenDecimals

string

Token decimals.

Example: 18

amount

string

Signed delta (positive = received, negative = spent).

Example: -1000

valueUsd

string

USD value of the delta.

Example: 1000.00

tokenId

string

Optional NFT / position token ID when applicable.

Example: 123456

object

Estimated network fee and the contract the action interacts with. Contains estimatedNetworkFee and interactWith.

Estimated network fee and the contract the action interacts with. Contains `estimatedNetworkFee` and `interactWith`.

object

Estimated gas cost for the action. Fields may be null when estimation is not available (e.g. a failed simulation).

Estimated gas cost for the action. Fields may be `null` when estimation is not available (e.g. a failed simulation).

amount

string | null

Estimated gas fee in the fee-paying native coin (human-readable). On Solana this may be null even when fee estimation succeeded — use valueUsd as the reliable figure when amount is absent.

Example: 0.000003056787

tokenSymbol

string

Symbol of the fee-paying token (native coin, e.g. BNB).

Example: BNB

valueUsd

string | null

USD value of the estimated fee.

Example: 0.002002

rentFeeAmount

string | null

Solana storage / rent fee portion (human-readable). null on EVM chains; only populated on Solana when the action creates an account (e.g. a first-time ATA).

Example: null

rentFeeValueUsd

string | null

USD value of the Solana rent fee. null on EVM chains; Solana-only.

Example: null

priorityFeeAmount

string | null

Solana priority fee portion (human-readable). null on EVM chains; Solana-only.

Example: null

object

The contract the action interacts with.

address

string

Target contract address.

Example: 0xae05cd22df81871bc7cc2a04becfb516bfe332c8

object

Lending health-factor change. Contains before / after values for lending protocols (e.g. Aave / Venus); null for non-lending protocols or when health factor is unavailable.

Example: {"before":"1.85","after":"1.35"}

Lending health-factor change. Contains `before` / `after` values for lending protocols (e.g. Aave / Venus); `null` for non-lending protocols or when health factor is unavailable.

before

string | null

Health factor before this transaction. Null when unavailable.

Example: 1.85

after

string | null

Health factor after this transaction. Null when unavailable.

Example: 1.35

object[]

Non-blocking risk warnings. Empty array when there are no warnings.

A single non-blocking risk warning.

code

string

Warning code. Known values: HEALTH_FACTOR_WARNING, HEALTH_FACTOR_DANGER, HIGH_SLIPPAGE, DELAYED_REDEMPTION, LP_OUT_OF_RANGE. Branch on code for control flow; display message as-is.

Example: HEALTH_FACTOR_WARNING

level

string

Severity level — INFO / WARN / DANGER.

Example: WARN

message

string

Human-readable warning text.

Example: Health factor will drop below 1.5 after this transaction.

errorMessage

string

Error message when the simulated transaction is expected to fail.

Example: insufficient balance

redeemDelayDays

string[]

Example: ["7","10"]

timestamp

integer · int64

Server timestamp in milliseconds.

Example: 1748601600000

success

boolean

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

Example: true

POST/api/v1/defi/transaction/lp-remove

curl --request POST \
  --url https://web3.binance.com/build/api/v1/defi/transaction/lp-remove \
  --header 'Content-Type: application/json' \
  --header 'X-OC-APIKEY: <string>' \
  --header 'X-OC-SIGN: <string>' \
  --header 'X-OC-TIMESTAMP: <string>' \
  --data '
{
  "address": "0x1234567890123456789012345678901234567890",
  "investmentId": "6a3522eee3f2fc4fa9cc1273603429ba95ebd9ff4d33fad8a14d39b9a0a6ce3a",
  "nftId": "123456",
  "ratio": "1"
}
'

Example Request Body

{
  "address": "0x1234567890123456789012345678901234567890",
  "investmentId": "6a3522eee3f2fc4fa9cc1273603429ba95ebd9ff4d33fad8a14d39b9a0a6ce3a",
  "nftId": "123456",
  "ratio": "1"
}

json

Example Responses

{
  "code": 0,
  "msg": "success",
  "data": {
    "dataList": [
      {
        "callDataType": "LP_REMOVE",
        "from": "0x1234567890123456789012345678901234567890",
        "to": "0x3662d86220BE5BEA975BE9Fd8aB3d6b5D4FB4163",
        "value": "0x0",
        "data": "0x96145dd60000000000000000000000000000000000000000000000000000000000000001",
        "gasLimit": "200000",
        "gasPrice": null,
        "maxPriorityFeePerGas": "1000000000",
        "maxFeePerGas": "3000000000"
      }
    ],
    "preview": {
      "success": true,
      "balanceChange": [
        {
          "tokenType": "TOKEN",
          "tokenSymbol": "USDT",
          "tokenAddress": "0x55d398326f99059fF775485246999027B3197955",
          "tokenDecimals": "18",
          "amount": "1.5",
          "valueUsd": "450.00"
        },
        {
          "tokenType": "TOKEN",
          "tokenSymbol": "BUSD",
          "tokenAddress": "0x4eCbB006EdcB9B984c0D4b5c6Fd1d5C1f12f9dE9",
          "tokenDecimals": "18",
          "amount": "451.5",
          "valueUsd": "451.50"
        },
        {
          "tokenType": "NFT",
          "tokenSymbol": null,
          "tokenAddress": "0x3662d86220BE5BEA975BE9Fd8aB3d6b5D4FB4163",
          "tokenDecimals": null,
          "amount": "-1",
          "valueUsd": null,
          "tokenId": "123456"
        }
      ],
      "feeAndContract": {
        "estimatedNetworkFee": {
          "amount": "0.000002884733",
          "tokenSymbol": "BNB",
          "valueUsd": "0.001891",
          "rentFeeAmount": null,
          "rentFeeValueUsd": null,
          "priorityFeeAmount": null
        },
        "interactWith": {
          "address": "0x3662d86220BE5BEA975BE9Fd8aB3d6b5D4FB4163"
        }
      },
      "healthFactor": null,
      "warnings": []
    }
  },
  "timestamp": 1748601600000,
  "success": true
}

json

application/json

Build DeFi Claim Transaction

Build the unsigned claim calldata for one of four claim types — see DefiClaimType for which companion fields each type requires and which protocol constraints apply (e.g. REWARD_PROTOCOL is not supported for LP protocols; PancakeSwap V3 farming uses LP_FEE, not REWARD_INVESTMENT). Returns an ordered dataList (typically [CLAIM]). binanceChainId resolution rules:

Normally resolved from investmentId; the call always executes on that chain.
For claim types other than REWARD_PROTOCOL, any client-supplied binanceChainId is silently ignored — passing a different chainId will not redirect the claim.
Exception: REWARD_PROTOCOL with no investmentId — the client MUST pass binanceChainId (it is the only chain signal).

tokenAddressList optionally narrows the claim scope. Set simulate=true to also receive preview.

POST

/api/v1/defi/transaction/claim

https://web3.binance.com/build

Build DeFi Claim Transaction › 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.

Build DeFi Claim Transaction › 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

Build DeFi Claim Transaction › Request Body

address

string · required

User wallet address (the signer / sender).

Example: 0x1234567890123456789012345678901234567890

claimType

string · enum · required

Claim routing type. Determines which companion fields are required:

REWARD_PROTOCOL: protocol-level rewards (e.g. Aave incentive, Radiant) — requires defiProtocolId + binanceChainId
REWARD_INVESTMENT: per-investment rewards — requires investmentId
LP_FEE: Uniswap V3/V4 LP fees — requires investmentId + nftId
REDEMPTION: redeem principal. Requires investmentId + redemptionId for EVM protocols (Lista, Aster, Solv) and for Solana protocols whose redeem mints a withdrawal ticket (renzo, marinadefinance liquid, jito, solayer, fragmetric, jupiter Stake JUP) — the redemptionId comes from the position list and is populated once the cooldown ends (unlockTimeReached = true). For Solana native staking (sol_staking) and Jupiter jupSOL (whose claim handle surfaces under sol_staking), substitute stakeAccounts for redemptionId (no redemption record).

Protocol constraints — not every claimType is valid for every protocol; an invalid combination is rejected (40453 or 40454):

REWARD_PROTOCOL is not supported for LP (liquidity-pool) protocols in this release.
REWARD_INVESTMENT is not supported for PancakeSwap V3 farming positions; use LP_FEE to claim farming incentives there.
LP_FEE applies only to concentrated-liquidity (V3/V4) LP positions, including Solana CLMM (raydium3, orca3).
REDEMPTION applies only to protocols with a redemption / lock-up flow: EVM Lista / Aster / Solv, and on Solana sol_staking, renzo, marinadefinance, jito, solayer, fragmetric, and jupiter stake surfaces.
Some Solana protocols auto-compound rewards into the position value (e.g. sol_staking, marinadefinance, jito); their claimReward (REWARD_PROTOCOL / REWARD_INVESTMENT) is not supported and is rejected with 40481.

For a given position, prefer the claimTypes / redemptionId / userStakeAccount fields returned by the position list to decide the claim path — see Integration Flow.

Enum values:

REWARD_PROTOCOL

REWARD_INVESTMENT

LP_FEE

REDEMPTION

Example: LP_FEE

binanceChainId

string

Binance chain ID. For REWARD_PROTOCOL (which does not use investmentId) this is the only chain signal and is required. For all other claim types the chain is resolved from investmentId and any client-supplied value is silently ignored — the call still executes on the investmentId chain, so a different chainId does not redirect the claim.

Example: 56

investmentId

string

Required for REWARD_INVESTMENT, LP_FEE, and REDEMPTION. Not used for REWARD_PROTOCOL (which keys off defiProtocolId).

Example: 6a3522eee3f2fc4fa9cc1273603429ba95ebd9ff4d33fad8a14d39b9a0a6ce3a

defiProtocolId

string

Required for REWARD_PROTOCOL (e.g. pancakeswap3).

Example: pancakeswap3

nftId

string

Required for LP_FEE. The NFT token ID as a decimal string (e.g. "7225901" or "#7225901"). The # prefix returned by the position list may be passed as-is — the service strips it automatically.

Example: 123456

redemptionId

string

Required for REDEMPTION on EVM and on the Solana protocols whose redeem mints a withdrawal ticket / record (renzo, marinadefinance liquid, jito, solayer, fragmetric, jupiter Stake JUP). Maps to the redemptionId returned in the position list (the on-line position index), and is only populated once the cooldown ends (unlockTimeReached = true; null while cooling down). For Solana native staking (sol_staking) and Jupiter jupSOL (jupiter stake surfaces) under REDEMPTION, pass stakeAccounts instead — these have no redemption record, so redemptionId becomes optional when stakeAccounts is supplied.

Example: test-redemption-1

stakeAccounts

array | null

Base58 stake account address(es) — the account(s) to withdraw after the deactivation cooldown. Required for REDEMPTION on Solana native staking (sol_staking) and Jupiter jupSOL (claimed under sol_staking in the position list; pass the sol_staking or the jupSOL investmentId + this address). Makes redemptionId optional for these (no redemption record). Do not pass stakeAccounts for Stake JUP (jupiter stake_jup) — it uses redemptionId, and passing stakeAccounts builds a transaction that fails on-chain. Passing stakeAccounts for any other protocol (EVM, LP, or other Solana protocols whose redeem produces a ticket — those use redemptionId) is also a parameter error. This release supports exactly one element (length at most 1).

Example: ["5vUt9pxBK9KaaHm19okrwSuP2vUU71Nm7ScsBiSqsW1s"]

tokenAddressList

string[]

Optional token address filter to narrow the claim scope.

Example: ["0x55d398326f99059fF775485246999027B3197955"]

simulate

boolean

Example: true

Build DeFi Claim Transaction › Responses

Claim transaction calldata returned successfully.

code

integer · int32

Business status code. 0 indicates success.

Example: 0

msg

string

Human-readable status message.

Example: success

object

object[]

Ordered unsigned transactions; APPROVE precedes the main action.

callDataType

string · enum

Action kind of this item:

APPROVE — ERC-20 approval (EVM only), must be signed/broadcast and confirmed before the main action. Never returned for Solana.
DEPOSIT / REDEEM / LP_ADD / LP_REMOVE / CLAIM — the main action. LP_ADD / LP_REMOVE are the LP add / remove legs (the same build path as deposit / redeem for liquidity-pool investments; the kind reflects the on-chain action, not the entry endpoint).

Enum values:

APPROVE

DEPOSIT

REDEEM

LP_ADD

LP_REMOVE

CLAIM

Example: DEPOSIT

from

string

Example: 0x1234567890123456789012345678901234567890

to

string | null

Example: 0x87870Bca3F3fF67225794148012b73643B78Ed36

value

string | null

Native-asset value as a 0x-prefixed hex string. Non-null on EVM; null on Solana.

Example: 0x0

data

string

Serialized transaction data. On EVM chains a 0x-prefixed hex calldata string. On Solana a base64-serialized wire transaction (compute-budget fee injected server-side for every action).

Example: 0xa9059cbb…

gasLimit

string | null

Example: 200000

gasPrice

string | null

Example: 3000000000

maxPriorityFeePerGas

string | null

EIP-1559 priority fee in wei (decimal string). null on non-1559 EVM chains and on Solana.

Example: 1000000000

maxFeePerGas

string | null

EIP-1559 max fee per gas in wei (decimal string). null on non-1559 EVM chains and on Solana.

Example: 3000000000

object

success

boolean

Whether the simulated transaction is expected to succeed on-chain.

Example: true

object[]

tokenType

string

Token role / type tag from the simulation.

Example: TOKEN

tokenSymbol

string

Token symbol.

Example: USDT

tokenAddress

string

Token contract address.

Example: 0xdac17f958d2ee523a2206206994597c13d831ec7

tokenDecimals

string

Token decimals.

Example: 18

amount

string

Signed delta (positive = received, negative = spent).

Example: -1000

valueUsd

string

USD value of the delta.

Example: 1000.00

tokenId

string

Optional NFT / position token ID when applicable.

Example: 123456

object

Estimated network fee and the contract the action interacts with. Contains estimatedNetworkFee and interactWith.

Estimated network fee and the contract the action interacts with. Contains `estimatedNetworkFee` and `interactWith`.

object

Estimated gas cost for the action. Fields may be null when estimation is not available (e.g. a failed simulation).

Estimated gas cost for the action. Fields may be `null` when estimation is not available (e.g. a failed simulation).

amount

string | null

Estimated gas fee in the fee-paying native coin (human-readable). On Solana this may be null even when fee estimation succeeded — use valueUsd as the reliable figure when amount is absent.

Example: 0.000003056787

tokenSymbol

string

Symbol of the fee-paying token (native coin, e.g. BNB).

Example: BNB

valueUsd

string | null

USD value of the estimated fee.

Example: 0.002002

rentFeeAmount

string | null

Solana storage / rent fee portion (human-readable). null on EVM chains; only populated on Solana when the action creates an account (e.g. a first-time ATA).

Example: null

rentFeeValueUsd

string | null

USD value of the Solana rent fee. null on EVM chains; Solana-only.

Example: null

priorityFeeAmount

string | null

Solana priority fee portion (human-readable). null on EVM chains; Solana-only.

Example: null

object

The contract the action interacts with.

address

string

Target contract address.

Example: 0xae05cd22df81871bc7cc2a04becfb516bfe332c8

object

Lending health-factor change. Contains before / after values for lending protocols (e.g. Aave / Venus); null for non-lending protocols or when health factor is unavailable.

Example: {"before":"1.85","after":"1.35"}

Lending health-factor change. Contains `before` / `after` values for lending protocols (e.g. Aave / Venus); `null` for non-lending protocols or when health factor is unavailable.

before

string | null

Health factor before this transaction. Null when unavailable.

Example: 1.85

after

string | null

Health factor after this transaction. Null when unavailable.

Example: 1.35

object[]

Non-blocking risk warnings. Empty array when there are no warnings.

A single non-blocking risk warning.

code

string

Warning code. Known values: HEALTH_FACTOR_WARNING, HEALTH_FACTOR_DANGER, HIGH_SLIPPAGE, DELAYED_REDEMPTION, LP_OUT_OF_RANGE. Branch on code for control flow; display message as-is.

Example: HEALTH_FACTOR_WARNING

level

string

Severity level — INFO / WARN / DANGER.

Example: WARN

message

string

Human-readable warning text.

Example: Health factor will drop below 1.5 after this transaction.

errorMessage

string

Error message when the simulated transaction is expected to fail.

Example: insufficient balance

redeemDelayDays

string[]

Example: ["7","10"]

timestamp

integer · int64

Server timestamp in milliseconds.

Example: 1748601600000

success

boolean

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

Example: true

POST/api/v1/defi/transaction/claim

curl --request POST \
  --url https://web3.binance.com/build/api/v1/defi/transaction/claim \
  --header 'Content-Type: application/json' \
  --header 'X-OC-APIKEY: <string>' \
  --header 'X-OC-SIGN: <string>' \
  --header 'X-OC-TIMESTAMP: <string>' \
  --data '
{
  "address": "0x1234567890123456789012345678901234567890",
  "claimType": "LP_FEE"
}
'

Example Request Body

{
  "address": "0x1234567890123456789012345678901234567890",
  "claimType": "LP_FEE"
}

json

Example Responses

{
  "code": 0,
  "msg": "success",
  "data": {
    "dataList": [
      {
        "callDataType": "CLAIM",
        "from": "0x1234567890123456789012345678901234567890",
        "to": "0x87870Bca3F3fF67225794148012b73643B78Ed36",
        "value": "0x0",
        "data": "0x4e71d9230000000000000000000000000000000000000000000000000000000000000002",
        "gasLimit": "150000",
        "gasPrice": null,
        "maxPriorityFeePerGas": "1000000000",
        "maxFeePerGas": "3000000000"
      }
    ],
    "preview": {
      "success": true,
      "balanceChange": [
        {
          "tokenType": "TOKEN",
          "tokenSymbol": "CAKE",
          "tokenAddress": "0x0E09FaBB73Bd3Ade0a17ECC321fD13a19e81cE82",
          "tokenDecimals": "18",
          "amount": "12.5",
          "valueUsd": "37.50"
        }
      ],
      "feeAndContract": {
        "estimatedNetworkFee": {
          "amount": "0.000002431077",
          "tokenSymbol": "BNB",
          "valueUsd": "0.001594",
          "rentFeeAmount": null,
          "rentFeeValueUsd": null,
          "priorityFeeAmount": null
        },
        "interactWith": {
          "address": "0x87870Bca3F3fF67225794148012b73643B78Ed36"
        }
      },
      "healthFactor": null,
      "warnings": []
    }
  },
  "timestamp": 1748601600000,
  "success": true
}

json

application/json