For the complete documentation index, see llms.txt. This page is also available as Markdown.

Fixture includes reference

This page documents the response shape for fixture includes that aren't covered by their own dedicated tutorial. Use it alongside the Fixture entity page when you need to know exactly what comes back for a specific include.

Timeline

What it returns

include=timeline returns a curated subset of in-match events, not the full events feed. Based on live testing, timeline entries currently cover:

type_id

Event

126

Corner

569

Shot On Target

570

Shot Off Target

1514

Offside

This list reflects what was observed on a single tested fixture and may not be exhaustive across all leagues or match states. If you need the full authoritative list of timeline type_ids, cross-check against /core/types filtered to the types above, or reach out and we'll expand this table.

For goals, cards, and substitutions, use the Events include instead, timeline and events are separate, non-overlapping includes.

Example response

{
  "id": 157432869,
  "fixture_id": 19714695,
  "period_id": 7032992,
  "participant_id": 73,
  "type_id": 126,
  "section": "timeline",
  "player_id": null,
  "related_player_id": null,
  "player_name": null,
  "related_player_name": null,
  "result": null,
  "info": null,
  "addition": "1st Corner",
  "minute": 12,
  "extra_minute": null,
  "injured": null,
  "on_bench": false,
  "coach_id": null,
  "sub_type_id": null,
  "detailed_period_id": 7032992,
  "rescinded": null,
  "sort_order": 1
}

Field descriptions

Field
Type
Description

id

integer

Unique identifier for this timeline entry

fixture_id

integer

The fixture this entry belongs to

period_id

integer

The period (half, extra time, etc.) this entry occurred in

participant_id

integer

The team this entry is attributed to

type_id

integer

The event type, see table above

section

string

Always "timeline" for this include

player_id / related_player_id

integer

Player(s) involved, null for team-level entries like corners

addition

string

Human-readable ordinal label (e.g. "1st Corner", "3rd Shot On Target")

minute / extra_minute

integer

When the entry occurred

rescinded

boolean/null

Whether this entry was later corrected or removed, see the Events corrections callout for how this is used on goals

sort_order

integer

Order within its type/period grouping

weatherReport

What it returns

include=weatherReport returns current weather conditions at the venue. Note the requested include is camelCase (weatherReport), but the key in the response body comes back lowercase as weatherreport, build your parsing with this in mind.

Example response

Field descriptions

Field
Type
Description

id

integer

Unique identifier for this weather report

fixture_id

integer

The fixture this report belongs to

venue_id

integer

The venue where conditions were recorded

temperature.current

float

Temperature at time of recording

feels_like.current

float

Perceived temperature

wind.speed / wind.direction

float / integer

Wind speed and direction in degrees

humidity

string

Relative humidity as a percentage string

pressure

integer

Atmospheric pressure

clouds

string

Cloud cover as a percentage string

description

string

Human-readable summary (e.g. "broken clouds")

icon

string

URL to a weather icon

type

string

e.g. "actual"

metric

string

Unit system, e.g. "celcius"

current

object

Flattened duplicate of the fields above for convenience


periods.statistics

What it returns

include=periods.statistics works and returns each period (1st half, 2nd half, extra time, etc.) with a nested statistics array scoped to that period only. This lets you break down stats like possession or shots by half, rather than only getting fixture-wide totals.

Example response (abbreviated)

Field descriptions

Field
Type
Description

id

integer

Unique identifier for this period

type_id

integer

1 = 1st half, 2 = 2nd half, others exist for extra time/penalties, see the States and Periods tutorial

description

string

Human-readable period name

statistics

array

Same shape as the top-level statistics include, but scoped to this period only

statistics[].type_id

integer

The statistic type, decode via statistics.type

statistics[].participant_id

integer

Which team this stat belongs to

statistics[].data.value

number

The stat value

To combine with the type names, add the nested include: include=periods.statistics.type.

A note on rule / rule.type

rule is not a valid include on the Fixture entity. Requesting include=rule.type on a fixture returns a 404 with error code 5013 ("The requested include 'rule' does not exist on Fixture"). If you're looking to determine promotion, relegation, or qualification logic for a knockout stage, check the Standings entity instead, that's where this kind of rule data is expected to live. This page will be updated once that's confirmed.

Last updated

Was this helpful?