⚽
API 3.0
OddsCoreFootball APIAPI 2 (Deprecated)WidgetsContact
Football API 3.0
Football API 3.0
  • Welcome
    • 🛬Welcome
    • 🙋‍♂️Getting Started
    • 🤓What can you do with Sportmonks' data?
    • 🆕Differences between API 2 and API 3
      • API Changes
      • Syntax and filters
      • New endpoints and data features
    • 🔐Authentication
    • 👶Making your first request
    • 🔧Best Practices
  • API coach (BETA)
  • Changelog
    • 📄Changelog
    • 📁Changelog (BETA)
  • API
    • 💡Request options
      • Includes
        • Nested includes
      • Selecting fields
      • Filtering
      • Selecting and filtering
      • Ordering and sorting
    • 🔤Syntax
    • ♾️Rate limit
    • 👀Meta description
    • 📔Error codes
      • Include Exceptions
      • Filtering and Complexity Exceptions
      • Other Exceptions
    • 📚Code libraries
    • Translations (beta)
    • Demo response files
    • Data corrections
    • API 2.0 (Deprecated)
  • Endpoints and Entities
    • Endpoints
      • 📡Livescores
        • GET Inplay Livescores
        • GET All Livescores
        • GET Latest Updated Livescores
      • 🥅Fixtures
        • GET All Fixtures
        • GET Fixture by ID
        • GET Fixtures by Multiple IDs
        • GET Fixtures by Date
        • GET Fixtures by Date Range
        • GET Fixtures by Date Range for Team
        • GET Fixtures by Head To Head
        • GET Fixtures by Search by Name
        • GET Upcoming Fixtures by Market ID
        • GET Upcoming Fixtures by TV Station ID
        • GET Past Fixtures by TV Station ID
        • GET Latest Updated Fixtures
      • 🛰️States
        • GET All States
        • GET State by ID
      • ⌨️Types
        • GET All Types
        • GET Type by ID
        • GET Type by Entity
      • 🏆Leagues
        • GET All Leagues
        • GET League by ID
        • GET Leagues by Live
        • GET Leagues by Fixture Date
        • GET Leagues by Country ID
        • GET Leagues Search by Name
        • GET All Leagues by Team ID
        • GET Current Leagues by Team ID
      • 🗓️Seasons
        • GET All Seasons
        • GET Seasons by ID
        • GET Seasons by Team ID
        • GET Seasons by Search by Name
      • 📊Statistics
        • GET Season Statistics by Participant
        • GET Stage Statistics by ID
        • GET Round Statistics by ID
      • 📅Schedules
        • GET Schedules by Season ID
        • GET Schedules by Team ID
        • GET Schedules by Season ID and Team ID
      • 🪜Stages
        • GET All Stages
        • GET Stage by ID
        • GET Stages by Season ID
        • GET Stages by Search by Name
      • 🔂Rounds
        • GET All Rounds
        • GET Round by ID
        • GET Rounds by Season ID
        • GET Rounds by Search by Name
      • 🔢Standings
        • GET All Standings
        • GET Standings by Season ID
        • GET Standings by Round ID
        • GET Standing Correction by Season ID
        • Get Live Standings by League ID
      • 🥇Topscorers
        • GET Topscorers by Season ID
        • GET Topscorers by Stage ID
      • 🏃Teams
        • GET All Teams
        • GET Team by ID
        • GET Teams by Country ID
        • GET Teams by Season ID
        • GET Teams by Search by Name
      • 🧑Players
        • GET All Players
        • GET Player by ID
        • GET Players by Country ID
        • GET Players by Search by Name
        • GET Last Updated Players
      • 🧑‍🦱Team Squads
        • GET Team Squad by Team ID
        • GET Extended Team Squad by Team ID
        • GET Team Squad by Team and Season ID
      • 👨‍🏫Coaches
        • GET All Coaches
        • GET Coach by ID
        • GET Coaches by Country ID
        • GET Coaches Search by Name
        • GET Last Updated Coaches
      • 🕴️Referees
        • GET All Referees
        • GET Referee by ID
        • GET Referees by Country ID
        • GET Referees by Season ID
        • GET Referees Search by Name
      • ↔️Transfers
        • GET All Transfers
        • GET Transfer by ID
        • GET Latest Transfers
        • GET Transfers Between Date Range
        • GET Transfers by Team ID
        • GET Transfers by Player ID
      • 🏟️Venues
        • GET All Venues
        • GET Venue by ID
        • GET Venues by Season ID
        • GET Venues by Search by Name
      • 📺TV Stations
        • GET All TV Stations
        • GET TV Station by ID
        • GET TV Stations by Fixture ID
      • 🔮Expected (xG)
        • GET Expected by Team
        • GET Expected by Player
      • 🔭Predictions
        • GET Probabilities
        • GET Predictability by League ID
        • GET Probabilities by Fixture ID
        • GET Value Bets
        • GET Value Bets by Fixture ID
      • 🧙Standard Odds Feed
        • 👓Pre-match Odds
          • GET All Odds
          • Get Odds by Fixture ID
          • GET Odds by Fixture ID and Bookmaker ID
          • GET Odds by Fixture ID and Market ID
          • GET Last Updated Odds
        • 🧠Inplay Odds
          • GET All Inplay Odds
          • GET Inplay Odds by Fixture ID
          • GET Inplay Odds by Fixture ID and Bookmaker ID
          • GET Inplay Odds by Fixture ID and Market ID
          • GET Last Updated Inplay Odds
      • 🧙‍♂️Premium Odds Feed
        • 🕶️Premium Pre-match Odds
          • GET All Premium Odds
          • Get Premium Odds by Fixture ID
          • GET Premium Odds by Fixture ID and Bookmaker ID
          • GET Premium Odds by Fixture ID and Market ID
          • GET Updated Premium Odds Between Time Range
          • GET Updated Historical Odds Between Time Range
          • GET All Historical Odds
      • 🛒Markets
        • GET All Markets
        • GET All Premium Markets
        • GET Market by ID
        • GET Market by Search
      • 📑Bookmakers
        • GET All Bookmakers
        • GET All Premium Bookmakers
        • GET Bookmaker by ID
        • GET Bookmaker by Search
        • GET Bookmaker by Fixture ID
      • 📰News
        • GET Pre-Match News
        • GET Pre-Match News by Season ID
        • GET Pre-Match News for Upcoming Fixtures
        • GET Post-Match News
        • GET Post-Match News by Season ID
      • ⚔️Rivals
        • GET All Rivals
        • GET Rivals by Team ID
      • 🎙️Commentaries
        • GET All Commentaries
        • GET Commentaries by Fixture ID
    • Entities
      • 🥅Fixture
      • 🏆League, Season, Schedule, Stage and Round
      • 🧑‍🤝‍🧑Team, Player, Squad, Coach and Referee
      • 🔢Statistic
      • 🔮Expected
      • 🥇Standing and Topscorer
      • 🔭Odd and Prediction
      • Other
  • Tutorials and Guides
    • Tutorials
      • Introduction
        • Make your first request
        • Set your time zone
        • Pagination
      • Enrich your response
        • Nested includes
          • Syntax and relations
      • Includes
        • Events
        • States
        • Periods
        • Scores
        • Participants
        • Lineups
        • ballCoordinates
        • Pressure Index
        • Tips and tricks
      • Filter and select fields
        • Selecting fields
        • Filtering
        • Selecting and filtering
      • Leagues and seasons
        • Leagues
        • Seasons
      • Season schedule
        • Schedules
        • Stages
        • Rounds
      • Livescores and fixtures
        • Livescores
        • Fixtures
      • Lineups and formations
      • Statistics
        • Statistics types
        • Season statistics
        • Fixture statistics
        • Team statistics
        • Players statistics
      • Teams, players, coaches and referees
        • Teams
        • Players
        • Coaches
        • Referees
      • Standings
        • Season standings
        • Topscorer standings
      • Odds and predictions
        • Bookmakers
        • Markets
        • Pre-match odds
        • Live(Inplay) odds
        • hasOdds
        • Predictions
          • Probabilities
          • Value Bet
      • Expected
        • Endpoints
        • Includes
        • Coverage
      • News
        • Pre-match News
        • Post-match News
      • Placeholders
      • Timezone parameters on different endpoints
    • Guides
      • How-to use components
      • How-to use the Football API with Postman
      • How-to use the Football API tester
      • How-to use the Football API ID finder
      • How-to build a livescore website
      • How-to use the Predictions API
      • How-to build a match page
      • How-to build a custom plan
      • How-to build a match page with odds
      • How-to use xG data
      • How-to build a news website
      • How-to build a fantasy game guide
      • How-to use the new Champions League data
      • How-to build your World Cup application
      • How-to build a team page
      • How-to keep your database in SYNC
      • How-to use team mode in MySportmonks
    • Programming languages
      • A developers guide: Unleashing the power of the football API with JSON
      • A developers guide: Unleashing the power of the football API with PHP
      • A developers guide: Unleashing the power of the football API with Python
  • Definitions
    • 📔Response Codes
    • 🛰️States
    • ⌨️Types
      • Lineups, positions and formations
      • Events
      • Statistics
        • Coach statistics
        • Referee statistics
        • Stage statistics
        • Season statistics
        • Fixture statistics
        • Team statistics
        • Player statistics
      • Expected
      • Leagues and stages
      • Standings
      • Transfers
      • Highlights
      • Weather and pitch
  • FAQ
    • API 3.0
    • Odds
    • Integration
    • Sportmonks
  • Quicklinks
    • Postman
    • ID Finder
    • Sportmonks
    • MySportmonks
    • Football widgets
    • Plans and Pricing
    • Data features
    • FAQ
