API Reference

The Running Days API is a RESTful service built with Fastify 5. All endpoints return JSON and use standard HTTP status codes.

Base URL

https://api.running-days.app/api/v1

For local development:

http://localhost:3000/api/v1

Authentication

All authenticated endpoints require a valid JWT token. See Authentication for details on obtaining tokens.

Authorization: Bearer <access_token>

Or via httpOnly cookies (automatically set by the auth flow).

API Sections

Common Response Formats

Success Response

{
  "success": true,
  "data": { ... }
}

Error Response

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Validation failed"
}

Rate Limiting

API requests are rate limited per user:

Rate limit headers are included in responses:

• X-RateLimit-Limit: Maximum requests allowed
• X-RateLimit-Remaining: Requests remaining
• X-RateLimit-Reset: Unix timestamp when limit resets

OpenAPI Documentation

Interactive API documentation is available at:

GET /api/v1/docs

Error Codes