Skip to main content
POST

Authorizations

X-API-Key
string
header
required

Service-account API key (tfk_test_/tfk_live_).

Body

application/json
user
string
required

Wallet initiating the trade. It signs the order payload and, on walletBroadcast candidates, broadcasts the prepared transactions.

Example:

"0x2e7E7cc62919eAf4c502dAC34753cFc5A29e9693"

intent
Intent · object
required

Declares what goes in and what must come out, rather than a fixed route. Each asset carries its own chainId, so a single intent can span networks.

supportedTypes
string[]
required

Order payload types your signer can handle. escrow-v0 is the current settlement payload - send ["escrow-v0"].

Example:
minValidUntil
integer | null

Earliest acceptable candidate expiry (unix seconds). Candidates whose firmness window closes sooner are filtered out - useful when your flow needs time between quoting and submission.

solverOptions
Solver Options · object | null

Per-request solver tuning: include or exclude specific solvers and adjust sweep timeouts. Server-managed defaults apply when omitted.

routingOptions
Routing Options · object | null

Multi-leg planner controls such as routes and maxRouteLegs. Server-managed defaults apply when omitted.

Response

Successful Response

quotes
QuoteCandidate · object[]
required

Ranked executable candidates, best first under the requested preference. Every entry is independently executable and states its own guarantees; one source being down, slow, or empty never suppresses candidates from the others.

totalQuotes
integer
required

Number of candidates returned.

metadata
Metadata · object

How the sweep went - aggregation stats across sources plus the planner's route detail.