border.bot
Docs menu

API reference

API reference

Credit balance

GET https://api.border.bot/v1/credits

Requires an API key (Authorization: Bearer bb_live_…).

Current balance, lifetime totals and the 20 most recent ledger entries (purchases, usage, refunds).

API key scope: account.

Responses#

  • 200: Balance and recent ledger. (CreditsResponse)
  • 401: Missing, invalid, revoked or expired API key (unauthorized). (Error)
  • 403: The API key doesn’t have the account scope (forbidden, details.reason: "missing_scope"). (Error)
  • 429: Rate limited (rate_limited). Retry after Retry-After seconds; RateLimit says which limit was hit (r=0, t seconds until its window ends) and RateLimit-Policy its quota. (Error)
  • 500: Unexpected error (internal). (Error)

Example#

bash
curl -X GET 'https://api.border.bot/v1/credits' \
  -H 'Authorization: Bearer bb_live_...'