Skip to main content
GET
Get quotes

Authorizations

Authorization
string
header
required

Send Authorization: <ApiKey>:<ApiSecret> — joined by a colon, raw. No Bearer prefix, no base64.

Get your credentials

Query Parameters

amount
number<double>
required

Amount of the from token to swap, e.g. 1.5 BTC or 250.75 USDT — not base units / wei like 100000000000000.

Required range: 0 <= x <= 1.7976931348623157e+308
from
string
required

Token you are swapping from. Use an id from Get tokens — a 24-character hex id such as 6689b73ec90e45f3b3e51566, not a symbol like ETH.

to
string
required

Token you are swapping to. Use an id from Get tokens — a 24-character hex id such as 6689b73ec90e45f3b3e51558, not a symbol like SOL.

markup
number<double>

Markup for this request, as a percentage — 0.5 means 0.5%.

  • range 0–4; overrides your account default for this trade
  • send 0 for no markup, or omit the field to use your account default
  • providers that cannot apply it are excluded from the results
  • not supported on DEX routes. Leave types unset and DEX quotes are simply left out; ask for types=dex together with a markup and the request is rejected
Required range: 0 <= x <= 4
useXmr
boolean

Use Monero (XMR) as the bridge token on a private swap.

A private route hops through an intermediary token so the deposit and the payout are not linkable on-chain. true pins that hop to XMR; leave it unset and the hop is picked from a rotating set of other tokens. Ignored by standard and DEX quotes, which are single-leg.

fixed
boolean

Request a fixed-rate quote. Only partners that support fixed rate will be returned. Available for standard and private CEX quotes; not supported for DEX.

refundAddress
string

Where funds are returned if a swap cannot complete. Optional here — quotes are never filtered by it.

  • use a wallet the user controls, not an exchange deposit address
  • must be on the source chain — the refund comes back as the token you deposited
  • a route that will need one comes back with requiresRefundAddress: true
  • supply it at Create exchange, where it is required for fixed-rate quotes and for those routes
Maximum string length: 200
deviationThreshold
number<double>

Maximum price deviation percentage when rotating wallets. Only used if rotatePayoutWallets is true. Default 5

Required range: 0 <= x <= 100
rotationLookback
integer<int32>

Number of recent orders to check for path rotation. Only used if rotatePayoutWallets is true. Default 10

Required range: 1 <= x <= 100
rotatePayoutWallets
boolean

Rotate the payout path for better privacy. Only used for private swaps (types=private) — standard and DEX are single-leg and ignore it.

rotateFallback
boolean

When strict rotation exhausts every rotated route, fall back to a valid non-rotated route instead of failing. Default false. Requires rotatePayoutWallets — a no-op on its own.

inLegIncludedSwaps
string[]

Only use these providers for the in-leg of a private (2-hop) route. Ignored by standard and DEX quotes, which are single-hop.

inLegExcludedSwaps
string[]

Never use these providers for the in-leg of a private (2-hop) route. Does not affect the out-leg. Ignored by standard and DEX quotes.

outLegIncludedSwaps
string[]

Only use these providers for the out-leg of a private (2-hop) route. Ignored by standard and DEX quotes, which are single-hop.

outLegExcludedSwaps
string[]

Never use these providers for the out-leg of a private (2-hop) route. Does not affect the in-leg. Ignored by standard and DEX quotes.

slippage
number<double>

Slippage percentage. Only used for DEX swaps.

Required range: 0 <= x <= 100
types
enum<string>[]

Types of quotes to return; if omitted, all types are used

Available options:
private,
standard,
dex
swaps
enum<string>[]

Only quote these providers. Omit to use all of them.

  • values are shortName from Get swap providers
  • applies to every quote type — private, standard and DEX
Available options:
ch,
cl,
cn,
ff,
le,
se,
ss,
sx,
sxby,
sxhu,
sxku,
sxmx,
sz,
sp,
eb,
nx,
cc,
qx,
sg,
tc,
hu,
nic,
dl,
ad,
wh,
cf,
un,
jp,
mn,
rd,
ps,
cs,
kd,
ct,
zx,
wc,
su,
tt,
ni,
sd,
bg,
ab,
pt,
ax,
rl
senderAddress
string

Wallet that funds the swap, on the source chain. Used by DEX quotes only — private and standard swaps ignore it.

receiverAddress
string

Wallet that receives the payout.

  • when it differs from senderAddress, DEX routes that cannot pay out to a different wallet are returned with filtered: true and filteredReason: different_recipient — still listed, but not usable
  • also used for payout wallet rotation
sort
enum<string>

Sort the quotes by the given field (default: amountOut)

Available options:
amountOut,
amountOutUsd,
amountIn,
duration
sortOrder
enum<string>

Sort direction for quotes (default: desc)

Available options:
asc,
desc
amountType
enum<string>

Whether amount refers to the send side or the receive side.

  • "send" (default): amount is what the user sends — system computes what they receive.
  • "receive": amount is what the user wants to receive — system computes what they must send. Requires fixed=true. Available for standard and private CEX quotes; DEX quotes are dropped from the result, and a DEX-only request is rejected.
Available options:
send,
receive

Response

Success

quotes
object[]
required
total
number<double>
required