Binance Web3 Connector JS
    Preparing search index...

    Interface GetAggregatedQuoteRequest

    Request parameters for getAggregatedQuote operation in TradingApi. GetAggregatedQuoteRequest

    interface GetAggregatedQuoteRequest {
        amount: string;
        binanceChainId: string;
        feePercent?: string;
        feeSource?: GetAggregatedQuoteFeeSourceEnum;
        fromTokenAddress: string;
        nonce?: string;
        recvWindow?: number | bigint;
        toTokenAddress: string;
        userWalletAddress?: string;
        vendor?: GetAggregatedQuoteVendorEnum;
    }
    Index
    amount binanceChainId feePercent? feeSource? fromTokenAddress nonce? recvWindow? toTokenAddress userWalletAddress? vendor?
    amount: string

    Sell-token amount in the token's smallest unit (positive integer string, no decimals). Example "1000000" = 1 USDT (decimals=6).

    TradingApiGetAggregatedQuote

    binanceChainId: string

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

    TradingApiGetAggregatedQuote

    feePercent?: string

    Custom fee (referral fee / Add Fee) percentage as a decimal string. Must be paired with feeSource — either both present or both absent.

    Range by chain:* (0, 5] for EVM chains (BSC, Ethereum, Base, etc.) and (0, 10] for Solana (CT_501) — greater than 0, up to the chain-specific maximum inclusive, max 2 decimal places. "1.5" means 1.5%. Values exceeding 2 decimal places are rejected with INVALID_FEE_PERCENT (40466).

    four.meme tokens are not supported* — do not pass fee parameters when either side of the pair is a four.meme token.

    TradingApiGetAggregatedQuote

    feeSource?: GetAggregatedQuoteFeeSourceEnum

    Fee deduction direction. FROM_TOKEN = deduct the fee from the sell token (the amount passed to the DEX is reduced to a net amount); TO_TOKEN = deduct the fee from the buy-token output (the user's actual received amount is reduced). Must be paired with feePercent.

    TradingApiGetAggregatedQuote

    fromTokenAddress: string

    Sell-token contract address. EVM chains require 0x + 40 hex chars; non-EVM chains use the chain's native address format.

    TradingApiGetAggregatedQuote

    nonce?: string

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

    TradingApiGetAggregatedQuote

    recvWindow?: number | bigint

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

    TradingApiGetAggregatedQuote

    toTokenAddress: string

    Buy-token contract address. Must differ from fromTokenAddress.

    TradingApiGetAggregatedQuote

    userWalletAddress?: string

    User wallet address. Required when quoting RFQ routes (equity / RWA tokens such as Ondo and BStock). This address is used as the receiver in the RFQ order and must match the wallet that signs rfq.typedDataToSign in the subsequent /swap call.

    TradingApiGetAggregatedQuote

    vendor?: GetAggregatedQuoteVendorEnum

    Optional vendor selector. When provided, only the specified vendor is queried through the single-vendor fast path; the request bypasses the multi-vendor dual-window, early-return, and price-check logic. Values are case-sensitive and must be one of LiquidMesh, Pancake, or Jupiter. The vendor must also support the requested chain. An unsupported value or unavailable vendor/chain returns PARAM_ERROR (40001). When omitted, the API queries all applicable vendors in parallel and returns the aggregated routes.

    TradingApiGetAggregatedQuote

    Settings
    Member Visibility

    On This Page
    Properties