Powered by GitBook
On this page
  • News
  • NewsItemLine
  • Commentary
  • Video Highlight
  • TvStation
  • Venue
  • WeatherReport
  • Transfer
  • Transfer Entity Filters
  • Rival
  • MetaData
  • State
  • ParticipantTrophy
  • Trophy
  • Social
  • SocialChannel
  • Ranking

Was this helpful?

  1. Endpoints and Entities
  2. Entities

Other

PreviousOdd and PredictionNextTutorials

Last updated 7 months ago

Was this helpful?

News

Related endpoints

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

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

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

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

TvStation

Related endpoints

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

Venue

Related endpoints

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

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

Transfer

Related endpoints

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

Transfer Entity Filters

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

select

NO

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.

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

Dynamic Filters
Available on Entity
Description
Examples

types

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

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

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

State

Related endpoints

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

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

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

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

Enrich the API response with more data by using . Ex. &include=type;fromTeam

​ specific fields on the ​

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.

Statistics, Events, Lineup, Transfers and way more. Check this for all possibilities.

🎙️Commentaries
📺TV Stations
🏟️Venues
↔️Transfers
Filters page
⚔️Rivals
type
🛰️States
includes
Select
base entity
endpoint
team
rival
channel
fixture
fixture
country
city
fixtures
venue
fixture
fixtures
countries
type
player
fromTeam
toTeam
sport
position
detailedPosition
type
📰News
lines
fixture
league
team
trophy
league
season