External API: basics

How to work with Budgeter External API: base URL, authentication, getting an API key, limits, and response format.

Download Postman collection (External API)

All methods (accounts, etc.) without key — add your key in collection variables.

Budgeter External API is a server-to-server API for integrations. Access is by API key (X-Api-Key header).

Base URL

  • Production: https://api-external.budgeter.online

Where to get the API key

In the web app: Settings → Integrations → API Keys. Create a key and copy it immediately — the raw key is shown only once. Keep it secret.

Authentication

Send the key in the header:

X-Api-Key: <your_api_key>

Request format

All methods use POST. Body is JSON:

{
  "meta": { "requestId": "optional-uuid", "locale": "optional" },
  "data": { ... }
}

Response format (success)

Response includes success: true, data, and meta (requestId, serverTime, executionTimeMs, project, rateLimit).

Error codes

INVALID_API_KEY / API_KEY_REVOKED (401), FORBIDDEN_SCOPE / API_KEY_TEMPORARILY_BLOCKED (403), RATE_LIMIT_EXCEEDED (429, use Retry-After header), VALIDATION_ERROR (400), RESOURCE_NOT_FOUND (404), INTERNAL_ERROR (500).

Rate limits (MVP)

  • 120 requests/minute

  • 3000/hour, 30000/day, 600000/month

  • Mutating operations (create/update/delete): 60/minute

On exceed: HTTP 429 and Retry-After header (seconds).

See also

API: Accounts — list, get, create, update, delete accounts.

wiki.ratingPrompt

0 (0 оценок)