Skip to main content
POST
CLI

Authorizations

Authorization
string
header
required

API Key in Bearer format (e.g., Bearer sk_test_...)

Headers

X-API-Key
string

API key

Idempotency-Key
string

Client-supplied key to deduplicate retries (e.g. on network timeout). Replays return the original quote rather than burning another vendor quote.

Body

application/json
onBehalfOf
string
required

Customer this quote is for (the customer who will deposit).

Example:

"cus_abc123"

pair
object
required
amount
object
required
maxSlippageBps
number

Per-trade max slippage tolerance on the re-quote step, in basis points (1 bp = 0.01%). Minimum 5, maximum 1000. Optional for stable sources — if omitted, the organization-level default for the pair applies. REQUIRED for volatile sources (e.g. BTC): a quote whose source can move materially across the deposit-confirmation window is rejected when this is omitted, so the tolerance the customer accepts is always explicit.

Required range: 5 <= x <= 1000
Example:

25

Response

Firm quote created.

id
string
required
Example:

"quote_abc123"

pair
object
required
amount
object
required
grossSource
string
required

Source amount, fees included, in source-currency minor units.

Example:

"10000000"

displayedDestination
string
required

Destination amount the customer will receive, in destination-currency minor units.

Example:

"9998500"

rate
string
required

All-in customer rate (displayedDestination / grossSource).

Example:

"0.9998500"

expiresAt
string
required

When the firm quote expires (ISO 8601).

Example:

"2026-05-26T19:42:00.000Z"

referenceRate
string

Independent reference rate used to price this quote, expressed as destination major units per source major unit. Present for benchmark-priced quotes.

Example:

"1.158691536019208779"

referenceRateAsOf
string

Timestamp of the independent reference rate used to price this quote (ISO 8601).

Example:

"2026-09-02T18:30:04.000Z"

referenceProvider
enum<string>

Independent market that published referenceRate. Present when referenceRate is present.

Available options:
XE
Example:

"XE"

quoteBinding
enum<string>

How this quote binds to a later trade. PERSISTED: the firm price is held and a trade created from this quote replays it, so accepting later (within expiresAt) is safe. AT_ACCEPT: pricing is finalized when the trade is created, so the price may move between quote and accept.

Available options:
PERSISTED,
AT_ACCEPT
Example:

"PERSISTED"

expectedDepositDetails
object

Preview of the deposit details the trade will carry once this quote is accepted. Omitted when the preview could not be resolved (the quote itself is unaffected — accept normally and use the deposit instructions on the trade).