Links
🥅

Fixture

Fixture

Fields description

Field
Description
Type
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

Fixture entity filters

Query Parameters
Static Filters
Dynamic Filters
Name
Required?
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
Select specific fields on the base entity
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.
Static Filters
Available on Entity
Description
Example
ParticipantSearch
Fixture
Filter on the matches of specific participants.
&include=participants&filters=participantSearch:{Celtic}
TodayDate
Fixture
Filter all fixtures to find only the fixtures of today.
&filters=todayDate
Venues
Fixture
Find all fixtures that are played in a specific venue.
&include=venue&filters=venues:{venueIDs} &include=venue&filters=venues:10,12
Deleted
Fixture
Filter on deleted fixtures only. This filter helps to keep your database in sync.
&filters=IsDeleted
IdAfter
All
Filter all fixtures starting from a certain fixture ID. Handy when you are only interested in the most recent fixtures.
&filters=IdAfter:{fixtureID} &filters=IdAfter:18535487
Markets
Odds
Filter the odds on a selection of markets separated by a comma.
&include=odds&filters=markets:{marketIDs} &include=odds&filters=markets:{12,14}
Bookmakers
Odds
Filter the odds on a selection of bookmakers separated by a comma. (e.g: 12,24).
&include=odds&filters=bookmakers:{bookmakerIDs} &include=odds&filters=bookmakers:2,14
WinningOdds
Odds
Filter all winning odds.
&include=odds&filters=WinningOdds
Dynamic Filters
Available on Entity
Description
Examples
types
Statistics, Events, Lineup, Metadata, Periods, Predictability, Predictions, Sidelined, States, Trends
Filter the Types on a selection of Fixture statistics separated by a comma. Filter on the specific trends you want to show.
&include=statistics&filters=statisticTypes:42,49 &include=events&filters=eventTypes:14
states
Fixtures
Filter the states of fixtures separated by a comma.
&include=state&filters=fixtureStates:1
leagues
Aggregates, Fixtures, News, Predictability, Rounds, Seasons, Stages, Standings
Filter the fixtures based on leagues and their rounds.
&filters=fixtureLeagues:{leagueID} &filters=roundLeagues:501
groups
Fixtures, Standing, Standing corrections
Filter the fixtures based on groups. Get their fixtures and standings.
&include=group&filters=fixtureGroups:{groupIDs} &include=group&filters=fixtureGroups:246691
countries
Coaches, Leagues, Players, Referees, Standings, Teams, Venues
Filter the coaches, leagues, players and more based on countries.
&include=coaches&filterscoachCountries:1161
seasons
Aggregates, Statistics (players, team, coaches, referees), Rounds, Sidelined, Stages, Standings, Standing Corrections, Topscorers.
Filter statistics, standings and topscorers based on seasons.
&include=season.statistics&filters=seasonStatisticTypes:52
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

Field
Description
Type
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
actual_period_start
Represents the actual start minute of the period
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
minutes
Represents the current minute of the period
integer
seconds
Represents the amount of seconds after the current minute
integer

Include options

Aggregate

Fields description

Field
Description
Type
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

Lineup

Fields description

Field
Description
Type
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
yersey_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

Field
Description
Type
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

Field
Description
Type
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

Field
Description
Type
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

Field
Description
Type
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

Score

Fields description

Field
Description
Type
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

Field
Description
Type
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