Binance Web3 Connector JS
    Preparing search index...

    Interface BuildSwapTransactionRequest

    Request parameters for buildSwapTransaction operation in TradingApi. BuildSwapTransactionRequest

    interface BuildSwapTransactionRequest {
        amount: string;
        approveAmount?: string;
        approveTransaction?: BuildSwapTransactionApproveTransactionEnum;
        autoSlippage?: BuildSwapTransactionAutoSlippageEnum;
        binanceChainId: string;
        computeUnitLimit?: string;
        computeUnitPrice?: string;
        fromTokenAddress: string;
        gasLevel?: BuildSwapTransactionGasLevelEnum;
        gasLimit?: string;
        maxAutoSlippagePercent?: string;
        nonce?: string;
        priceImpactProtectionPercent?: string;
        quoteId: string;
        recvWindow?: number | bigint;
        slippagePercent?: string;
        tips?: string;
        toTokenAddress: string;
        userWalletAddress: string;
    }
    Index

    Properties

    amount approveAmount? approveTransaction? autoSlippage? binanceChainId computeUnitLimit? computeUnitPrice? fromTokenAddress gasLevel? gasLimit? maxAutoSlippagePercent? nonce? priceImpactProtectionPercent? quoteId recvWindow? slippagePercent? tips? toTokenAddress userWalletAddress

    Properties

    amount: string

    Sell-token amount in the token's smallest unit (positive integer string, no decimals).

    TradingApiBuildSwapTransaction

    approveAmount?: string

    Override approve amount (smallest unit, positive integer string). Defaults to the swap amount.

    TradingApiBuildSwapTransaction

    approveTransaction?: BuildSwapTransactionApproveTransactionEnum

    When "true", signatureData includes the spender address and approve calldata so the client can submit it before the swap. Defaults to false.

    TradingApiBuildSwapTransaction

    autoSlippage?: BuildSwapTransactionAutoSlippageEnum

    When "true", slippage is auto-derived from market data and overrides slippagePercent. Either slippagePercent or autoSlippage=true must be provided — omitting both returns a parameter error. Defaults to "false".

    TradingApiBuildSwapTransaction

    binanceChainId: string

    Unique chain identifier (e.g. "56"=BSC, "1"=Ethereum, "CT_501"=Solana).

    TradingApiBuildSwapTransaction

    computeUnitLimit?: string

    Solana only — maximum compute units the transaction may consume (analogous to EVM gasLimit). Applies only when binanceChainId=CT_501.

    TradingApiBuildSwapTransaction

    computeUnitPrice?: string

    Solana only — priority fee per compute unit (micro-lamports), analogous to EVM gasPrice. When omitted, the platform computes a value dynamically. Applies only when binanceChainId=CT_501.

    TradingApiBuildSwapTransaction

    fromTokenAddress: string

    Sell-token contract address.

    TradingApiBuildSwapTransaction

    gasLevel?: BuildSwapTransactionGasLevelEnum

    Gas price tier. Defaults to "average".

    TradingApiBuildSwapTransaction

    gasLimit?: string

    Gas limit override (positive integer string). EVM only.

    TradingApiBuildSwapTransaction

    maxAutoSlippagePercent?: string

    Cap on auto-derived slippage (only applies when autoSlippage=true).

    TradingApiBuildSwapTransaction

    nonce?: string

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

    TradingApiBuildSwapTransaction

    priceImpactProtectionPercent?: string

    Maximum allowed price impact percentage (0–100). Defaults to 90; set to 100 to disable.

    TradingApiBuildSwapTransaction

    quoteId: string

    quoteId returned from /quote for the route to execute. TTL ~30s; expired entries return QUOTE_EXPIRED (40401).

    TradingApiBuildSwapTransaction

    recvWindow?: number | bigint

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

    TradingApiBuildSwapTransaction

    slippagePercent?: string

    Maximum slippage tolerance as a percentage string. Required unless autoSlippage=true.

    Range by chain:*

    • EVM chains (BSC, Ethereum, Base, etc.): 0 to 100 (inclusive)
    • Solana (CT_501): 0 to less than 100 (i.e. < 100)

    Range by vendor:*

    • 1inch, PancakeSwap: 0 to 50 (values above 50 are rejected)
    • LiFi, LiquidMesh: 0 to 100 (EVM) or 0 to < 100 (Solana)
    • Jupiter (Solana): 0 to less than 100; the value is converted to basis points (slippageBps = ceil(slippagePercent × 100)) and applied to the on-chain swap

    "0.5" means 0.5% maximum slippage. When autoSlippage=true this field is overridden by the auto-computed value.

    TradingApiBuildSwapTransaction

    tips?: string

    Solana only — Jito tips in SOL for MEV protection. Valid range [0.000000001, 2] (minimum 1 lamport). When specified, it is recommended to set computeUnitPrice=0. Applies only when binanceChainId=CT_501.

    TradingApiBuildSwapTransaction

    toTokenAddress: string

    Buy-token contract address.

    TradingApiBuildSwapTransaction

    userWalletAddress: string

    User wallet address (transaction sender).

    TradingApiBuildSwapTransaction

    Settings

    Member Visibility

    On This Page

    Properties