Skip to content

Practical shooting help

Public API — reference

← All guides

Integrate your system with Orbit through the REST API: read the entity configuration, manage athletes, Matches, divisions, Stages, Squads, ROs and registrations, get the public URLs and read the full results in JSON. Every resource is addressed by a stable, opaque identifier that is safe to expose.

This is the practical shooting reference. The clay target and precision shooting modules have their own APIs, with the same entity key and the same limits. See the APIs of all three sports.

Getting started

  1. In the entity dashboard, open API keys (owner only) and create a key with the desired permission — read or read-write.
  2. Store the secret: it is shown only once. If you lose it, regenerate the key.
  3. Send on every request the header Authorization: Bearer <access_key>.<secret>.
All access is limited to your entity data, with a per-key rate limit (X-RateLimit-* headers).
Required fields are defined by your entity. Which data the athlete must provide (email, CPF, RG, CR/expiry and additional fields) — and which are unique — is up to you, on the entity screen under Athletes → Configure fields. Before creating athletes or registrations, check GET /entidade: the requisitos_inscricao block returns exactly what is required and unique for your entity.
Do you make or distribute a shot timer? Today the system connects right in the browser to Special Pie (SP M1A2 and M1A2-F) and Shooters Global (SG Timer, SG Timer 2 and SG Timer GO), and new timer integrations are considered case by case — from the Bluetooth protocol to posting shots through the API. Get in touch.

Interactive reference

Explore and try the endpoints below (Swagger UI). The OpenAPI specification JSON is at openapi.json.