Skip to main content
POST
cURL

Headers

​
x-api-key
string

Optional API key for authentication and higher rate limits.

Body

application/json
​
user
string
default:0x03508bb71268bba25ecacc8f620e01866650532c
required

Address that is depositing funds on the origin chain and submitting transactions or signatures

​
originChainId
number
default:8453
required
​
destinationChainId
number
default:10
required
​
originCurrency
string
default:0x0000000000000000000000000000000000000000
required
​
destinationCurrency
string
default:0x0000000000000000000000000000000000000000
required
​
amount
string
default:1000000000000000000
required

Amount to swap as the base amount (can be switched to exact input/output using the dedicated flag), denoted in the smallest unit of the specified currency (e.g., wei for ETH)

Pattern: ^[0-9]+$
​
tradeType
enum<string>
default:EXACT_INPUT
required

Whether to use the amount as the output or the input for the basis of the swap

Available options:
EXACT_INPUT,
EXACT_OUTPUT,
EXPECTED_OUTPUT
​
recipient
string

Address that is receiving the funds on the destination chain, if not specified then this will default to the user address

​
txs
object[]
​
txsGasLimit
number

Total gas limit for the destination chain call transactions

​
authorizationList
object[]

Authorization list for EIP-7702 transactions to be executed on destination chain

​
additionalData
object

Additional data needed for specific routes

​
referrer
string
​
referrerAddress
string
Pattern: ^0x[a-fA-F0-9]{40}$
​
refundTo
string

Address to send the refund to in the case of failure, if not specified then the recipient address or user address is used

​
recoveryAddress
string

Origin-chain address used for deposit-address fund recovery. Requires useDepositAddress=true.

​
refundOnOrigin
boolean
deprecated

Always refund on the origin chain in case of any issues

​
topupGas
boolean

If set, the destination fill will include a gas topup to the recipient (only supported for EVM chains if the requested currency is not the gas currency on the destination chain)

​
topupGasAmount
string

The destination gas topup amount in USD decimal format, e.g 100000 = $1. topupGas is required to be enabled. Defaults to 2000000 ($2)

​
enableTrueExactOutput
boolean
default:false

Enabling will send any swap surplus when doing exact output operations to the solver EOA, otherwise it will be swept to the recipient

​
explicitDeposit
boolean
default:true

Enable this to avoid direct transfers to the depository (only relevant for EVM and v2 protocol flow)

​
useExternalLiquidity
boolean
deprecated

Deprecated: canonical+ bridging has been removed and this flag is ignored

​
useFallbacks
boolean
deprecated

Deprecated: fallback routes have been removed and this flag is ignored

​
usePermit
boolean

Enable this to use permit (eip3009) when bridging, only works on supported currency such as usdc

​
permitExpiry
number

How long the permit remains valid, in seconds. Defaults to 10 minutes.

​
useMulticallAuthorization
boolean

Opt into the two signature EIP-3009 permit flow of approval proxy 3.1+. The authorize step then starts with a MulticallAuthorization signature item (posted to /execute/permits with kind multicall-authorization, no status check) followed by the EIP-3009 authorization item. Without it, EIP-3009 permits keep the single signature flow on the chain's 3.0 contracts.

​
includeProtocolData
boolean

Return protocol data for on-chain intent validation. This includes protocol.v2.orderSignature and may increase quote latency.

​
swapContractsVersion
enum<string>

Require exact swap contracts on each EVM leg, overriding the App pin. v3 means 3.0. Unavailable versions and incompatible permit flows return 400 instead of falling back. Only supported for swap execution kinds.

Available options:
v3,
v3.2
​
useDepositAddress
boolean

Use a deposit address when calldata cannot be sent with the origin transaction. In /quote/v2, creation follows the requested trade type.

​
strict
boolean

Makes the deposit address one-time use. On /quote/v2, EXACT_OUTPUT addresses are always one-time use.

​
slippageTolerance
string

Slippage tolerance for the swap, if not specified then the slippage tolerance is automatically calculated to avoid front-running. This value is in basis points (1/100th of a percent), e.g. 50 for 0.5% slippage. Must be 0–10000 bps.

Pattern: ^([0-9]{1,4}|10000)$
​
latePaymentSlippageTolerance
string

Slippage tolerance for destination gas in the event that the deposit occurs after the order deadline, and more gas is required for the solver to execute the destination transaction. Must be 0–10000 bps.

Pattern: ^([0-9]{1,4}|10000)$
​
appFees
object[]
​
gasLimitForDepositSpecifiedTxs
number

If the request involves specifying transactions to be executed during the deposit transaction, an explicit gas limit must be set when requesting the quote

​
forceSolverExecution
boolean

Force executing swap requests via the solver (by default, same-chain swap requests are self-executed)

​
subsidizeFees
boolean

If the sponsor should pay for the fees associated with the request. Includes gas topup amounts.

​
sponsoredFeeComponents
enum<string>[]

