Reference
Error Handling
On this page
Error Format
When the API rejects a request, it returns "success": false and an error object. The error object is based on the RFC 7807 Problem Details format and adds a machine-readable code. The response has the Content-Type: application/problem+json header.
{
"success": false,
"error": {
"type": "https://rateflowapi.com/errors/invalid-api-key",
"code": "INVALID_API_KEY",
"title": "Invalid API Key",
"status": 401,
"detail": "The API key provided is missing or invalid."
}
}
| Field | Description |
|---|---|
success |
Always false for an error |
error.type |
A URI that identifies the error type |
error.code |
A stable, machine-readable code in UPPER_SNAKE_CASE. Use this field in your error handling |
error.title |
A short human-readable summary |
error.status |
The HTTP status code |
error.detail |
A detailed explanation of this specific error |
Error Codes
| Error Type | Code | HTTP Status | Description |
|---|---|---|---|
invalid-api-key |
INVALID_API_KEY |
401 | API key is missing or invalid |
inactive-account |
INACTIVE_ACCOUNT |
403 | Account is blocked, API key is deactivated, or email is not verified |
plan-upgrade-required |
PLAN_UPGRADE_REQUIRED |
403 | The requested feature is not available on your current plan (e.g. historical data on a Free plan) |
unsupported-currency |
UNSUPPORTED_CURRENCY |
422 | The currency code is not recognized |
invalid-date |
INVALID_DATE |
422 | The date format is invalid or the date is in the future |
invalid-amount |
INVALID_AMOUNT |
422 | The amount is not a number, or it is not greater than 0 and at most 1,000,000,000,000 |
no-data-available |
NO_DATA_AVAILABLE |
404 | No exchange rate data is available for the requested date or currency pair |
quota-reached |
QUOTA_REACHED |
429 | The per-minute request limit has been reached. Includes a Retry-After header |
quota-exceeded |
QUOTA_EXCEEDED |
429 | The monthly request quota has been used up. Includes a Retry-After header |
service-unavailable |
SERVICE_UNAVAILABLE |
503 | The API is temporarily unavailable for maintenance. Includes a Retry-After header |