Interface GetSwapPriceOptions

Options for getting a swap price.

interface GetSwapPriceOptions {
    fromAmount: bigint;
    fromToken: `0x${string}`;
    gasPrice?: bigint;
    idempotencyKey?: string;
    network: EvmSwapsNetwork;
    signerAddress?: `0x${string}`;
    slippageBps?: number;
    taker: `0x${string}`;
    toToken: `0x${string}`;
}

Properties

fromAmount fromToken gasPrice? idempotencyKey? network signerAddress? slippageBps? taker toToken

Properties

fromAmount

fromAmount: bigint

The amount to send in atomic units of the token.

fromToken

fromToken: `0x${string}`

The token to send (source token).

OptionalgasPrice

gasPrice?: bigint

The gas price in Wei.

OptionalidempotencyKey

idempotencyKey?: string

The idempotency key.

network

network: EvmSwapsNetwork

The network to get a price from.

OptionalsignerAddress

signerAddress?: `0x${string}`

The signer address (only needed if taker is a smart contract).

OptionalslippageBps

slippageBps?: number

The slippage tolerance in basis points (0-10000).

taker

taker: `0x${string}`

The address that will perform the swap.

toToken

toToken: `0x${string}`

The token to receive (destination token).

Settings

Member Visibility

On This Page

Properties