/api/v1/export/rates/{id}/prices.{ext}GETExport historical reference rate values as a CSV or TSV file download, newest first. Columns: timestamp, price. Exports are raw aggregate buckets: unlike the JSON price endpoint, an
interval=1d export is not forward-filled, so days with no trades are absent rather than carried forward. price is 0-100 percent, the same scale the JSON rate endpoints serve.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
per_page?integer
Points per page (1-10000). Combine with
page to walk the series.Default:
100Min: 1Max: 10000start?string (date-time)
Start time
end?string (date-time)
End time
interval?"1min" | "5min" | "1hour" | "1d"
Time bucket interval (daily, 1day also accepted as aliases for 1d)
Default:
"5min"order?"asc" | "desc"
Sort direction by timestamp
Default:
"desc"page?integer
1-based page number. The window is taken from the most recent points, so page 2 is the next-older block.
Default:
1Min: 1Response
200 · CSV/TSV file of reference rate price history
CSV/TSV file of reference rate price history
400 · Invalid format or interval
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.