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
Current operational status of the APIPossible values:
operational
- API is fully functionaldegraded
- API is experiencing issues but functionaloutage
- API is experiencing a full outage
ISO 8601 timestamp of when RBA data was last successfully fetched and processed
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)
ISO 8601 timestamp of when the next RBA data update is expected (4 PM AEST next business day)
Status Codes
Status | Description |
---|---|
operational | All systems functioning normally |
degraded | Minor issues detected, API still functional |
outage | Major issues, API may not be functioning |
Data Freshness
The Exchange Rates API fetches RBA data daily at 4:00 PM AEST. Thestale
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:Response
API status information
The response is of type object
.