Skip to navigation
API ReferenceChanges

Read a game's change stream

The same changes the WebSocket stream game:<id> carries, after a seq, oldest first. Poll it with the last seq you applied. A game’s stream stays readable for at least 7 days after the game ends; after that, or when after_seq is older than what is retained, it returns 410 with code resync_required, and the client fetches the game again.

Authentication

AuthorizationBearer

An API key, sent as Authorization: Bearer <key>.

Path parameters

leaguestringRequiredformat: "^[a-z][a-z0-9]*$"
The league's alias.
game_idstringRequiredformat: "uuid"

Query parameters

after_seqlongRequired>=0
The last seq the client applied, or 0 for the start.
limitintegerOptional1-1000Defaults to 500
Page size.

Response headers

RateLimit-PolicystringOptional

Your plan’s allowance: q requests per period of w seconds. See Rate limits.

RateLimitstringOptional

Requests left this period after this response (r) and seconds until it resets (t). See Rate limits.

Response

The next changes, and where the stream stands.
streamstringformat: "^(game:[0-9a-f-]{36}|league:[a-z][a-z0-9]*)$"

game:<game id> carries one game: the game, its live state, game roster, play groups, plays and stats. league:<alias> carries the league’s shared data: teams, players, venues, seasons and weeks, plus rosters, injuries, transactions and depth charts.

datalist of objects
head_seqlong>=0

The stream’s last seq visible to this plan. Fewer changes than limit and the last one at head_seq means caught up.

min_seqlong>=0
The oldest seq the stream still holds.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
410
Gone Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error