DocsConventions

Conventions

Shared rules that apply to every REST endpoint in the API. All routes return JSON and require an API key via the x-api-key header.

Base URL

All REST routes are served from this host. Use it as the base for every data request:

Base URL
https://api.tickerlayer.com
  • All responses are Content-Type: application/json.
  • Timestamps are Unix milliseconds (number).
  • HTTP methods are GET only for all data endpoints.

Authentication

Prefer the x-api-key header on every request. The API also accepts ?apiKey= on REST URLs as a compatibility fallback — do not put keys in logged URLs when you can use the header.

  • Preferred: x-api-key: <YOUR_API_KEY>
  • Fallback: ?apiKey=<YOUR_API_KEY> (query string)
Example
curl -sS "https://api.tickerlayer.com/crypto/quote/BTCUSD" \
  -H "x-api-key: <YOUR_API_KEY>"

Full authentication guide →

Response shape

  • Null fields — keys remain in the schema; values are null when temporarily absent from the aggregated market view, not omitted. Individual fields may be optional depending on market conditions; see each route for response details.
  • 404 vs empty — a missing symbol or resource returns 404 with a JSON object such as { "statusCode": 404, "message": "symbol not available" }. An empty list returns 200 with an empty array.
  • 400 — invalid path or query parameters; body contains a descriptive message listing valid values.

Errors & metering

Authenticated REST traffic passes through usage metering. Rate limits are evaluated first, so throttled requests do not consume monthly quota.

  • 429 — rate limit: REST_RATE_LIMIT_EXCEEDED with limitRps and retryAfterMs.
  • 429 — quota: REST_QUOTA_EXCEEDED with limit (monthly cap).
  • 503 — metering unavailable: USAGE_METERING_UNAVAILABLE when usage storage is unreachable (fail closed).

Rate limits · Error reference