API Reference

Complete REST API reference for Banatie. All endpoints, parameters, and response formats.

Base URL

Base URL
https://api.banatie.app

Authentication

All endpoints require the X-API-Key header:

Header
X-API-Key: your_api_key_here

See Authentication for details on obtaining and using API keys.

Response Format

All responses follow a consistent JSON structure:

Success Response:

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

Error Response:

Error
{
  "success": false,
  "error": {
    "message": "Error description",
    "code": "ERROR_CODE"
  }
}

Paginated Response:

Paginated
{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "total": 100,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  }
}

Common Error Codes

Status
Code
Description
400VALIDATION_ERRORMissing or invalid parameters
401UNAUTHORIZEDMissing or invalid API key
404*_NOT_FOUNDRequested resource not found
409ALIAS_CONFLICTAlias already exists
429RATE_LIMIT_EXCEEDEDToo many requests
500INTERNAL_ERRORServer error

Rate Limits

API requests are rate limited to 100 requests per hour per API key.

Rate limit headers are included in every response:

Header
Description
X-RateLimit-LimitMaximum requests per hour
X-RateLimit-RemainingRequests remaining in current window
X-RateLimit-ResetUnix timestamp when limit resets

Endpoints

Next Steps