/api/v1/export/rates/{ext}GETExport the list of reference rates as a CSV or TSV file download. Up to 10,000 rows are returned (server-side cap), ordered by rate_id. Columns: rate_id, name, methodology, sources_count, latest_price, spread, previous_close_1d.
latest_price, spread, and previous_close_1d are 0-100 percent, the same scale the JSON rates endpoint serves.Authorization
bearerAuth *Bearer <token>
Clerk session JWT, or an API key (the
ak_ prefix), sent as a Bearer token or an ?api_key= query parameter. Each endpoint requires the read scope for its resource (e.g. org:rates:read for rates). Token in: headerQuery Parameters
start?string (date-time)
Only consider rate prices at or after this time when selecting the latest price/spread
end?string (date-time)
Only consider rate prices at or before this time when selecting the latest price/spread
Response
200 · CSV/TSV file of reference rates
CSV/TSV file of reference rates
400 · Invalid format (ext must be csv or tsv)
error?string
Stable, machine-readable code identifying the failure; branch on this rather than on
message. One of bad_request, unauthorized, forbidden, not_found, conflict, service_unavailable, upstream_error, service_error, or internal_error.message?string
Human-readable explanation, safe to show to a user. For client errors it names the specific problem; for server-side failures it is a generic notice and the underlying detail is deliberately withheld.
403 · The organization has no paid plan, so the realtime read scopes are refused. Distinct from a 429, which means a plan's budget ran out: nothing here resets on a timer, and the request succeeds only once the organization holds a plan.
error *string
Human-readable reason the request was refused.
status *integer
HTTP status code, repeated in the body.
upgrade_url?string (uri)
Page listing the plans and their request allowances, for buying access. Absent when no plan is available for purchase.
429 · The paid organization's minute or UTC-day request budget is exhausted.
error *"rate_limited"
Always
rate_limited. Branch on this to detect a throttled request.limit *"rpm" | "daily"
Which limit was hit:
rpm for the per-minute cap or daily for the daily one.message *string
Human-readable explanation naming the limit that was exceeded.
upgrade_url?string (uri)
Page listing the plans and their request allowances, for buying a larger budget. Absent when no plan is available for purchase.