Skip to main content
GET
API Status

Overview

The status endpoint provides real-time information about the API’s operational status and data freshness. This endpoint is public and doesn’t require authentication.
This endpoint is perfect for health checks and monitoring integrations. It’s unlimited and cached at the edge for optimal performance.

Request

Response

string
required
Current operational status of the APIPossible values:
  • operational - API is fully functional
  • degraded - API is experiencing issues but functional
  • outage - API is experiencing a full outage
string
required
ISO 8601 timestamp of when RBA data was last successfully fetched and processed
boolean
required
Indicates if the current data is stale (older than expected)
  • false - Data is fresh (within expected timeframe)
  • true - Data is stale (RBA update may have failed)
string
required
ISO 8601 timestamp of when the next RBA data update is expected (4 PM AEST next business day)

Status Codes

Data Freshness

The Exchange Rates API fetches RBA data daily at 4:00 PM AEST. The stale field helps you understand data freshness:

Fresh Data (stale: false)

  • Last update was within expected timeframe (within 26 hours of last business day 4 PM AEST)
  • RBA data fetch was successful
  • All systems operating normally

Stale Data (stale: true)

  • Last update was longer ago than expected (over 26 hours)
  • May indicate RBA website issues or weekend/holiday delay
  • Data is still valid but older than usual
  • Additional headers will be present on rate endpoints:
    • X-Data-Stale: true
    • X-RBA-Source-Date: YYYY-MM-DD

Monitoring Integration

Health Check Example

Nagios/Zabbix Integration

Response Headers

The status endpoint returns Cache-Control: no-store to ensure you always get current status information rather than cached responses.

Use Cases

Application Health Checks

Monitor your application’s dependency on the Exchange Rates API:

Status Page Integration

Display API status on your own status page:

Scheduled Monitoring

Set up automated monitoring to track API reliability:

Error Responses

While the status endpoint is highly reliable, it may occasionally return errors:
In such cases, you should assume the API may be experiencing issues and implement appropriate fallback logic in your applications.

Response

API status information

status
enum<string>
required

Current API status

Available options:
operational,
degraded
last_update
string
required

Last successful data update timestamp or 'unknown'

stale
boolean
required

Whether the data is considered stale

next_update_expected
string
required

ISO 8601 timestamp of when next RBA update is expected