API Reference
Complete REST API reference for Banatie. All endpoints, parameters, and response formats.
Base URL
Base URL
https://api.banatie.appAuthentication
All endpoints require the X-API-Key header:
Header
X-API-Key: your_api_key_hereSee 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 |
|---|---|---|
400 | VALIDATION_ERROR | Missing or invalid parameters |
401 | UNAUTHORIZED | Missing or invalid API key |
404 | *_NOT_FOUND | Requested resource not found |
409 | ALIAS_CONFLICT | Alias already exists |
429 | RATE_LIMIT_EXCEEDED | Too many requests |
500 | INTERNAL_ERROR | Server 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-Limit | Maximum requests per hour |
X-RateLimit-Remaining | Requests remaining in current window |
X-RateLimit-Reset | Unix timestamp when limit resets |