Skip to main content
GET
Node.js

Authorizations

Authorization
string
header
required

ES256-signed JWT bearer token, single-use, 60-second TTL. See Authentication for how to mint one.

X-Request-Signature
string
header
required

ES256 signature over the request, bound to the bearer JWT. Required on every v3 request. See Authentication → Request signing.

Headers

X-Request-Id
string

Optional, client-supplied correlation ID for this request. Echoed verbatim on the response when supplied; the response omits it when the request did not supply one. Distinct from X-Trace-Id (server-generated, always present). See Metadata & tracing.

Example:

"my-req-abc-123"

Path Parameters

id
string
required

Quote ID. Accepts either the current readable, typed-prefix ID (see ResourceId) or a legacy bare UUID v4, for backward compatibility with IDs persisted before v3 introduced readable IDs. Both forms resolve to the same underlying record. Responses always return the readable form — see Resource IDs.

Pattern: ^([a-z]{3,5}_[1-9A-HJ-NP-Za-km-z]{1,22}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
Example:

"tde_5W7guYdHT24JFnRQrZN9y8"

Response

The quote. status is derived from consumed and expiresAt at read time (CONSUMED > EXPIRED > ACTIVE).

data
object
required

A time-limited foreign exchange quote that can be used to create a trade.