UniRate OpenAPI specification

Canonical OpenAPI 3.1 description of the UniRate API — openapi.yaml.

This is the single reuse asset behind several PR-campaign ships:

• APIs.guru — submit openapi.yaml to the directory (self-serve GitHub PR).
• Postman — import into a public UniRate workspace (DR 90 backlink).
• Directory listings / SDK generators — seed further surfaces from one file.
• Doubles as canonical, human-readable API docs for the org.

Source of truth

openapi.yaml is derived from and must stay in sync with ../_canonical-api-spec.md. When the canonical spec changes (endpoints, params, response shapes, error mapping), update this file to match.

Coverage

All 7 endpoints, the api_key query-parameter security scheme, and the full status-code → error mapping (400/401/403/404/429/503).

Endpoint	Tier
GET /api/rates	Free
GET /api/convert	Free
GET /api/currencies	Free
GET /api/vat/rates	Free
GET /api/historical/rates	Pro (403 on free tier)
GET /api/historical/timeseries	Pro (403 on free tier)
GET /api/historical/limits	Pro (403 on free tier)

Validate

Validation runs inside the workspace dev container (never on the host):

dev node npx --yes @redocly/cli@latest lint openapi/openapi.yaml

License

MIT © 2026 UniRate Team