border.bot
Docs menu

API reference

API reference

Catalogue vocabularies

GET https://api.border.bot/v1/catalog/terms

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

The harmonised codes catalogue fields take: materials, material origins (by stage), attributes (dangerous goods, restricted), categories, origin bases and quantity units. Free.

API key scope: catalog.

Parameters#

Name Type Required Description
vocabulary "material" | "material_origin" | "attribute" | "category" | "origin_basis" | "quantity_unit" no

Responses#

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