Getting started
Quickstart
freeFirst request in 60 seconds.
First request in 60 seconds.
- 01
Create an account. Free tier, no credit card.
- 02
Open API Keys in your dashboard and copy your key. It looks like
sk_live_…(orsk_test_…for sandbox testing). - 03
Set the key in your shell, then make your first request — list every competition:
shell export STATSHAWK_KEY="sk_live_YOUR_KEY_HERE"competitions.sh curl -H "X-API-Key: $STATSHAWK_KEY" \ https://api.statshawk.ai/v1/competitionsExpected response (truncated):
response { "data": { "items": [ { "id": "comp_2r9wq7k3", "slug": "nba", "name": "National Basketball Association", "sport": "Basketball", "kind": "DomesticClub" } ], "total": 12 }, "meta": { "request_id": "550e8400-e29b-41d4-a716-446655440000", "fetched_at": "2025-01-01T00:00:00Z", "cache": "HIT", "version": "v1" } }
Next steps
- Authentication — key format, live vs test, revocation
- Quotas — what counts as a unit and plan limits
- REST API reference — every endpoint, with a try-it playground