API Reference

XBuddy exposes a REST API at https://api.xbuddy.co/api/v1.

All endpoints require authentication via JWT Bearer token.

Base URL

https://api.xbuddy.co/api/v1

Authentication

See Authentication →

Rate limits

Response format

All responses follow this structure:

{
  "success": true,
  "data": { ... },
  "message": "Operation completed"
}

Paginated responses:

{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 243,
    "pages": 5
  }
}

Error responses

{
  "success": false,
  "error": "Unauthorized",
  "statusCode": 401
}

Common status codes:

• 200 — OK
• 201 — Created
• 400 — Bad Request (validation error)
• 401 — Unauthorized
• 403 — Forbidden (quota exceeded or module not active)
• 404 — Not Found
• 429 — Rate limit exceeded