Skip to main content
GET
CLI

Authorizations

Authorization
string
header
required

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

Headers

X-API-Key
string

API key

Query Parameters

sourceCurrency
string
required
Example:

"USDT"

sourceNetwork
string

Network for crypto source (e.g. BASE, ETHEREUM). Required when source is a crypto asset; must be omitted when source is fiat.

Example:

"BASE"

sourceRail
string

Rail for fiat source (SEPA, SEPA_INSTANT, FASTER_PAYMENTS). Required when source is fiat; must be omitted when source is crypto. For EUR onramp prefer SEPA; SEPA_INSTANT remains accepted. Slow EUR rails are not available today.

Example:

"SEPA"

destinationCurrency
string
required
Example:

"USDC"

destinationNetwork
string

Network for crypto destination. Required when destination is a crypto asset; must be omitted when destination is fiat.

Example:

"BASE"

destinationRail
string

Rail for fiat destination (SEPA, SWIFT, ACH). Required when destination is fiat; must be omitted when destination is crypto.

Example:

"SEPA"

onBehalfOf
string

Customer the rate is browsed for. Required when either leg is fiat (GBP/EUR) — fiat pairs quote against per-customer Codex credentials. Optional on stablecoin pairs: pass the customer that will later request the firm quote when they have customer-specific pricing (e.g. market-rate pin) so the indicative rate matches it.

Example:

"cus_abc123"

Response

Indicative rate.

rate
string
required

Indicative all-in customer rate for destinationCurrency / sourceCurrency, post-spread. Not a firm quote — request POST /v1/fx/quotes to commit a price.

Example:

"0.99975"

asOf
string
required

When the underlying reference rate was sourced (ISO 8601). Rates are cached briefly to stay inside vendor budgets; this is the cache anchor, not a per-request timestamp.

Example:

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

pairKey
string
required

Canonical SOURCE:DEST pair key (uppercase).

Example:

"USDT:USDC"

source
enum<string>
required

Always reference for this endpoint. Discriminator left open for future indicative-rate sources without changing the response shape.

Available options:
reference
Example:

"reference"