Get a quote
Prices a swap, or commits to one. Across chains a swap settles through two escrows and a solver: without
executionCondition the answer is an indicative price; with it, a firm quote with everything needed to fund it.
On one chain it settles in one transaction through the chain’s TernSwap and a DEX aggregator: indicative without
sender and recipient, firm with both.
A firm quote’s execute lists what to send: EVM transactions in order, or Starknet calls as one multicall. An
escrow quote also has a depositAddress, to which the exact from.amount can be sent from any wallet instead.
Authorizations
A partner's API key. Optional: without it a request is anonymous. An invalid key is 401 unauthorized.
Headers
Firm quotes: repeats with the same key and body get the first response; 1 to 255 visible ASCII characters
Body
The body of POST /v1/quote. Across chains, executionCondition asks for a firm quote, which needs sender and
recipient. On one chain the quote is a swap through a DEX aggregator: firm with sender and recipient, and it
takes no executionCondition. A private swap (privacy: "shielded", Starknet only) takes neither: it is
indicative, and firm with firm: true.
What the user pays.
Show child attributes
Show child attributes
What the user receives; the solver names the amount.
Show child attributes
Show child attributes
SHA-256 of the client's 32-byte fulfillment, in hex. Never reuse one.
Private swaps: true asks for the firm quote, with the actions for the wallet to prove. Other quotes are firm
by what they carry (executionCondition, recipient) and take no firm.
shielded: a private swap on Starknet, from the user's shielded balance in the privacy pool (STRK20) to a new
shielded note, sent by Tern's relayer. Same chain only; the request names no sender or recipient.
shielded The user's address on the destination chain.
The user's refund address on the source chain.
How far under the expected output the user accepts, in basis points: a swap reverts below it, and a cross-chain solver commits to the expected amount less it. The server picks a default without it.
x >= 050
Response
An indicative or firm quote
- Option 1
- Option 2
POST /v1/quote's answer.
How to fund a firm quote's source escrow, or send its swap.
Show child attributes
Show child attributes
Escrows: the deposit deadline. Swaps: the time to send by (the route goes stale). Unix seconds.
x >= 0One leg with its amount.
Show child attributes
Show child attributes
"q_01JB8Z5W3F6V9Q2X4K7M1N0P8R"
Escrows: to.amount is what the solver committed to deliver, the minimum to check before revealing. Swaps:
to.amount is the route's expected output and to.minAmount the least it delivers.
Show child attributes
Show child attributes
The fees' total in basis points of from.usd: from.usd − to.usd, plus the sender's own gas on the source
chain when network includes it. Everything the user gives up, when known.
x >= 0Seconds from the deposit (or the swap) being seen until the recipient is paid, as estimated at quote time.
x >= 0The fees at quote time, when known.
Show child attributes
Show child attributes
What the route loses against market price, router fees included, in basis points of from.usd, when known.
x >= 0How a quote settles.
escrow, swap What the sender's wallet pays in gas on the source chain, when known. An indicative quote with a sender
counts only the approvals that sender still needs; without one it counts the approval a token needs at most.
A private swap's is the relayer's fee in STRK, which the shielded balance pays instead of a wallet.
Show child attributes
Show child attributes