REST API reference
Every Statshawk endpoint, with a try-it playground. Auto-generated from the OpenAPI spec.
The Statshawk REST API is normalized across NBA, MLB, NFL, NHL, KBO, NCAA, and major soccer competitions. One REST API key, source-agnostic ids, and one shape per concept: persons, teams, competitions, editions, contests, analysis, and assets.
Player injury availability and history ride the persons, teams, and analysis resources. See Injuries for what is covered and the rules for reading it, since an absent injury field only means healthy inside a source's coverage window.
Conventions
- Base URL:
https://api.statshawk.ai - REST auth:
X-API-Key: sk_test_...orX-API-Key: sk_live_...header, see Authentication - Response envelope: every endpoint returns
{ "data": ..., "meta": { request_id, fetched_at, cache, version, source? } }.sourceis optional and, when present, names where the data was served from (e.g.postgres,registry) - Errors:
{ "error": { "code": "...", "message": "..." } }, see Errors - Quotas: unit-based, not per-second, see Quotas
Try it from the docs
Every REST endpoint page has a built-in playground. Sign in and your REST API key prefix surfaces in a banner above the playground; paste the full REST API key once and run requests directly from the docs.
Browse by tag
Use the sidebar to navigate by tag (Persons, Teams, Competitions, Contests, Analysis, Assets). Each tag groups the endpoints that share a resource shape.