Using This Reference

All endpoints are JSON‑based and require HTTPS.

Item
Value/Notes

Base URL

https://api.openorigins.com

Auth header

Authorization: Bearer <API_KEY>

Content type

application/json (requests & responses)

Versioning

All paths are currently prefixed with /v1/. Breaking changes will trigger a new /v2/ path after

Rate Limit headers

X‑RateLimit‑Limit, X‑RateLimit‑Remaining, Retry‑After

Status code guide

  • 200 OK – Successful read

  • 201 Created – Successful create

  • 400 Bad Request – Invalid input

  • 401/403 – Missing or invalid API key

  • 429 Too Many Requests – Rate‑limit exceeded

  • 500 – Unhandled error (contact support)

All error responses share this schema:

{
  "code": "string",        // short machine code, e.g. INVALID_HASH
  "message": "string",     // human‑readable summary
  "details": "object|null" // optional extra context
}

Last updated