Health
The Health API provides a comprehensive health check endpoint to monitor the operational status of the Paper API and all its dependencies. Use this endpoint for monitoring, alerting, and load balancing.
Overview
The health check endpoint provides real-time status information about all critical system components. No authentication is required, making it accessible for monitoring tools and load balancers.
API Endpoints Overview
| Endpoint | Method | Description |
|---|---|---|
/v1/health | GET | Get comprehensive health status of all services |
Get Health Status
Check the health status of the Paper API. This endpoint does not require authentication and returns a simplified response for security.
Request
GET
/v1/healthcurl -X GET https://api.paperinvest.io/v1/health
Healthy Response
Response
200 OK
{
"status": "ok",
"timestamp": "2025-01-15T14:30:00.000Z"
}
Unhealthy Response
Response
503 Service Unavailable
{
"status": "error",
"timestamp": "2025-01-15T14:30:00.000Z"
}
Response Fields
| Field | Type | Description |
|---|---|---|
status | String | Health status: "ok" when healthy, "error" when unhealthy |
timestamp | String | ISO 8601 timestamp of the health check |
Status Codes
| Status Code | Description |
|---|---|
200 OK | All critical services are healthy |
503 Service Unavailable | One or more critical services are unhealthy |
See Also
- Status Codes - For understanding API status codes
- Rate Limiting - For API rate limits and best practices