Statyx API documentation

Introduction

The Statyx API is a read-only HTTPS/JSON API. The base URL for all requests is:

https://api.statyx.io/v1

Every response uses a consistent envelope: a data payload plus a meta object with echoed filters and pagination.

Advanced capabilities

Beyond raw feeds: the computed analytics behind the Statyx product, exposed as first-class endpoints. Everything is source-neutral and keyed by stable Statyx ids.

Authentication

Pass your key in the x-api-key header on every request. Keys are stored hashed and scoped to your tier.

# Your first request
curl https://api.statyx.io/v1/nba/players \
  -H "x-api-key: sk_live_••••••••••••"

Responses & errors

List endpoints return { data, meta }. Errors always use one shape, with an HTTP status and a stable code:

// success
{ "data": [ … ], "meta": { "limit": 50, "offset": 0 } }

// error
{ "error": { "code": "VALIDATION_ERROR", "message": "Invalid query", "details": { … } } }

Common codes: VALIDATION_ERROR (422), UNAUTHORIZED (401), FORBIDDEN (403, missing scope), RATE_LIMITED (429), NOT_FOUND (404).

Pagination

List endpoints accept limit and offset query parameters. The applied values are echoed back in meta so you can page deterministically.

GET /v1/nfl/players?limit=25&offset=50

Rate limits & scopes

Requests are rate-limited per key; every response carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset headers. Each endpoint requires a scope, granted by your tier: