border.bot
Docs menu

API reference

API reference

A bulk run’s results

GET https://api.border.bot/v1/bulk/results

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

The answers so far, in item order, up to 1,000 at a time (next is the following page’s offset). Each is exactly what its single endpoint returns, or the error it failed with.

API key scope: bulk.

Parameters#

Name Type Required Description
id string yes
offset integer | null no
limit integer no

Responses#

  • 200: A page of results. (BulkResultsResponse)
  • 400: Invalid input (invalid_input). (Error)
  • 401: Missing, invalid, revoked or expired API key (unauthorized). (Error)
  • 403: The API key doesn’t have the bulk 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/bulk/results' \
  -H 'Authorization: Bearer bb_live_...'