🥅Fixture

Fixture

Fields description

FieldDescriptionType

id

Refers the unique id of the fixture

integer

sport_id

Refers to the sport the fixture is played at

integer

league_id

Refers to the league the fixture is played in

integer

season_id

Refers to the seasons the fixture is played in

integer

stage_id

Refers to the stage the fixture is played in

integer

group_id

Refers to the group the fixture is played in

integer / null

aggregate_id

Refers to the aggregate the fixture is played at

integer / null

state_id

Refers to the state the fixture is played at

integer

round_id

Refers to the round the fixture is played at

integer / null

state_id

Refers to the state the fixture is played at

integer

venue_id

Refers to the venue the fixture is played at

integer / null

name

Represents the name of the participants

string / null

starting_at

Datetime object representing the start time

date / null

result_info

Represents the final result info

string / null

leg

Represents the leg of the fixture

string

details

Represents details about the fixture

string / null

length

Length of the fixture (minutes)

integer / null

Include options

Sorting options

name starting_at

Fixture entity filters

NameRequired?Description

api_token

YES Another option is to provide the API token in the header.

Your unique API token. Ex. ?api_token={{YOURTOKEN}}

include

NO

Enrich the API response with more data by using includes. Ex. &include=participants;events

select

NO

filters

Available on Entity

Filter the API response on multiple related entities. There are static filters and dynamic filters. Please find the possibilities in the Static and Dynamic Filter tab.

Filters

More information on how to use filters can be found on our tutorials on how to filter. If you want more information on which filters to use you can check out the following endpoint:

https://api.sportmonks.com/v3/my/filters/entity?api_token={{YOURTOKEN}}

Period

Fields description

FieldDescriptionType

id

Refers to the unique id of the period

integer

fixture_id

Refers to the fixture related to the period

integer

type_id

Refers to the type of the period

integer

started

UNIX timestamp of when the period started

integer

ended

UNIX timestamp of when the period ended

integer / null

counts_from

Represents the minute the period starts counting from

integer

ticking

Determines if the period is being played at the moment

boolean

sort_order

Represents the sort order of the period

integer

description

Represents the description of the period

string

time_added

Represents the time added to the period

integer / null

period_length

Represents the scheduled length of the period.

integer

minutes

Represents the current minute of the period

integer

seconds

Represents the amount of seconds after the current minute

integer

has_timer

Marks if we have detailed timer information for minutes and seconds available

boolean

Include options

Aggregate

Fields description

FieldDescriptionType

id

Refers to the unique id of the aggregate

integer

league_id

Refers to the league of the aggregate

integer

season_id

Refers to the season of the aggregate

integer

stage_id

Refers to the stage the aggregate

integer

name

Represents the name of the aggregate

string

fixture_ids

Represent the fixture id's related to the aggregate

array

result

Represents the final result of the aggregate

string / null

detail

Gives details of the result of the aggregate

string / null

winner_participant_id

Refers to the winner of the aggregate

integer

Include options

stage league season winner

Lineup

Fields description

FieldDescriptionType

id

Refers to the unique id of the lineup

integer

sport_id

Refers to the sport of the lineup

integer

fixture_id

Refers to the fixture the lineup is from

integer

player_id

Refers to the player linked to the lineup

integer

team_id

Refers to the team of the lineup

integer

position_id

Refers to the position of the lineup

integer

detailed_position_id

Refers to the detailed position of the lineup

integer / null

formation_field

Represents the lineup's position in the formation

string / null

type_id

Refers to the type of the lineup

integer

jersey_number

Represents the lineup's jersey number

integer

formation_position

Represents the numeric position of the lineup

integer

player_name

Represents the player name of the lineup

string

Include options

Sidelined

Fields description

FieldDescriptionType

id

Refers to the unique id of the lineup detail object

integer

fixture_id

Refers to the fixture related to the fixture object

integer

sideline_id

Refers to the sideline related to the fixture

integer

participant_id

Refers to the participant related to the fixture

integer

Include options

fixture sideline participant

LineupDetail

Fields description

FieldDescriptionType

id

Refers to the unique id of the lineup detail object

integer

fixture_id

Refers to the fixture related to the lineup detail object

integer

player_id

Refers to the player related to the lineup detail object

integer

team_id

Refers to the team related to the lineup detail object

integer

lineup_id

Refers to the lineup related to the lineup detail object

integer

type_id

Refers to the type of the lineup detail object

integer

data

Represents the value of the lineup detail object

object

Include options

Event

Fields description

FieldDescriptionType

id

Refers to the unique id of the event

integer

fixture_id

Refers to the fixture related to the event

integer

period_id

Refers to the period related to the event

integer

participant_id

Refers to the participant related to the event

integer

type_id

Refers to the type of the event

integer

player_id

Refers to the player related to the event

integer

related_player_id

Refers to the related player of the event

integer / null

player_name

Represents the name of the player

string

related_player_name

Represents the name of the related player

string / null

result

Represents the score after the event happened

string / null

info

Represents info about the event

string / null

addition

Represents extra info about the event

string / null

minute

Represents the minute the event occurred

integer

extra_minute

Represents the extra minutes of injury time

integer / null

injured

Determines if the player of substitution event is injured or not

boolean

Include options

Formation

Fields description

FieldDescriptionType

id

Refers to the unique id of the formation

integer

fixture_id

Refers to the fixture related to the formation

integer

participant_id

Refers to the participant related to the formation

integer

formation

Displays the formation used by the participant

string

location

Displays the location (home/away) of the formation

string

Include options

fixture participant

Score

Fields description

FieldDescriptionType

id

Refers to the unique id of the score

integer

fixture_id

Refers to the fixture related to the score

integer

type_id

Refers to the type of the score

integer

participant_id

Refers to the participant related to the score

integer

score

The score object with the goals and the participant (home/away)

object

description

Displays the description of the score (eg. 1ST_HALF)

string

Include options

BallCoordinate

Fields description

FieldDescriptionType

id

Refers to the unique id of the ball coordinate

integer

fixture_id

Refers to the fixture related to the ball coordinate

integer

period_id

Refers to the period related to the ball coordinate

integer

timer

Displays the time of the ball coordinate

string

x

Displays the X-coordinate of the ball coordinate

string

y

Displays the Y-coordinate of the ball coordinate

string

Include options

fixture period

Last updated