The fee components to sponsor for swap execution kinds. Requires subsidizeFees=true. Defaults to execution, swap, relay, and app when omitted; rent remains user-paid unless explicitly selected.

Minimum array length: 1
Available options:
execution,
swap,
relay,
app,
rent
​
maxSubsidizationAmount
string

The max subsidization amount in USDC decimal format, e.g 1000000 = $1. subsidizeFees must be enabled. The sponsor will cover fees up to this cap and the user pays any remainder.

​
subsidizationBps
integer

The share of each sponsored fee component the sponsor covers, in bps, e.g 10000 = 100% and 2500 = 25%. subsidizeFees must be enabled. Defaults to full coverage when omitted; the user pays the remainder. Applied before maxSubsidizationAmount, which still caps the sponsor's total.

Required range: 0 <= x <= 10000
​
subsidizeRent
boolean
deprecated

Deprecated compatibility alias that adds "rent" to sponsoredFeeComponents.

​
includedSwapSources
string[]

Swap sources to include for swap routing.

​
excludedSwapSources
string[]

Swap sources to exclude for swap routing.

​
includedOriginSwapSources
string[]

Swap sources to include for swap routing on origin.

​
includedDestinationSwapSources
string[]

Swap sources to include for swap routing on destination.

​
originGasOverhead
integer

The gas overhead for the origin chain, this is used to calculate the gas fee for the origin chain when the solver is executing a gasless transaction on the origin chain

Required range: 0 <= x <= 9007199254740991
​
depositFeePayer
string

The payer to be set for deposit transactions on solana. This account must have enough for fees and rent.

​
maxRouteLength
number

Maximum number of hops to use in solana swap routing. Can reduce transaction size.

​
useSharedAccounts
boolean

Prevents certain ATA creation instructions in solana routing

​
forJitoBundle
boolean

Restricts solana swap routing to routes that are compatible with Jito bundles. Only set this when the swap will be executed inside a Jito bundle.

​
includeComputeUnitLimit
boolean

Whether to include compute unit limit instruction for solana origin requests.

​
useV1Transaction
boolean

Whether to return the solana deposit transaction in the v1 (SIMD-0385) format: no lookup tables, a 4096 byte limit, and the compute budget in transactionConfig. Best effort; the returned step data sets transactionVersion to 1 when honored.

​
overridePriceImpact
boolean

Whether to ignore price impact errors.

​
disableSwapProviderPreference
boolean

Whether to disable preferred swap provider selection.

​
disableOriginSwaps
boolean

Whether to disable origin swaps.

​
indicativeQuote
boolean

Whether to return an inexecutable quote meant to be used as a preview.

​
fixedRate
string

The rate to charge for fixed spread quotes.

​
referencePrice
string

Requester-provided price (output units per input unit, human units) to compare router quotes against. When fastestInPriceRange is enabled for the API key, destination-leg quotes more than 20% below it are skipped. When useRouteRacingOnOrigin is set, it anchors origin swap route selection: routes priced within a fixed band of it (20% below to 50% above) are preferred, and the best route overall is used when none is in the band. The selected route alone sets the expected and minimum output (with slippageTolerance applied to it); the reference price never sets a floor. Expects a positive decimal string such as "0.000131" (scientific notation is not parsed). Deliberately unconstrained by a schema pattern: a malformed or non-positive value, or one sent by a key without the relevant grant, is ignored and the quote is served without a reference price rather than rejected.

​
useRouteRacing
boolean

Whether to use route racing for this quote (executing multiple candidate routes on-chain and keeping the best), when the API key is authorized for it.

​
routeRacingMinUsdSize
number

Minimum fill size in USD eligible for route racing. Defaults to 100. Route racing has no maximum fill size.

​
useRouteRacingOnOrigin
boolean

Whether to use route racing for this quote's origin swap (executing multiple candidate routes on-chain and keeping the best), when the API key is authorized for it and the origin chain is configured for route racing.

​
ttl
integer

Time-to-live for the quote, in seconds, measured from when the quote was generated. If the request is not filled within this window it is refunded instead of filled.

Required range: x >= 1
​
useQueueing
boolean

Opt-in queueing: when the destination fill hits temporarily insufficient liquidity, keep retrying it until the queueingTtl window expires (then refund) instead of refunding immediately. Requires queueingTtl.

​
queueingTtl
number

Queueing window, in seconds, measured from when the quote was generated. While it is open, a useQueueing request that hits insufficient destination liquidity is retried instead of refunded; once it expires the request is refunded. Independent of ttl. Only used together with useQueueing.

Response

Default Response

​
requestId
string

A unique identifier for the quote

​
steps
object[]

An array of steps detailing what needs to be done to complete the bridge or swap. Each step contains a single item, either a signature or a transaction

Example:
​
fees
object
​
feeSponsorship
object

Granular fee sponsorship details derived from the solver's internal sponsorship resolution.

​
details
object

A summary of the swap and what the user should expect to happen given an input

​
protocol
object

Protocol information for the quote