Other

News

Related endpoints

📰News

Field Description

Field		Type
id	Refers to the unique id of the news article	integer
fixture_id	Refers to the fixture related to the news article	integer
league_id	Refers to the league related to the news article	integer
title	The title of the news article	string
type	The type of the news	string

Include options

fixture league lines

NewsItemLine

Field Description

Field		Type
id	Refers to the unique id of the news article line	integer
newsitem_id	Refers to the news article related to the news article line	integer
text	The text of the news article line	string
type	The type of the news article line	string

Include options

none

Commentary

Related endpoints

🎙️Commentaries

Field Description

Field		Type
id	Refers to the unique id of the commentary	string
fixture_id	Refers to the fixture related to the commentary	integer
comment	The textual representation of the event in the fixture	string
minute	The minute of the comment in the fixture	integer
extra_minute	The extra minute of the comment in the fixture	integer
is_goal	Indicates if the comment is a goal	boolean
is_important	Indicates if the comment is important	boolean
order	The order of the comment	integer

Include options

fixture

Video Highlight

Related endpoints

Currently, the video highlights are removed due to a lack of service. We're working on finding a new data partner to adjust this.

Field Description

Field		Type
id	Refers to the id of the video highlight	integer
fixture_id	Refers to the fixture related to the video highlights	integer
type_id	Refers to the type related to the video highlights	integer
event_id	Refers to the event related to the video highlights	integer
location	Returns the location URL of the video highlight	string

Include options

fixture

TvStation

Related endpoints

📺TV Stations

Field Description

Field		Type
id	Refers to the unique id of the tv station	integer
name	Displays the name of the tv station	string
url	Displays the url of the tv station	string / null
image_path	Displays the image path of the tv station	string / null

Include options

fixtures countries

Venue

Related endpoints

🏟️Venues

Field description

Field	Description	Type
id	Refers to the unique id of the venue	integer
country_id	Refers to the country of the venue	integer
name	Returns the name of the venue	string
address	Returns the address of the venue	string
zipcode	Returns the zipcode of the venue	string
state	Returns the state of the venue	string / null
latitude	Returns the latitude of the venue	string
longitude	Returns the longitude of the venue	string
capacity	Returns the seating capacity of the venue	integer
image_path	Returns the image path of the venue	string / null
city_name	Returns the name of the city the venue is located in	string
surface	Returns the surface type of the venue	string
national_team	Indicates if the venue is used for the national team of the country	boolean

Include options

country city fixtures

WeatherReport

Field description

Field	Description	Type
id	Refers to the unique id of the weather report	integer
fixture_id	Refers to the fixture related to the weather report	integer
venue_id	Refers to the venue related to the weather report	integer
temperature	Displays the temperatures over the day	object
feels_like	Displays the perceived temperatures over the day	object
wind	Displays the wind speed and direction	object
humidity	Displays the degree of humidity of the weather report	string
pressure	Displays the pressure of the weather report	integer
clouds	Displays the degree of clouds of the weather report	string
description	Displays the description of the weather report	string
icon	Displays the Sportmonks icon related to the weather report	string
type	Displays the type of the weather report	string
metric	Displays the metric of temperature of the weather report	string
current	Indicates if the weather is current. Only available when the type is actual.	string / null

Include options

venue fixture

Transfer

Related endpoints

↔️Transfers

Field Description

Field	Description	Type
id	Refers to the id of the transfer	integer
sport_id	Refers to the sport related to the transfer	integer
player_id	Refers to the player related to the transfer	integer
type_id	Refers to the type of the transfer	integer
from_team_id	Refers to the team the player transferred from	integer
to_team_id	Refers to the team the player transferred to	integer
position_id	Refers to the position of the player	integer
detailed_position_id	Refers to the detailed position of the player	integer
date	Displays the date of the transfer	string
career_ended	Indicates if the player has ended his career	integer
amount	Displays the amount of the transfer	string
completed	Indicates if the transfer is completed or not	boolean
completed_at	Displays the date time of when the transfer has been completed	string

Include options

sport player type fromTeam toTeam position detailedPosition

Transfer Entity Filters

Query Parameters

Query Parameters	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=type;fromTeam
select	NO	​Select specific fields on the base entity​
filters	NO	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

No Static Filters available for this entity, beside the Get All Transfers endpoint where you can use the idAfter filter

Dynamic Filters

The dynamic filters are based on entities and includes. Each dynamic filter uses an entity to filter on and one entity to apply the filter on. Below are examples with explanations of how filters are set up. For more information, please look at our Filters page.

Dynamic Filters	Available on Entity	Description	Examples
types	Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all possibilities.	Filter the Types on a selection of Transfers separated by a comma.	&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220

Rival

Related endpoints

⚔️Rivals

Field Description

Field	Description	Type
sport_id	Refers to the sport of the rival	integer
team_id	Refers to the team of the team	integer
rival_id	Refers to the team of the rival of the team	integer

Include options

team rival

MetaData

Field Description

Field	Description	Type
id	Refers to the id of the meta data object	integer
metadatable_type	Displays the type of the related meta data object	string
metadatable_id	Refers to the id of the related meta data object	integer
type_id	Refers to the type of the meta data object	integer
value	Displays the values of the meta data object	mixed
value_type	Displays the type of the value	string

Include options

type

State

Related endpoints

🛰️States

Field Description

Field	Description	Type
id	Refers to the id of the state	integer
state	Displays the state of the state	string
name	Displays the full name of the state	string
short_name	Displays the short name of the state	string
developer_name	Displays the developer name of the state	string

Include options

type

ParticipantTrophy

Field Description

Field	Description	Type
id	Refers to the id of the participant trophy	integer
participant_id	Refers to the id of the related participant	integer
team_id	Refers to the id of the related team of the participant	integer
league_id	Refers to the id of the related league	integer
season_id	Refers to the id of the related season	integer
trophy_id	Refers to the id of the related trophy	integer

Include options

team league season trophy

Trophy

Field Description

Field	Description	Type
id	Refers to the id of the trophy	integer
sport_id	Refers to the id of the related sport	integer
position	Displays the position of the trophy	integer
name	Displays the name of the trophy (eg. Winner)	integer

Include options

none

Social

Field Description

Field	Description	Type
id	Refers to the id of the social	integer
social_id	Refers to the id of the related entity of the social	integer
social_channel_id	Refers to the id of the related channel of the social	integer
value	Displays the value of the social (eg. account name)	string

Include options

channel

SocialChannel

Field Description

Field	Description	Type
id	Refers to the id of the social channel	integer
name	Displays the name of the social channel	string
base_url	Displays the url of the social channel	string
hex_color	Displays the main color of the social channel	string

Include options

none

Ranking

Field Description

Field	Description	Type
id	Refers to the id of the ranking.	integer
position	Refers to the position of the team in the rankings.	integer
participant_id	Refers to the id of the participant.	integer
points	Refers to the number of points by the participant.	integer
sport_id	Refers to the sport of the rankings.	integer
type	Refers to the type of rankings.	string

Include options

None