API Reference

The Element API exposes shot data and device state so you can pull Element into your own software — a simulator, a fitting tool, a practice app, or your own analytics.

DRAFT

The shapes on these pages are placeholders. Replace them with the real contract before publishing.

Base URL

TODO: https://api.example.com/v1

Authentication

TODO: Document the scheme (API key, OAuth, local device token) and how to obtain credentials.

Authorization: Bearer <token>

Transports

Transport	Use it for
HTTP	Fetching sessions and past shots
Streaming (WebSocket / SSE — TODO)	Reacting to shots live as they're hit

Conventions

• All responses are JSON.
• Timestamps are ISO 8601 in UTC.
• Units: TODO — state the default unit system and whether it's configurable.

Errors

TODO: Error envelope and the status codes callers should handle.

{
  "error": {
    "code": "TODO",
    "message": "TODO"
  }
}

Rate limits

TODO

Where to go next

• Shot Data Model — every field on a shot
• Endpoints — the available operations