v1

latestOpenAPI 3.0.02026-07-225015.0 KB

Swap

Get quotes

get/v3/swap/quote

Query parameters

userOpsstring[] required

Requested user operation types. Use a comma-separated value or repeat the query param. Allowed values: tx, deposit, cex-withdraw.

[
  "tx",
  "deposit"
]

destinationChainIdstring required

Example:8453

Destination chain ID.

inputTokenstring required

Example:0xaf88d065e77c8cc2239327c5edb3a432268e5831

Input token address on originChainId, or token symbol when userOps is cex-withdraw and originChainId is omitted.

inputAmountstring required

Example:1000000

Input amount in token base units. HyperCore origins accept decimal strings.

outputTokenstring required

Example:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913

Output token address on destinationChainId.

receiverAddressstring required

Example:0x3e8cB4bd04d81498aB4b94a392c334F5328b237b

Destination receiver address. Final recipient for plain routes; executor/contract receiver when destinationPayload is set.

originChainIdstring required

Example:42161

Origin chain ID. Required for tx and deposit userOps; optional for cex-withdraw.

userAddressstring required

Example:0x3e8cB4bd04d81498aB4b94a392c334F5328b237b

Origin wallet address. Required for tx userOp. Used as the default refund address unless refundAddress is set.

slippagestring

Slippage tolerance percentage.

refundAddressstring

Address to refund funds to. Required for deposit and cex-withdraw userOps.

contractCallerstring

Intermediate contract that will call AllowanceHolder.exec on behalf of userAddress (e.g. an integrator bridge contract), for direct tx routes. userAddress remains the default refund address unless refundAddress is set. Pass this only when a contract — not the user's own wallet — is the AllowanceHolder caller, otherwise the transaction reverts (CallerNotSignedUser).

feeBpsstring

Affiliate fee in basis points. Must be provided together with feeTakerAddress.

feeTakerAddressstring

Address that receives the affiliate fee. Must be provided together with feeBps.

refuel'true' | 'false'

Whether to request gas refuel. Must be exactly true or false.

destinationPayloadstring

Hex payload to execute on the destination receiver. Requires destinationGasLimit when set.

destinationGasLimitstring

Gas limit for destination payload execution. Requires destinationPayload when set.

includeProviderstring

Comma-separated provider IDs to include. Same-chain routes treat these as DEX IDs; cross-chain routes treat these as public bridge IDs.

excludeProviderstring

Comma-separated provider IDs to exclude. Same-chain routes treat these as DEX IDs; cross-chain routes treat these as public bridge IDs.

exchangestring

CEX exchange ID. Required for cex-withdraw userOp.

includeQuoteRejections'true' | 'false'

When true, include per-provider rejection reasons for cross-chain tx quotes that returned no route.

private'true' | 'false'

When true, only privacy-capable direct tx providers are quoted.

simulatedQuotesRequired'true' | 'false'

When true, return only same-chain DEX routes that passed on-chain simulation, with output amounts replaced by simulated values.

solanaSponsorAddressstring

Solana sponsor address for gasless same-chain swaps. When set, the sponsor pays tx fees and ATA rent (DFlow sponsored swap). Solana origin only.

Response

V3 swap quote routes.