{ "openapi": "3.1.0", "info": { "title": "Rate-API", "version": "v1", "description": "**Rate-API** is a fast, reliable exchange-rates API covering **160+ currencies**, with\n**daily history back to 1999** for the ~30 currencies the ECB publishes. Use it for currency\nconversion, historical rates, daily time series and fluctuation, currency pairs, cryptocurrency\nprices, stock closes and precious metals - in JSON, XML or CSV.\n\n### Update frequency\nWe check our sources every hour. A rate changes when its publisher releases a new one: for most\ncurrencies once per business day (the ECB publishes at about 16:00 CET), so rates hold overnight,\nat weekends and on holidays.\n\n### Base URL\n```\nhttps:\/\/rate-api.com\/api\/v1\n```\nThe `\/api\/v1` and `\/api\/v2` prefixes (and the legacy `\/api`) all resolve to the same\nimplementation, so existing integrations keep working.\n\n### Data sources\nReference rates for the major currencies come from the **European Central Bank**, cited\nas their source; the same data is available free of charge from the ECB at ecb.europa.eu.\nOther currencies come from other central banks and governments, fixed official parities and\nthird-party market data. Every source we credit, and the licence its\ndata is used under, is listed on the [Data sources](https:\/\/rate-api.com\/sources) page.\nRates are informational and provided without warranty of accuracy \u2014 see the\n[terms](https:\/\/rate-api.com\/terms).\n\n### Authentication\nSend your API key in **any** of these ways:\n- **URL path** - `\/api\/v1\/YOUR_API_KEY\/latest`\n- **Header** - `Authorization: Bearer YOUR_API_KEY`\n- **Header** - `X-API-Key: YOUR_API_KEY`\n\nCreate a key in your [dashboard](\/dashboard). The Free plan includes 2,500 requests\/month - no card required.\n\n### Quick start\n```bash\n# Latest USD rates\ncurl \"https:\/\/rate-api.com\/api\/v1\/YOUR_API_KEY\/latest?base=USD\"\n\n# Convert 100 USD to EUR\ncurl \"https:\/\/rate-api.com\/api\/v1\/YOUR_API_KEY\/convert?from=USD&to=EUR&amount=100\"\n```\n\n### Response formats\nAppend `?format=json` (default), `?format=xml` or `?format=csv`. XML returns an\n`application\/xml` document; CSV returns `currency,rate` rows for rate endpoints,\n`date,currency,rate` rows for `\/timeseries`, `currency,start_rate,end_rate,change,change_pct`\nrows for `\/fluctuation`, and `key,value` otherwise. Responses are gzip-compressed when the client accepts it.\nEvery response carries an `X-Request-Id` you can quote in support requests.\n\n### Rate limits\nPer-minute limits scale with your plan (Free 10 \u00b7 Pro 100 \u00b7 Business\/Enterprise 1000).\nEvery response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`;\na `429` includes `Retry-After`. Track monthly usage at `\/usage` and `\/quota`.\n\n### Errors\nErrors return a consistent envelope:\n```json\n{ \"success\": false, \"error\": { \"code\": 400, \"type\": \"invalid_base_currency\", \"message\": \"Invalid base currency\" } }\n```\n\n### SDKs\nOfficial clients: **PHP** (Composer), **JavaScript\/TypeScript** (npm), **Python** (PyPI), plus an **MCP server** for AI tools." }, "servers": [ { "url": "https:\/\/rate-api.com\/api" } ], "paths": { "\/v1\/health": { "get": { "operationId": "rateApi.health", "summary": "Public health check - no API key required", "tags": [ "RateApi" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "status": { "type": "string", "description": "Upstream (free tier) publishes ~daily, so rates legitimately age past\nseveral hours; only flag degraded once data is clearly stale (>26h).", "enum": [ "operational", "degraded" ] }, "rates_last_update": { "type": [ "string", "null" ] }, "rates_age_hours": { "type": [ "number", "null" ] }, "currencies": { "type": "integer", "minimum": 0 }, "timestamp": { "type": "integer" } }, "required": [ "success", "status", "rates_last_update", "rates_age_hours", "currencies", "timestamp" ] } } } } } } }, "\/v1\/status": { "get": { "operationId": "rateApi.status_0", "summary": "API status and version metadata", "tags": [ "RateApi" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" }, { "type": "object" }, { "type": "string" } ] }, "version": { "type": "string" }, "uptime": { "type": "string" }, "response_time": { "type": "string" }, "last_update": { "type": "string" }, "deprecation_notice": { "type": "null" }, "timestamp": { "type": "integer" } }, "required": [ "success", "status", "version", "uptime", "response_time", "last_update", "deprecation_notice", "timestamp" ] } } } } } } }, "\/v1\/latest": { "get": { "operationId": "rateApi.latest_0", "summary": "Latest exchange rates for a base currency (optionally filtered to symbols)", "tags": [ "RateApi" ], "parameters": [ { "name": "symbols", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "timestamp": { "type": "integer" }, "base": { "type": "string" }, "date": { "type": "string" }, "rates": { "type": "object", "additionalProperties": { "type": "number" } } }, "required": [ "success", "timestamp", "base", "date", "rates" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_symbol" }, "message": { "type": "string" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_base_currency" }, "message": { "type": "string", "const": "Invalid base currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } ] } } } } } } }, "\/v1\/currencies": { "get": { "operationId": "rateApi.currencies_0", "summary": "List supported currencies with names, symbols and decimal places", "tags": [ "RateApi" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "currencies": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "symbol": { "type": [ "string", "null" ] }, "decimal_places": { "type": "integer" } }, "required": [ "name", "symbol", "decimal_places" ] } }, "total": { "type": "integer" }, "timestamp": { "type": "integer" } }, "required": [ "success", "currencies", "total", "timestamp" ] } } } } } } }, "\/v1\/convert": { "get": { "operationId": "rateApi.convert_0", "summary": "Convert an amount from one currency to another (Pro+)", "tags": [ "RateApi" ], "parameters": [ { "name": "amount", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "query": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "amount": { "type": "number" } }, "required": [ "from", "to", "amount" ] }, "info": { "type": "object", "properties": { "timestamp": { "type": "integer" }, "rate": { "type": "number" } }, "required": [ "timestamp", "rate" ] }, "date": { "type": "string" }, "result": { "type": "number" } }, "required": [ "success", "query", "info", "date", "result" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 404 }, "type": { "type": "string", "const": "rate_not_available" }, "message": { "type": "string", "const": "Conversion rate not available" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_target_currency" }, "message": { "type": "string", "const": "Invalid target currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_source_currency" }, "message": { "type": "string", "const": "Invalid source currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "amount_not_positive" }, "message": { "type": "string", "const": "Amount must be a positive number" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "missing_parameters" }, "message": { "type": "string", "const": "Parameters from, to, and amount are required" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/pair\/{from}\/{to}": { "get": { "operationId": "rateApi.pair_0", "summary": "Latest rate for a currency pair (amount-multiplied result is Pro+)", "tags": [ "RateApi" ], "parameters": [ { "name": "from", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "to", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "amount", "in": "query", "schema": { "type": "string", "default": 1 } }, { "name": "precision", "in": "query", "schema": { "type": "string", "default": 4 } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "pair": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] }, "rate": { "type": "number" }, "timestamp": { "type": "integer" }, "date": { "type": "string" }, "info": { "type": "object", "properties": { "rate_source": { "type": "string", "const": "live" }, "last_updated": { "type": "string" }, "spread": { "type": "number" } }, "required": [ "rate_source", "last_updated", "spread" ] }, "amount": { "type": "number" }, "result": { "type": "number" } }, "required": [ "success", "pair", "rate", "timestamp", "date", "info", "amount", "result" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 404 }, "type": { "type": "string", "const": "rate_not_available" }, "message": { "type": "string", "const": "Exchange rate not available" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "amount_not_positive" }, "message": { "type": "string", "const": "Amount must be a positive number" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_target_currency" }, "message": { "type": "string", "const": "Invalid target currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_source_currency" }, "message": { "type": "string", "const": "Invalid source currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } ] } } } } } } }, "\/v1\/historical": { "get": { "operationId": "rateApi.historical_0", "summary": "Historical rates for a past date (Pro+)", "tags": [ "RateApi" ], "parameters": [ { "name": "symbols", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "historical": { "type": "boolean" }, "date": { "type": "string" }, "base": { "type": "string" }, "rates": { "type": "object", "additionalProperties": { "type": "number" } }, "timestamp": { "type": "integer" } }, "required": [ "success", "historical", "date", "base", "rates", "timestamp" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 404 }, "type": { "type": "string", "const": "no_data_for_date" }, "message": { "type": "string", "const": "No rates stored for that date." } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_base_currency" }, "message": { "type": "string", "const": "Invalid base currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_date" }, "message": { "type": "string", "const": "Invalid date format. Use YYYY-MM-DD" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "missing_parameters" }, "message": { "type": "string", "const": "Date parameter is required" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/timeseries": { "get": { "operationId": "rateApi.timeseries_0", "description": "Daily exchange rates for every day from `start_date` to `end_date` (inclusive, at most **366 days**), keyed by date and then by currency code.\nDays with no published rates - weekends, holidays, or dates before a currency's history begins - are left out rather than returned empty.\n\nA non-USD `base` is cross-rated through USD for each day, the same way `\/historical` does, so any base works over the whole range.\nRates are returned as stored for a USD base and to 6 decimals for other bases, unless you pass `precision`.\n\nAvailable on the **Business** and **Enterprise** plans; other plans get `403 feature_not_available`.\nWith `?format=csv` the response is one `date,currency,rate` row per rate.", "summary": "Daily rates for a date range (Business+)", "tags": [ "RateApi" ], "parameters": [ { "name": "start_date", "in": "query", "required": true, "description": "First day of the range, `YYYY-MM-DD`.", "schema": { "type": "string", "format": "date" }, "example": "2026-01-01" }, { "name": "end_date", "in": "query", "required": true, "description": "Last day of the range, `YYYY-MM-DD`. On or after `start_date`, and the range may span at most 366 days.", "schema": { "type": "string", "format": "date" }, "example": "2026-01-31" }, { "name": "base", "in": "query", "description": "Base currency code. Defaults to your account base currency (USD unless changed in settings).", "schema": { "type": "string" }, "example": "USD" }, { "name": "symbols", "in": "query", "description": "Comma-separated target currency codes. Omit for every currency.", "schema": { "type": "string" }, "example": "EUR,GBP" }, { "name": "precision", "in": "query", "description": "Round every rate to this many decimals (0-12).", "schema": { "type": "integer" }, "example": 6 } ], "responses": { "200": { "description": "Rates keyed by date, then currency code.", "content": { "application\/json": { "schema": { "type": "object", "examples": [ { "success": true, "timeseries": true, "base": "USD", "start_date": "2026-01-01", "end_date": "2026-01-05", "rates": { "2026-01-02": { "EUR": 0.8534, "GBP": 0.7431 }, "2026-01-05": { "EUR": 0.8551, "GBP": 0.7446 } }, "api_version": "v1", "request_id": "0b7e7c1e-2f7a-4a55-9d3e-0c1f2d3e4f5a", "timestamp": 1767657600 } ], "properties": { "success": { "type": "boolean" }, "timeseries": { "type": "boolean" }, "base": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "rates": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } } }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "timeseries", "base", "start_date", "end_date", "rates", "api_version", "request_id", "timestamp" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 404 }, "type": { "type": "string", "const": "no_data_for_range" }, "message": { "type": "string", "const": "No rates stored for that date range." } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_symbol" }, "message": { "type": "string" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_base_currency" }, "message": { "type": "string", "const": "Invalid base currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "date_range_too_long" }, "message": { "type": "string", "const": "The date range cannot span more than 366 days" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_date_range" }, "message": { "type": "string", "const": "end_date must be on or after start_date" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_date" }, "message": { "type": "string", "const": "Invalid end_date format. Use YYYY-MM-DD" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_date" }, "message": { "type": "string", "const": "Invalid start_date format. Use YYYY-MM-DD" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "missing_parameters" }, "message": { "type": "string", "const": "Parameters start_date and end_date are required" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/fluctuation": { "get": { "operationId": "rateApi.fluctuation_0", "description": "How each currency moved between `start_date` and `end_date` (inclusive, at most **366 days**).\n\n`start_rate` is the first published rate on or after `start_date` and `end_rate` the last one on or before `end_date`,\nso a range that starts or ends on a weekend still compares real fixings. `change` is `end_rate - start_rate`\nand `change_pct` is that change as a percentage of `start_rate`, to 4 decimals. A non-USD `base` is cross-rated through USD.\n\nAvailable on the **Business** and **Enterprise** plans; other plans get `403 feature_not_available`.\nWith `?format=csv` the response is one `currency,start_rate,end_rate,change,change_pct` row per currency.", "summary": "How each currency moved over a date range (Business+)", "tags": [ "RateApi" ], "parameters": [ { "name": "start_date", "in": "query", "required": true, "description": "First day of the range, `YYYY-MM-DD`.", "schema": { "type": "string", "format": "date" }, "example": "2026-01-01" }, { "name": "end_date", "in": "query", "required": true, "description": "Last day of the range, `YYYY-MM-DD`. On or after `start_date`, and the range may span at most 366 days.", "schema": { "type": "string", "format": "date" }, "example": "2026-01-31" }, { "name": "base", "in": "query", "description": "Base currency code. Defaults to your account base currency (USD unless changed in settings).", "schema": { "type": "string" }, "example": "USD" }, { "name": "symbols", "in": "query", "description": "Comma-separated target currency codes. Omit for every currency.", "schema": { "type": "string" }, "example": "EUR,GBP" }, { "name": "precision", "in": "query", "description": "Round start_rate, end_rate and change to this many decimals (0-12).", "schema": { "type": "integer" }, "example": 6 } ], "responses": { "200": { "description": "Start and end rate, change and percentage change per currency.", "content": { "application\/json": { "schema": { "type": "object", "examples": [ { "success": true, "fluctuation": true, "base": "USD", "start_date": "2026-01-01", "end_date": "2026-01-31", "rates": { "EUR": { "start_rate": 0.8534, "end_rate": 0.8612, "change": 0.0078, "change_pct": 0.914 }, "GBP": { "start_rate": 0.7431, "end_rate": 0.7389, "change": -0.0042, "change_pct": -0.5652 } }, "api_version": "v1", "request_id": "0b7e7c1e-2f7a-4a55-9d3e-0c1f2d3e4f5a", "timestamp": 1769817600 } ], "properties": { "success": { "type": "boolean" }, "fluctuation": { "type": "boolean" }, "base": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "rates": { "type": "object", "additionalProperties": { "type": "object", "properties": { "start_rate": { "type": "number" }, "end_rate": { "type": "number" }, "change": { "type": "number" }, "change_pct": { "type": "number" } }, "required": [ "start_rate", "end_rate", "change", "change_pct" ] } }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "fluctuation", "base", "start_date", "end_date", "rates", "api_version", "request_id", "timestamp" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 404 }, "type": { "type": "string", "const": "no_data_for_range" }, "message": { "type": "string", "const": "No rates stored for that date range." } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_symbol" }, "message": { "type": "string" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_base_currency" }, "message": { "type": "string", "const": "Invalid base currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "date_range_too_long" }, "message": { "type": "string", "const": "The date range cannot span more than 366 days" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_date_range" }, "message": { "type": "string", "const": "end_date must be on or after start_date" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_date" }, "message": { "type": "string", "const": "Invalid end_date format. Use YYYY-MM-DD" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_date" }, "message": { "type": "string", "const": "Invalid start_date format. Use YYYY-MM-DD" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "missing_parameters" }, "message": { "type": "string", "const": "Parameters start_date and end_date are required" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/crypto": { "get": { "operationId": "rateApi.crypto_0", "summary": "Cryptocurrency prices (Pro+). Served from crypto_rates; USD-based", "tags": [ "RateApi" ], "parameters": [ { "name": "symbols", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "base": { "type": "string", "const": "USD" }, "rates": { "type": "string" }, "crypto": { "type": "string" }, "count": { "type": "integer" }, "last_update": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "base", "rates", "crypto", "count", "last_update", "timestamp" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/stocks": { "get": { "operationId": "rateApi.stocks_0", "summary": "Stock closes (Pro+). Served from stock_prices; USD-based", "tags": [ "RateApi" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "base": { "type": "string", "const": "USD" }, "date": { "type": "string" }, "prices": { "type": "string" }, "stocks": { "type": "string" }, "count": { "type": "integer" }, "timestamp": { "type": "integer" } }, "required": [ "success", "base", "date", "prices", "stocks", "count", "timestamp" ] } } } }, "503": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 503 }, "type": { "type": "string", "const": "data_unavailable" }, "message": { "type": "string", "const": "No stock prices are available yet." } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/metals": { "get": { "operationId": "rateApi.metals_0", "summary": "Precious-metal prices per troy ounce (Pro+). Served from metal_prices; USD-based", "tags": [ "RateApi" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "base": { "type": "string", "const": "USD" }, "unit": { "type": "string", "const": "troy ounce" }, "date": { "type": [ "string", "null" ] }, "prices": { "type": "object", "additionalProperties": { "type": "number" } }, "metals": { "type": "string" }, "count": { "type": "integer" }, "timestamp": { "type": "integer" } }, "required": [ "success", "base", "unit", "date", "prices", "metals", "count", "timestamp" ] } } } }, "503": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 503 }, "type": { "type": "string", "const": "data_unavailable" }, "message": { "type": "string", "const": "No metal prices are available yet." } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/usage": { "get": { "operationId": "rateApi.usage_0", "summary": "This API key's current-month usage vs. its plan quota (all plans)", "tags": [ "RateApi" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "plan": { "type": "string" }, "period": { "type": "string" }, "used": { "type": "integer" }, "limit": { "type": "integer" }, "remaining": { "type": [ "object", "null" ] }, "percent_used": { "type": "number" }, "resets_at": { "type": "string" }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "plan", "period", "used", "limit", "remaining", "percent_used", "resets_at", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/quota": { "get": { "operationId": "rateApi.quota_0", "summary": "Lean quota view - same numbers as \/usage, handy for client SDK guards", "tags": [ "RateApi" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "plan": { "type": "string" }, "limit": { "type": "integer" }, "used": { "type": "integer" }, "remaining": { "type": [ "object", "null" ] }, "resets_at": { "type": "string" }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "plan", "limit", "used", "remaining", "resets_at", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/{apiKey}\/status": { "get": { "operationId": "rateApi.status_0", "summary": "API status and version metadata", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" }, { "type": "object" }, { "type": "string" } ] }, "version": { "type": "string" }, "uptime": { "type": "string" }, "response_time": { "type": "string" }, "last_update": { "type": "string" }, "deprecation_notice": { "type": "null" }, "timestamp": { "type": "integer" } }, "required": [ "success", "status", "version", "uptime", "response_time", "last_update", "deprecation_notice", "timestamp" ] } } } } } } }, "\/v1\/{apiKey}\/latest": { "get": { "operationId": "rateApi.latest_0", "summary": "Latest exchange rates for a base currency (optionally filtered to symbols)", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "timestamp": { "type": "integer" }, "base": { "type": "string" }, "date": { "type": "string" }, "rates": { "type": "object", "additionalProperties": { "type": "number" } } }, "required": [ "success", "timestamp", "base", "date", "rates" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_symbol" }, "message": { "type": "string" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_base_currency" }, "message": { "type": "string", "const": "Invalid base currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } ] } } } } } } }, "\/v1\/{apiKey}\/currencies": { "get": { "operationId": "rateApi.currencies_0", "summary": "List supported currencies with names, symbols and decimal places", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "currencies": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "symbol": { "type": [ "string", "null" ] }, "decimal_places": { "type": "integer" } }, "required": [ "name", "symbol", "decimal_places" ] } }, "total": { "type": "integer" }, "timestamp": { "type": "integer" } }, "required": [ "success", "currencies", "total", "timestamp" ] } } } } } } }, "\/v1\/{apiKey}\/convert": { "get": { "operationId": "rateApi.convert_0", "summary": "Convert an amount from one currency to another (Pro+)", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "query": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "amount": { "type": "number" } }, "required": [ "from", "to", "amount" ] }, "info": { "type": "object", "properties": { "timestamp": { "type": "integer" }, "rate": { "type": "number" } }, "required": [ "timestamp", "rate" ] }, "date": { "type": "string" }, "result": { "type": "number" } }, "required": [ "success", "query", "info", "date", "result" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 404 }, "type": { "type": "string", "const": "rate_not_available" }, "message": { "type": "string", "const": "Conversion rate not available" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_target_currency" }, "message": { "type": "string", "const": "Invalid target currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_source_currency" }, "message": { "type": "string", "const": "Invalid source currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "amount_not_positive" }, "message": { "type": "string", "const": "Amount must be a positive number" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "missing_parameters" }, "message": { "type": "string", "const": "Parameters from, to, and amount are required" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/{apiKey}\/pair\/{from}\/{to}": { "get": { "operationId": "rateApi.pair_0", "summary": "Latest rate for a currency pair (amount-multiplied result is Pro+)", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "to", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "pair": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] }, "rate": { "type": "number" }, "timestamp": { "type": "integer" }, "date": { "type": "string" }, "info": { "type": "object", "properties": { "rate_source": { "type": "string", "const": "live" }, "last_updated": { "type": "string" }, "spread": { "type": "number" } }, "required": [ "rate_source", "last_updated", "spread" ] }, "amount": { "type": "number" }, "result": { "type": "number" } }, "required": [ "success", "pair", "rate", "timestamp", "date", "info", "amount", "result" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 404 }, "type": { "type": "string", "const": "rate_not_available" }, "message": { "type": "string", "const": "Exchange rate not available" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "amount_not_positive" }, "message": { "type": "string", "const": "Amount must be a positive number" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_target_currency" }, "message": { "type": "string", "const": "Invalid target currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_source_currency" }, "message": { "type": "string", "const": "Invalid source currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } ] } } } } } } }, "\/v1\/{apiKey}\/historical": { "get": { "operationId": "rateApi.historical_0", "summary": "Historical rates for a past date (Pro+)", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "historical": { "type": "boolean" }, "date": { "type": "string" }, "base": { "type": "string" }, "rates": { "type": "object", "additionalProperties": { "type": "number" } }, "timestamp": { "type": "integer" } }, "required": [ "success", "historical", "date", "base", "rates", "timestamp" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 404 }, "type": { "type": "string", "const": "no_data_for_date" }, "message": { "type": "string", "const": "No rates stored for that date." } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_base_currency" }, "message": { "type": "string", "const": "Invalid base currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_date" }, "message": { "type": "string", "const": "Invalid date format. Use YYYY-MM-DD" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "missing_parameters" }, "message": { "type": "string", "const": "Date parameter is required" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/{apiKey}\/timeseries": { "get": { "operationId": "rateApi.timeseries_0", "description": "Daily exchange rates for every day from `start_date` to `end_date` (inclusive, at most **366 days**), keyed by date and then by currency code.\nDays with no published rates - weekends, holidays, or dates before a currency's history begins - are left out rather than returned empty.\n\nA non-USD `base` is cross-rated through USD for each day, the same way `\/historical` does, so any base works over the whole range.\nRates are returned as stored for a USD base and to 6 decimals for other bases, unless you pass `precision`.\n\nAvailable on the **Business** and **Enterprise** plans; other plans get `403 feature_not_available`.\nWith `?format=csv` the response is one `date,currency,rate` row per rate.", "summary": "Daily rates for a date range (Business+)", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": true, "description": "First day of the range, `YYYY-MM-DD`.", "schema": { "type": "string", "format": "date" }, "example": "2026-01-01" }, { "name": "end_date", "in": "query", "required": true, "description": "Last day of the range, `YYYY-MM-DD`. On or after `start_date`, and the range may span at most 366 days.", "schema": { "type": "string", "format": "date" }, "example": "2026-01-31" }, { "name": "base", "in": "query", "description": "Base currency code. Defaults to your account base currency (USD unless changed in settings).", "schema": { "type": "string" }, "example": "USD" }, { "name": "symbols", "in": "query", "description": "Comma-separated target currency codes. Omit for every currency.", "schema": { "type": "string" }, "example": "EUR,GBP" }, { "name": "precision", "in": "query", "description": "Round every rate to this many decimals (0-12).", "schema": { "type": "integer" }, "example": 6 } ], "responses": { "200": { "description": "Rates keyed by date, then currency code.", "content": { "application\/json": { "schema": { "type": "object", "examples": [ { "success": true, "timeseries": true, "base": "USD", "start_date": "2026-01-01", "end_date": "2026-01-05", "rates": { "2026-01-02": { "EUR": 0.8534, "GBP": 0.7431 }, "2026-01-05": { "EUR": 0.8551, "GBP": 0.7446 } }, "api_version": "v1", "request_id": "0b7e7c1e-2f7a-4a55-9d3e-0c1f2d3e4f5a", "timestamp": 1767657600 } ], "properties": { "success": { "type": "boolean" }, "timeseries": { "type": "boolean" }, "base": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "rates": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } } }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "timeseries", "base", "start_date", "end_date", "rates", "api_version", "request_id", "timestamp" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 404 }, "type": { "type": "string", "const": "no_data_for_range" }, "message": { "type": "string", "const": "No rates stored for that date range." } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_symbol" }, "message": { "type": "string" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_base_currency" }, "message": { "type": "string", "const": "Invalid base currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "date_range_too_long" }, "message": { "type": "string", "const": "The date range cannot span more than 366 days" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_date_range" }, "message": { "type": "string", "const": "end_date must be on or after start_date" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_date" }, "message": { "type": "string", "const": "Invalid end_date format. Use YYYY-MM-DD" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_date" }, "message": { "type": "string", "const": "Invalid start_date format. Use YYYY-MM-DD" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "missing_parameters" }, "message": { "type": "string", "const": "Parameters start_date and end_date are required" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/{apiKey}\/fluctuation": { "get": { "operationId": "rateApi.fluctuation_0", "description": "How each currency moved between `start_date` and `end_date` (inclusive, at most **366 days**).\n\n`start_rate` is the first published rate on or after `start_date` and `end_rate` the last one on or before `end_date`,\nso a range that starts or ends on a weekend still compares real fixings. `change` is `end_rate - start_rate`\nand `change_pct` is that change as a percentage of `start_rate`, to 4 decimals. A non-USD `base` is cross-rated through USD.\n\nAvailable on the **Business** and **Enterprise** plans; other plans get `403 feature_not_available`.\nWith `?format=csv` the response is one `currency,start_rate,end_rate,change,change_pct` row per currency.", "summary": "How each currency moved over a date range (Business+)", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": true, "description": "First day of the range, `YYYY-MM-DD`.", "schema": { "type": "string", "format": "date" }, "example": "2026-01-01" }, { "name": "end_date", "in": "query", "required": true, "description": "Last day of the range, `YYYY-MM-DD`. On or after `start_date`, and the range may span at most 366 days.", "schema": { "type": "string", "format": "date" }, "example": "2026-01-31" }, { "name": "base", "in": "query", "description": "Base currency code. Defaults to your account base currency (USD unless changed in settings).", "schema": { "type": "string" }, "example": "USD" }, { "name": "symbols", "in": "query", "description": "Comma-separated target currency codes. Omit for every currency.", "schema": { "type": "string" }, "example": "EUR,GBP" }, { "name": "precision", "in": "query", "description": "Round start_rate, end_rate and change to this many decimals (0-12).", "schema": { "type": "integer" }, "example": 6 } ], "responses": { "200": { "description": "Start and end rate, change and percentage change per currency.", "content": { "application\/json": { "schema": { "type": "object", "examples": [ { "success": true, "fluctuation": true, "base": "USD", "start_date": "2026-01-01", "end_date": "2026-01-31", "rates": { "EUR": { "start_rate": 0.8534, "end_rate": 0.8612, "change": 0.0078, "change_pct": 0.914 }, "GBP": { "start_rate": 0.7431, "end_rate": 0.7389, "change": -0.0042, "change_pct": -0.5652 } }, "api_version": "v1", "request_id": "0b7e7c1e-2f7a-4a55-9d3e-0c1f2d3e4f5a", "timestamp": 1769817600 } ], "properties": { "success": { "type": "boolean" }, "fluctuation": { "type": "boolean" }, "base": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "rates": { "type": "object", "additionalProperties": { "type": "object", "properties": { "start_rate": { "type": "number" }, "end_rate": { "type": "number" }, "change": { "type": "number" }, "change_pct": { "type": "number" } }, "required": [ "start_rate", "end_rate", "change", "change_pct" ] } }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "fluctuation", "base", "start_date", "end_date", "rates", "api_version", "request_id", "timestamp" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 404 }, "type": { "type": "string", "const": "no_data_for_range" }, "message": { "type": "string", "const": "No rates stored for that date range." } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_symbol" }, "message": { "type": "string" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_base_currency" }, "message": { "type": "string", "const": "Invalid base currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "date_range_too_long" }, "message": { "type": "string", "const": "The date range cannot span more than 366 days" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_date_range" }, "message": { "type": "string", "const": "end_date must be on or after start_date" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_date" }, "message": { "type": "string", "const": "Invalid end_date format. Use YYYY-MM-DD" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_date" }, "message": { "type": "string", "const": "Invalid start_date format. Use YYYY-MM-DD" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "missing_parameters" }, "message": { "type": "string", "const": "Parameters start_date and end_date are required" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/{apiKey}\/crypto": { "get": { "operationId": "rateApi.crypto_0", "summary": "Cryptocurrency prices (Pro+). Served from crypto_rates; USD-based", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "base": { "type": "string", "const": "USD" }, "rates": { "type": "string" }, "crypto": { "type": "string" }, "count": { "type": "integer" }, "last_update": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "base", "rates", "crypto", "count", "last_update", "timestamp" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/{apiKey}\/stocks": { "get": { "operationId": "rateApi.stocks_0", "summary": "Stock closes (Pro+). Served from stock_prices; USD-based", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "base": { "type": "string", "const": "USD" }, "date": { "type": "string" }, "prices": { "type": "string" }, "stocks": { "type": "string" }, "count": { "type": "integer" }, "timestamp": { "type": "integer" } }, "required": [ "success", "base", "date", "prices", "stocks", "count", "timestamp" ] } } } }, "503": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 503 }, "type": { "type": "string", "const": "data_unavailable" }, "message": { "type": "string", "const": "No stock prices are available yet." } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/{apiKey}\/metals": { "get": { "operationId": "rateApi.metals_0", "summary": "Precious-metal prices per troy ounce (Pro+). Served from metal_prices; USD-based", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "base": { "type": "string", "const": "USD" }, "unit": { "type": "string", "const": "troy ounce" }, "date": { "type": [ "string", "null" ] }, "prices": { "type": "object", "additionalProperties": { "type": "number" } }, "metals": { "type": "string" }, "count": { "type": "integer" }, "timestamp": { "type": "integer" } }, "required": [ "success", "base", "unit", "date", "prices", "metals", "count", "timestamp" ] } } } }, "503": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 503 }, "type": { "type": "string", "const": "data_unavailable" }, "message": { "type": "string", "const": "No metal prices are available yet." } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/{apiKey}\/usage": { "get": { "operationId": "rateApi.usage_0", "summary": "This API key's current-month usage vs. its plan quota (all plans)", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "plan": { "type": "string" }, "period": { "type": "string" }, "used": { "type": "integer" }, "limit": { "type": "integer" }, "remaining": { "type": [ "object", "null" ] }, "percent_used": { "type": "number" }, "resets_at": { "type": "string" }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "plan", "period", "used", "limit", "remaining", "percent_used", "resets_at", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/{apiKey}\/quota": { "get": { "operationId": "rateApi.quota_0", "summary": "Lean quota view - same numbers as \/usage, handy for client SDK guards", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "plan": { "type": "string" }, "limit": { "type": "integer" }, "used": { "type": "integer" }, "remaining": { "type": [ "object", "null" ] }, "resets_at": { "type": "string" }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "plan", "limit", "used", "remaining", "resets_at", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/{apiKey}\/alerts": { "get": { "operationId": "rateApi.alertsIndex", "summary": "List the key owner's rate alerts (Business+)", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "alerts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "from": { "type": "string" }, "to": { "type": "string" }, "direction": { "type": "string" }, "threshold": { "type": "number" }, "notify_url": { "type": [ "string", "null" ] }, "secret": { "type": [ "string", "null" ], "description": "Additive: lets the customer verify X-RateApi-Signature on the callback." }, "status": { "type": "string" }, "triggered_at": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "from", "to", "direction", "threshold", "notify_url", "secret", "status", "triggered_at", "created_at" ] } }, "count": { "type": "integer", "minimum": 0 }, "timestamp": { "type": "integer" } }, "required": [ "success", "alerts", "count", "timestamp" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } }, "post": { "operationId": "rateApi.alertsStore", "summary": "Create a rate alert (Business+). Fires by email + optional webhook when the rate crosses the threshold", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "threshold": { "type": "string" }, "notify_url": { "type": "string" } } } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "alert": { "type": "object", "properties": { "id": { "type": "integer" }, "from": { "type": "string" }, "to": { "type": "string" }, "direction": { "type": "string" }, "threshold": { "type": "number" }, "notify_url": { "type": [ "string", "null" ] }, "secret": { "type": [ "string", "null" ], "description": "Additive: lets the customer verify X-RateApi-Signature on the callback." }, "status": { "type": "string" }, "triggered_at": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "from", "to", "direction", "threshold", "notify_url", "secret", "status", "triggered_at", "created_at" ] }, "timestamp": { "type": "integer" } }, "required": [ "success", "alert", "timestamp" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_notify_url" }, "message": { "type": "string", "const": "notify_url must be a public http(s) URL" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_threshold" }, "message": { "type": "string", "const": "Threshold must be a positive number" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_direction" }, "message": { "type": "string", "const": "Direction must be 'above' or 'below'" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_target_currency" }, "message": { "type": "string", "const": "Invalid target currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 400 }, "type": { "type": "string", "const": "invalid_source_currency" }, "message": { "type": "string", "const": "Invalid source currency" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } }, "\/v1\/{apiKey}\/alerts\/{id}": { "delete": { "operationId": "rateApi.alertsDestroy", "summary": "Delete one of the key owner's rate alerts (Business+)", "tags": [ "RateApi" ], "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "const": "Alert deleted" }, "timestamp": { "type": "integer" } }, "required": [ "success", "message", "timestamp" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 404 }, "type": { "type": "string", "const": "alert_not_found" }, "message": { "type": "string", "const": "Alert not found" } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": "object", "properties": { "code": { "type": "integer", "const": 403 }, "type": { "type": "string", "const": "feature_not_available" }, "message": { "type": "string", "enum": [ "Currency conversion requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Historical rates require the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Cryptocurrency data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Stock data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Precious-metal data requires the Pro plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Time-series data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Fluctuation data requires the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "Rate alerts require the Business plan or higher \u2014 upgrade your account at rate-api.com\/pricing", "This feature is not available on your plan \u2014 upgrade at rate-api.com\/pricing" ] } }, "required": [ "code", "type", "message" ] }, "api_version": { "type": "string" }, "request_id": { "type": "string" }, "timestamp": { "type": "integer" } }, "required": [ "success", "error", "api_version", "request_id", "timestamp" ] } } } } } } } } }