Glossary

A — F

Analysis card  ·  A composed response that pre-computes game-log values, an average, and optional hit rate for a single person + stat + line. The /analysis/* endpoints return these. Weight 10×.

Box score  ·  The per-appearance stat lines for a contest. Each appearance carries typed phase blocks (basketball_player_game, batting, pitching, etc.) rather than a raw stats blob.

Capability  ·  A competition's advertised measure and phase surface. See /v1/competitions/{comp}/capabilities before assuming a 501 NOT_SUPPORTED.

Envelope  ·  The { data, meta } wrapper around every successful response, and the { error } body returned for errors. Same success shape every time, every endpoint.

H — L

Hit rate  ·  The fraction of in-scope games where a person exceeded a given stat line. 0.7 means seven of every ten included games were over the line.

Live key  ·  An API key prefixed sk_live_. Counts against your monthly unit quota and is rate-limited.

M — Q

Meta  ·  The trailing object on every response. Carries request_id, fetched_at, cache (HIT, MISS, or STALE, see the cache contract), version, and an optional source: where the data was served from (e.g. postgres, registry) when the endpoint reports it.

Prefix  ·  The first 16 characters of a key (sk_live_ + 8 chars). Non-secret: shown in the dashboard, in this docs banner, and in support tickets. The remainder of the key is unrecoverable.

R — Z

Request ID  ·  A UUID returned in meta.request_id on every response. Include this in support tickets: it's the fastest way to pull the trace.

Test key  ·  An API key prefixed sk_test_, for separating sandbox traffic from production traffic in your own logs and key rotation. Test keys authenticate, meter, and rate-limit exactly like live keys.

Tier  ·  Your billing plan: free, hobby, pro, scale, growth, or enterprise. Endpoints document tier gating via x-requires-tier (any or paid, /v1/analysis/* requires a paid plan).

Unit  ·  The metering currency. Endpoint weights run 1×–10× (lookups and odds discovery 1×, spot odds boards 5×, history pages and analysis cards 10×). Your monthly quota is denominated in units. See Quotas.

Weight  ·  The multiplier applied to a single call when computing units consumed. Posted as x-statshawk-weight in the OpenAPI spec and documented in Auth & Quotas. Lookups 1×, current odds boards 5×, history pages and analysis 10×.