Skip to content

Finance API endpoint reference.

Endpoints

GET /health

Check if the API is running.

Response:

{
"status": "ok"
}

GET /api/protected

Example protected endpoint requiring subscription and auth token.

Headers:

  • Authorization: Bearer <token>
  • X-Subscription-Status: active

Response:

{
"message": "You have accessed a protected endpoint",
"token": "tkn****"
}

Error Codes

StatusMeaning
401Missing or invalid auth token
403Active subscription required
500Internal server error