The snapshot schema depends on the sport. Always branch on the
sport field. This page documents the soccer snapshot first, then the cricket snapshot (which has a completely different shape — no clock, phase, stats, or events; instead an innings score, batting/bowling cards, a current-over ticker, and a per-innings scorecard). Other sports will follow over time; treat unknown fields as optional.Used by
GET /matches/{id}/live— returns the snapshot directlyGET /matches/{id}/result— returns the snapshot ashalf_timeandfull_timeobjects- WebSocket
snapshotandupdateframes — the snapshot is thedatafield
The soccer live snapshot object
Returned with"sport": "soccer".
Top-level fields
Schema version. Currently
1.Your match id. Present on WebSocket frames for multiplexing; omitted on REST responses.
Upstream reference ids. Clients can usually ignore this object.
"soccer".League or competition name, e.g.
"USA MLS Next Pro League".Home team name.
Away team name.
Current match state:
live, ht (half-time), ft (full-time), or not_started.Current score as
{"home": int, "away": int}.Map of stat key →
{"home": int, "away": int}. See Statistics.Last event-anchored ball position on the pitch. See Ball Position.
When this snapshot was produced, in ISO 8601 UTC.
Clock
Displaying a live timer
minute:second is the clock as of as_of, not as of right now. How you turn it into a ticking timer depends on which surface you read from:
-
REST (
GET /matches/{id}/live) — the server projects the clock forward to request time before responding. Whenrunningistrue,minute:secondis already current andas_ofis set to the response time. Displayminute:secondas-is. -
WebSocket
snapshotandupdateframes — frames carry the clock as of the last provider update, so consumers must advance it themselves between frames. Whilerunningistrue:Whenrunningisfalse(half-time, full-time, stoppages), do not project — displayminute:secondas-is. A new frame will reset the anchor when play resumes.
1H → HT → 2H) always arrive in a real frame, so the projected value can run uncapped through stoppage time and snaps back if the provider pauses silently.
Phase
The phase object describes what is happening on the pitch right now.Full soccer example
The cricket live snapshot object
Returned with"sport": "cricket" from the same surfaces as the soccer snapshot — GET /matches/{id}/live and the WebSocket data field. The shape is different: an innings score, the batting and bowling cards, a current-over ticker, the last decoded incident, and a full per-innings scorecard. There is no clock, phase, stats, events, or ball.
Reading a cricket snapshot
The payload has two layers — a quick-glance live state and the full card:- Live, at a glance (top level):
score(the current innings total),over(the over in progress),batsmen(the two at the crease),bowler(current spell), andlast_event. This is everything you need for a compact live scoreboard — e.g. “West Indies 138/3 (40.1) — Jangoo 20*, Da Silva 12* — Dinusha 9-0-25-1”. - Full detail (
scorecard): every innings of the match in order, each with its complete batting and bowling cards, fall of wickets, and an over-by-over breakdown (overs: runs in that over plus cumulative score — the data behind a worm or run-rate graph). Use this for a full scorecard view.
score/batsmen/bowler/over describe the same innings that is flagged "live": true in scorecard. They come from two separate provider feeds, so they can differ by a ball or two for a moment; the next frame reconciles them. scorecard is omitted until the match is live mid-session — limited-overs games have up to two innings, a Test up to four.
Multi-day Tests. Between days a Test is at stumps: the live snapshot freezes at the last ball — no new frames until play resumes the next day — and the catalog match object’s
status becomes CLOSE_OF_PLAY (see Match status values), so the match stays visible in /matches and /matches/live rather than disappearing overnight. The snapshot’s own status (below) is the in-play state and is distinct from that catalog lifecycle status.Top-level fields
Your match id. Present on WebSocket frames.
"cricket".Competition or match name, e.g.
"West Indies vs Sri Lanka - 1st Test".Home team name.
Away team name.
Current match state:
not_started, live, innings_break, stopped (rain, bad light, tea, …), or ended.Format:
test, t20, one_day (50-over), the_hundred, or limited_overs (overs not yet known).Current innings number.
Side at the crease:
"home" or "away".The batting side’s innings score. See Cricket score below.
Raw score string from the provider; for a multi-innings match it may carry prior innings too.
The decoded last incident. See Last event below.
Full per-innings card (all innings, in order). See Scorecard below. Omitted until the match is live mid-session.
When this snapshot was produced, in ISO 8601 UTC.
Cricket score
The batting side’s current innings total.Over
Ticker for the over in progress.Batsman
Each entry inbatsmen describes one of the two batters at the crease.
Bowler
The current bowler’s spell figures.Scorecard
scorecard is an array of innings — every innings of the match, in order. The live innings is flagged with "live": true; finished innings carry their final figures; innings yet to bat are present but omit score.
Last event
The decoded last incident on the field.Full cricket example
The
batting and bowling arrays above are trimmed to one or two rows for brevity; a real innings carries every batter and bowler.Appendix: enumerations
Snapshotsport: soccer, cricket. Other sports may appear in future — branch on this field.
Snapshot status — soccer: not_started, live, ht, ft.
Snapshot status — cricket: not_started, live, innings_break, stopped (rain, bad light, tea, …), ended.
Cricket match_type: test, t20, one_day (50-over), the_hundred, limited_overs (overs not yet known).
Clock period (soccer): 1H, 2H, HT, FT (and similar period codes).
Event type (soccer): goal, corner, yellow_card, red_card, penalty, substitution, event.
Common soccer stat keys: shots_on_target, shots_off_target, attacks, dangerous_attacks, possession, corners, yellow_cards, red_cards.
Cricket last_event.label is drawn from the provider’s incident table, e.g. runs, bye, wide, no ball, wicket, bowled, LBW, caught, stumped, run out, bowling, maiden over, end of over, duck, century, review, innings break, match ended.
Catalog match status (for the match object, not the live snapshot): NOT_STARTED, STARTED, CLOSE_OF_PLAY (multi-day cricket Test between days), FINISHED.