# Sportmonks (/integrations/sportmonks)
{/* MANUAL-CONTENT-START:intro */}
Use [Sportmonks](https://www.sportmonks.com/) to query sports and reference data.
* **Football:** fixtures, livescores, leagues, seasons, stages, rounds, teams, squads, players, coaches, referees, venues, standings, topscorers, transfers, schedules, commentaries, TV stations, rivals, expected goals (xG), and predictions.
* **Motorsport:** sessions, drivers, teams, championship standings, laps, and pitstops.
* **Odds:** pre-match and in-play odds, bookmakers, and markets.
* **Reference data:** continents, countries, regions, cities, types, and time zones.
Use `include` to retrieve supported related data, such as statistics or match details. Available leagues, datasets, and related entities depend on your Sportmonks subscription; an operation's presence in Sim does not grant provider access.
{/* MANUAL-CONTENT-END */}
## Use the block [#usage-instructions]
Query data across the Sportmonks APIs. Football: fixtures, livescores, leagues, seasons, stages, rounds, teams, squads, players, coaches, referees, venues, standings, topscorers, transfers, schedules, commentaries, TV stations, rivals, expected goals (xG), and predictions. Motorsport: sessions, drivers, teams, championship standings, laps, and pitstops. Odds: pre-match and in-play odds, bookmakers, and markets. Core: continents, countries, regions, cities, types, and time zones.
## Actions [#actions]
### Football [#actions-sportmonks_football_expected_by_player]
#### Get Expected xG by Player [#get-expected-xg-by-player]
Retrieve lineup-level expected goals (xG) values per player from Sportmonks
##### Input [#input]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. fixture;player;team;type) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output]
| Parameter | Type | Description |
| - | - | - |
| `expected` | array | Array of player-level expected goals (xG) entries |
| ↳ `id` | number | Unique id of the expected value |
| ↳ `fixture_id` | number | Fixture related to the value |
| ↳ `player_id` | number | Player related to the value |
| ↳ `team_id` | number | Team related to the value |
| ↳ `lineup_id` | number | Lineup record the player relates to |
| ↳ `type_id` | number | Type of the expected value |
| ↳ `data` | object | The expected value payload |
| ↳ `value` | number | The xG value |
#### Get Expected xG by Team [#get-expected-xg-by-team]
Retrieve fixture-level expected goals (xG) values per team from Sportmonks
##### Input [#input-1]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. fixture;participant;type) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-1]
| Parameter | Type | Description |
| - | - | - |
| `expected` | array | Array of team-level expected goals (xG) entries |
| ↳ `id` | number | Unique id of the expected value |
| ↳ `fixture_id` | number | Fixture related to the value |
| ↳ `type_id` | number | Type of the expected value |
| ↳ `participant_id` | number | Team related to the expected value |
| ↳ `data` | object | The expected value payload |
| ↳ `value` | number | The xG value |
| ↳ `location` | string | Home or away |
#### Get All Commentaries [#get-all-commentaries]
Retrieve all textual commentaries available within your Sportmonks subscription
##### Input [#input-2]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. fixture;player) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-2]
| Parameter | Type | Description |
| - | - | - |
| `commentaries` | array | Array of commentary entries |
| ↳ `id` | number | Unique id of the commentary |
| ↳ `fixture_id` | number | Fixture related to the commentary |
| ↳ `comment` | string | The commentary text |
| ↳ `minute` | number | Match minute of the comment |
| ↳ `extra_minute` | number | Extra (injury) minute of the comment |
| ↳ `is_goal` | boolean | Whether the comment is a goal |
| ↳ `is_important` | boolean | Whether the comment is important |
| ↳ `order` | number | Order of the comment |
#### Get All Fixtures [#get-all-fixtures]
Retrieve all football fixtures available within your Sportmonks subscription
##### Input [#input-3]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;scores) |
| `filters` | string | No | Filters to apply (e.g. fixtureLeagues:501) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-3]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of fixture objects |
| ↳ `id` | number | Unique id of the fixture |
| ↳ `sport_id` | number | Sport the fixture is played at |
| ↳ `league_id` | number | League the fixture is played in |
| ↳ `season_id` | number | Season the fixture is played in |
| ↳ `stage_id` | number | Stage the fixture is played in |
| ↳ `group_id` | number | Group the fixture is played in |
| ↳ `aggregate_id` | number | Aggregate the fixture belongs to |
| ↳ `round_id` | number | Round the fixture is played in |
| ↳ `state_id` | number | State (status) of the fixture |
| ↳ `venue_id` | number | Venue the fixture is played at |
| ↳ `name` | string | Name of the fixture (participants) |
| ↳ `starting_at` | string | Datetime the fixture starts |
| ↳ `result_info` | string | Final result summary |
| ↳ `leg` | string | Leg of the fixture (e.g. 1/1) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Length of the fixture in minutes |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Whether odds are available |
| ↳ `has_premium_odds` | boolean | Whether premium odds are available |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get All Players [#get-all-players]
Retrieve all football players available within your Sportmonks subscription
##### Input [#input-4]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. nationality;position) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order players by id (asc or desc) |
##### Output [#output-4]
| Parameter | Type | Description |
| - | - | - |
| `players` | array | Array of player objects |
| ↳ `id` | number | Unique id of the player |
| ↳ `sport_id` | number | Sport of the player |
| ↳ `country_id` | number | Country of birth of the player |
| ↳ `nationality_id` | number | Nationality of the player |
| ↳ `city_id` | number | City of birth of the player |
| ↳ `position_id` | number | Position of the player |
| ↳ `detailed_position_id` | number | Detailed position of the player |
| ↳ `type_id` | number | Type of the player |
| ↳ `common_name` | string | Name the player is known for |
| ↳ `firstname` | string | First name of the player |
| ↳ `lastname` | string | Last name of the player |
| ↳ `name` | string | Name of the player |
| ↳ `display_name` | string | Display name of the player |
| ↳ `image_path` | string | URL to the player headshot |
| ↳ `height` | number | Height of the player in cm |
| ↳ `weight` | number | Weight of the player in kg |
| ↳ `date_of_birth` | string | Date of birth of the player |
| ↳ `gender` | string | Gender of the player |
#### Get All Rivals [#get-all-rivals]
Retrieve all teams with their rivals information from Sportmonks
##### Input [#input-5]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. team;rival) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-5]
| Parameter | Type | Description |
| - | - | - |
| `rivals` | array | Array of rival relationships |
| ↳ `sport_id` | number | Sport of the rival |
| ↳ `team_id` | number | Team the rivalry belongs to |
| ↳ `rival_id` | number | Rival team id |
#### Get All Teams [#get-all-teams]
Retrieve all football teams available within your Sportmonks subscription
##### Input [#input-6]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;venue) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order teams by id (asc or desc) |
##### Output [#output-6]
| Parameter | Type | Description |
| - | - | - |
| `teams` | array | Array of team objects |
| ↳ `id` | number | Unique id of the team |
| ↳ `sport_id` | number | Sport of the team |
| ↳ `country_id` | number | Country of the team |
| ↳ `venue_id` | number | Home venue of the team |
| ↳ `gender` | string | Gender of the team |
| ↳ `name` | string | Name of the team |
| ↳ `short_code` | string | Short code of the team |
| ↳ `image_path` | string | URL to the team logo |
| ↳ `founded` | number | Founding year of the team |
| ↳ `type` | string | Type of the team |
| ↳ `placeholder` | boolean | Whether the team is a placeholder |
| ↳ `last_played_at` | string | Date and time of the last played match |
#### Get All Transfer Rumours [#get-all-transfer-rumours]
Retrieve all transfer rumours available within your Sportmonks subscription
##### Input [#input-7]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;fromTeam;toTeam) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-7]
| Parameter | Type | Description |
| - | - | - |
| `transferRumours` | array | Array of transfer rumour objects |
| ↳ `id` | number | Unique id of the transfer rumour |
| ↳ `sport_id` | number | Sport of the transfer rumour |
| ↳ `player_id` | number | Player the rumour relates to |
| ↳ `position_id` | number | Position id of the player |
| ↳ `from_team_id` | number | Team the player would transfer from |
| ↳ `to_team_id` | number | Team the player would transfer to |
| ↳ `transfer_fee_id` | number | Transfer fee id of the rumour |
| ↳ `probability` | string | Probability of the rumour (e.g. LOW) |
| ↳ `source_name` | string | Name of the source of the rumour |
| ↳ `source_url` | string | URL of the source of the rumour |
| ↳ `amount` | number | Estimated transfer fee amount |
| ↳ `currency` | string | Currency of the amount |
| ↳ `date` | string | Date of the rumour |
| ↳ `type_id` | number | Type of the transfer rumour |
#### Get All Transfers [#get-all-transfers]
Retrieve all transfers available within your Sportmonks subscription
##### Input [#input-8]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;fromTeam;toTeam) |
| `filters` | string | No | Filters to apply (e.g. transferTypes:219,220) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-8]
| Parameter | Type | Description |
| - | - | - |
| `transfers` | array | Array of transfer objects |
| ↳ `id` | number | Unique id of the transfer |
| ↳ `sport_id` | number | Sport of the transfer |
| ↳ `player_id` | number | Player who transferred |
| ↳ `type_id` | number | Type of the transfer |
| ↳ `from_team_id` | number | Team the player transferred from |
| ↳ `to_team_id` | number | Team the player transferred to |
| ↳ `position_id` | number | Position id of the transfer |
| ↳ `detailed_position_id` | number | Detailed position id of the transfer |
| ↳ `date` | string | Date of the transfer |
| ↳ `career_ended` | boolean | Whether the transfer ended the career |
| ↳ `completed` | boolean | Whether the transfer is completed |
| ↳ `amount` | number | Transfer fee amount |
#### Get Brackets by Season [#get-brackets-by-season]
Retrieve the knockout-stage tournament bracket (stages and progression edges) for a season ID
##### Input [#input-9]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response |
##### Output [#output-9]
| Parameter | Type | Description |
| - | - | - |
| `brackets` | json | Bracket object containing stages (fixtures grouped by knockout round) and edges (progression paths between fixtures) |
#### Get Coach by ID [#get-coach-by-id]
Retrieve a single football coach by their ID from Sportmonks
##### Input [#input-10]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `coachId` | string | Yes | The unique id of the coach |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;teams;statistics) |
| `filters` | string | No | Filters to apply |
##### Output [#output-10]
| Parameter | Type | Description |
| - | - | - |
| `coach` | object | The requested coach object |
| ↳ `id` | number | Unique id of the coach |
| ↳ `player_id` | number | Player related to the coach |
| ↳ `sport_id` | number | Sport of the coach |
| ↳ `country_id` | number | Country of the coach |
| ↳ `nationality_id` | number | Nationality of the coach |
| ↳ `city_id` | number | Birth city of the coach |
| ↳ `common_name` | string | Common name of the coach |
| ↳ `firstname` | string | First name of the coach |
| ↳ `lastname` | string | Last name of the coach |
| ↳ `name` | string | Name of the coach |
| ↳ `display_name` | string | Display name of the coach |
| ↳ `image_path` | string | URL to the coach headshot |
| ↳ `height` | number | Height of the coach in cm |
| ↳ `weight` | number | Weight of the coach in kg |
| ↳ `date_of_birth` | string | Date of birth of the coach |
| ↳ `gender` | string | Gender of the coach |
#### Get Coaches [#get-coaches]
Retrieve all football coaches available within your Sportmonks subscription
##### Input [#input-11]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;teams) |
| `filters` | string | No | Filters to apply (e.g. coachCountries:462) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-11]
| Parameter | Type | Description |
| - | - | - |
| `coaches` | array | Array of coach objects |
| ↳ `id` | number | Unique id of the coach |
| ↳ `player_id` | number | Player related to the coach |
| ↳ `sport_id` | number | Sport of the coach |
| ↳ `country_id` | number | Country of the coach |
| ↳ `nationality_id` | number | Nationality of the coach |
| ↳ `city_id` | number | Birth city of the coach |
| ↳ `common_name` | string | Common name of the coach |
| ↳ `firstname` | string | First name of the coach |
| ↳ `lastname` | string | Last name of the coach |
| ↳ `name` | string | Name of the coach |
| ↳ `display_name` | string | Display name of the coach |
| ↳ `image_path` | string | URL to the coach headshot |
| ↳ `height` | number | Height of the coach in cm |
| ↳ `weight` | number | Weight of the coach in kg |
| ↳ `date_of_birth` | string | Date of birth of the coach |
| ↳ `gender` | string | Gender of the coach |
#### Get Coaches by Country [#get-coaches-by-country]
Retrieve all coaches for a country ID from Sportmonks
##### Input [#input-12]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `countryId` | string | Yes | The unique id of the country |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;nationality) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-12]
| Parameter | Type | Description |
| - | - | - |
| `coaches` | array | Array of coach objects for the country |
| ↳ `id` | number | Unique id of the coach |
| ↳ `player_id` | number | Player related to the coach |
| ↳ `sport_id` | number | Sport of the coach |
| ↳ `country_id` | number | Country of the coach |
| ↳ `nationality_id` | number | Nationality of the coach |
| ↳ `city_id` | number | Birth city of the coach |
| ↳ `common_name` | string | Common name of the coach |
| ↳ `firstname` | string | First name of the coach |
| ↳ `lastname` | string | Last name of the coach |
| ↳ `name` | string | Name of the coach |
| ↳ `display_name` | string | Display name of the coach |
| ↳ `image_path` | string | URL to the coach headshot |
| ↳ `height` | number | Height of the coach in cm |
| ↳ `weight` | number | Weight of the coach in kg |
| ↳ `date_of_birth` | string | Date of birth of the coach |
| ↳ `gender` | string | Gender of the coach |
#### Get Commentaries by Fixture [#get-commentaries-by-fixture]
Retrieve textual commentary for a fixture by fixture ID from Sportmonks
##### Input [#input-13]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;relatedPlayer) |
##### Output [#output-13]
| Parameter | Type | Description |
| - | - | - |
| `commentaries` | array | Array of commentary entries for the fixture |
| ↳ `id` | number | Unique id of the commentary |
| ↳ `fixture_id` | number | Fixture related to the commentary |
| ↳ `comment` | string | The commentary text |
| ↳ `minute` | number | Match minute of the comment |
| ↳ `extra_minute` | number | Extra (injury) minute of the comment |
| ↳ `is_goal` | boolean | Whether the comment is a goal |
| ↳ `is_important` | boolean | Whether the comment is important |
| ↳ `order` | number | Order of the comment |
#### Get Current Leagues by Team [#get-current-leagues-by-team]
Retrieve all current leagues for a team ID from Sportmonks
##### Input [#input-14]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `teamId` | string | Yes | The unique id of the team |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;currentSeason) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order leagues (asc or desc) |
##### Output [#output-14]
| Parameter | Type | Description |
| - | - | - |
| `leagues` | array | Array of current league objects for the team |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | number | Whether the league is active (1) or inactive (0) |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date the last fixture was played |
| ↳ `category` | number | Importance category of the league (1-4) |
#### Get Expected Lineups by Player [#get-expected-lineups-by-player]
Retrieve the premium expected lineups for a player ID from Sportmonks
##### Input [#input-15]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `playerId` | string | Yes | The unique id of the player |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;fixture) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-15]
| Parameter | Type | Description |
| - | - | - |
| `expectedLineups` | array | Array of expected lineup entries for the player |
| ↳ `id` | number | Unique id of the expected lineup record |
| ↳ `sport_id` | number | Sport of the expected lineup |
| ↳ `fixture_id` | number | Fixture the expected lineup relates to |
| ↳ `player_id` | number | Player in the expected lineup |
| ↳ `team_id` | number | Team of the expected lineup player |
| ↳ `formation_field` | string | Formation field of the player |
| ↳ `position_id` | number | Position id of the player |
| ↳ `detailed_position_id` | number | Detailed position id of the player |
| ↳ `type_id` | number | Type of the expected lineup record |
| ↳ `formation_position` | number | Position of the player in the formation |
| ↳ `player_name` | string | Name of the player |
| ↳ `jersey_number` | number | Jersey number of the player |
#### Get Expected Lineups by Team [#get-expected-lineups-by-team]
Retrieve the premium expected lineups for a team ID from Sportmonks
##### Input [#input-16]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `teamId` | string | Yes | The unique id of the team |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;fixture) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-16]
| Parameter | Type | Description |
| - | - | - |
| `expectedLineups` | array | Array of expected lineup entries for the team |
| ↳ `id` | number | Unique id of the expected lineup record |
| ↳ `sport_id` | number | Sport of the expected lineup |
| ↳ `fixture_id` | number | Fixture the expected lineup relates to |
| ↳ `player_id` | number | Player in the expected lineup |
| ↳ `team_id` | number | Team of the expected lineup player |
| ↳ `formation_field` | string | Formation field of the player |
| ↳ `position_id` | number | Position id of the player |
| ↳ `detailed_position_id` | number | Detailed position id of the player |
| ↳ `type_id` | number | Type of the expected lineup record |
| ↳ `formation_position` | number | Position of the player in the formation |
| ↳ `player_name` | string | Name of the player |
| ↳ `jersey_number` | number | Jersey number of the player |
#### Get Extended Team Squad [#get-extended-team-squad]
Retrieve all squad entries for a team (based on current seasons) by team ID
##### Input [#input-17]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `teamId` | string | Yes | The unique id of the team |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;position) |
| `filters` | string | No | Filters to apply |
##### Output [#output-17]
| Parameter | Type | Description |
| - | - | - |
| `squad` | array | Array of extended squad entries for the team |
| ↳ `id` | number | Unique id of the squad record |
| ↳ `transfer_id` | number | Transfer id of the squad record |
| ↳ `player_id` | number | Player in the squad |
| ↳ `team_id` | number | Team of the squad |
| ↳ `position_id` | number | Position of the player in the squad |
| ↳ `detailed_position_id` | number | Detailed position of the player in the squad |
| ↳ `jersey_number` | number | Jersey number of the player |
| ↳ `start` | string | Start contract date of the player |
| ↳ `end` | string | End contract date of the player |
#### Get Fixture by ID [#get-fixture-by-id]
Retrieve a single football fixture by its ID from Sportmonks
##### Input [#input-18]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;scores;events;lineups;statistics) |
| `filters` | string | No | Filters to apply (e.g. eventTypes:14) |
##### Output [#output-18]
| Parameter | Type | Description |
| - | - | - |
| `fixture` | object | The requested fixture object |
| ↳ `id` | number | Unique id of the fixture |
| ↳ `sport_id` | number | Sport the fixture is played at |
| ↳ `league_id` | number | League the fixture is played in |
| ↳ `season_id` | number | Season the fixture is played in |
| ↳ `stage_id` | number | Stage the fixture is played in |
| ↳ `group_id` | number | Group the fixture is played in |
| ↳ `aggregate_id` | number | Aggregate the fixture belongs to |
| ↳ `round_id` | number | Round the fixture is played in |
| ↳ `state_id` | number | State (status) of the fixture |
| ↳ `venue_id` | number | Venue the fixture is played at |
| ↳ `name` | string | Name of the fixture (participants) |
| ↳ `starting_at` | string | Datetime the fixture starts |
| ↳ `result_info` | string | Final result summary |
| ↳ `leg` | string | Leg of the fixture (e.g. 1/1) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Length of the fixture in minutes |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Whether odds are available |
| ↳ `has_premium_odds` | boolean | Whether premium odds are available |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Fixtures by Date [#get-fixtures-by-date]
Retrieve all football fixtures on a specific date (YYYY-MM-DD) from Sportmonks
##### Input [#input-19]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `date` | string | Yes | The date to fetch fixtures for, in YYYY-MM-DD format |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;scores;league) |
| `filters` | string | No | Filters to apply (e.g. fixtureLeagues:501,271) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order fixtures by starting\_at (asc or desc) |
##### Output [#output-19]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of fixture objects for the requested date |
| ↳ `id` | number | Unique id of the fixture |
| ↳ `sport_id` | number | Sport the fixture is played at |
| ↳ `league_id` | number | League the fixture is played in |
| ↳ `season_id` | number | Season the fixture is played in |
| ↳ `stage_id` | number | Stage the fixture is played in |
| ↳ `group_id` | number | Group the fixture is played in |
| ↳ `aggregate_id` | number | Aggregate the fixture belongs to |
| ↳ `round_id` | number | Round the fixture is played in |
| ↳ `state_id` | number | State (status) of the fixture |
| ↳ `venue_id` | number | Venue the fixture is played at |
| ↳ `name` | string | Name of the fixture (participants) |
| ↳ `starting_at` | string | Datetime the fixture starts |
| ↳ `result_info` | string | Final result summary |
| ↳ `leg` | string | Leg of the fixture (e.g. 1/1) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Length of the fixture in minutes |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Whether odds are available |
| ↳ `has_premium_odds` | boolean | Whether premium odds are available |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Fixtures by Date Range [#get-fixtures-by-date-range]
Retrieve football fixtures between two dates (YYYY-MM-DD) from Sportmonks. Max range is 100 days.
##### Input [#input-20]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `startDate` | string | Yes | Start date in YYYY-MM-DD format |
| `endDate` | string | Yes | End date in YYYY-MM-DD format (max 100 days after start) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;scores) |
| `filters` | string | No | Filters to apply (e.g. fixtureLeagues:501,271) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order fixtures by starting\_at (asc or desc) |
##### Output [#output-20]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of fixture objects within the requested date range |
| ↳ `id` | number | Unique id of the fixture |
| ↳ `sport_id` | number | Sport the fixture is played at |
| ↳ `league_id` | number | League the fixture is played in |
| ↳ `season_id` | number | Season the fixture is played in |
| ↳ `stage_id` | number | Stage the fixture is played in |
| ↳ `group_id` | number | Group the fixture is played in |
| ↳ `aggregate_id` | number | Aggregate the fixture belongs to |
| ↳ `round_id` | number | Round the fixture is played in |
| ↳ `state_id` | number | State (status) of the fixture |
| ↳ `venue_id` | number | Venue the fixture is played at |
| ↳ `name` | string | Name of the fixture (participants) |
| ↳ `starting_at` | string | Datetime the fixture starts |
| ↳ `result_info` | string | Final result summary |
| ↳ `leg` | string | Leg of the fixture (e.g. 1/1) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Length of the fixture in minutes |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Whether odds are available |
| ↳ `has_premium_odds` | boolean | Whether premium odds are available |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Fixtures by Date Range for Team [#get-fixtures-by-date-range-for-team]
Retrieve fixtures for a team within a date range (YYYY-MM-DD) from Sportmonks
##### Input [#input-21]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `startDate` | string | Yes | Start date in YYYY-MM-DD format |
| `endDate` | string | Yes | End date in YYYY-MM-DD format |
| `teamId` | string | Yes | The unique id of the team |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;scores) |
| `filters` | string | No | Filters to apply (e.g. fixtureLeagues:501) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order fixtures by starting\_at (asc or desc) |
##### Output [#output-21]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of fixture objects for the team within the date range |
| ↳ `id` | number | Unique id of the fixture |
| ↳ `sport_id` | number | Sport the fixture is played at |
| ↳ `league_id` | number | League the fixture is played in |
| ↳ `season_id` | number | Season the fixture is played in |
| ↳ `stage_id` | number | Stage the fixture is played in |
| ↳ `group_id` | number | Group the fixture is played in |
| ↳ `aggregate_id` | number | Aggregate the fixture belongs to |
| ↳ `round_id` | number | Round the fixture is played in |
| ↳ `state_id` | number | State (status) of the fixture |
| ↳ `venue_id` | number | Venue the fixture is played at |
| ↳ `name` | string | Name of the fixture (participants) |
| ↳ `starting_at` | string | Datetime the fixture starts |
| ↳ `result_info` | string | Final result summary |
| ↳ `leg` | string | Leg of the fixture (e.g. 1/1) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Length of the fixture in minutes |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Whether odds are available |
| ↳ `has_premium_odds` | boolean | Whether premium odds are available |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Fixtures by Multiple IDs [#get-fixtures-by-multiple-ids]
Retrieve multiple football fixtures by a comma-separated list of IDs (max 50)
##### Input [#input-22]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `ids` | string | Yes | Comma-separated fixture IDs (e.g. 18535517,18535518). Maximum of 50 IDs |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;scores) |
| `filters` | string | No | Filters to apply (e.g. fixtureLeagues:501) |
##### Output [#output-22]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of fixture objects for the requested IDs |
| ↳ `id` | number | Unique id of the fixture |
| ↳ `sport_id` | number | Sport the fixture is played at |
| ↳ `league_id` | number | League the fixture is played in |
| ↳ `season_id` | number | Season the fixture is played in |
| ↳ `stage_id` | number | Stage the fixture is played in |
| ↳ `group_id` | number | Group the fixture is played in |
| ↳ `aggregate_id` | number | Aggregate the fixture belongs to |
| ↳ `round_id` | number | Round the fixture is played in |
| ↳ `state_id` | number | State (status) of the fixture |
| ↳ `venue_id` | number | Venue the fixture is played at |
| ↳ `name` | string | Name of the fixture (participants) |
| ↳ `starting_at` | string | Datetime the fixture starts |
| ↳ `result_info` | string | Final result summary |
| ↳ `leg` | string | Leg of the fixture (e.g. 1/1) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Length of the fixture in minutes |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Whether odds are available |
| ↳ `has_premium_odds` | boolean | Whether premium odds are available |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Grouped Standings by Round [#get-grouped-standings-by-round]
Retrieve the standing table for a round ID grouped by group where applicable from Sportmonks
##### Input [#input-23]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `roundId` | string | Yes | The unique id of the round |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details) |
| `filters` | string | No | Filters to apply (e.g. standingGroups:246697) |
##### Output [#output-23]
| Parameter | Type | Description |
| - | - | - |
| `standings` | json | Standings for the round: an array of groups (each with id, name and a standings array) when groups exist, otherwise a flat array of standing entries |
#### Get Head to Head [#get-head-to-head]
Retrieve the head-to-head fixtures between two teams from Sportmonks
##### Input [#input-24]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `team1` | string | Yes | The id of the first team |
| `team2` | string | Yes | The id of the second team |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;scores) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order fixtures by starting\_at (asc or desc) |
##### Output [#output-24]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of head-to-head fixture objects between the two teams |
| ↳ `id` | number | Unique id of the fixture |
| ↳ `sport_id` | number | Sport the fixture is played at |
| ↳ `league_id` | number | League the fixture is played in |
| ↳ `season_id` | number | Season the fixture is played in |
| ↳ `stage_id` | number | Stage the fixture is played in |
| ↳ `group_id` | number | Group the fixture is played in |
| ↳ `aggregate_id` | number | Aggregate the fixture belongs to |
| ↳ `round_id` | number | Round the fixture is played in |
| ↳ `state_id` | number | State (status) of the fixture |
| ↳ `venue_id` | number | Venue the fixture is played at |
| ↳ `name` | string | Name of the fixture (participants) |
| ↳ `starting_at` | string | Datetime the fixture starts |
| ↳ `result_info` | string | Final result summary |
| ↳ `leg` | string | Leg of the fixture (e.g. 1/1) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Length of the fixture in minutes |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Whether odds are available |
| ↳ `has_premium_odds` | boolean | Whether premium odds are available |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Inplay Livescores [#get-inplay-livescores]
Retrieve all fixtures that are currently being played (in-play) from Sportmonks
##### Input [#input-25]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;scores;events) |
| `filters` | string | No | Filters to apply (e.g. fixtureLeagues:501) |
##### Output [#output-25]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of in-play fixture objects |
| ↳ `id` | number | Unique id of the fixture |
| ↳ `sport_id` | number | Sport the fixture is played at |
| ↳ `league_id` | number | League the fixture is played in |
| ↳ `season_id` | number | Season the fixture is played in |
| ↳ `stage_id` | number | Stage the fixture is played in |
| ↳ `group_id` | number | Group the fixture is played in |
| ↳ `aggregate_id` | number | Aggregate the fixture belongs to |
| ↳ `round_id` | number | Round the fixture is played in |
| ↳ `state_id` | number | State (status) of the fixture |
| ↳ `venue_id` | number | Venue the fixture is played at |
| ↳ `name` | string | Name of the fixture (participants) |
| ↳ `starting_at` | string | Datetime the fixture starts |
| ↳ `result_info` | string | Final result summary |
| ↳ `leg` | string | Leg of the fixture (e.g. 1/1) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Length of the fixture in minutes |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Whether odds are available |
| ↳ `has_premium_odds` | boolean | Whether premium odds are available |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Last Updated Coaches [#get-last-updated-coaches]
Retrieve all coaches that have received updates in the past two hours
##### Input [#input-26]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;nationality) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-26]
| Parameter | Type | Description |
| - | - | - |
| `coaches` | array | Array of recently updated coach objects |
| ↳ `id` | number | Unique id of the coach |
| ↳ `player_id` | number | Player related to the coach |
| ↳ `sport_id` | number | Sport of the coach |
| ↳ `country_id` | number | Country of the coach |
| ↳ `nationality_id` | number | Nationality of the coach |
| ↳ `city_id` | number | Birth city of the coach |
| ↳ `common_name` | string | Common name of the coach |
| ↳ `firstname` | string | First name of the coach |
| ↳ `lastname` | string | Last name of the coach |
| ↳ `name` | string | Name of the coach |
| ↳ `display_name` | string | Display name of the coach |
| ↳ `image_path` | string | URL to the coach headshot |
| ↳ `height` | number | Height of the coach in cm |
| ↳ `weight` | number | Weight of the coach in kg |
| ↳ `date_of_birth` | string | Date of birth of the coach |
| ↳ `gender` | string | Gender of the coach |
#### Get Latest Updated Fixtures [#get-latest-updated-fixtures]
Retrieve all fixtures that have received updates within the last 10 seconds
##### Input [#input-27]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;scores) |
| `filters` | string | No | Filters to apply (e.g. fixtureLeagues:501) |
##### Output [#output-27]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of recently updated fixture objects |
| ↳ `id` | number | Unique id of the fixture |
| ↳ `sport_id` | number | Sport the fixture is played at |
| ↳ `league_id` | number | League the fixture is played in |
| ↳ `season_id` | number | Season the fixture is played in |
| ↳ `stage_id` | number | Stage the fixture is played in |
| ↳ `group_id` | number | Group the fixture is played in |
| ↳ `aggregate_id` | number | Aggregate the fixture belongs to |
| ↳ `round_id` | number | Round the fixture is played in |
| ↳ `state_id` | number | State (status) of the fixture |
| ↳ `venue_id` | number | Venue the fixture is played at |
| ↳ `name` | string | Name of the fixture (participants) |
| ↳ `starting_at` | string | Datetime the fixture starts |
| ↳ `result_info` | string | Final result summary |
| ↳ `leg` | string | Leg of the fixture (e.g. 1/1) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Length of the fixture in minutes |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Whether odds are available |
| ↳ `has_premium_odds` | boolean | Whether premium odds are available |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Latest Updated Livescores [#get-latest-updated-livescores]
Retrieve all livescores that have received updates within the last 10 seconds
##### Input [#input-28]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;scores) |
| `filters` | string | No | Filters to apply (e.g. fixtureLeagues:501) |
##### Output [#output-28]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of recently updated live fixture objects |
| ↳ `id` | number | Unique id of the fixture |
| ↳ `sport_id` | number | Sport the fixture is played at |
| ↳ `league_id` | number | League the fixture is played in |
| ↳ `season_id` | number | Season the fixture is played in |
| ↳ `stage_id` | number | Stage the fixture is played in |
| ↳ `group_id` | number | Group the fixture is played in |
| ↳ `aggregate_id` | number | Aggregate the fixture belongs to |
| ↳ `round_id` | number | Round the fixture is played in |
| ↳ `state_id` | number | State (status) of the fixture |
| ↳ `venue_id` | number | Venue the fixture is played at |
| ↳ `name` | string | Name of the fixture (participants) |
| ↳ `starting_at` | string | Datetime the fixture starts |
| ↳ `result_info` | string | Final result summary |
| ↳ `leg` | string | Leg of the fixture (e.g. 1/1) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Length of the fixture in minutes |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Whether odds are available |
| ↳ `has_premium_odds` | boolean | Whether premium odds are available |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Last Updated Players [#get-last-updated-players]
Retrieve all players that have received updates in the past two hours
##### Input [#input-29]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. nationality;position) |
| `filters` | string | No | Filters to apply |
##### Output [#output-29]
| Parameter | Type | Description |
| - | - | - |
| `players` | array | Array of recently updated player objects |
| ↳ `id` | number | Unique id of the player |
| ↳ `sport_id` | number | Sport of the player |
| ↳ `country_id` | number | Country of birth of the player |
| ↳ `nationality_id` | number | Nationality of the player |
| ↳ `city_id` | number | City of birth of the player |
| ↳ `position_id` | number | Position of the player |
| ↳ `detailed_position_id` | number | Detailed position of the player |
| ↳ `type_id` | number | Type of the player |
| ↳ `common_name` | string | Name the player is known for |
| ↳ `firstname` | string | First name of the player |
| ↳ `lastname` | string | Last name of the player |
| ↳ `name` | string | Name of the player |
| ↳ `display_name` | string | Display name of the player |
| ↳ `image_path` | string | URL to the player headshot |
| ↳ `height` | number | Height of the player in cm |
| ↳ `weight` | number | Weight of the player in kg |
| ↳ `date_of_birth` | string | Date of birth of the player |
| ↳ `gender` | string | Gender of the player |
#### Get Latest Team of the Week [#get-latest-team-of-the-week]
Retrieve the latest Team of the Week (TOTW) for a league ID from Sportmonks
##### Input [#input-30]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `leagueId` | string | Yes | The unique id of the league |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. fixture;team;player;round) |
##### Output [#output-30]
| Parameter | Type | Description |
| - | - | - |
| `totw` | array | Array of the latest Team of the Week entries for the league |
| ↳ `id` | number | Unique id of the TOTW entry |
| ↳ `player_id` | number | Player of the team of the week |
| ↳ `fixture_id` | number | Fixture the TOTW player played in |
| ↳ `round_id` | number | Round the fixture is played at |
| ↳ `team_id` | number | Team the TOTW player played for |
| ↳ `rating` | string | Rating of the TOTW player |
| ↳ `formation_position` | number | Player position in the TOTW formation |
| ↳ `formation` | string | The TOTW's formation |
#### Get Latest Transfers [#get-latest-transfers]
Retrieve the latest transfers available within your Sportmonks subscription
##### Input [#input-31]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;fromTeam;toTeam) |
| `filters` | string | No | Filters to apply (e.g. transferTypes:219,220) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-31]
| Parameter | Type | Description |
| - | - | - |
| `transfers` | array | Array of the latest transfer objects |
| ↳ `id` | number | Unique id of the transfer |
| ↳ `sport_id` | number | Sport of the transfer |
| ↳ `player_id` | number | Player who transferred |
| ↳ `type_id` | number | Type of the transfer |
| ↳ `from_team_id` | number | Team the player transferred from |
| ↳ `to_team_id` | number | Team the player transferred to |
| ↳ `position_id` | number | Position id of the transfer |
| ↳ `detailed_position_id` | number | Detailed position id of the transfer |
| ↳ `date` | string | Date of the transfer |
| ↳ `career_ended` | boolean | Whether the transfer ended the career |
| ↳ `completed` | boolean | Whether the transfer is completed |
| ↳ `amount` | number | Transfer fee amount |
#### Get League by ID [#get-league-by-id]
Retrieve a single football league by its ID from Sportmonks
##### Input [#input-32]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `leagueId` | string | Yes | The unique id of the league |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;currentSeason;seasons) |
| `filters` | string | No | Filters to apply |
##### Output [#output-32]
| Parameter | Type | Description |
| - | - | - |
| `league` | object | The requested league object |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | number | Whether the league is active (1) or inactive (0) |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date the last fixture was played |
| ↳ `category` | number | Importance category of the league (1-4) |
#### Get Leagues [#get-leagues]
Retrieve all football leagues available within your Sportmonks subscription
##### Input [#input-33]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;currentSeason) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order leagues (asc or desc) |
##### Output [#output-33]
| Parameter | Type | Description |
| - | - | - |
| `leagues` | array | Array of league objects |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | number | Whether the league is active (1) or inactive (0) |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date the last fixture was played |
| ↳ `category` | number | Importance category of the league (1-4) |
#### Get Leagues by Country [#get-leagues-by-country]
Retrieve all leagues for a country ID from Sportmonks
##### Input [#input-34]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `countryId` | string | Yes | The unique id of the country |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;currentSeason) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order leagues (asc or desc) |
##### Output [#output-34]
| Parameter | Type | Description |
| - | - | - |
| `leagues` | array | Array of league objects for the country |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | number | Whether the league is active (1) or inactive (0) |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date the last fixture was played |
| ↳ `category` | number | Importance category of the league (1-4) |
#### Get Leagues by Date [#get-leagues-by-date]
Retrieve all leagues with fixtures on a given date (YYYY-MM-DD) from Sportmonks
##### Input [#input-35]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `date` | string | Yes | The fixture date in YYYY-MM-DD format |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;currentSeason) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order leagues (asc or desc) |
##### Output [#output-35]
| Parameter | Type | Description |
| - | - | - |
| `leagues` | array | Array of league objects with fixtures on the requested date |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | number | Whether the league is active (1) or inactive (0) |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date the last fixture was played |
| ↳ `category` | number | Importance category of the league (1-4) |
#### Get Leagues by Team [#get-leagues-by-team]
Retrieve all current and historical leagues for a team ID from Sportmonks
##### Input [#input-36]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `teamId` | string | Yes | The unique id of the team |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;currentSeason) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order leagues (asc or desc) |
##### Output [#output-36]
| Parameter | Type | Description |
| - | - | - |
| `leagues` | array | Array of current and historical league objects for the team |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | number | Whether the league is active (1) or inactive (0) |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date the last fixture was played |
| ↳ `category` | number | Importance category of the league (1-4) |
#### Get Live Leagues [#get-live-leagues]
Retrieve all leagues that have fixtures currently being played from Sportmonks
##### Input [#input-37]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;currentSeason) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order leagues (asc or desc) |
##### Output [#output-37]
| Parameter | Type | Description |
| - | - | - |
| `leagues` | array | Array of currently live league objects |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | number | Whether the league is active (1) or inactive (0) |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date the last fixture was played |
| ↳ `category` | number | Importance category of the league (1-4) |
#### Get Live Probabilities [#get-live-probabilities]
Retrieve all live (in-play) prediction probabilities from Sportmonks
##### Input [#input-38]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. type;fixture) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-38]
| Parameter | Type | Description |
| - | - | - |
| `predictions` | array | Array of live probability prediction objects |
| ↳ `id` | number | Unique id of the live prediction record |
| ↳ `fixture_id` | number | Fixture the prediction belongs to |
| ↳ `period_id` | number | Match period the prediction was recorded in |
| ↳ `minute` | number | Match minute the prediction was generated |
| ↳ `predictions` | json | Home win, away win and draw probabilities as percentages |
| ↳ `type_id` | number | Type of the prediction (237 for fulltime result) |
#### Get Live Probabilities by Fixture [#get-live-probabilities-by-fixture]
Retrieve all live (in-play) prediction probabilities for a fixture ID from Sportmonks
##### Input [#input-39]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. type;fixture) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-39]
| Parameter | Type | Description |
| - | - | - |
| `predictions` | array | Array of live probability prediction objects for the fixture |
| ↳ `id` | number | Unique id of the live prediction record |
| ↳ `fixture_id` | number | Fixture the prediction belongs to |
| ↳ `period_id` | number | Match period the prediction was recorded in |
| ↳ `minute` | number | Match minute the prediction was generated |
| ↳ `predictions` | json | Home win, away win and draw probabilities as percentages |
| ↳ `type_id` | number | Type of the prediction (237 for fulltime result) |
#### Get Live Standings by League [#get-live-standings-by-league]
Retrieve the live standing table for a league ID from Sportmonks
##### Input [#input-40]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `leagueId` | string | Yes | The unique id of the league |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details) |
| `filters` | string | No | Filters to apply (e.g. standingGroups:246697) |
##### Output [#output-40]
| Parameter | Type | Description |
| - | - | - |
| `standings` | array | Array of live standing entries for the league |
| ↳ `id` | number | Unique id of the standing |
| ↳ `participant_id` | number | Team related to the standing |
| ↳ `sport_id` | number | Sport related to the standing |
| ↳ `league_id` | number | League related to the standing |
| ↳ `season_id` | number | Season related to the standing |
| ↳ `stage_id` | number | Stage related to the standing |
| ↳ `group_id` | number | Group related to the standing |
| ↳ `round_id` | number | Round related to the standing |
| ↳ `standing_rule_id` | number | Standing rule related to the standing |
| ↳ `position` | number | Position of the team in the standing |
| ↳ `result` | string | Movement of the team in the standing |
| ↳ `points` | number | Points the team has gathered |
#### Get Livescores [#get-livescores]
Retrieve fixtures starting within 15 minutes and currently in progress from Sportmonks
##### Input [#input-41]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;scores;events) |
| `filters` | string | No | Filters to apply (e.g. fixtureLeagues:501) |
##### Output [#output-41]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of live fixture objects |
| ↳ `id` | number | Unique id of the fixture |
| ↳ `sport_id` | number | Sport the fixture is played at |
| ↳ `league_id` | number | League the fixture is played in |
| ↳ `season_id` | number | Season the fixture is played in |
| ↳ `stage_id` | number | Stage the fixture is played in |
| ↳ `group_id` | number | Group the fixture is played in |
| ↳ `aggregate_id` | number | Aggregate the fixture belongs to |
| ↳ `round_id` | number | Round the fixture is played in |
| ↳ `state_id` | number | State (status) of the fixture |
| ↳ `venue_id` | number | Venue the fixture is played at |
| ↳ `name` | string | Name of the fixture (participants) |
| ↳ `starting_at` | string | Datetime the fixture starts |
| ↳ `result_info` | string | Final result summary |
| ↳ `leg` | string | Leg of the fixture (e.g. 1/1) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Length of the fixture in minutes |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Whether odds are available |
| ↳ `has_premium_odds` | boolean | Whether premium odds are available |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get All Match Facts [#get-all-match-facts]
Retrieve all available match facts within your Sportmonks subscription (beta)
##### Input [#input-42]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. type;sport;fixture) |
| `filters` | string | No | Filters to apply (e.g. matchFactTypes:76088) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-42]
| Parameter | Type | Description |
| - | - | - |
| `matchFacts` | array | Array of match fact objects |
| ↳ `id` | number | Unique id of the match fact |
| ↳ `sport_id` | number | Sport of the match fact |
| ↳ `fixture_id` | number | Fixture related to the match fact |
| ↳ `type_id` | number | Type of the match fact |
| ↳ `participant` | string | Team the fact relates to (home or away) |
| ↳ `basis` | string | Basis of the match fact (e.g. h2h, overall) |
| ↳ `data` | json | Match fact data payload (counts and percentages) |
| ↳ `natural_language` | string | Human-readable description of the match fact |
| ↳ `category` | string | Category of the match fact |
| ↳ `scope` | string | Scope of the match fact |
#### Get Match Facts by Date Range [#get-match-facts-by-date-range]
Retrieve match facts within a date range (YYYY-MM-DD) from Sportmonks (beta)
##### Input [#input-43]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `startDate` | string | Yes | Start date in YYYY-MM-DD format |
| `endDate` | string | Yes | End date in YYYY-MM-DD format |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. type;sport;fixture) |
| `filters` | string | No | Filters to apply (e.g. matchFactTypes:76088) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-43]
| Parameter | Type | Description |
| - | - | - |
| `matchFacts` | array | Array of match fact objects within the date range |
| ↳ `id` | number | Unique id of the match fact |
| ↳ `sport_id` | number | Sport of the match fact |
| ↳ `fixture_id` | number | Fixture related to the match fact |
| ↳ `type_id` | number | Type of the match fact |
| ↳ `participant` | string | Team the fact relates to (home or away) |
| ↳ `basis` | string | Basis of the match fact (e.g. h2h, overall) |
| ↳ `data` | json | Match fact data payload (counts and percentages) |
| ↳ `natural_language` | string | Human-readable description of the match fact |
| ↳ `category` | string | Category of the match fact |
| ↳ `scope` | string | Scope of the match fact |
#### Get Match Facts by Fixture [#get-match-facts-by-fixture]
Retrieve match facts for a fixture ID from Sportmonks (beta)
##### Input [#input-44]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. type;sport;fixture) |
| `filters` | string | No | Filters to apply (e.g. matchFactTypes:76088) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-44]
| Parameter | Type | Description |
| - | - | - |
| `matchFacts` | array | Array of match fact objects for the fixture |
| ↳ `id` | number | Unique id of the match fact |
| ↳ `sport_id` | number | Sport of the match fact |
| ↳ `fixture_id` | number | Fixture related to the match fact |
| ↳ `type_id` | number | Type of the match fact |
| ↳ `participant` | string | Team the fact relates to (home or away) |
| ↳ `basis` | string | Basis of the match fact (e.g. h2h, overall) |
| ↳ `data` | json | Match fact data payload (counts and percentages) |
| ↳ `natural_language` | string | Human-readable description of the match fact |
| ↳ `category` | string | Category of the match fact |
| ↳ `scope` | string | Scope of the match fact |
#### Get Match Facts by League [#get-match-facts-by-league]
Retrieve match facts for a league ID from Sportmonks (beta)
##### Input [#input-45]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `leagueId` | string | Yes | The unique id of the league |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. type;sport;fixture) |
| `filters` | string | No | Filters to apply (e.g. matchFactTypes:76088) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-45]
| Parameter | Type | Description |
| - | - | - |
| `matchFacts` | array | Array of match fact objects for the league |
| ↳ `id` | number | Unique id of the match fact |
| ↳ `sport_id` | number | Sport of the match fact |
| ↳ `fixture_id` | number | Fixture related to the match fact |
| ↳ `type_id` | number | Type of the match fact |
| ↳ `participant` | string | Team the fact relates to (home or away) |
| ↳ `basis` | string | Basis of the match fact (e.g. h2h, overall) |
| ↳ `data` | json | Match fact data payload (counts and percentages) |
| ↳ `natural_language` | string | Human-readable description of the match fact |
| ↳ `category` | string | Category of the match fact |
| ↳ `scope` | string | Scope of the match fact |
#### Get Past Fixtures by TV Station [#get-past-fixtures-by-tv-station]
Retrieve all past fixtures that were available for a TV station ID from Sportmonks
##### Input [#input-46]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `tvStationId` | string | Yes | The unique id of the TV station |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants) |
| `filters` | string | No | Filters to apply (e.g. fixtureLeagues:501) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-46]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of past fixture objects for the TV station |
| ↳ `id` | number | Unique id of the fixture |
| ↳ `sport_id` | number | Sport the fixture is played at |
| ↳ `league_id` | number | League the fixture is played in |
| ↳ `season_id` | number | Season the fixture is played in |
| ↳ `stage_id` | number | Stage the fixture is played in |
| ↳ `group_id` | number | Group the fixture is played in |
| ↳ `aggregate_id` | number | Aggregate the fixture belongs to |
| ↳ `round_id` | number | Round the fixture is played in |
| ↳ `state_id` | number | State (status) of the fixture |
| ↳ `venue_id` | number | Venue the fixture is played at |
| ↳ `name` | string | Name of the fixture (participants) |
| ↳ `starting_at` | string | Datetime the fixture starts |
| ↳ `result_info` | string | Final result summary |
| ↳ `leg` | string | Leg of the fixture (e.g. 1/1) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Length of the fixture in minutes |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Whether odds are available |
| ↳ `has_premium_odds` | boolean | Whether premium odds are available |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Player by ID [#get-player-by-id]
Retrieve a single football player by their ID from Sportmonks
##### Input [#input-47]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `playerId` | string | Yes | The unique id of the player |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;position;teams.team;statistics) |
| `filters` | string | No | Filters to apply |
##### Output [#output-47]
| Parameter | Type | Description |
| - | - | - |
| `player` | object | The requested player object |
| ↳ `id` | number | Unique id of the player |
| ↳ `sport_id` | number | Sport of the player |
| ↳ `country_id` | number | Country of birth of the player |
| ↳ `nationality_id` | number | Nationality of the player |
| ↳ `city_id` | number | City of birth of the player |
| ↳ `position_id` | number | Position of the player |
| ↳ `detailed_position_id` | number | Detailed position of the player |
| ↳ `type_id` | number | Type of the player |
| ↳ `common_name` | string | Name the player is known for |
| ↳ `firstname` | string | First name of the player |
| ↳ `lastname` | string | Last name of the player |
| ↳ `name` | string | Name of the player |
| ↳ `display_name` | string | Display name of the player |
| ↳ `image_path` | string | URL to the player headshot |
| ↳ `height` | number | Height of the player in cm |
| ↳ `weight` | number | Weight of the player in kg |
| ↳ `date_of_birth` | string | Date of birth of the player |
| ↳ `gender` | string | Gender of the player |
#### Get Players by Country [#get-players-by-country]
Retrieve all players for a country ID from Sportmonks
##### Input [#input-48]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `countryId` | string | Yes | The unique id of the country |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. nationality;position) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order players by id (asc or desc) |
##### Output [#output-48]
| Parameter | Type | Description |
| - | - | - |
| `players` | array | Array of player objects for the country |
| ↳ `id` | number | Unique id of the player |
| ↳ `sport_id` | number | Sport of the player |
| ↳ `country_id` | number | Country of birth of the player |
| ↳ `nationality_id` | number | Nationality of the player |
| ↳ `city_id` | number | City of birth of the player |
| ↳ `position_id` | number | Position of the player |
| ↳ `detailed_position_id` | number | Detailed position of the player |
| ↳ `type_id` | number | Type of the player |
| ↳ `common_name` | string | Name the player is known for |
| ↳ `firstname` | string | First name of the player |
| ↳ `lastname` | string | Last name of the player |
| ↳ `name` | string | Name of the player |
| ↳ `display_name` | string | Display name of the player |
| ↳ `image_path` | string | URL to the player headshot |
| ↳ `height` | number | Height of the player in cm |
| ↳ `weight` | number | Weight of the player in kg |
| ↳ `date_of_birth` | string | Date of birth of the player |
| ↳ `gender` | string | Gender of the player |
#### Get Post-Match News [#get-post-match-news]
Retrieve all post-match news articles available within your Sportmonks subscription
##### Input [#input-49]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. fixture;league) |
| `filters` | string | No | Filters to apply (e.g. newsitemLeagues:8) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order news by id (asc or desc) |
##### Output [#output-49]
| Parameter | Type | Description |
| - | - | - |
| `news` | array | Array of post-match news articles |
| ↳ `id` | number | Unique id of the news article |
| ↳ `fixture_id` | number | Fixture related to the news article |
| ↳ `league_id` | number | League related to the news article |
| ↳ `title` | string | Title of the news article |
| ↳ `type` | string | Type of the news (prematch or postmatch) |
#### Get Post-Match News by Season [#get-post-match-news-by-season]
Retrieve all post-match news articles for a season ID from Sportmonks
##### Input [#input-50]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. fixture;league) |
| `filters` | string | No | Filters to apply (e.g. newsitemLeagues:8) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order news (asc or desc) |
##### Output [#output-50]
| Parameter | Type | Description |
| - | - | - |
| `news` | array | Array of post-match news articles for the season |
| ↳ `id` | number | Unique id of the news article |
| ↳ `fixture_id` | number | Fixture related to the news article |
| ↳ `league_id` | number | League related to the news article |
| ↳ `title` | string | Title of the news article |
| ↳ `type` | string | Type of the news (prematch or postmatch) |
#### Get Predictability by League [#get-predictability-by-league]
Retrieve the predictions model performance for a league ID from Sportmonks
##### Input [#input-51]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `leagueId` | string | Yes | The unique id of the league |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. type;league) |
| `filters` | string | No | Filters to apply (e.g. predictabilityTypes:245) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-51]
| Parameter | Type | Description |
| - | - | - |
| `predictability` | array | Array of predictability records for the league |
| ↳ `id` | number | Unique id of the predictability record |
| ↳ `league_id` | number | League related to the predictability |
| ↳ `type_id` | number | Type of the predictability |
| ↳ `data` | json | Predictability values per market |
#### Get Pre-Match News [#get-pre-match-news]
Retrieve all pre-match news articles available within your Sportmonks subscription
##### Input [#input-52]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. fixture;league) |
| `filters` | string | No | Filters to apply (e.g. newsitemLeagues:8) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order news by id (asc or desc) |
##### Output [#output-52]
| Parameter | Type | Description |
| - | - | - |
| `news` | array | Array of pre-match news articles |
| ↳ `id` | number | Unique id of the news article |
| ↳ `fixture_id` | number | Fixture related to the news article |
| ↳ `league_id` | number | League related to the news article |
| ↳ `title` | string | Title of the news article |
| ↳ `type` | string | Type of the news (prematch or postmatch) |
#### Get Pre-Match News by Season [#get-pre-match-news-by-season]
Retrieve all pre-match news articles for a season ID from Sportmonks
##### Input [#input-53]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. fixture;league) |
| `filters` | string | No | Filters to apply (e.g. newsitemLeagues:8) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order news (asc or desc) |
##### Output [#output-53]
| Parameter | Type | Description |
| - | - | - |
| `news` | array | Array of pre-match news articles for the season |
| ↳ `id` | number | Unique id of the news article |
| ↳ `fixture_id` | number | Fixture related to the news article |
| ↳ `league_id` | number | League related to the news article |
| ↳ `title` | string | Title of the news article |
| ↳ `type` | string | Type of the news (prematch or postmatch) |
#### Get Pre-Match News for Upcoming Fixtures [#get-pre-match-news-for-upcoming-fixtures]
Retrieve all pre-match news articles for upcoming fixtures from Sportmonks
##### Input [#input-54]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. fixture;league) |
| `filters` | string | No | Filters to apply (e.g. newsitemLeagues:8) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order news (asc or desc) |
##### Output [#output-54]
| Parameter | Type | Description |
| - | - | - |
| `news` | array | Array of pre-match news articles for upcoming fixtures |
| ↳ `id` | number | Unique id of the news article |
| ↳ `fixture_id` | number | Fixture related to the news article |
| ↳ `league_id` | number | League related to the news article |
| ↳ `title` | string | Title of the news article |
| ↳ `type` | string | Type of the news (prematch or postmatch) |
#### Get Probabilities [#get-probabilities]
Retrieve all prediction probabilities available within your Sportmonks subscription
##### Input [#input-55]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. type;fixture) |
| `filters` | string | No | Filters to apply (e.g. predictionTypes:236) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-55]
| Parameter | Type | Description |
| - | - | - |
| `predictions` | array | Array of prediction probability objects |
| ↳ `id` | number | Unique id of the prediction |
| ↳ `fixture_id` | number | Fixture related to the prediction |
| ↳ `predictions` | json | Prediction payload (varies by type: score map, value bet object, etc.) |
| ↳ `type_id` | number | Type of the prediction |
#### Get Predictions by Fixture [#get-predictions-by-fixture]
Retrieve prediction probabilities for a fixture by fixture ID from Sportmonks
##### Input [#input-56]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. type;fixture) |
| `filters` | string | No | Filters to apply (e.g. predictionTypes:236) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-56]
| Parameter | Type | Description |
| - | - | - |
| `predictions` | array | Array of prediction probability entries for the fixture |
| ↳ `id` | number | Unique id of the prediction |
| ↳ `fixture_id` | number | Fixture related to the prediction |
| ↳ `predictions` | json | Prediction payload (varies by type: score map, value bet object, etc.) |
| ↳ `type_id` | number | Type of the prediction |
#### Get Referee by ID [#get-referee-by-id]
Retrieve a single football referee by their ID from Sportmonks
##### Input [#input-57]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `refereeId` | string | Yes | The unique id of the referee |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;statistics) |
| `filters` | string | No | Filters to apply |
##### Output [#output-57]
| Parameter | Type | Description |
| - | - | - |
| `referee` | object | The requested referee object |
| ↳ `id` | number | Unique id of the referee |
| ↳ `sport_id` | number | Sport of the referee |
| ↳ `country_id` | number | Country of the referee |
| ↳ `nationality_id` | number | Nationality of the referee |
| ↳ `city_id` | number | Birth city of the referee |
| ↳ `common_name` | string | Common name of the referee |
| ↳ `firstname` | string | First name of the referee |
| ↳ `lastname` | string | Last name of the referee |
| ↳ `name` | string | Name of the referee |
| ↳ `display_name` | string | Display name of the referee |
| ↳ `image_path` | string | URL to the referee headshot |
| ↳ `height` | number | Height of the referee in cm |
| ↳ `weight` | number | Weight of the referee in kg |
| ↳ `date_of_birth` | string | Date of birth of the referee |
| ↳ `gender` | string | Gender of the referee |
#### Get Referees [#get-referees]
Retrieve all football referees available within your Sportmonks subscription
##### Input [#input-58]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;statistics) |
| `filters` | string | No | Filters to apply (e.g. refereeCountries:44) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-58]
| Parameter | Type | Description |
| - | - | - |
| `referees` | array | Array of referee objects |
| ↳ `id` | number | Unique id of the referee |
| ↳ `sport_id` | number | Sport of the referee |
| ↳ `country_id` | number | Country of the referee |
| ↳ `nationality_id` | number | Nationality of the referee |
| ↳ `city_id` | number | Birth city of the referee |
| ↳ `common_name` | string | Common name of the referee |
| ↳ `firstname` | string | First name of the referee |
| ↳ `lastname` | string | Last name of the referee |
| ↳ `name` | string | Name of the referee |
| ↳ `display_name` | string | Display name of the referee |
| ↳ `image_path` | string | URL to the referee headshot |
| ↳ `height` | number | Height of the referee in cm |
| ↳ `weight` | number | Weight of the referee in kg |
| ↳ `date_of_birth` | string | Date of birth of the referee |
| ↳ `gender` | string | Gender of the referee |
#### Get Referees by Country [#get-referees-by-country]
Retrieve all referees for a country ID from Sportmonks
##### Input [#input-59]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `countryId` | string | Yes | The unique id of the country |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;nationality) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-59]
| Parameter | Type | Description |
| - | - | - |
| `referees` | array | Array of referee objects for the country |
| ↳ `id` | number | Unique id of the referee |
| ↳ `sport_id` | number | Sport of the referee |
| ↳ `country_id` | number | Country of the referee |
| ↳ `nationality_id` | number | Nationality of the referee |
| ↳ `city_id` | number | Birth city of the referee |
| ↳ `common_name` | string | Common name of the referee |
| ↳ `firstname` | string | First name of the referee |
| ↳ `lastname` | string | Last name of the referee |
| ↳ `name` | string | Name of the referee |
| ↳ `display_name` | string | Display name of the referee |
| ↳ `image_path` | string | URL to the referee headshot |
| ↳ `height` | number | Height of the referee in cm |
| ↳ `weight` | number | Weight of the referee in kg |
| ↳ `date_of_birth` | string | Date of birth of the referee |
| ↳ `gender` | string | Gender of the referee |
#### Get Referees by Season [#get-referees-by-season]
Retrieve all referees for a season ID from Sportmonks
##### Input [#input-60]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;nationality) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-60]
| Parameter | Type | Description |
| - | - | - |
| `referees` | array | Array of referee objects for the season |
| ↳ `id` | number | Unique id of the referee |
| ↳ `sport_id` | number | Sport of the referee |
| ↳ `country_id` | number | Country of the referee |
| ↳ `nationality_id` | number | Nationality of the referee |
| ↳ `city_id` | number | Birth city of the referee |
| ↳ `common_name` | string | Common name of the referee |
| ↳ `firstname` | string | First name of the referee |
| ↳ `lastname` | string | Last name of the referee |
| ↳ `name` | string | Name of the referee |
| ↳ `display_name` | string | Display name of the referee |
| ↳ `image_path` | string | URL to the referee headshot |
| ↳ `height` | number | Height of the referee in cm |
| ↳ `weight` | number | Weight of the referee in kg |
| ↳ `date_of_birth` | string | Date of birth of the referee |
| ↳ `gender` | string | Gender of the referee |
#### Get Rivals by Team [#get-rivals-by-team]
Retrieve rival teams for a team by team ID from Sportmonks
##### Input [#input-61]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `teamId` | string | Yes | The unique id of the team |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. team;rival) |
##### Output [#output-61]
| Parameter | Type | Description |
| - | - | - |
| `rivals` | array | Array of rival relationships for the team |
| ↳ `sport_id` | number | Sport of the rival |
| ↳ `team_id` | number | Team the rivalry belongs to |
| ↳ `rival_id` | number | Rival team id |
#### Get Round by ID [#get-round-by-id]
Retrieve a single football round by its ID from Sportmonks
##### Input [#input-62]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `roundId` | string | Yes | The unique id of the round |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;season;stage;fixtures) |
| `filters` | string | No | Filters to apply |
##### Output [#output-62]
| Parameter | Type | Description |
| - | - | - |
| `round` | object | The requested round object |
| ↳ `id` | number | Unique id of the round |
| ↳ `sport_id` | number | Sport of the round |
| ↳ `league_id` | number | League of the round |
| ↳ `season_id` | number | Season of the round |
| ↳ `stage_id` | number | Stage of the round |
| ↳ `name` | string | Name of the round |
| ↳ `finished` | boolean | Whether the round is finished |
| ↳ `is_current` | boolean | Whether the round is the current round |
| ↳ `starting_at` | string | Start date of the round |
| ↳ `ending_at` | string | End date of the round |
| ↳ `games_in_current_week` | boolean | Whether the round has fixtures this week |
#### Get Round Statistics [#get-round-statistics]
Retrieve all available statistics for a round ID from Sportmonks
##### Input [#input-63]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `roundId` | string | Yes | The unique id of the round |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant) |
| `filters` | string | No | Filters to apply (e.g. seasonstatisticTypes:52,88) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-63]
| Parameter | Type | Description |
| - | - | - |
| `statistics` | array | Array of statistic entries for the round |
| ↳ `id` | number | Unique id of the statistic record |
| ↳ `model_id` | number | Id of the entity the statistic belongs to |
| ↳ `type_id` | number | Type of the statistic |
| ↳ `relation_id` | number | Related entity id (e.g. participant) when applicable |
| ↳ `value` | json | Statistic value payload (varies by type) |
#### Get Rounds [#get-rounds]
Retrieve all football rounds available within your Sportmonks subscription
##### Input [#input-64]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;season;stage) |
| `filters` | string | No | Filters to apply (e.g. roundSeasons:19735) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-64]
| Parameter | Type | Description |
| - | - | - |
| `rounds` | array | Array of round objects |
| ↳ `id` | number | Unique id of the round |
| ↳ `sport_id` | number | Sport of the round |
| ↳ `league_id` | number | League of the round |
| ↳ `season_id` | number | Season of the round |
| ↳ `stage_id` | number | Stage of the round |
| ↳ `name` | string | Name of the round |
| ↳ `finished` | boolean | Whether the round is finished |
| ↳ `is_current` | boolean | Whether the round is the current round |
| ↳ `starting_at` | string | Start date of the round |
| ↳ `ending_at` | string | End date of the round |
| ↳ `games_in_current_week` | boolean | Whether the round has fixtures this week |
#### Get Rounds by Season [#get-rounds-by-season]
Retrieve all rounds for a season ID from Sportmonks
##### Input [#input-65]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;stage) |
| `filters` | string | No | Filters to apply |
##### Output [#output-65]
| Parameter | Type | Description |
| - | - | - |
| `rounds` | array | Array of round objects for the season |
| ↳ `id` | number | Unique id of the round |
| ↳ `sport_id` | number | Sport of the round |
| ↳ `league_id` | number | League of the round |
| ↳ `season_id` | number | Season of the round |
| ↳ `stage_id` | number | Stage of the round |
| ↳ `name` | string | Name of the round |
| ↳ `finished` | boolean | Whether the round is finished |
| ↳ `is_current` | boolean | Whether the round is the current round |
| ↳ `starting_at` | string | Start date of the round |
| ↳ `ending_at` | string | End date of the round |
| ↳ `games_in_current_week` | boolean | Whether the round has fixtures this week |
#### Get Schedules by Season [#get-schedules-by-season]
Retrieve the full schedule (stages, rounds and fixtures) for a season by season ID
##### Input [#input-66]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
##### Output [#output-66]
| Parameter | Type | Description |
| - | - | - |
| `schedules` | json | Array of stages, each with nested rounds and their fixtures (participants, scores) |
#### Get Schedules by Season and Team [#get-schedules-by-season-and-team]
Retrieve the full season schedule for a specific team by season ID and team ID
##### Input [#input-67]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `teamId` | string | Yes | The unique id of the team |
##### Output [#output-67]
| Parameter | Type | Description |
| - | - | - |
| `schedules` | json | Array of stages, each with nested rounds and their fixtures for the team in the season |
#### Get Schedules by Team [#get-schedules-by-team]
Retrieve the full schedule (stages, rounds and fixtures) for a team by team ID
##### Input [#input-68]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `teamId` | string | Yes | The unique id of the team |
##### Output [#output-68]
| Parameter | Type | Description |
| - | - | - |
| `schedules` | json | Array of stages, each with nested rounds and their fixtures (participants, scores) |
#### Get Season by ID [#get-season-by-id]
Retrieve a single football season by its ID from Sportmonks
##### Input [#input-69]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;stages;fixtures) |
| `filters` | string | No | Filters to apply |
##### Output [#output-69]
| Parameter | Type | Description |
| - | - | - |
| `season` | object | The requested season object |
| ↳ `id` | number | Unique id of the season |
| ↳ `sport_id` | number | Sport of the season |
| ↳ `league_id` | number | League of the season |
| ↳ `tie_breaker_rule_id` | number | Tie-breaker rule of the season |
| ↳ `name` | string | Name of the season (e.g. 2023/2024) |
| ↳ `finished` | boolean | Whether the season is finished |
| ↳ `pending` | boolean | Whether the season is pending |
| ↳ `is_current` | boolean | Whether the season is the current season |
| ↳ `standing_method` | string | Standing calculation method |
| ↳ `starting_at` | string | Start date of the season |
| ↳ `ending_at` | string | End date of the season |
| ↳ `standings_recalculated_at` | string | Last standings recalculation time |
| ↳ `games_in_current_week` | boolean | Whether the season has fixtures this week |
#### Get Seasons [#get-seasons]
Retrieve all football seasons available within your Sportmonks subscription
##### Input [#input-70]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;stages) |
| `filters` | string | No | Filters to apply (e.g. seasonLeagues:501) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-70]
| Parameter | Type | Description |
| - | - | - |
| `seasons` | array | Array of season objects |
| ↳ `id` | number | Unique id of the season |
| ↳ `sport_id` | number | Sport of the season |
| ↳ `league_id` | number | League of the season |
| ↳ `tie_breaker_rule_id` | number | Tie-breaker rule of the season |
| ↳ `name` | string | Name of the season (e.g. 2023/2024) |
| ↳ `finished` | boolean | Whether the season is finished |
| ↳ `pending` | boolean | Whether the season is pending |
| ↳ `is_current` | boolean | Whether the season is the current season |
| ↳ `standing_method` | string | Standing calculation method |
| ↳ `starting_at` | string | Start date of the season |
| ↳ `ending_at` | string | End date of the season |
| ↳ `standings_recalculated_at` | string | Last standings recalculation time |
| ↳ `games_in_current_week` | boolean | Whether the season has fixtures this week |
#### Get Seasons by Team [#get-seasons-by-team]
Retrieve all seasons for a team ID from Sportmonks
##### Input [#input-71]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `teamId` | string | Yes | The unique id of the team |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;stages) |
| `filters` | string | No | Filters to apply |
##### Output [#output-71]
| Parameter | Type | Description |
| - | - | - |
| `seasons` | array | Array of season objects for the team |
| ↳ `id` | number | Unique id of the season |
| ↳ `sport_id` | number | Sport of the season |
| ↳ `league_id` | number | League of the season |
| ↳ `tie_breaker_rule_id` | number | Tie-breaker rule of the season |
| ↳ `name` | string | Name of the season (e.g. 2023/2024) |
| ↳ `finished` | boolean | Whether the season is finished |
| ↳ `pending` | boolean | Whether the season is pending |
| ↳ `is_current` | boolean | Whether the season is the current season |
| ↳ `standing_method` | string | Standing calculation method |
| ↳ `starting_at` | string | Start date of the season |
| ↳ `ending_at` | string | End date of the season |
| ↳ `standings_recalculated_at` | string | Last standings recalculation time |
| ↳ `games_in_current_week` | boolean | Whether the season has fixtures this week |
#### Get Stage by ID [#get-stage-by-id]
Retrieve a single football stage by its ID from Sportmonks
##### Input [#input-72]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `stageId` | string | Yes | The unique id of the stage |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;season;rounds) |
| `filters` | string | No | Filters to apply |
##### Output [#output-72]
| Parameter | Type | Description |
| - | - | - |
| `stage` | object | The requested stage object |
| ↳ `id` | number | Unique id of the stage |
| ↳ `sport_id` | number | Sport of the stage |
| ↳ `league_id` | number | League of the stage |
| ↳ `season_id` | number | Season of the stage |
| ↳ `type_id` | number | Type of the stage |
| ↳ `name` | string | Name of the stage |
| ↳ `sort_order` | number | Sort order of the stage |
| ↳ `finished` | boolean | Whether the stage is finished |
| ↳ `is_current` | boolean | Whether the stage is the current stage |
| ↳ `starting_at` | string | Start date of the stage |
| ↳ `ending_at` | string | End date of the stage |
| ↳ `games_in_current_week` | boolean | Whether the stage has fixtures this week |
#### Get Stage Statistics [#get-stage-statistics]
Retrieve all available statistics for a stage ID from Sportmonks
##### Input [#input-73]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `stageId` | string | Yes | The unique id of the stage |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant) |
| `filters` | string | No | Filters to apply (e.g. seasonstatisticTypes:52,88) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-73]
| Parameter | Type | Description |
| - | - | - |
| `statistics` | array | Array of statistic entries for the stage |
| ↳ `id` | number | Unique id of the statistic record |
| ↳ `model_id` | number | Id of the entity the statistic belongs to |
| ↳ `type_id` | number | Type of the statistic |
| ↳ `relation_id` | number | Related entity id (e.g. participant) when applicable |
| ↳ `value` | json | Statistic value payload (varies by type) |
#### Get Stages [#get-stages]
Retrieve all football stages available within your Sportmonks subscription
##### Input [#input-74]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;season;rounds) |
| `filters` | string | No | Filters to apply (e.g. stageSeasons:19735) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-74]
| Parameter | Type | Description |
| - | - | - |
| `stages` | array | Array of stage objects |
| ↳ `id` | number | Unique id of the stage |
| ↳ `sport_id` | number | Sport of the stage |
| ↳ `league_id` | number | League of the stage |
| ↳ `season_id` | number | Season of the stage |
| ↳ `type_id` | number | Type of the stage |
| ↳ `name` | string | Name of the stage |
| ↳ `sort_order` | number | Sort order of the stage |
| ↳ `finished` | boolean | Whether the stage is finished |
| ↳ `is_current` | boolean | Whether the stage is the current stage |
| ↳ `starting_at` | string | Start date of the stage |
| ↳ `ending_at` | string | End date of the stage |
| ↳ `games_in_current_week` | boolean | Whether the stage has fixtures this week |
#### Get Stages by Season [#get-stages-by-season]
Retrieve all stages for a season ID from Sportmonks
##### Input [#input-75]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;rounds) |
| `filters` | string | No | Filters to apply |
##### Output [#output-75]
| Parameter | Type | Description |
| - | - | - |
| `stages` | array | Array of stage objects for the season |
| ↳ `id` | number | Unique id of the stage |
| ↳ `sport_id` | number | Sport of the stage |
| ↳ `league_id` | number | League of the stage |
| ↳ `season_id` | number | Season of the stage |
| ↳ `type_id` | number | Type of the stage |
| ↳ `name` | string | Name of the stage |
| ↳ `sort_order` | number | Sort order of the stage |
| ↳ `finished` | boolean | Whether the stage is finished |
| ↳ `is_current` | boolean | Whether the stage is the current stage |
| ↳ `starting_at` | string | Start date of the stage |
| ↳ `ending_at` | string | End date of the stage |
| ↳ `games_in_current_week` | boolean | Whether the stage has fixtures this week |
#### Get Standing Corrections by Season [#get-standing-corrections-by-season]
Retrieve point corrections (awarded or deducted) for a season ID from Sportmonks
##### Input [#input-76]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;stage) |
| `filters` | string | No | Filters to apply |
##### Output [#output-76]
| Parameter | Type | Description |
| - | - | - |
| `corrections` | array | Array of standing correction entries for the season |
| ↳ `id` | number | Unique id of the standing correction |
| ↳ `season_id` | number | Season related to the correction |
| ↳ `stage_id` | number | Stage related to the correction |
| ↳ `group_id` | number | Group related to the correction |
| ↳ `type_id` | number | Type of the correction |
| ↳ `value` | number | Amount of points awarded or deducted |
| ↳ `calc_type` | string | Calculation type applied (e.g. + or -) |
| ↳ `participant_type` | string | Type of the participant (e.g. team) |
| ↳ `participant_id` | number | Participant the correction applies to |
| ↳ `active` | boolean | Whether the correction is active |
#### Get All Standings [#get-all-standings]
Retrieve all standings available within your Sportmonks subscription
##### Input [#input-77]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;league;season) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-77]
| Parameter | Type | Description |
| - | - | - |
| `standings` | array | Array of standing entries |
| ↳ `id` | number | Unique id of the standing |
| ↳ `participant_id` | number | Team related to the standing |
| ↳ `sport_id` | number | Sport related to the standing |
| ↳ `league_id` | number | League related to the standing |
| ↳ `season_id` | number | Season related to the standing |
| ↳ `stage_id` | number | Stage related to the standing |
| ↳ `group_id` | number | Group related to the standing |
| ↳ `round_id` | number | Round related to the standing |
| ↳ `standing_rule_id` | number | Standing rule related to the standing |
| ↳ `position` | number | Position of the team in the standing |
| ↳ `result` | string | Movement of the team in the standing |
| ↳ `points` | number | Points the team has gathered |
#### Get Standings by Round [#get-standings-by-round]
Retrieve the full standing table for a round ID from Sportmonks
##### Input [#input-78]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `roundId` | string | Yes | The unique id of the round |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details) |
| `filters` | string | No | Filters to apply (e.g. standingGroups:246697) |
##### Output [#output-78]
| Parameter | Type | Description |
| - | - | - |
| `standings` | array | Array of standing entries for the round |
| ↳ `id` | number | Unique id of the standing |
| ↳ `participant_id` | number | Team related to the standing |
| ↳ `sport_id` | number | Sport related to the standing |
| ↳ `league_id` | number | League related to the standing |
| ↳ `season_id` | number | Season related to the standing |
| ↳ `stage_id` | number | Stage related to the standing |
| ↳ `group_id` | number | Group related to the standing |
| ↳ `round_id` | number | Round related to the standing |
| ↳ `standing_rule_id` | number | Standing rule related to the standing |
| ↳ `position` | number | Position of the team in the standing |
| ↳ `result` | string | Movement of the team in the standing |
| ↳ `points` | number | Points the team has gathered |
#### Get Standings by Season [#get-standings-by-season]
Retrieve the full league standings table for a season by season ID from Sportmonks
##### Input [#input-79]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details;form) |
| `filters` | string | No | Filters to apply (e.g. standingStages:77453568) |
##### Output [#output-79]
| Parameter | Type | Description |
| - | - | - |
| `standings` | array | Array of standing entries for the season |
| ↳ `id` | number | Unique id of the standing |
| ↳ `participant_id` | number | Team related to the standing |
| ↳ `sport_id` | number | Sport related to the standing |
| ↳ `league_id` | number | League related to the standing |
| ↳ `season_id` | number | Season related to the standing |
| ↳ `stage_id` | number | Stage related to the standing |
| ↳ `group_id` | number | Group related to the standing |
| ↳ `round_id` | number | Round related to the standing |
| ↳ `standing_rule_id` | number | Standing rule related to the standing |
| ↳ `position` | number | Position of the team in the standing |
| ↳ `result` | string | Movement of the team in the standing |
| ↳ `points` | number | Points the team has gathered |
#### Get State by ID [#get-state-by-id]
Retrieve a single fixture state by its ID from Sportmonks
##### Input [#input-80]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `stateId` | string | Yes | The unique id of the state |
##### Output [#output-80]
| Parameter | Type | Description |
| - | - | - |
| `state` | object | The requested fixture state object |
| ↳ `id` | number | Unique id of the state |
| ↳ `state` | string | State code (e.g. NS, INPLAY\_1ST\_HALF) |
| ↳ `name` | string | Full name of the state (e.g. Not Started) |
| ↳ `short_name` | string | Short name of the state (e.g. NS) |
| ↳ `developer_name` | string | Developer name of the state |
#### Get States [#get-states]
Retrieve all fixture states (e.g. Not Started, 1st Half, Full Time) from Sportmonks
##### Input [#input-81]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-81]
| Parameter | Type | Description |
| - | - | - |
| `states` | array | Array of fixture state objects |
| ↳ `id` | number | Unique id of the state |
| ↳ `state` | string | State code (e.g. NS, INPLAY\_1ST\_HALF) |
| ↳ `name` | string | Full name of the state (e.g. Not Started) |
| ↳ `short_name` | string | Short name of the state (e.g. NS) |
| ↳ `developer_name` | string | Developer name of the state |
#### Get Team by ID [#get-team-by-id]
Retrieve a single football team by its ID from Sportmonks
##### Input [#input-82]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `teamId` | string | Yes | The unique id of the team |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;venue;coaches;players.player) |
| `filters` | string | No | Filters to apply |
##### Output [#output-82]
| Parameter | Type | Description |
| - | - | - |
| `team` | object | The requested team object |
| ↳ `id` | number | Unique id of the team |
| ↳ `sport_id` | number | Sport of the team |
| ↳ `country_id` | number | Country of the team |
| ↳ `venue_id` | number | Home venue of the team |
| ↳ `gender` | string | Gender of the team |
| ↳ `name` | string | Name of the team |
| ↳ `short_code` | string | Short code of the team |
| ↳ `image_path` | string | URL to the team logo |
| ↳ `founded` | number | Founding year of the team |
| ↳ `type` | string | Type of the team |
| ↳ `placeholder` | boolean | Whether the team is a placeholder |
| ↳ `last_played_at` | string | Date and time of the last played match |
#### Get All Team Rankings [#get-all-team-rankings]
Retrieve all team rankings available within your Sportmonks subscription (beta)
##### Input [#input-83]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. team) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-83]
| Parameter | Type | Description |
| - | - | - |
| `teamRankings` | array | Array of team ranking objects |
| ↳ `id` | number | Unique id of the team ranking |
| ↳ `team_id` | number | Team related to the ranking |
| ↳ `date` | string | Date of the ranking |
| ↳ `current_rank` | number | Placement of the team on that date |
| ↳ `scaled_score` | number | Scaled score of the team (0-100) |
#### Get Team Rankings by Date [#get-team-rankings-by-date]
Retrieve team rankings for a given date (YYYY-MM-DD) from Sportmonks (beta)
##### Input [#input-84]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `date` | string | Yes | The ranking date in YYYY-MM-DD format |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. team) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-84]
| Parameter | Type | Description |
| - | - | - |
| `teamRankings` | array | Array of team ranking objects for the date |
| ↳ `id` | number | Unique id of the team ranking |
| ↳ `team_id` | number | Team related to the ranking |
| ↳ `date` | string | Date of the ranking |
| ↳ `current_rank` | number | Placement of the team on that date |
| ↳ `scaled_score` | number | Scaled score of the team (0-100) |
#### Get Team Rankings by Team [#get-team-rankings-by-team]
Retrieve team rankings for a team ID from Sportmonks (beta)
##### Input [#input-85]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `teamId` | string | Yes | The unique id of the team |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. team) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-85]
| Parameter | Type | Description |
| - | - | - |
| `teamRankings` | array | Array of team ranking objects for the team |
| ↳ `id` | number | Unique id of the team ranking |
| ↳ `team_id` | number | Team related to the ranking |
| ↳ `date` | string | Date of the ranking |
| ↳ `current_rank` | number | Placement of the team on that date |
| ↳ `scaled_score` | number | Scaled score of the team (0-100) |
#### Get Team Squad [#get-team-squad]
Retrieve the current domestic squad for a team by team ID from Sportmonks
##### Input [#input-86]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `teamId` | string | Yes | The unique id of the team |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;position) |
| `filters` | string | No | Filters to apply |
##### Output [#output-86]
| Parameter | Type | Description |
| - | - | - |
| `squad` | array | Array of squad entries for the team |
| ↳ `id` | number | Unique id of the squad record |
| ↳ `transfer_id` | number | Transfer id of the squad record |
| ↳ `player_id` | number | Player in the squad |
| ↳ `team_id` | number | Team of the squad |
| ↳ `position_id` | number | Position of the player in the squad |
| ↳ `detailed_position_id` | number | Detailed position of the player in the squad |
| ↳ `jersey_number` | number | Jersey number of the player |
| ↳ `start` | string | Start contract date of the player |
| ↳ `end` | string | End contract date of the player |
#### Get Team Squad by Season [#get-team-squad-by-season]
Retrieve the (historical) squad for a team in a specific season from Sportmonks
##### Input [#input-87]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `teamId` | string | Yes | The unique id of the team |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;position) |
| `filters` | string | No | Filters to apply |
##### Output [#output-87]
| Parameter | Type | Description |
| - | - | - |
| `squad` | array | Array of squad entries for the team in the season |
| ↳ `id` | number | Unique id of the squad record |
| ↳ `transfer_id` | number | Transfer id of the squad record |
| ↳ `player_id` | number | Player in the squad |
| ↳ `team_id` | number | Team of the squad |
| ↳ `position_id` | number | Position of the player in the squad |
| ↳ `detailed_position_id` | number | Detailed position of the player in the squad |
| ↳ `jersey_number` | number | Jersey number of the player |
| ↳ `start` | string | Start contract date of the player |
| ↳ `end` | string | End contract date of the player |
#### Get Teams by Country [#get-teams-by-country]
Retrieve all teams for a country ID from Sportmonks
##### Input [#input-88]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `countryId` | string | Yes | The unique id of the country |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;venue) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order teams by id (asc or desc) |
##### Output [#output-88]
| Parameter | Type | Description |
| - | - | - |
| `teams` | array | Array of team objects for the country |
| ↳ `id` | number | Unique id of the team |
| ↳ `sport_id` | number | Sport of the team |
| ↳ `country_id` | number | Country of the team |
| ↳ `venue_id` | number | Home venue of the team |
| ↳ `gender` | string | Gender of the team |
| ↳ `name` | string | Name of the team |
| ↳ `short_code` | string | Short code of the team |
| ↳ `image_path` | string | URL to the team logo |
| ↳ `founded` | number | Founding year of the team |
| ↳ `type` | string | Type of the team |
| ↳ `placeholder` | boolean | Whether the team is a placeholder |
| ↳ `last_played_at` | string | Date and time of the last played match |
#### Get Teams by Season [#get-teams-by-season]
Retrieve all teams for a season ID from Sportmonks
##### Input [#input-89]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;venue) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order teams by id (asc or desc) |
##### Output [#output-89]
| Parameter | Type | Description |
| - | - | - |
| `teams` | array | Array of team objects for the season |
| ↳ `id` | number | Unique id of the team |
| ↳ `sport_id` | number | Sport of the team |
| ↳ `country_id` | number | Country of the team |
| ↳ `venue_id` | number | Home venue of the team |
| ↳ `gender` | string | Gender of the team |
| ↳ `name` | string | Name of the team |
| ↳ `short_code` | string | Short code of the team |
| ↳ `image_path` | string | URL to the team logo |
| ↳ `founded` | number | Founding year of the team |
| ↳ `type` | string | Type of the team |
| ↳ `placeholder` | boolean | Whether the team is a placeholder |
| ↳ `last_played_at` | string | Date and time of the last played match |
#### Get Topscorers by Season [#get-topscorers-by-season]
Retrieve the topscorers (goals, assists, cards) for a season by season ID from Sportmonks
##### Input [#input-90]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;participant;type) |
| `filters` | string | No | Filters to apply (e.g. seasontopscorerTypes:208) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order topscorers by position (asc or desc) |
##### Output [#output-90]
| Parameter | Type | Description |
| - | - | - |
| `topscorers` | array | Array of topscorer entries for the season |
| ↳ `id` | number | Unique id of the topscorer record |
| ↳ `season_id` | number | Season related to the topscorer (absent on stage topscorers) |
| ↳ `league_id` | number | League related to the topscorer |
| ↳ `stage_id` | number | Stage related to the topscorer |
| ↳ `player_id` | number | Player related to the topscorer |
| ↳ `participant_id` | number | Team related to the topscorer |
| ↳ `type_id` | number | Type of the topscorer (goals, assists, cards) |
| ↳ `position` | number | Position of the topscorer |
| ↳ `total` | number | Number of goals, assists or cards |
#### Get Topscorers by Stage [#get-topscorers-by-stage]
Retrieve topscorers for a stage by stage ID from Sportmonks
##### Input [#input-91]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `stageId` | string | Yes | The unique id of the stage |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;participant;type) |
| `filters` | string | No | Filters to apply (e.g. stageTopscorerTypes:208) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-91]
| Parameter | Type | Description |
| - | - | - |
| `topscorers` | array | Array of topscorer entries for the stage |
| ↳ `id` | number | Unique id of the topscorer record |
| ↳ `season_id` | number | Season related to the topscorer (absent on stage topscorers) |
| ↳ `league_id` | number | League related to the topscorer |
| ↳ `stage_id` | number | Stage related to the topscorer |
| ↳ `player_id` | number | Player related to the topscorer |
| ↳ `participant_id` | number | Team related to the topscorer |
| ↳ `type_id` | number | Type of the topscorer (goals, assists, cards) |
| ↳ `position` | number | Position of the topscorer |
| ↳ `total` | number | Number of goals, assists or cards |
#### Get All Team of the Week [#get-all-team-of-the-week]
Retrieve all available Team of the Week (TOTW) entries from Sportmonks
##### Input [#input-92]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. fixture;team;player;round) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-92]
| Parameter | Type | Description |
| - | - | - |
| `totw` | array | Array of Team of the Week entries |
| ↳ `id` | number | Unique id of the TOTW entry |
| ↳ `player_id` | number | Player of the team of the week |
| ↳ `fixture_id` | number | Fixture the TOTW player played in |
| ↳ `round_id` | number | Round the fixture is played at |
| ↳ `team_id` | number | Team the TOTW player played for |
| ↳ `rating` | string | Rating of the TOTW player |
| ↳ `formation_position` | number | Player position in the TOTW formation |
| ↳ `formation` | string | The TOTW's formation |
#### Get Team of the Week by Round [#get-team-of-the-week-by-round]
Retrieve the Team of the Week (TOTW) for a round ID from Sportmonks
##### Input [#input-93]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `roundId` | string | Yes | The unique id of the round |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. fixture;team;player;round) |
##### Output [#output-93]
| Parameter | Type | Description |
| - | - | - |
| `totw` | array | Array of Team of the Week entries for the round |
| ↳ `id` | number | Unique id of the TOTW entry |
| ↳ `player_id` | number | Player of the team of the week |
| ↳ `fixture_id` | number | Fixture the TOTW player played in |
| ↳ `round_id` | number | Round the fixture is played at |
| ↳ `team_id` | number | Team the TOTW player played for |
| ↳ `rating` | string | Rating of the TOTW player |
| ↳ `formation_position` | number | Player position in the TOTW formation |
| ↳ `formation` | string | The TOTW's formation |
#### Get Transfer by ID [#get-transfer-by-id]
Retrieve a single transfer by its ID from Sportmonks
##### Input [#input-94]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `transferId` | string | Yes | The unique id of the transfer |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;fromTeam;toTeam) |
| `filters` | string | No | Filters to apply |
##### Output [#output-94]
| Parameter | Type | Description |
| - | - | - |
| `transfer` | object | The requested transfer object |
| ↳ `id` | number | Unique id of the transfer |
| ↳ `sport_id` | number | Sport of the transfer |
| ↳ `player_id` | number | Player who transferred |
| ↳ `type_id` | number | Type of the transfer |
| ↳ `from_team_id` | number | Team the player transferred from |
| ↳ `to_team_id` | number | Team the player transferred to |
| ↳ `position_id` | number | Position id of the transfer |
| ↳ `detailed_position_id` | number | Detailed position id of the transfer |
| ↳ `date` | string | Date of the transfer |
| ↳ `career_ended` | boolean | Whether the transfer ended the career |
| ↳ `completed` | boolean | Whether the transfer is completed |
| ↳ `amount` | number | Transfer fee amount |
#### Get Transfer Rumour by ID [#get-transfer-rumour-by-id]
Retrieve a single transfer rumour by its ID from Sportmonks
##### Input [#input-95]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `rumourId` | string | Yes | The unique id of the transfer rumour |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;fromTeam;toTeam) |
| `filters` | string | No | Filters to apply |
##### Output [#output-95]
| Parameter | Type | Description |
| - | - | - |
| `transferRumour` | object | The requested transfer rumour object |
| ↳ `id` | number | Unique id of the transfer rumour |
| ↳ `sport_id` | number | Sport of the transfer rumour |
| ↳ `player_id` | number | Player the rumour relates to |
| ↳ `position_id` | number | Position id of the player |
| ↳ `from_team_id` | number | Team the player would transfer from |
| ↳ `to_team_id` | number | Team the player would transfer to |
| ↳ `transfer_fee_id` | number | Transfer fee id of the rumour |
| ↳ `probability` | string | Probability of the rumour (e.g. LOW) |
| ↳ `source_name` | string | Name of the source of the rumour |
| ↳ `source_url` | string | URL of the source of the rumour |
| ↳ `amount` | number | Estimated transfer fee amount |
| ↳ `currency` | string | Currency of the amount |
| ↳ `date` | string | Date of the rumour |
| ↳ `type_id` | number | Type of the transfer rumour |
#### Get Transfer Rumours Between Dates [#get-transfer-rumours-between-dates]
Retrieve transfer rumours within a date range (YYYY-MM-DD) from Sportmonks
##### Input [#input-96]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `startDate` | string | Yes | Start date in YYYY-MM-DD format |
| `endDate` | string | Yes | End date in YYYY-MM-DD format |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;fromTeam;toTeam) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-96]
| Parameter | Type | Description |
| - | - | - |
| `transferRumours` | array | Array of transfer rumour objects within the date range |
| ↳ `id` | number | Unique id of the transfer rumour |
| ↳ `sport_id` | number | Sport of the transfer rumour |
| ↳ `player_id` | number | Player the rumour relates to |
| ↳ `position_id` | number | Position id of the player |
| ↳ `from_team_id` | number | Team the player would transfer from |
| ↳ `to_team_id` | number | Team the player would transfer to |
| ↳ `transfer_fee_id` | number | Transfer fee id of the rumour |
| ↳ `probability` | string | Probability of the rumour (e.g. LOW) |
| ↳ `source_name` | string | Name of the source of the rumour |
| ↳ `source_url` | string | URL of the source of the rumour |
| ↳ `amount` | number | Estimated transfer fee amount |
| ↳ `currency` | string | Currency of the amount |
| ↳ `date` | string | Date of the rumour |
| ↳ `type_id` | number | Type of the transfer rumour |
#### Get Transfer Rumours by Player [#get-transfer-rumours-by-player]
Retrieve transfer rumours for a player ID from Sportmonks
##### Input [#input-97]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `playerId` | string | Yes | The unique id of the player |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;fromTeam;toTeam) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-97]
| Parameter | Type | Description |
| - | - | - |
| `transferRumours` | array | Array of transfer rumour objects for the player |
| ↳ `id` | number | Unique id of the transfer rumour |
| ↳ `sport_id` | number | Sport of the transfer rumour |
| ↳ `player_id` | number | Player the rumour relates to |
| ↳ `position_id` | number | Position id of the player |
| ↳ `from_team_id` | number | Team the player would transfer from |
| ↳ `to_team_id` | number | Team the player would transfer to |
| ↳ `transfer_fee_id` | number | Transfer fee id of the rumour |
| ↳ `probability` | string | Probability of the rumour (e.g. LOW) |
| ↳ `source_name` | string | Name of the source of the rumour |
| ↳ `source_url` | string | URL of the source of the rumour |
| ↳ `amount` | number | Estimated transfer fee amount |
| ↳ `currency` | string | Currency of the amount |
| ↳ `date` | string | Date of the rumour |
| ↳ `type_id` | number | Type of the transfer rumour |
#### Get Transfer Rumours by Team [#get-transfer-rumours-by-team]
Retrieve transfer rumours for a team ID from Sportmonks
##### Input [#input-98]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `teamId` | string | Yes | The unique id of the team |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;fromTeam;toTeam) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-98]
| Parameter | Type | Description |
| - | - | - |
| `transferRumours` | array | Array of transfer rumour objects for the team |
| ↳ `id` | number | Unique id of the transfer rumour |
| ↳ `sport_id` | number | Sport of the transfer rumour |
| ↳ `player_id` | number | Player the rumour relates to |
| ↳ `position_id` | number | Position id of the player |
| ↳ `from_team_id` | number | Team the player would transfer from |
| ↳ `to_team_id` | number | Team the player would transfer to |
| ↳ `transfer_fee_id` | number | Transfer fee id of the rumour |
| ↳ `probability` | string | Probability of the rumour (e.g. LOW) |
| ↳ `source_name` | string | Name of the source of the rumour |
| ↳ `source_url` | string | URL of the source of the rumour |
| ↳ `amount` | number | Estimated transfer fee amount |
| ↳ `currency` | string | Currency of the amount |
| ↳ `date` | string | Date of the rumour |
| ↳ `type_id` | number | Type of the transfer rumour |
#### Get Transfers Between Dates [#get-transfers-between-dates]
Retrieve transfers within a date range (YYYY-MM-DD) from Sportmonks
##### Input [#input-99]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `startDate` | string | Yes | Start date in YYYY-MM-DD format |
| `endDate` | string | Yes | End date in YYYY-MM-DD format |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;fromTeam;toTeam) |
| `filters` | string | No | Filters to apply (e.g. transferTypes:219,220) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-99]
| Parameter | Type | Description |
| - | - | - |
| `transfers` | array | Array of transfer objects within the date range |
| ↳ `id` | number | Unique id of the transfer |
| ↳ `sport_id` | number | Sport of the transfer |
| ↳ `player_id` | number | Player who transferred |
| ↳ `type_id` | number | Type of the transfer |
| ↳ `from_team_id` | number | Team the player transferred from |
| ↳ `to_team_id` | number | Team the player transferred to |
| ↳ `position_id` | number | Position id of the transfer |
| ↳ `detailed_position_id` | number | Detailed position id of the transfer |
| ↳ `date` | string | Date of the transfer |
| ↳ `career_ended` | boolean | Whether the transfer ended the career |
| ↳ `completed` | boolean | Whether the transfer is completed |
| ↳ `amount` | number | Transfer fee amount |
#### Get Transfers by Player [#get-transfers-by-player]
Retrieve transfers for a player by player ID from Sportmonks
##### Input [#input-100]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `playerId` | string | Yes | The unique id of the player |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. fromTeam;toTeam;type) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-100]
| Parameter | Type | Description |
| - | - | - |
| `transfers` | array | Array of transfer objects for the player |
| ↳ `id` | number | Unique id of the transfer |
| ↳ `sport_id` | number | Sport of the transfer |
| ↳ `player_id` | number | Player who transferred |
| ↳ `type_id` | number | Type of the transfer |
| ↳ `from_team_id` | number | Team the player transferred from |
| ↳ `to_team_id` | number | Team the player transferred to |
| ↳ `position_id` | number | Position id of the transfer |
| ↳ `detailed_position_id` | number | Detailed position id of the transfer |
| ↳ `date` | string | Date of the transfer |
| ↳ `career_ended` | boolean | Whether the transfer ended the career |
| ↳ `completed` | boolean | Whether the transfer is completed |
| ↳ `amount` | number | Transfer fee amount |
#### Get Transfers by Team [#get-transfers-by-team]
Retrieve transfers for a team by team ID from Sportmonks
##### Input [#input-101]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `teamId` | string | Yes | The unique id of the team |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. player;fromTeam;toTeam) |
| `filters` | string | No | Filters to apply (e.g. transferTypes:219,220) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-101]
| Parameter | Type | Description |
| - | - | - |
| `transfers` | array | Array of transfer objects for the team |
| ↳ `id` | number | Unique id of the transfer |
| ↳ `sport_id` | number | Sport of the transfer |
| ↳ `player_id` | number | Player who transferred |
| ↳ `type_id` | number | Type of the transfer |
| ↳ `from_team_id` | number | Team the player transferred from |
| ↳ `to_team_id` | number | Team the player transferred to |
| ↳ `position_id` | number | Position id of the transfer |
| ↳ `detailed_position_id` | number | Detailed position id of the transfer |
| ↳ `date` | string | Date of the transfer |
| ↳ `career_ended` | boolean | Whether the transfer ended the career |
| ↳ `completed` | boolean | Whether the transfer is completed |
| ↳ `amount` | number | Transfer fee amount |
#### Get TV Station by ID [#get-tv-station-by-id]
Retrieve a single TV station by its ID from Sportmonks
##### Input [#input-102]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `tvStationId` | string | Yes | The unique id of the TV station |
| `include` | string | No | Semicolon-separated relations to enrich the response |
| `filters` | string | No | Filters to apply |
##### Output [#output-102]
| Parameter | Type | Description |
| - | - | - |
| `tvStation` | object | The requested TV station object |
| ↳ `id` | number | Unique id of the TV station |
| ↳ `name` | string | Name of the TV station |
| ↳ `url` | string | URL of the TV station |
| ↳ `image_path` | string | Image path of the TV station |
| ↳ `type` | string | Type of the TV station (tv, channel) |
| ↳ `related_id` | number | Related id of the TV station |
#### Get TV Stations [#get-tv-stations]
Retrieve all TV stations available within your Sportmonks subscription
##### Input [#input-103]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-103]
| Parameter | Type | Description |
| - | - | - |
| `tvStations` | array | Array of TV station objects |
| ↳ `id` | number | Unique id of the TV station |
| ↳ `name` | string | Name of the TV station |
| ↳ `url` | string | URL of the TV station |
| ↳ `image_path` | string | Image path of the TV station |
| ↳ `type` | string | Type of the TV station (tv, channel) |
| ↳ `related_id` | number | Related id of the TV station |
#### Get TV Stations by Fixture [#get-tv-stations-by-fixture]
Retrieve broadcasting TV stations for a fixture by fixture ID from Sportmonks
##### Input [#input-104]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. fixtures;countries) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-104]
| Parameter | Type | Description |
| - | - | - |
| `tvStations` | array | Array of TV station objects broadcasting the fixture |
| ↳ `id` | number | Unique id of the TV station |
| ↳ `name` | string | Name of the TV station |
| ↳ `url` | string | URL of the TV station |
| ↳ `image_path` | string | Image path of the TV station |
| ↳ `type` | string | Type of the TV station (tv, channel) |
| ↳ `related_id` | number | Related id of the TV station |
#### Get Upcoming Fixtures by Market [#get-upcoming-fixtures-by-market]
Retrieve all upcoming fixtures for a market ID from Sportmonks
##### Input [#input-105]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `marketId` | string | Yes | The unique id of the market |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;odds) |
| `filters` | string | No | Filters to apply (e.g. fixtureLeagues:501) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-105]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of upcoming fixture objects for the market |
| ↳ `id` | number | Unique id of the fixture |
| ↳ `sport_id` | number | Sport the fixture is played at |
| ↳ `league_id` | number | League the fixture is played in |
| ↳ `season_id` | number | Season the fixture is played in |
| ↳ `stage_id` | number | Stage the fixture is played in |
| ↳ `group_id` | number | Group the fixture is played in |
| ↳ `aggregate_id` | number | Aggregate the fixture belongs to |
| ↳ `round_id` | number | Round the fixture is played in |
| ↳ `state_id` | number | State (status) of the fixture |
| ↳ `venue_id` | number | Venue the fixture is played at |
| ↳ `name` | string | Name of the fixture (participants) |
| ↳ `starting_at` | string | Datetime the fixture starts |
| ↳ `result_info` | string | Final result summary |
| ↳ `leg` | string | Leg of the fixture (e.g. 1/1) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Length of the fixture in minutes |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Whether odds are available |
| ↳ `has_premium_odds` | boolean | Whether premium odds are available |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Upcoming Fixtures by TV Station [#get-upcoming-fixtures-by-tv-station]
Retrieve all upcoming fixtures available for a TV station ID from Sportmonks
##### Input [#input-106]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `tvStationId` | string | Yes | The unique id of the TV station |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants) |
| `filters` | string | No | Filters to apply (e.g. fixtureLeagues:501) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-106]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of upcoming fixture objects for the TV station |
| ↳ `id` | number | Unique id of the fixture |
| ↳ `sport_id` | number | Sport the fixture is played at |
| ↳ `league_id` | number | League the fixture is played in |
| ↳ `season_id` | number | Season the fixture is played in |
| ↳ `stage_id` | number | Stage the fixture is played in |
| ↳ `group_id` | number | Group the fixture is played in |
| ↳ `aggregate_id` | number | Aggregate the fixture belongs to |
| ↳ `round_id` | number | Round the fixture is played in |
| ↳ `state_id` | number | State (status) of the fixture |
| ↳ `venue_id` | number | Venue the fixture is played at |
| ↳ `name` | string | Name of the fixture (participants) |
| ↳ `starting_at` | string | Datetime the fixture starts |
| ↳ `result_info` | string | Final result summary |
| ↳ `leg` | string | Leg of the fixture (e.g. 1/1) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Length of the fixture in minutes |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Whether odds are available |
| ↳ `has_premium_odds` | boolean | Whether premium odds are available |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Value Bets [#get-value-bets]
Retrieve all value bets available within your Sportmonks subscription
##### Input [#input-107]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. type;fixture) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-107]
| Parameter | Type | Description |
| - | - | - |
| `valueBets` | array | Array of value bet prediction objects |
| ↳ `id` | number | Unique id of the prediction |
| ↳ `fixture_id` | number | Fixture related to the prediction |
| ↳ `predictions` | json | Prediction payload (varies by type: score map, value bet object, etc.) |
| ↳ `type_id` | number | Type of the prediction |
#### Get Value Bets by Fixture [#get-value-bets-by-fixture]
Retrieve value bet predictions for a fixture by fixture ID from Sportmonks
##### Input [#input-108]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. type;fixture) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-108]
| Parameter | Type | Description |
| - | - | - |
| `valueBets` | array | Array of value bet prediction entries for the fixture |
| ↳ `id` | number | Unique id of the prediction |
| ↳ `fixture_id` | number | Fixture related to the prediction |
| ↳ `predictions` | json | Prediction payload (varies by type: score map, value bet object, etc.) |
| ↳ `type_id` | number | Type of the prediction |
#### Get Venue by ID [#get-venue-by-id]
Retrieve a single football venue by its ID from Sportmonks
##### Input [#input-109]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `venueId` | string | Yes | The unique id of the venue |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;city;fixtures) |
| `filters` | string | No | Filters to apply |
##### Output [#output-109]
| Parameter | Type | Description |
| - | - | - |
| `venue` | object | The requested venue object |
| ↳ `id` | number | Unique id of the venue |
| ↳ `country_id` | number | Country of the venue |
| ↳ `city_id` | number | City of the venue |
| ↳ `name` | string | Name of the venue |
| ↳ `address` | string | Address of the venue |
| ↳ `zipcode` | string | Zipcode of the venue |
| ↳ `latitude` | string | Latitude of the venue |
| ↳ `longitude` | string | Longitude of the venue |
| ↳ `capacity` | number | Seating capacity of the venue |
| ↳ `image_path` | string | Image path of the venue |
| ↳ `city_name` | string | Name of the city the venue is in |
| ↳ `surface` | string | Surface type of the venue |
| ↳ `national_team` | boolean | Whether the venue is used by the national team |
#### Get Venues [#get-venues]
Retrieve all football venues available within your Sportmonks subscription
##### Input [#input-110]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;city) |
| `filters` | string | No | Filters to apply (e.g. venueCountries:98) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-110]
| Parameter | Type | Description |
| - | - | - |
| `venues` | array | Array of venue objects |
| ↳ `id` | number | Unique id of the venue |
| ↳ `country_id` | number | Country of the venue |
| ↳ `city_id` | number | City of the venue |
| ↳ `name` | string | Name of the venue |
| ↳ `address` | string | Address of the venue |
| ↳ `zipcode` | string | Zipcode of the venue |
| ↳ `latitude` | string | Latitude of the venue |
| ↳ `longitude` | string | Longitude of the venue |
| ↳ `capacity` | number | Seating capacity of the venue |
| ↳ `image_path` | string | Image path of the venue |
| ↳ `city_name` | string | Name of the city the venue is in |
| ↳ `surface` | string | Surface type of the venue |
| ↳ `national_team` | boolean | Whether the venue is used by the national team |
#### Get Venues by Season [#get-venues-by-season]
Retrieve all venues for a season ID from Sportmonks
##### Input [#input-111]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;city) |
| `filters` | string | No | Filters to apply |
##### Output [#output-111]
| Parameter | Type | Description |
| - | - | - |
| `venues` | array | Array of venue objects for the season |
| ↳ `id` | number | Unique id of the venue |
| ↳ `country_id` | number | Country of the venue |
| ↳ `city_id` | number | City of the venue |
| ↳ `name` | string | Name of the venue |
| ↳ `address` | string | Address of the venue |
| ↳ `zipcode` | string | Zipcode of the venue |
| ↳ `latitude` | string | Latitude of the venue |
| ↳ `longitude` | string | Longitude of the venue |
| ↳ `capacity` | number | Seating capacity of the venue |
| ↳ `image_path` | string | Image path of the venue |
| ↳ `city_name` | string | Name of the city the venue is in |
| ↳ `surface` | string | Surface type of the venue |
| ↳ `national_team` | boolean | Whether the venue is used by the national team |
#### Search Coaches [#search-coaches]
Search for football coaches by name from Sportmonks
##### Input [#input-112]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The coach name to search for (e.g. Gerrard) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;teams) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-112]
| Parameter | Type | Description |
| - | - | - |
| `coaches` | array | Array of coach objects matching the search query |
| ↳ `id` | number | Unique id of the coach |
| ↳ `player_id` | number | Player related to the coach |
| ↳ `sport_id` | number | Sport of the coach |
| ↳ `country_id` | number | Country of the coach |
| ↳ `nationality_id` | number | Nationality of the coach |
| ↳ `city_id` | number | Birth city of the coach |
| ↳ `common_name` | string | Common name of the coach |
| ↳ `firstname` | string | First name of the coach |
| ↳ `lastname` | string | Last name of the coach |
| ↳ `name` | string | Name of the coach |
| ↳ `display_name` | string | Display name of the coach |
| ↳ `image_path` | string | URL to the coach headshot |
| ↳ `height` | number | Height of the coach in cm |
| ↳ `weight` | number | Weight of the coach in kg |
| ↳ `date_of_birth` | string | Date of birth of the coach |
| ↳ `gender` | string | Gender of the coach |
#### Search Fixtures [#search-fixtures]
Search for football fixtures by name (participants) from Sportmonks
##### Input [#input-113]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The fixture name to search for (e.g. Celtic) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;scores) |
| `filters` | string | No | Filters to apply (e.g. fixtureLeagues:501) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order fixtures by starting\_at (asc or desc) |
##### Output [#output-113]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of fixture objects matching the search query |
| ↳ `id` | number | Unique id of the fixture |
| ↳ `sport_id` | number | Sport the fixture is played at |
| ↳ `league_id` | number | League the fixture is played in |
| ↳ `season_id` | number | Season the fixture is played in |
| ↳ `stage_id` | number | Stage the fixture is played in |
| ↳ `group_id` | number | Group the fixture is played in |
| ↳ `aggregate_id` | number | Aggregate the fixture belongs to |
| ↳ `round_id` | number | Round the fixture is played in |
| ↳ `state_id` | number | State (status) of the fixture |
| ↳ `venue_id` | number | Venue the fixture is played at |
| ↳ `name` | string | Name of the fixture (participants) |
| ↳ `starting_at` | string | Datetime the fixture starts |
| ↳ `result_info` | string | Final result summary |
| ↳ `leg` | string | Leg of the fixture (e.g. 1/1) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Length of the fixture in minutes |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Whether odds are available |
| ↳ `has_premium_odds` | boolean | Whether premium odds are available |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Search Leagues [#search-leagues]
Search for football leagues by name from Sportmonks
##### Input [#input-114]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The league name to search for (e.g. Premier) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;currentSeason) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order leagues (asc or desc) |
##### Output [#output-114]
| Parameter | Type | Description |
| - | - | - |
| `leagues` | array | Array of league objects matching the search query |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | number | Whether the league is active (1) or inactive (0) |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date the last fixture was played |
| ↳ `category` | number | Importance category of the league (1-4) |
#### Search Players [#search-players]
Search for football players by name from Sportmonks
##### Input [#input-115]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The player name to search for (e.g. Tavernier) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;position;teams.team) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order players by id (asc or desc) |
##### Output [#output-115]
| Parameter | Type | Description |
| - | - | - |
| `players` | array | Array of player objects matching the search query |
| ↳ `id` | number | Unique id of the player |
| ↳ `sport_id` | number | Sport of the player |
| ↳ `country_id` | number | Country of birth of the player |
| ↳ `nationality_id` | number | Nationality of the player |
| ↳ `city_id` | number | City of birth of the player |
| ↳ `position_id` | number | Position of the player |
| ↳ `detailed_position_id` | number | Detailed position of the player |
| ↳ `type_id` | number | Type of the player |
| ↳ `common_name` | string | Name the player is known for |
| ↳ `firstname` | string | First name of the player |
| ↳ `lastname` | string | Last name of the player |
| ↳ `name` | string | Name of the player |
| ↳ `display_name` | string | Display name of the player |
| ↳ `image_path` | string | URL to the player headshot |
| ↳ `height` | number | Height of the player in cm |
| ↳ `weight` | number | Weight of the player in kg |
| ↳ `date_of_birth` | string | Date of birth of the player |
| ↳ `gender` | string | Gender of the player |
#### Search Referees [#search-referees]
Search for football referees by name from Sportmonks
##### Input [#input-116]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The referee name to search for |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-116]
| Parameter | Type | Description |
| - | - | - |
| `referees` | array | Array of referee objects matching the search query |
| ↳ `id` | number | Unique id of the referee |
| ↳ `sport_id` | number | Sport of the referee |
| ↳ `country_id` | number | Country of the referee |
| ↳ `nationality_id` | number | Nationality of the referee |
| ↳ `city_id` | number | Birth city of the referee |
| ↳ `common_name` | string | Common name of the referee |
| ↳ `firstname` | string | First name of the referee |
| ↳ `lastname` | string | Last name of the referee |
| ↳ `name` | string | Name of the referee |
| ↳ `display_name` | string | Display name of the referee |
| ↳ `image_path` | string | URL to the referee headshot |
| ↳ `height` | number | Height of the referee in cm |
| ↳ `weight` | number | Weight of the referee in kg |
| ↳ `date_of_birth` | string | Date of birth of the referee |
| ↳ `gender` | string | Gender of the referee |
#### Search Rounds [#search-rounds]
Search for football rounds by name from Sportmonks
##### Input [#input-117]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The round name to search for (e.g. 5) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;season) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-117]
| Parameter | Type | Description |
| - | - | - |
| `rounds` | array | Array of round objects matching the search query |
| ↳ `id` | number | Unique id of the round |
| ↳ `sport_id` | number | Sport of the round |
| ↳ `league_id` | number | League of the round |
| ↳ `season_id` | number | Season of the round |
| ↳ `stage_id` | number | Stage of the round |
| ↳ `name` | string | Name of the round |
| ↳ `finished` | boolean | Whether the round is finished |
| ↳ `is_current` | boolean | Whether the round is the current round |
| ↳ `starting_at` | string | Start date of the round |
| ↳ `ending_at` | string | End date of the round |
| ↳ `games_in_current_week` | boolean | Whether the round has fixtures this week |
#### Search Seasons [#search-seasons]
Search for football seasons by name from Sportmonks
##### Input [#input-118]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The season name to search for (e.g. 2023/2024) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-118]
| Parameter | Type | Description |
| - | - | - |
| `seasons` | array | Array of season objects matching the search query |
| ↳ `id` | number | Unique id of the season |
| ↳ `sport_id` | number | Sport of the season |
| ↳ `league_id` | number | League of the season |
| ↳ `tie_breaker_rule_id` | number | Tie-breaker rule of the season |
| ↳ `name` | string | Name of the season (e.g. 2023/2024) |
| ↳ `finished` | boolean | Whether the season is finished |
| ↳ `pending` | boolean | Whether the season is pending |
| ↳ `is_current` | boolean | Whether the season is the current season |
| ↳ `standing_method` | string | Standing calculation method |
| ↳ `starting_at` | string | Start date of the season |
| ↳ `ending_at` | string | End date of the season |
| ↳ `standings_recalculated_at` | string | Last standings recalculation time |
| ↳ `games_in_current_week` | boolean | Whether the season has fixtures this week |
#### Search Stages [#search-stages]
Search for football stages by name from Sportmonks
##### Input [#input-119]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The stage name to search for (e.g. Group) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;season) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-119]
| Parameter | Type | Description |
| - | - | - |
| `stages` | array | Array of stage objects matching the search query |
| ↳ `id` | number | Unique id of the stage |
| ↳ `sport_id` | number | Sport of the stage |
| ↳ `league_id` | number | League of the stage |
| ↳ `season_id` | number | Season of the stage |
| ↳ `type_id` | number | Type of the stage |
| ↳ `name` | string | Name of the stage |
| ↳ `sort_order` | number | Sort order of the stage |
| ↳ `finished` | boolean | Whether the stage is finished |
| ↳ `is_current` | boolean | Whether the stage is the current stage |
| ↳ `starting_at` | string | Start date of the stage |
| ↳ `ending_at` | string | End date of the stage |
| ↳ `games_in_current_week` | boolean | Whether the stage has fixtures this week |
#### Search Teams [#search-teams]
Search for football teams by name from Sportmonks
##### Input [#input-120]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The team name to search for (e.g. Celtic) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;venue) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order teams by id (asc or desc) |
##### Output [#output-120]
| Parameter | Type | Description |
| - | - | - |
| `teams` | array | Array of team objects matching the search query |
| ↳ `id` | number | Unique id of the team |
| ↳ `sport_id` | number | Sport of the team |
| ↳ `country_id` | number | Country of the team |
| ↳ `venue_id` | number | Home venue of the team |
| ↳ `gender` | string | Gender of the team |
| ↳ `name` | string | Name of the team |
| ↳ `short_code` | string | Short code of the team |
| ↳ `image_path` | string | URL to the team logo |
| ↳ `founded` | number | Founding year of the team |
| ↳ `type` | string | Type of the team |
| ↳ `placeholder` | boolean | Whether the team is a placeholder |
| ↳ `last_played_at` | string | Date and time of the last played match |
#### Search Venues [#search-venues]
Search for football venues by name from Sportmonks
##### Input [#input-121]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The venue name to search for (e.g. Celtic Park) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;city) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-121]
| Parameter | Type | Description |
| - | - | - |
| `venues` | array | Array of venue objects matching the search query |
| ↳ `id` | number | Unique id of the venue |
| ↳ `country_id` | number | Country of the venue |
| ↳ `city_id` | number | City of the venue |
| ↳ `name` | string | Name of the venue |
| ↳ `address` | string | Address of the venue |
| ↳ `zipcode` | string | Zipcode of the venue |
| ↳ `latitude` | string | Latitude of the venue |
| ↳ `longitude` | string | Longitude of the venue |
| ↳ `capacity` | number | Seating capacity of the venue |
| ↳ `image_path` | string | Image path of the venue |
| ↳ `city_name` | string | Name of the city the venue is in |
| ↳ `surface` | string | Surface type of the venue |
| ↳ `national_team` | boolean | Whether the venue is used by the national team |
### Motorsport [#actions-sportmonks_motorsport_get_all_fixtures]
#### Get All Motorsport Fixtures [#get-all-motorsport-fixtures]
Retrieve all motorsport fixtures (sessions) from Sportmonks
##### Input [#input-122]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;results) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-122]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of motorsport fixture (session) objects |
| ↳ `id` | number | Unique id of the fixture (session) |
| ↳ `sport_id` | number | Sport of the fixture |
| ↳ `league_id` | number | League the fixture is held in |
| ↳ `season_id` | number | Season the fixture is held in |
| ↳ `stage_id` | number | Stage (race weekend) the fixture is held in |
| ↳ `group_id` | number | Not used in the Motorsport API |
| ↳ `aggregate_id` | number | Not used in the Motorsport API |
| ↳ `round_id` | number | Not used in the Motorsport API |
| ↳ `state_id` | number | State the fixture is currently in |
| ↳ `venue_id` | number | Venue (track) the fixture is held at |
| ↳ `name` | string | Name of the fixture (e.g. Practice 1, Race) |
| ↳ `starting_at` | string | Start date and time |
| ↳ `result_info` | string | Final result info |
| ↳ `leg` | string | Stage of the fixture (e.g. 2/3 for Practice 2) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Session length in minutes or total laps |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Not used in the Motorsport API |
| ↳ `has_premium_odds` | boolean | Not used in the Motorsport API |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Current Leagues by Team [#get-current-leagues-by-team-1]
Retrieve the current motorsport leagues for a team by team ID from Sportmonks
##### Input [#input-123]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `teamId` | string | Yes | The unique id of the team (constructor) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;seasons) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-123]
| Parameter | Type | Description |
| - | - | - |
| `leagues` | array | Array of current league objects for the team |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | boolean | Whether the league is active |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date of the last fixture held in the league |
| ↳ `category` | number | Category of the league |
| ↳ `has_jerseys` | boolean | Not used in the Motorsport API |
#### Get Driver by ID [#get-driver-by-id]
Retrieve a single motorsport driver by their ID from Sportmonks
##### Input [#input-124]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `driverId` | string | Yes | The unique id of the driver |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;teams) |
| `filters` | string | No | Filters to apply |
##### Output [#output-124]
| Parameter | Type | Description |
| - | - | - |
| `driver` | object | The requested driver object |
| ↳ `id` | number | Unique id of the driver (player\_id in responses) |
| ↳ `sport_id` | number | Sport of the driver |
| ↳ `country_id` | number | Country of birth of the driver |
| ↳ `nationality_id` | number | Nationality of the driver |
| ↳ `city_id` | number | City of birth of the driver |
| ↳ `position_id` | number | Position of the driver within the team |
| ↳ `detailed_position_id` | number | Not used in the Motorsport API |
| ↳ `type_id` | number | Not used in the Motorsport API |
| ↳ `common_name` | string | Name the driver is known for |
| ↳ `firstname` | string | First name of the driver |
| ↳ `lastname` | string | Last name of the driver |
| ↳ `name` | string | Name of the driver |
| ↳ `display_name` | string | Display name of the driver |
| ↳ `image_path` | string | URL to the driver headshot |
| ↳ `height` | number | Height of the driver in cm |
| ↳ `weight` | number | Weight of the driver in kg |
| ↳ `date_of_birth` | string | Date of birth of the driver |
| ↳ `gender` | string | Gender of the driver |
#### Get All Driver Standings [#get-all-driver-standings]
Retrieve all driver championship standings from Sportmonks
##### Input [#input-125]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;season) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-125]
| Parameter | Type | Description |
| - | - | - |
| `standings` | array | Array of driver standing entries |
| ↳ `id` | number | Unique id of the standing |
| ↳ `participant_id` | number | Driver or team related to the standing |
| ↳ `sport_id` | number | Sport related to the standing |
| ↳ `league_id` | number | League related to the standing |
| ↳ `season_id` | number | Season related to the standing |
| ↳ `stage_id` | number | Stage related to the standing |
| ↳ `group_id` | number | Not used in the Motorsport API |
| ↳ `round_id` | number | Not used in the Motorsport API |
| ↳ `standing_rule_id` | number | Not used in the Motorsport API |
| ↳ `position` | number | Position of the participant in the standing |
| ↳ `result` | string | Not used in the Motorsport API |
| ↳ `points` | number | Points the participant has gathered |
#### Get Driver Standings by Season [#get-driver-standings-by-season]
Retrieve the drivers championship standings for a season by season ID from Sportmonks
##### Input [#input-126]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;season) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-126]
| Parameter | Type | Description |
| - | - | - |
| `standings` | array | Array of driver standing entries for the season |
| ↳ `id` | number | Unique id of the standing |
| ↳ `participant_id` | number | Driver or team related to the standing |
| ↳ `sport_id` | number | Sport related to the standing |
| ↳ `league_id` | number | League related to the standing |
| ↳ `season_id` | number | Season related to the standing |
| ↳ `stage_id` | number | Stage related to the standing |
| ↳ `group_id` | number | Not used in the Motorsport API |
| ↳ `round_id` | number | Not used in the Motorsport API |
| ↳ `standing_rule_id` | number | Not used in the Motorsport API |
| ↳ `position` | number | Position of the participant in the standing |
| ↳ `result` | string | Not used in the Motorsport API |
| ↳ `points` | number | Points the participant has gathered |
#### Get Drivers [#get-drivers]
Retrieve all motorsport drivers from Sportmonks
##### Input [#input-127]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;teams) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-127]
| Parameter | Type | Description |
| - | - | - |
| `drivers` | array | Array of driver objects |
| ↳ `id` | number | Unique id of the driver (player\_id in responses) |
| ↳ `sport_id` | number | Sport of the driver |
| ↳ `country_id` | number | Country of birth of the driver |
| ↳ `nationality_id` | number | Nationality of the driver |
| ↳ `city_id` | number | City of birth of the driver |
| ↳ `position_id` | number | Position of the driver within the team |
| ↳ `detailed_position_id` | number | Not used in the Motorsport API |
| ↳ `type_id` | number | Not used in the Motorsport API |
| ↳ `common_name` | string | Name the driver is known for |
| ↳ `firstname` | string | First name of the driver |
| ↳ `lastname` | string | Last name of the driver |
| ↳ `name` | string | Name of the driver |
| ↳ `display_name` | string | Display name of the driver |
| ↳ `image_path` | string | URL to the driver headshot |
| ↳ `height` | number | Height of the driver in cm |
| ↳ `weight` | number | Weight of the driver in kg |
| ↳ `date_of_birth` | string | Date of birth of the driver |
| ↳ `gender` | string | Gender of the driver |
#### Get Drivers by Country [#get-drivers-by-country]
Retrieve all motorsport drivers for a country by country ID from Sportmonks
##### Input [#input-128]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `countryId` | string | Yes | The unique id of the country |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;teams) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-128]
| Parameter | Type | Description |
| - | - | - |
| `drivers` | array | Array of driver objects for the country |
| ↳ `id` | number | Unique id of the driver (player\_id in responses) |
| ↳ `sport_id` | number | Sport of the driver |
| ↳ `country_id` | number | Country of birth of the driver |
| ↳ `nationality_id` | number | Nationality of the driver |
| ↳ `city_id` | number | City of birth of the driver |
| ↳ `position_id` | number | Position of the driver within the team |
| ↳ `detailed_position_id` | number | Not used in the Motorsport API |
| ↳ `type_id` | number | Not used in the Motorsport API |
| ↳ `common_name` | string | Name the driver is known for |
| ↳ `firstname` | string | First name of the driver |
| ↳ `lastname` | string | Last name of the driver |
| ↳ `name` | string | Name of the driver |
| ↳ `display_name` | string | Display name of the driver |
| ↳ `image_path` | string | URL to the driver headshot |
| ↳ `height` | number | Height of the driver in cm |
| ↳ `weight` | number | Weight of the driver in kg |
| ↳ `date_of_birth` | string | Date of birth of the driver |
| ↳ `gender` | string | Gender of the driver |
#### Get Drivers by Season [#get-drivers-by-season]
Retrieve all motorsport drivers for a season by season ID from Sportmonks
##### Input [#input-129]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;teams) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-129]
| Parameter | Type | Description |
| - | - | - |
| `drivers` | array | Array of driver objects for the season |
| ↳ `id` | number | Unique id of the driver (player\_id in responses) |
| ↳ `sport_id` | number | Sport of the driver |
| ↳ `country_id` | number | Country of birth of the driver |
| ↳ `nationality_id` | number | Nationality of the driver |
| ↳ `city_id` | number | City of birth of the driver |
| ↳ `position_id` | number | Position of the driver within the team |
| ↳ `detailed_position_id` | number | Not used in the Motorsport API |
| ↳ `type_id` | number | Not used in the Motorsport API |
| ↳ `common_name` | string | Name the driver is known for |
| ↳ `firstname` | string | First name of the driver |
| ↳ `lastname` | string | Last name of the driver |
| ↳ `name` | string | Name of the driver |
| ↳ `display_name` | string | Display name of the driver |
| ↳ `image_path` | string | URL to the driver headshot |
| ↳ `height` | number | Height of the driver in cm |
| ↳ `weight` | number | Weight of the driver in kg |
| ↳ `date_of_birth` | string | Date of birth of the driver |
| ↳ `gender` | string | Gender of the driver |
#### Get Motorsport Fixture by ID [#get-motorsport-fixture-by-id]
Retrieve a single motorsport fixture (session) by its ID from Sportmonks
##### Input [#input-130]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture (session) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;results;latestLaps;pitstops) |
| `filters` | string | No | Filters to apply |
##### Output [#output-130]
| Parameter | Type | Description |
| - | - | - |
| `fixture` | object | The requested motorsport fixture (session) object |
| ↳ `id` | number | Unique id of the fixture (session) |
| ↳ `sport_id` | number | Sport of the fixture |
| ↳ `league_id` | number | League the fixture is held in |
| ↳ `season_id` | number | Season the fixture is held in |
| ↳ `stage_id` | number | Stage (race weekend) the fixture is held in |
| ↳ `group_id` | number | Not used in the Motorsport API |
| ↳ `aggregate_id` | number | Not used in the Motorsport API |
| ↳ `round_id` | number | Not used in the Motorsport API |
| ↳ `state_id` | number | State the fixture is currently in |
| ↳ `venue_id` | number | Venue (track) the fixture is held at |
| ↳ `name` | string | Name of the fixture (e.g. Practice 1, Race) |
| ↳ `starting_at` | string | Start date and time |
| ↳ `result_info` | string | Final result info |
| ↳ `leg` | string | Stage of the fixture (e.g. 2/3 for Practice 2) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Session length in minutes or total laps |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Not used in the Motorsport API |
| ↳ `has_premium_odds` | boolean | Not used in the Motorsport API |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Motorsport Fixtures by Date [#get-motorsport-fixtures-by-date]
Retrieve motorsport fixtures (sessions) on a specific date (YYYY-MM-DD) from Sportmonks
##### Input [#input-131]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `date` | string | Yes | The date to fetch fixtures for, in YYYY-MM-DD format |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;venue) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order fixtures by starting\_at (asc or desc) |
##### Output [#output-131]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of motorsport fixture (session) objects for the requested date |
| ↳ `id` | number | Unique id of the fixture (session) |
| ↳ `sport_id` | number | Sport of the fixture |
| ↳ `league_id` | number | League the fixture is held in |
| ↳ `season_id` | number | Season the fixture is held in |
| ↳ `stage_id` | number | Stage (race weekend) the fixture is held in |
| ↳ `group_id` | number | Not used in the Motorsport API |
| ↳ `aggregate_id` | number | Not used in the Motorsport API |
| ↳ `round_id` | number | Not used in the Motorsport API |
| ↳ `state_id` | number | State the fixture is currently in |
| ↳ `venue_id` | number | Venue (track) the fixture is held at |
| ↳ `name` | string | Name of the fixture (e.g. Practice 1, Race) |
| ↳ `starting_at` | string | Start date and time |
| ↳ `result_info` | string | Final result info |
| ↳ `leg` | string | Stage of the fixture (e.g. 2/3 for Practice 2) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Session length in minutes or total laps |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Not used in the Motorsport API |
| ↳ `has_premium_odds` | boolean | Not used in the Motorsport API |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Motorsport Fixtures by Date Range [#get-motorsport-fixtures-by-date-range]
Retrieve motorsport fixtures (sessions) between two dates (YYYY-MM-DD, max 100 days) from Sportmonks
##### Input [#input-132]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `startDate` | string | Yes | The start date of the range, in YYYY-MM-DD format |
| `endDate` | string | Yes | The end date of the range, in YYYY-MM-DD format |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;venue) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order fixtures by starting\_at (asc or desc) |
##### Output [#output-132]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of motorsport fixture (session) objects within the requested date range |
| ↳ `id` | number | Unique id of the fixture (session) |
| ↳ `sport_id` | number | Sport of the fixture |
| ↳ `league_id` | number | League the fixture is held in |
| ↳ `season_id` | number | Season the fixture is held in |
| ↳ `stage_id` | number | Stage (race weekend) the fixture is held in |
| ↳ `group_id` | number | Not used in the Motorsport API |
| ↳ `aggregate_id` | number | Not used in the Motorsport API |
| ↳ `round_id` | number | Not used in the Motorsport API |
| ↳ `state_id` | number | State the fixture is currently in |
| ↳ `venue_id` | number | Venue (track) the fixture is held at |
| ↳ `name` | string | Name of the fixture (e.g. Practice 1, Race) |
| ↳ `starting_at` | string | Start date and time |
| ↳ `result_info` | string | Final result info |
| ↳ `leg` | string | Stage of the fixture (e.g. 2/3 for Practice 2) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Session length in minutes or total laps |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Not used in the Motorsport API |
| ↳ `has_premium_odds` | boolean | Not used in the Motorsport API |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Motorsport Fixtures by IDs [#get-motorsport-fixtures-by-ids]
Retrieve multiple motorsport fixtures (sessions) by their IDs (max 50) from Sportmonks
##### Input [#input-133]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureIds` | string | Yes | Comma-separated list of fixture ids (max 50, e.g. 19408487,19408480) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;results) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-133]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of motorsport fixture (session) objects for the requested ids |
| ↳ `id` | number | Unique id of the fixture (session) |
| ↳ `sport_id` | number | Sport of the fixture |
| ↳ `league_id` | number | League the fixture is held in |
| ↳ `season_id` | number | Season the fixture is held in |
| ↳ `stage_id` | number | Stage (race weekend) the fixture is held in |
| ↳ `group_id` | number | Not used in the Motorsport API |
| ↳ `aggregate_id` | number | Not used in the Motorsport API |
| ↳ `round_id` | number | Not used in the Motorsport API |
| ↳ `state_id` | number | State the fixture is currently in |
| ↳ `venue_id` | number | Venue (track) the fixture is held at |
| ↳ `name` | string | Name of the fixture (e.g. Practice 1, Race) |
| ↳ `starting_at` | string | Start date and time |
| ↳ `result_info` | string | Final result info |
| ↳ `leg` | string | Stage of the fixture (e.g. 2/3 for Practice 2) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Session length in minutes or total laps |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Not used in the Motorsport API |
| ↳ `has_premium_odds` | boolean | Not used in the Motorsport API |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Laps by Fixture [#get-laps-by-fixture]
Retrieve all laps for a motorsport fixture (session) by fixture ID from Sportmonks
##### Input [#input-134]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture (session) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details) |
| `filters` | string | No | Filters to apply |
##### Output [#output-134]
| Parameter | Type | Description |
| - | - | - |
| `laps` | array | Array of lap objects for the fixture |
| ↳ `id` | number | Unique id of the lap/pitstop |
| ↳ `fixture_id` | number | Fixture related to the lap/pitstop |
| ↳ `lap_number` | number | Lap number in the fixture |
| ↳ `driver_number` | number | Number of the driver |
| ↳ `participant_id` | number | Driver related to the lap/pitstop |
| ↳ `is_latest` | boolean | Whether it is the latest lap/pitstop |
#### Get Laps by Fixture and Driver [#get-laps-by-fixture-and-driver]
Retrieve all laps for a motorsport fixture and driver from Sportmonks
##### Input [#input-135]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture (session) |
| `driverId` | string | Yes | The unique id of the driver |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details) |
| `filters` | string | No | Filters to apply |
##### Output [#output-135]
| Parameter | Type | Description |
| - | - | - |
| `laps` | array | Array of lap objects for the fixture and driver |
| ↳ `id` | number | Unique id of the lap/pitstop |
| ↳ `fixture_id` | number | Fixture related to the lap/pitstop |
| ↳ `lap_number` | number | Lap number in the fixture |
| ↳ `driver_number` | number | Number of the driver |
| ↳ `participant_id` | number | Driver related to the lap/pitstop |
| ↳ `is_latest` | boolean | Whether it is the latest lap/pitstop |
#### Get Laps by Fixture and Lap Number [#get-laps-by-fixture-and-lap-number]
Retrieve all laps for a motorsport fixture and lap number from Sportmonks
##### Input [#input-136]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture (session) |
| `lapNumber` | string | Yes | The lap number to retrieve |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details) |
| `filters` | string | No | Filters to apply |
##### Output [#output-136]
| Parameter | Type | Description |
| - | - | - |
| `laps` | array | Array of lap objects for the fixture and lap number |
| ↳ `id` | number | Unique id of the lap/pitstop |
| ↳ `fixture_id` | number | Fixture related to the lap/pitstop |
| ↳ `lap_number` | number | Lap number in the fixture |
| ↳ `driver_number` | number | Number of the driver |
| ↳ `participant_id` | number | Driver related to the lap/pitstop |
| ↳ `is_latest` | boolean | Whether it is the latest lap/pitstop |
#### Get Latest Laps by Fixture [#get-latest-laps-by-fixture]
Retrieve the latest laps for a motorsport fixture (session) by fixture ID from Sportmonks
##### Input [#input-137]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture (session) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details) |
| `filters` | string | No | Filters to apply |
##### Output [#output-137]
| Parameter | Type | Description |
| - | - | - |
| `laps` | array | Array of the latest lap objects for the fixture |
| ↳ `id` | number | Unique id of the lap/pitstop |
| ↳ `fixture_id` | number | Fixture related to the lap/pitstop |
| ↳ `lap_number` | number | Lap number in the fixture |
| ↳ `driver_number` | number | Number of the driver |
| ↳ `participant_id` | number | Driver related to the lap/pitstop |
| ↳ `is_latest` | boolean | Whether it is the latest lap/pitstop |
#### Get Latest Pitstops by Fixture [#get-latest-pitstops-by-fixture]
Retrieve the latest pitstops for a motorsport fixture (session) by fixture ID from Sportmonks
##### Input [#input-138]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture (session) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details) |
| `filters` | string | No | Filters to apply |
##### Output [#output-138]
| Parameter | Type | Description |
| - | - | - |
| `pitstops` | array | Array of the latest pitstop objects for the fixture |
| ↳ `id` | number | Unique id of the lap/pitstop |
| ↳ `fixture_id` | number | Fixture related to the lap/pitstop |
| ↳ `lap_number` | number | Lap number in the fixture |
| ↳ `driver_number` | number | Number of the driver |
| ↳ `participant_id` | number | Driver related to the lap/pitstop |
| ↳ `is_latest` | boolean | Whether it is the latest lap/pitstop |
#### Get Latest Stints by Fixture [#get-latest-stints-by-fixture]
Retrieve the latest tyre stints for a motorsport fixture (session) by fixture ID from Sportmonks
##### Input [#input-139]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture (session) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details) |
| `filters` | string | No | Filters to apply |
##### Output [#output-139]
| Parameter | Type | Description |
| - | - | - |
| `stints` | array | Array of the latest stint objects for the fixture |
| ↳ `id` | number | Unique id of the stint |
| ↳ `fixture_id` | number | Fixture related to the stint |
| ↳ `stint_number` | number | Stint number in the fixture |
| ↳ `driver_number` | number | Number of the driver |
| ↳ `participant_id` | number | Driver related to the stint |
| ↳ `is_latest` | boolean | Whether it is the latest stint |
#### Get Latest Updated Drivers [#get-latest-updated-drivers]
Retrieve the most recently updated motorsport drivers from Sportmonks
##### Input [#input-140]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;teams) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-140]
| Parameter | Type | Description |
| - | - | - |
| `drivers` | array | Array of recently updated driver objects |
| ↳ `id` | number | Unique id of the driver (player\_id in responses) |
| ↳ `sport_id` | number | Sport of the driver |
| ↳ `country_id` | number | Country of birth of the driver |
| ↳ `nationality_id` | number | Nationality of the driver |
| ↳ `city_id` | number | City of birth of the driver |
| ↳ `position_id` | number | Position of the driver within the team |
| ↳ `detailed_position_id` | number | Not used in the Motorsport API |
| ↳ `type_id` | number | Not used in the Motorsport API |
| ↳ `common_name` | string | Name the driver is known for |
| ↳ `firstname` | string | First name of the driver |
| ↳ `lastname` | string | Last name of the driver |
| ↳ `name` | string | Name of the driver |
| ↳ `display_name` | string | Display name of the driver |
| ↳ `image_path` | string | URL to the driver headshot |
| ↳ `height` | number | Height of the driver in cm |
| ↳ `weight` | number | Weight of the driver in kg |
| ↳ `date_of_birth` | string | Date of birth of the driver |
| ↳ `gender` | string | Gender of the driver |
#### Get Latest Updated Motorsport Fixtures [#get-latest-updated-motorsport-fixtures]
Retrieve the most recently updated motorsport fixtures (sessions) from Sportmonks
##### Input [#input-141]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;results) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-141]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of recently updated motorsport fixture (session) objects |
| ↳ `id` | number | Unique id of the fixture (session) |
| ↳ `sport_id` | number | Sport of the fixture |
| ↳ `league_id` | number | League the fixture is held in |
| ↳ `season_id` | number | Season the fixture is held in |
| ↳ `stage_id` | number | Stage (race weekend) the fixture is held in |
| ↳ `group_id` | number | Not used in the Motorsport API |
| ↳ `aggregate_id` | number | Not used in the Motorsport API |
| ↳ `round_id` | number | Not used in the Motorsport API |
| ↳ `state_id` | number | State the fixture is currently in |
| ↳ `venue_id` | number | Venue (track) the fixture is held at |
| ↳ `name` | string | Name of the fixture (e.g. Practice 1, Race) |
| ↳ `starting_at` | string | Start date and time |
| ↳ `result_info` | string | Final result info |
| ↳ `leg` | string | Stage of the fixture (e.g. 2/3 for Practice 2) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Session length in minutes or total laps |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Not used in the Motorsport API |
| ↳ `has_premium_odds` | boolean | Not used in the Motorsport API |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get League by ID [#get-league-by-id-1]
Retrieve a single motorsport league by its ID from Sportmonks
##### Input [#input-142]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `leagueId` | string | Yes | The unique id of the league |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;seasons) |
| `filters` | string | No | Filters to apply |
##### Output [#output-142]
| Parameter | Type | Description |
| - | - | - |
| `league` | object | The requested league object |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | boolean | Whether the league is active |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date of the last fixture held in the league |
| ↳ `category` | number | Category of the league |
| ↳ `has_jerseys` | boolean | Not used in the Motorsport API |
#### Get All Leagues [#get-all-leagues]
Retrieve all motorsport leagues from Sportmonks
##### Input [#input-143]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;seasons) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-143]
| Parameter | Type | Description |
| - | - | - |
| `leagues` | array | Array of league objects |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | boolean | Whether the league is active |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date of the last fixture held in the league |
| ↳ `category` | number | Category of the league |
| ↳ `has_jerseys` | boolean | Not used in the Motorsport API |
#### Get Leagues by Country [#get-leagues-by-country-1]
Retrieve all motorsport leagues for a country by country ID from Sportmonks
##### Input [#input-144]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `countryId` | string | Yes | The unique id of the country |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;seasons) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-144]
| Parameter | Type | Description |
| - | - | - |
| `leagues` | array | Array of league objects for the country |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | boolean | Whether the league is active |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date of the last fixture held in the league |
| ↳ `category` | number | Category of the league |
| ↳ `has_jerseys` | boolean | Not used in the Motorsport API |
#### Get Leagues by Fixture Date [#get-leagues-by-fixture-date]
Retrieve all motorsport leagues with fixtures on a specific date (YYYY-MM-DD) from Sportmonks
##### Input [#input-145]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `date` | string | Yes | The date to fetch leagues for, in YYYY-MM-DD format |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;seasons) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-145]
| Parameter | Type | Description |
| - | - | - |
| `leagues` | array | Array of league objects with fixtures on the requested date |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | boolean | Whether the league is active |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date of the last fixture held in the league |
| ↳ `category` | number | Category of the league |
| ↳ `has_jerseys` | boolean | Not used in the Motorsport API |
#### Get Leagues by Live [#get-leagues-by-live]
Retrieve all motorsport leagues that currently have live fixtures from Sportmonks
##### Input [#input-146]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;seasons) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-146]
| Parameter | Type | Description |
| - | - | - |
| `leagues` | array | Array of league objects that currently have live fixtures |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | boolean | Whether the league is active |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date of the last fixture held in the league |
| ↳ `category` | number | Category of the league |
| ↳ `has_jerseys` | boolean | Not used in the Motorsport API |
#### Get Leagues by Team [#get-leagues-by-team-1]
Retrieve all current and historical motorsport leagues for a team by team ID from Sportmonks
##### Input [#input-147]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `teamId` | string | Yes | The unique id of the team (constructor) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;seasons) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-147]
| Parameter | Type | Description |
| - | - | - |
| `leagues` | array | Array of league objects for the team |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | boolean | Whether the league is active |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date of the last fixture held in the league |
| ↳ `category` | number | Category of the league |
| ↳ `has_jerseys` | boolean | Not used in the Motorsport API |
#### Get Motorsport Livescores [#get-motorsport-livescores]
Retrieve all live motorsport fixtures (sessions) from Sportmonks
##### Input [#input-148]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participants;results) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-148]
| Parameter | Type | Description |
| - | - | - |
| `fixtures` | array | Array of live motorsport fixture (session) objects |
| ↳ `id` | number | Unique id of the fixture (session) |
| ↳ `sport_id` | number | Sport of the fixture |
| ↳ `league_id` | number | League the fixture is held in |
| ↳ `season_id` | number | Season the fixture is held in |
| ↳ `stage_id` | number | Stage (race weekend) the fixture is held in |
| ↳ `group_id` | number | Not used in the Motorsport API |
| ↳ `aggregate_id` | number | Not used in the Motorsport API |
| ↳ `round_id` | number | Not used in the Motorsport API |
| ↳ `state_id` | number | State the fixture is currently in |
| ↳ `venue_id` | number | Venue (track) the fixture is held at |
| ↳ `name` | string | Name of the fixture (e.g. Practice 1, Race) |
| ↳ `starting_at` | string | Start date and time |
| ↳ `result_info` | string | Final result info |
| ↳ `leg` | string | Stage of the fixture (e.g. 2/3 for Practice 2) |
| ↳ `details` | string | Details about the fixture |
| ↳ `length` | number | Session length in minutes or total laps |
| ↳ `placeholder` | boolean | Whether the fixture is a placeholder |
| ↳ `has_odds` | boolean | Not used in the Motorsport API |
| ↳ `has_premium_odds` | boolean | Not used in the Motorsport API |
| ↳ `starting_at_timestamp` | number | UNIX timestamp of the start time |
#### Get Pitstops by Fixture [#get-pitstops-by-fixture]
Retrieve all pitstops for a motorsport fixture (session) by fixture ID from Sportmonks
##### Input [#input-149]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture (session) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details) |
| `filters` | string | No | Filters to apply |
##### Output [#output-149]
| Parameter | Type | Description |
| - | - | - |
| `pitstops` | array | Array of pitstop objects for the fixture |
| ↳ `id` | number | Unique id of the lap/pitstop |
| ↳ `fixture_id` | number | Fixture related to the lap/pitstop |
| ↳ `lap_number` | number | Lap number in the fixture |
| ↳ `driver_number` | number | Number of the driver |
| ↳ `participant_id` | number | Driver related to the lap/pitstop |
| ↳ `is_latest` | boolean | Whether it is the latest lap/pitstop |
#### Get Pitstops by Fixture and Driver [#get-pitstops-by-fixture-and-driver]
Retrieve all pitstops for a motorsport fixture and driver from Sportmonks
##### Input [#input-150]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture (session) |
| `driverId` | string | Yes | The unique id of the driver |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details) |
| `filters` | string | No | Filters to apply |
##### Output [#output-150]
| Parameter | Type | Description |
| - | - | - |
| `pitstops` | array | Array of pitstop objects for the fixture and driver |
| ↳ `id` | number | Unique id of the lap/pitstop |
| ↳ `fixture_id` | number | Fixture related to the lap/pitstop |
| ↳ `lap_number` | number | Lap number in the fixture |
| ↳ `driver_number` | number | Number of the driver |
| ↳ `participant_id` | number | Driver related to the lap/pitstop |
| ↳ `is_latest` | boolean | Whether it is the latest lap/pitstop |
#### Get Pitstops by Fixture and Lap Number [#get-pitstops-by-fixture-and-lap-number]
Retrieve all pitstops for a motorsport fixture and lap number from Sportmonks
##### Input [#input-151]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture (session) |
| `lapNumber` | string | Yes | The lap number to retrieve |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details) |
| `filters` | string | No | Filters to apply |
##### Output [#output-151]
| Parameter | Type | Description |
| - | - | - |
| `pitstops` | array | Array of pitstop objects for the fixture and lap number |
| ↳ `id` | number | Unique id of the lap/pitstop |
| ↳ `fixture_id` | number | Fixture related to the lap/pitstop |
| ↳ `lap_number` | number | Lap number in the fixture |
| ↳ `driver_number` | number | Number of the driver |
| ↳ `participant_id` | number | Driver related to the lap/pitstop |
| ↳ `is_latest` | boolean | Whether it is the latest lap/pitstop |
#### Get Race Results by Season and Driver [#get-race-results-by-season-and-driver]
Retrieve race results (stages with fixtures, lineups and lineup details) for a season and driver from Sportmonks
##### Input [#input-152]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `driverId` | string | Yes | The unique id of the driver |
| `include` | string | No | Semicolon-separated relations to enrich the response |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-152]
| Parameter | Type | Description |
| - | - | - |
| `results` | array | Array of stage objects for the season and driver, each including nested fixtures, lineups and lineup details |
| ↳ `id` | number | Unique id of the stage (race weekend) |
| ↳ `sport_id` | number | Sport of the stage |
| ↳ `league_id` | number | League related to the stage |
| ↳ `season_id` | number | Season related to the stage |
| ↳ `type_id` | number | Type of the stage |
| ↳ `name` | string | Name of the stage |
| ↳ `sort_order` | number | Order of the stage |
| ↳ `finished` | boolean | Whether the stage is finished |
| ↳ `is_current` | boolean | Whether the stage is the current stage |
| ↳ `starting_at` | string | Starting date of the stage |
| ↳ `ending_at` | string | Ending date of the stage |
| ↳ `games_in_current_week` | boolean | Not used in the Motorsport API |
| ↳ `tie_breaker_rule_id` | number | Not used in the Motorsport API |
#### Get Race Results by Season and Team [#get-race-results-by-season-and-team]
Retrieve race results (stages with fixtures, lineups and lineup details) for a season and team from Sportmonks
##### Input [#input-153]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `teamId` | string | Yes | The unique id of the team (constructor) |
| `include` | string | No | Semicolon-separated relations to enrich the response |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-153]
| Parameter | Type | Description |
| - | - | - |
| `results` | array | Array of stage objects for the season and team, each including nested fixtures, lineups and lineup details |
| ↳ `id` | number | Unique id of the stage (race weekend) |
| ↳ `sport_id` | number | Sport of the stage |
| ↳ `league_id` | number | League related to the stage |
| ↳ `season_id` | number | Season related to the stage |
| ↳ `type_id` | number | Type of the stage |
| ↳ `name` | string | Name of the stage |
| ↳ `sort_order` | number | Order of the stage |
| ↳ `finished` | boolean | Whether the stage is finished |
| ↳ `is_current` | boolean | Whether the stage is the current stage |
| ↳ `starting_at` | string | Starting date of the stage |
| ↳ `ending_at` | string | Ending date of the stage |
| ↳ `games_in_current_week` | boolean | Not used in the Motorsport API |
| ↳ `tie_breaker_rule_id` | number | Not used in the Motorsport API |
#### Get Schedules by Season [#get-schedules-by-season-1]
Retrieve the full schedule (stages with nested fixtures and venues) for a season by season ID from Sportmonks
##### Input [#input-154]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-154]
| Parameter | Type | Description |
| - | - | - |
| `schedules` | array | Array of stage objects for the season schedule, each including nested fixtures and venues |
| ↳ `id` | number | Unique id of the stage (race weekend) |
| ↳ `sport_id` | number | Sport of the stage |
| ↳ `league_id` | number | League related to the stage |
| ↳ `season_id` | number | Season related to the stage |
| ↳ `type_id` | number | Type of the stage |
| ↳ `name` | string | Name of the stage |
| ↳ `sort_order` | number | Order of the stage |
| ↳ `finished` | boolean | Whether the stage is finished |
| ↳ `is_current` | boolean | Whether the stage is the current stage |
| ↳ `starting_at` | string | Starting date of the stage |
| ↳ `ending_at` | string | Ending date of the stage |
| ↳ `games_in_current_week` | boolean | Not used in the Motorsport API |
| ↳ `tie_breaker_rule_id` | number | Not used in the Motorsport API |
#### Get Season by ID [#get-season-by-id-1]
Retrieve a single motorsport season by its ID from Sportmonks
##### Input [#input-155]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;stages) |
| `filters` | string | No | Filters to apply |
##### Output [#output-155]
| Parameter | Type | Description |
| - | - | - |
| `season` | object | The requested season object |
| ↳ `id` | number | Unique id of the season |
| ↳ `sport_id` | number | Sport of the season |
| ↳ `league_id` | number | League of the season |
| ↳ `tie_breaker_rule_id` | number | Not used in the Motorsport API |
| ↳ `name` | string | Name of the season |
| ↳ `finished` | boolean | Whether the season is finished |
| ↳ `pending` | boolean | Whether the season is pending |
| ↳ `is_current` | boolean | Whether the season is the current season |
| ↳ `starting_at` | string | Starting date of the season |
| ↳ `ending_at` | string | Ending date of the season |
| ↳ `standings_recalculated_at` | string | Timestamp when standings were last updated |
| ↳ `games_in_current_week` | boolean | Not used in the Motorsport API |
#### Get All Seasons [#get-all-seasons]
Retrieve all motorsport seasons from Sportmonks
##### Input [#input-156]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;stages) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-156]
| Parameter | Type | Description |
| - | - | - |
| `seasons` | array | Array of season objects |
| ↳ `id` | number | Unique id of the season |
| ↳ `sport_id` | number | Sport of the season |
| ↳ `league_id` | number | League of the season |
| ↳ `tie_breaker_rule_id` | number | Not used in the Motorsport API |
| ↳ `name` | string | Name of the season |
| ↳ `finished` | boolean | Whether the season is finished |
| ↳ `pending` | boolean | Whether the season is pending |
| ↳ `is_current` | boolean | Whether the season is the current season |
| ↳ `starting_at` | string | Starting date of the season |
| ↳ `ending_at` | string | Ending date of the season |
| ↳ `standings_recalculated_at` | string | Timestamp when standings were last updated |
| ↳ `games_in_current_week` | boolean | Not used in the Motorsport API |
#### Get Stage by ID [#get-stage-by-id-1]
Retrieve a single motorsport stage (race weekend) by its ID from Sportmonks
##### Input [#input-157]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `stageId` | string | Yes | The unique id of the stage (race weekend) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;season;fixtures) |
| `filters` | string | No | Filters to apply |
##### Output [#output-157]
| Parameter | Type | Description |
| - | - | - |
| `stage` | object | The requested stage (race weekend) object |
| ↳ `id` | number | Unique id of the stage (race weekend) |
| ↳ `sport_id` | number | Sport of the stage |
| ↳ `league_id` | number | League related to the stage |
| ↳ `season_id` | number | Season related to the stage |
| ↳ `type_id` | number | Type of the stage |
| ↳ `name` | string | Name of the stage |
| ↳ `sort_order` | number | Order of the stage |
| ↳ `finished` | boolean | Whether the stage is finished |
| ↳ `is_current` | boolean | Whether the stage is the current stage |
| ↳ `starting_at` | string | Starting date of the stage |
| ↳ `ending_at` | string | Ending date of the stage |
| ↳ `games_in_current_week` | boolean | Not used in the Motorsport API |
| ↳ `tie_breaker_rule_id` | number | Not used in the Motorsport API |
#### Get All Stages [#get-all-stages]
Retrieve all motorsport stages (race weekends) from Sportmonks
##### Input [#input-158]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;season;fixtures) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-158]
| Parameter | Type | Description |
| - | - | - |
| `stages` | array | Array of stage (race weekend) objects |
| ↳ `id` | number | Unique id of the stage (race weekend) |
| ↳ `sport_id` | number | Sport of the stage |
| ↳ `league_id` | number | League related to the stage |
| ↳ `season_id` | number | Season related to the stage |
| ↳ `type_id` | number | Type of the stage |
| ↳ `name` | string | Name of the stage |
| ↳ `sort_order` | number | Order of the stage |
| ↳ `finished` | boolean | Whether the stage is finished |
| ↳ `is_current` | boolean | Whether the stage is the current stage |
| ↳ `starting_at` | string | Starting date of the stage |
| ↳ `ending_at` | string | Ending date of the stage |
| ↳ `games_in_current_week` | boolean | Not used in the Motorsport API |
| ↳ `tie_breaker_rule_id` | number | Not used in the Motorsport API |
#### Get Stages by Season [#get-stages-by-season-1]
Retrieve all motorsport stages (race weekends) for a season by season ID from Sportmonks
##### Input [#input-159]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;season;fixtures) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-159]
| Parameter | Type | Description |
| - | - | - |
| `stages` | array | Array of stage (race weekend) objects for the season |
| ↳ `id` | number | Unique id of the stage (race weekend) |
| ↳ `sport_id` | number | Sport of the stage |
| ↳ `league_id` | number | League related to the stage |
| ↳ `season_id` | number | Season related to the stage |
| ↳ `type_id` | number | Type of the stage |
| ↳ `name` | string | Name of the stage |
| ↳ `sort_order` | number | Order of the stage |
| ↳ `finished` | boolean | Whether the stage is finished |
| ↳ `is_current` | boolean | Whether the stage is the current stage |
| ↳ `starting_at` | string | Starting date of the stage |
| ↳ `ending_at` | string | Ending date of the stage |
| ↳ `games_in_current_week` | boolean | Not used in the Motorsport API |
| ↳ `tie_breaker_rule_id` | number | Not used in the Motorsport API |
#### Get State by ID [#get-state-by-id-1]
Retrieve a single motorsport fixture state by its ID from Sportmonks
##### Input [#input-160]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `stateId` | string | Yes | The unique id of the state |
| `include` | string | No | Semicolon-separated relations to enrich the response |
| `filters` | string | No | Filters to apply |
##### Output [#output-160]
| Parameter | Type | Description |
| - | - | - |
| `state` | object | The requested fixture state object |
| ↳ `id` | number | Unique id of the state |
| ↳ `state` | string | Abbreviation of the state |
| ↳ `name` | string | Full name of the state |
| ↳ `short_name` | string | Short name of the state |
| ↳ `developer_name` | string | Name recommended for developers to use |
#### Get All States [#get-all-states]
Retrieve all possible motorsport fixture states from Sportmonks
##### Input [#input-161]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-161]
| Parameter | Type | Description |
| - | - | - |
| `states` | array | Array of fixture state objects |
| ↳ `id` | number | Unique id of the state |
| ↳ `state` | string | Abbreviation of the state |
| ↳ `name` | string | Full name of the state |
| ↳ `short_name` | string | Short name of the state |
| ↳ `developer_name` | string | Name recommended for developers to use |
#### Get Stints by Fixture [#get-stints-by-fixture]
Retrieve all tyre stints for a motorsport fixture (session) by fixture ID from Sportmonks
##### Input [#input-162]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture (session) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details) |
| `filters` | string | No | Filters to apply |
##### Output [#output-162]
| Parameter | Type | Description |
| - | - | - |
| `stints` | array | Array of stint objects for the fixture |
| ↳ `id` | number | Unique id of the stint |
| ↳ `fixture_id` | number | Fixture related to the stint |
| ↳ `stint_number` | number | Stint number in the fixture |
| ↳ `driver_number` | number | Number of the driver |
| ↳ `participant_id` | number | Driver related to the stint |
| ↳ `is_latest` | boolean | Whether it is the latest stint |
#### Get Stints by Fixture and Driver [#get-stints-by-fixture-and-driver]
Retrieve all tyre stints for a motorsport fixture and driver from Sportmonks
##### Input [#input-163]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture (session) |
| `driverId` | string | Yes | The unique id of the driver |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details) |
| `filters` | string | No | Filters to apply |
##### Output [#output-163]
| Parameter | Type | Description |
| - | - | - |
| `stints` | array | Array of stint objects for the fixture and driver |
| ↳ `id` | number | Unique id of the stint |
| ↳ `fixture_id` | number | Fixture related to the stint |
| ↳ `stint_number` | number | Stint number in the fixture |
| ↳ `driver_number` | number | Number of the driver |
| ↳ `participant_id` | number | Driver related to the stint |
| ↳ `is_latest` | boolean | Whether it is the latest stint |
#### Get Stints by Fixture and Stint Number [#get-stints-by-fixture-and-stint-number]
Retrieve all tyre stints for a motorsport fixture and stint number from Sportmonks
##### Input [#input-164]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture (session) |
| `stintNumber` | string | Yes | The stint number to retrieve |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;details) |
| `filters` | string | No | Filters to apply |
##### Output [#output-164]
| Parameter | Type | Description |
| - | - | - |
| `stints` | array | Array of stint objects for the fixture and stint number |
| ↳ `id` | number | Unique id of the stint |
| ↳ `fixture_id` | number | Fixture related to the stint |
| ↳ `stint_number` | number | Stint number in the fixture |
| ↳ `driver_number` | number | Number of the driver |
| ↳ `participant_id` | number | Driver related to the stint |
| ↳ `is_latest` | boolean | Whether it is the latest stint |
#### Get Team by ID [#get-team-by-id-1]
Retrieve a single motorsport team (constructor) by its ID from Sportmonks
##### Input [#input-165]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `teamId` | string | Yes | The unique id of the team (constructor) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;drivers) |
| `filters` | string | No | Filters to apply |
##### Output [#output-165]
| Parameter | Type | Description |
| - | - | - |
| `team` | object | The requested team (constructor) object |
| ↳ `id` | number | Unique id of the team |
| ↳ `sport_id` | number | Sport of the team |
| ↳ `country_id` | number | Country of the team |
| ↳ `venue_id` | number | Not used in the Motorsport API |
| ↳ `gender` | string | Gender of the team |
| ↳ `name` | string | Name of the team (constructor) |
| ↳ `short_code` | string | Short code of the team |
| ↳ `image_path` | string | URL to the team logo |
| ↳ `founded` | number | Founding year of the team |
| ↳ `type` | string | Type of the team |
| ↳ `placeholder` | boolean | Whether the team is a placeholder |
| ↳ `last_played_at` | string | Date and time of the team's last session |
#### Get All Team Standings [#get-all-team-standings]
Retrieve all team (constructor) championship standings from Sportmonks
##### Input [#input-166]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;season) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-166]
| Parameter | Type | Description |
| - | - | - |
| `standings` | array | Array of team (constructor) standing entries |
| ↳ `id` | number | Unique id of the standing |
| ↳ `participant_id` | number | Driver or team related to the standing |
| ↳ `sport_id` | number | Sport related to the standing |
| ↳ `league_id` | number | League related to the standing |
| ↳ `season_id` | number | Season related to the standing |
| ↳ `stage_id` | number | Stage related to the standing |
| ↳ `group_id` | number | Not used in the Motorsport API |
| ↳ `round_id` | number | Not used in the Motorsport API |
| ↳ `standing_rule_id` | number | Not used in the Motorsport API |
| ↳ `position` | number | Position of the participant in the standing |
| ↳ `result` | string | Not used in the Motorsport API |
| ↳ `points` | number | Points the participant has gathered |
#### Get Team Standings by Season [#get-team-standings-by-season]
Retrieve the constructors championship standings for a season by season ID from Sportmonks
##### Input [#input-167]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. participant;season) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-167]
| Parameter | Type | Description |
| - | - | - |
| `standings` | array | Array of team (constructor) standing entries for the season |
| ↳ `id` | number | Unique id of the standing |
| ↳ `participant_id` | number | Driver or team related to the standing |
| ↳ `sport_id` | number | Sport related to the standing |
| ↳ `league_id` | number | League related to the standing |
| ↳ `season_id` | number | Season related to the standing |
| ↳ `stage_id` | number | Stage related to the standing |
| ↳ `group_id` | number | Not used in the Motorsport API |
| ↳ `round_id` | number | Not used in the Motorsport API |
| ↳ `standing_rule_id` | number | Not used in the Motorsport API |
| ↳ `position` | number | Position of the participant in the standing |
| ↳ `result` | string | Not used in the Motorsport API |
| ↳ `points` | number | Points the participant has gathered |
#### Get Teams [#get-teams]
Retrieve all motorsport teams (constructors) from Sportmonks
##### Input [#input-168]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;drivers) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-168]
| Parameter | Type | Description |
| - | - | - |
| `teams` | array | Array of team (constructor) objects |
| ↳ `id` | number | Unique id of the team |
| ↳ `sport_id` | number | Sport of the team |
| ↳ `country_id` | number | Country of the team |
| ↳ `venue_id` | number | Not used in the Motorsport API |
| ↳ `gender` | string | Gender of the team |
| ↳ `name` | string | Name of the team (constructor) |
| ↳ `short_code` | string | Short code of the team |
| ↳ `image_path` | string | URL to the team logo |
| ↳ `founded` | number | Founding year of the team |
| ↳ `type` | string | Type of the team |
| ↳ `placeholder` | boolean | Whether the team is a placeholder |
| ↳ `last_played_at` | string | Date and time of the team's last session |
#### Get Teams by Country [#get-teams-by-country-1]
Retrieve all motorsport teams (constructors) for a country by country ID from Sportmonks
##### Input [#input-169]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `countryId` | string | Yes | The unique id of the country |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;drivers) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-169]
| Parameter | Type | Description |
| - | - | - |
| `teams` | array | Array of team (constructor) objects for the country |
| ↳ `id` | number | Unique id of the team |
| ↳ `sport_id` | number | Sport of the team |
| ↳ `country_id` | number | Country of the team |
| ↳ `venue_id` | number | Not used in the Motorsport API |
| ↳ `gender` | string | Gender of the team |
| ↳ `name` | string | Name of the team (constructor) |
| ↳ `short_code` | string | Short code of the team |
| ↳ `image_path` | string | URL to the team logo |
| ↳ `founded` | number | Founding year of the team |
| ↳ `type` | string | Type of the team |
| ↳ `placeholder` | boolean | Whether the team is a placeholder |
| ↳ `last_played_at` | string | Date and time of the team's last session |
#### Get Teams by Season [#get-teams-by-season-1]
Retrieve all motorsport teams (constructors) for a season by season ID from Sportmonks
##### Input [#input-170]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;drivers) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-170]
| Parameter | Type | Description |
| - | - | - |
| `teams` | array | Array of team (constructor) objects for the season |
| ↳ `id` | number | Unique id of the team |
| ↳ `sport_id` | number | Sport of the team |
| ↳ `country_id` | number | Country of the team |
| ↳ `venue_id` | number | Not used in the Motorsport API |
| ↳ `gender` | string | Gender of the team |
| ↳ `name` | string | Name of the team (constructor) |
| ↳ `short_code` | string | Short code of the team |
| ↳ `image_path` | string | URL to the team logo |
| ↳ `founded` | number | Founding year of the team |
| ↳ `type` | string | Type of the team |
| ↳ `placeholder` | boolean | Whether the team is a placeholder |
| ↳ `last_played_at` | string | Date and time of the team's last session |
#### Get Venue by ID [#get-venue-by-id-1]
Retrieve a single motorsport venue (racing track) by its ID from Sportmonks
##### Input [#input-171]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `venueId` | string | Yes | The unique id of the venue (track) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;city) |
| `filters` | string | No | Filters to apply |
##### Output [#output-171]
| Parameter | Type | Description |
| - | - | - |
| `venue` | object | The requested venue (racing track) object |
| ↳ `id` | number | Unique id of the venue (track) |
| ↳ `country_id` | number | Country the venue is in |
| ↳ `city_id` | number | City the venue is in |
| ↳ `name` | string | Name of the venue/track |
| ↳ `address` | string | Address of the venue |
| ↳ `zipcode` | string | Zipcode of the venue |
| ↳ `latitude` | string | Latitude of the venue |
| ↳ `longitude` | string | Longitude of the venue |
| ↳ `capacity` | number | Capacity of the venue |
| ↳ `image_path` | string | URL to the track layout image |
| ↳ `city_name` | string | Name of the city the venue is in |
| ↳ `surface` | string | Surface of the venue |
| ↳ `national_team` | boolean | Not used in the Motorsport API |
#### Get Venues [#get-venues-1]
Retrieve all motorsport venues (racing tracks) from Sportmonks
##### Input [#input-172]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;city) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-172]
| Parameter | Type | Description |
| - | - | - |
| `venues` | array | Array of venue (racing track) objects |
| ↳ `id` | number | Unique id of the venue (track) |
| ↳ `country_id` | number | Country the venue is in |
| ↳ `city_id` | number | City the venue is in |
| ↳ `name` | string | Name of the venue/track |
| ↳ `address` | string | Address of the venue |
| ↳ `zipcode` | string | Zipcode of the venue |
| ↳ `latitude` | string | Latitude of the venue |
| ↳ `longitude` | string | Longitude of the venue |
| ↳ `capacity` | number | Capacity of the venue |
| ↳ `image_path` | string | URL to the track layout image |
| ↳ `city_name` | string | Name of the city the venue is in |
| ↳ `surface` | string | Surface of the venue |
| ↳ `national_team` | boolean | Not used in the Motorsport API |
#### Get Venues by Season [#get-venues-by-season-1]
Retrieve all motorsport venues (racing tracks) for a season by season ID from Sportmonks
##### Input [#input-173]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `seasonId` | string | Yes | The unique id of the season |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;city) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-173]
| Parameter | Type | Description |
| - | - | - |
| `venues` | array | Array of venue (racing track) objects for the season |
| ↳ `id` | number | Unique id of the venue (track) |
| ↳ `country_id` | number | Country the venue is in |
| ↳ `city_id` | number | City the venue is in |
| ↳ `name` | string | Name of the venue/track |
| ↳ `address` | string | Address of the venue |
| ↳ `zipcode` | string | Zipcode of the venue |
| ↳ `latitude` | string | Latitude of the venue |
| ↳ `longitude` | string | Longitude of the venue |
| ↳ `capacity` | number | Capacity of the venue |
| ↳ `image_path` | string | URL to the track layout image |
| ↳ `city_name` | string | Name of the city the venue is in |
| ↳ `surface` | string | Surface of the venue |
| ↳ `national_team` | boolean | Not used in the Motorsport API |
#### Search Drivers [#search-drivers]
Search for motorsport drivers by name from Sportmonks
##### Input [#input-174]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The driver name to search for (e.g. Verstappen) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;teams) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-174]
| Parameter | Type | Description |
| - | - | - |
| `drivers` | array | Array of driver objects matching the search query |
| ↳ `id` | number | Unique id of the driver (player\_id in responses) |
| ↳ `sport_id` | number | Sport of the driver |
| ↳ `country_id` | number | Country of birth of the driver |
| ↳ `nationality_id` | number | Nationality of the driver |
| ↳ `city_id` | number | City of birth of the driver |
| ↳ `position_id` | number | Position of the driver within the team |
| ↳ `detailed_position_id` | number | Not used in the Motorsport API |
| ↳ `type_id` | number | Not used in the Motorsport API |
| ↳ `common_name` | string | Name the driver is known for |
| ↳ `firstname` | string | First name of the driver |
| ↳ `lastname` | string | Last name of the driver |
| ↳ `name` | string | Name of the driver |
| ↳ `display_name` | string | Display name of the driver |
| ↳ `image_path` | string | URL to the driver headshot |
| ↳ `height` | number | Height of the driver in cm |
| ↳ `weight` | number | Weight of the driver in kg |
| ↳ `date_of_birth` | string | Date of birth of the driver |
| ↳ `gender` | string | Gender of the driver |
#### Search Leagues [#search-leagues-1]
Search for motorsport leagues by name from Sportmonks
##### Input [#input-175]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The league name to search for (e.g. Formula) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;seasons) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-175]
| Parameter | Type | Description |
| - | - | - |
| `leagues` | array | Array of league objects matching the search query |
| ↳ `id` | number | Unique id of the league |
| ↳ `sport_id` | number | Sport of the league |
| ↳ `country_id` | number | Country of the league |
| ↳ `name` | string | Name of the league |
| ↳ `active` | boolean | Whether the league is active |
| ↳ `short_code` | string | Short code of the league |
| ↳ `image_path` | string | URL to the league logo |
| ↳ `type` | string | Type of the league |
| ↳ `sub_type` | string | Subtype of the league |
| ↳ `last_played_at` | string | Date of the last fixture held in the league |
| ↳ `category` | number | Category of the league |
| ↳ `has_jerseys` | boolean | Not used in the Motorsport API |
#### Search Stages [#search-stages-1]
Search for motorsport stages (race weekends) by name from Sportmonks
##### Input [#input-176]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The stage name to search for (e.g. Monaco) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. league;season;fixtures) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-176]
| Parameter | Type | Description |
| - | - | - |
| `stages` | array | Array of stage (race weekend) objects matching the search query |
| ↳ `id` | number | Unique id of the stage (race weekend) |
| ↳ `sport_id` | number | Sport of the stage |
| ↳ `league_id` | number | League related to the stage |
| ↳ `season_id` | number | Season related to the stage |
| ↳ `type_id` | number | Type of the stage |
| ↳ `name` | string | Name of the stage |
| ↳ `sort_order` | number | Order of the stage |
| ↳ `finished` | boolean | Whether the stage is finished |
| ↳ `is_current` | boolean | Whether the stage is the current stage |
| ↳ `starting_at` | string | Starting date of the stage |
| ↳ `ending_at` | string | Ending date of the stage |
| ↳ `games_in_current_week` | boolean | Not used in the Motorsport API |
| ↳ `tie_breaker_rule_id` | number | Not used in the Motorsport API |
#### Search Teams [#search-teams-1]
Search for motorsport teams (constructors) by name from Sportmonks
##### Input [#input-177]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The team name to search for (e.g. Bull) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;drivers) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-177]
| Parameter | Type | Description |
| - | - | - |
| `teams` | array | Array of team (constructor) objects matching the search query |
| ↳ `id` | number | Unique id of the team |
| ↳ `sport_id` | number | Sport of the team |
| ↳ `country_id` | number | Country of the team |
| ↳ `venue_id` | number | Not used in the Motorsport API |
| ↳ `gender` | string | Gender of the team |
| ↳ `name` | string | Name of the team (constructor) |
| ↳ `short_code` | string | Short code of the team |
| ↳ `image_path` | string | URL to the team logo |
| ↳ `founded` | number | Founding year of the team |
| ↳ `type` | string | Type of the team |
| ↳ `placeholder` | boolean | Whether the team is a placeholder |
| ↳ `last_played_at` | string | Date and time of the team's last session |
#### Search Venues [#search-venues-1]
Search for motorsport venues (racing tracks) by name from Sportmonks
##### Input [#input-178]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The venue name to search for (e.g. Hungaroring) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;city) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-178]
| Parameter | Type | Description |
| - | - | - |
| `venues` | array | Array of venue (racing track) objects matching the search query |
| ↳ `id` | number | Unique id of the venue (track) |
| ↳ `country_id` | number | Country the venue is in |
| ↳ `city_id` | number | City the venue is in |
| ↳ `name` | string | Name of the venue/track |
| ↳ `address` | string | Address of the venue |
| ↳ `zipcode` | string | Zipcode of the venue |
| ↳ `latitude` | string | Latitude of the venue |
| ↳ `longitude` | string | Longitude of the venue |
| ↳ `capacity` | number | Capacity of the venue |
| ↳ `image_path` | string | URL to the track layout image |
| ↳ `city_name` | string | Name of the city the venue is in |
| ↳ `surface` | string | Surface of the venue |
| ↳ `national_team` | boolean | Not used in the Motorsport API |
### Odds [#actions-sportmonks_odds_get_all_historical_odds]
#### Get All Historical Odds [#get-all-historical-odds]
Retrieve all available historical (premium) pre-match odd values from the Sportmonks Odds API
##### Input [#input-179]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. odd) |
| `filters` | string | No | Filters to apply (e.g. winningOdds) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-179]
| Parameter | Type | Description |
| - | - | - |
| `historicalOdds` | array | Array of historical premium odd value records |
| ↳ `id` | number | Unique id of the history record |
| ↳ `odd_id` | number | Premium odd this history record belongs to |
| ↳ `value` | string | Historical decimal odds value |
| ↳ `probability` | string | Implied probability at this point in time |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds |
| ↳ `american` | string | American/moneyline odds |
| ↳ `bookmaker_update` | string | Bookmaker's update timestamp for this record (UTC) |
#### Get All In-play Odds [#get-all-in-play-odds]
Retrieve all available live (in-play) odds from the Sportmonks Odds API
##### Input [#input-180]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. market;bookmaker) |
| `filters` | string | No | Filters to apply (e.g. markets:1,12, bookmakers:2,14, IdAfter:oddID) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-180]
| Parameter | Type | Description |
| - | - | - |
| `odds` | array | Array of in-play odd objects |
| ↳ `id` | number | Unique id of the odd |
| ↳ `fixture_id` | number | Fixture the odd belongs to |
| ↳ `external_id` | number | External id of the odd |
| ↳ `market_id` | number | Market the odd belongs to |
| ↳ `bookmaker_id` | number | Bookmaker offering the odd |
| ↳ `label` | string | Outcome label (e.g. 1, X, 2) |
| ↳ `value` | string | Decimal odds value |
| ↳ `name` | string | Outcome name |
| ↳ `sort_order` | number | Sort order of the odd |
| ↳ `market_description` | string | Description of the market |
| ↳ `probability` | string | Implied probability |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds |
| ↳ `american` | string | American/moneyline odds |
| ↳ `winning` | boolean | Whether this is the winning outcome |
| ↳ `suspended` | boolean | Whether the odd is suspended |
| ↳ `stopped` | boolean | Whether the odd is stopped |
| ↳ `total` | string | Total line for over/under markets |
| ↳ `handicap` | string | Handicap line for handicap markets |
| ↳ `participants` | string | Participant ids related to the outcome |
#### Get All Pre-match Odds [#get-all-pre-match-odds]
Retrieve all available pre-match odds from the Sportmonks Odds API
##### Input [#input-181]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. market;bookmaker) |
| `filters` | string | No | Filters to apply (e.g. markets:1,12, bookmakers:2,14, winningOdds, IdAfter:oddID) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-181]
| Parameter | Type | Description |
| - | - | - |
| `odds` | array | Array of pre-match odd objects |
| ↳ `id` | number | Unique id of the odd |
| ↳ `fixture_id` | number | Fixture the odd belongs to |
| ↳ `market_id` | number | Market the odd belongs to |
| ↳ `bookmaker_id` | number | Bookmaker offering the odd |
| ↳ `label` | string | Outcome label (e.g. 1, X, 2) |
| ↳ `value` | string | Decimal odds value |
| ↳ `name` | string | Outcome name (e.g. Home, Draw, Away) |
| ↳ `sort_order` | number | Sort order of the odd |
| ↳ `market_description` | string | Description of the market |
| ↳ `probability` | string | Implied probability (e.g. 48.78%) |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds (e.g. 31/15) |
| ↳ `american` | string | American/moneyline odds (e.g. +104) |
| ↳ `winning` | boolean | Whether this is the winning outcome |
| ↳ `stopped` | boolean | Whether the odd is stopped |
| ↳ `total` | string | Total line for over/under markets |
| ↳ `handicap` | string | Handicap line for handicap markets |
| ↳ `participants` | string | Participant ids related to the outcome |
| ↳ `original_label` | string | Original handicap value of the odd (handicap markets) |
#### Get All Premium Odds [#get-all-premium-odds]
Retrieve all available premium (historical) pre-match odds from the Sportmonks Odds API
##### Input [#input-182]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. market;bookmaker) |
| `filters` | string | No | Filters to apply (e.g. markets:1,12, bookmakers:2,14, IdAfter:oddID) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-182]
| Parameter | Type | Description |
| - | - | - |
| `premiumOdds` | array | Array of premium odd objects |
| ↳ `id` | number | Unique id of the odd |
| ↳ `fixture_id` | number | Fixture the odd belongs to |
| ↳ `market_id` | number | Market the odd belongs to |
| ↳ `bookmaker_id` | number | Bookmaker offering the odd |
| ↳ `label` | string | Outcome label |
| ↳ `value` | string | Decimal odds value |
| ↳ `name` | string | Outcome name |
| ↳ `sort_order` | number | Sort order of the odd |
| ↳ `market_description` | string | Description of the market |
| ↳ `probability` | string | Implied probability (e.g. 29.85%) |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds |
| ↳ `american` | string | American/moneyline odds |
| ↳ `stopped` | boolean | Whether the odd is stopped |
| ↳ `total` | string | Total line for over/under markets |
| ↳ `handicap` | string | Handicap line for handicap markets |
| ↳ `created_at` | string | Timestamp the odd was created (UTC) |
| ↳ `updated_at` | string | Timestamp the odd was last updated (UTC) |
| ↳ `latest_bookmaker_update` | string | Bookmaker's own last-update timestamp (UTC) |
#### Get Bookmaker by ID [#get-bookmaker-by-id]
Retrieve a single bookmaker by its ID from the Sportmonks Odds API
##### Input [#input-183]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `bookmakerId` | string | Yes | The unique id of the bookmaker |
##### Output [#output-183]
| Parameter | Type | Description |
| - | - | - |
| `bookmaker` | object | The requested bookmaker object |
| ↳ `id` | number | Unique id of the bookmaker |
| ↳ `name` | string | Name of the bookmaker |
| ↳ `logo` | string | Logo of the bookmaker |
#### Get Bookmaker Event IDs by Fixture [#get-bookmaker-event-ids-by-fixture]
Retrieve bookmakers' own event ids mapped to a Sportmonks fixture via the Sportmonks Odds API
##### Input [#input-184]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-184]
| Parameter | Type | Description |
| - | - | - |
| `bookmakerEvents` | array | Array of bookmaker event mapping records for the fixture |
| ↳ `fixture_id` | number | Sportmonks fixture id |
| ↳ `bookmaker_id` | number | Id of the bookmaker |
| ↳ `bookmaker_name` | string | Name of the bookmaker |
| ↳ `bookmaker_event_id` | string | The fixture's event id at the bookmaker |
#### Get Bookmakers [#get-bookmakers]
Retrieve all bookmakers from the Sportmonks Odds API
##### Input [#input-185]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `filters` | string | No | Filters to apply (e.g. IdAfter:bookmakerID) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-185]
| Parameter | Type | Description |
| - | - | - |
| `bookmakers` | array | Array of bookmaker objects |
| ↳ `id` | number | Unique id of the bookmaker |
| ↳ `name` | string | Name of the bookmaker |
| ↳ `logo` | string | Logo of the bookmaker |
#### Get Bookmakers by Fixture [#get-bookmakers-by-fixture]
Retrieve all bookmakers available for a fixture from the Sportmonks Odds API
##### Input [#input-186]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-186]
| Parameter | Type | Description |
| - | - | - |
| `bookmakers` | array | Array of bookmaker objects available for the fixture |
| ↳ `id` | number | Unique id of the bookmaker |
| ↳ `name` | string | Name of the bookmaker |
| ↳ `logo` | string | Logo of the bookmaker |
#### Get In-play Odds by Fixture [#get-in-play-odds-by-fixture]
Retrieve live (in-play) odds for a fixture by fixture ID from the Sportmonks Odds API
##### Input [#input-187]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. market;bookmaker) |
| `filters` | string | No | Filters to apply (e.g. markets:1,12 or bookmakers:2,14 or winningOdds) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-187]
| Parameter | Type | Description |
| - | - | - |
| `odds` | array | Array of in-play odd objects for the fixture |
| ↳ `id` | number | Unique id of the odd |
| ↳ `fixture_id` | number | Fixture the odd belongs to |
| ↳ `external_id` | number | External id of the odd |
| ↳ `market_id` | number | Market the odd belongs to |
| ↳ `bookmaker_id` | number | Bookmaker offering the odd |
| ↳ `label` | string | Outcome label (e.g. 1, X, 2) |
| ↳ `value` | string | Decimal odds value |
| ↳ `name` | string | Outcome name |
| ↳ `sort_order` | number | Sort order of the odd |
| ↳ `market_description` | string | Description of the market |
| ↳ `probability` | string | Implied probability |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds |
| ↳ `american` | string | American/moneyline odds |
| ↳ `winning` | boolean | Whether this is the winning outcome |
| ↳ `suspended` | boolean | Whether the odd is suspended |
| ↳ `stopped` | boolean | Whether the odd is stopped |
| ↳ `total` | string | Total line for over/under markets |
| ↳ `handicap` | string | Handicap line for handicap markets |
| ↳ `participants` | string | Participant ids related to the outcome |
#### Get In-play Odds by Fixture and Bookmaker [#get-in-play-odds-by-fixture-and-bookmaker]
Retrieve live (in-play) odds for a fixture from a specific bookmaker via the Sportmonks Odds API
##### Input [#input-188]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `bookmakerId` | string | Yes | The unique id of the bookmaker |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. market;bookmaker) |
| `filters` | string | No | Filters to apply (e.g. markets:1,12) |
##### Output [#output-188]
| Parameter | Type | Description |
| - | - | - |
| `odds` | array | Array of in-play odd objects for the fixture and bookmaker |
| ↳ `id` | number | Unique id of the odd |
| ↳ `fixture_id` | number | Fixture the odd belongs to |
| ↳ `external_id` | number | External id of the odd |
| ↳ `market_id` | number | Market the odd belongs to |
| ↳ `bookmaker_id` | number | Bookmaker offering the odd |
| ↳ `label` | string | Outcome label (e.g. 1, X, 2) |
| ↳ `value` | string | Decimal odds value |
| ↳ `name` | string | Outcome name |
| ↳ `sort_order` | number | Sort order of the odd |
| ↳ `market_description` | string | Description of the market |
| ↳ `probability` | string | Implied probability |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds |
| ↳ `american` | string | American/moneyline odds |
| ↳ `winning` | boolean | Whether this is the winning outcome |
| ↳ `suspended` | boolean | Whether the odd is suspended |
| ↳ `stopped` | boolean | Whether the odd is stopped |
| ↳ `total` | string | Total line for over/under markets |
| ↳ `handicap` | string | Handicap line for handicap markets |
| ↳ `participants` | string | Participant ids related to the outcome |
#### Get In-play Odds by Fixture and Market [#get-in-play-odds-by-fixture-and-market]
Retrieve live (in-play) odds for a fixture on a specific market via the Sportmonks Odds API
##### Input [#input-189]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `marketId` | string | Yes | The unique id of the market |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. market;bookmaker) |
| `filters` | string | No | Filters to apply (e.g. bookmakers:2,14) |
##### Output [#output-189]
| Parameter | Type | Description |
| - | - | - |
| `odds` | array | Array of in-play odd objects for the fixture and market |
| ↳ `id` | number | Unique id of the odd |
| ↳ `fixture_id` | number | Fixture the odd belongs to |
| ↳ `external_id` | number | External id of the odd |
| ↳ `market_id` | number | Market the odd belongs to |
| ↳ `bookmaker_id` | number | Bookmaker offering the odd |
| ↳ `label` | string | Outcome label (e.g. 1, X, 2) |
| ↳ `value` | string | Decimal odds value |
| ↳ `name` | string | Outcome name |
| ↳ `sort_order` | number | Sort order of the odd |
| ↳ `market_description` | string | Description of the market |
| ↳ `probability` | string | Implied probability |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds |
| ↳ `american` | string | American/moneyline odds |
| ↳ `winning` | boolean | Whether this is the winning outcome |
| ↳ `suspended` | boolean | Whether the odd is suspended |
| ↳ `stopped` | boolean | Whether the odd is stopped |
| ↳ `total` | string | Total line for over/under markets |
| ↳ `handicap` | string | Handicap line for handicap markets |
| ↳ `participants` | string | Participant ids related to the outcome |
#### Get Last Updated In-play Odds [#get-last-updated-in-play-odds]
Retrieve in-play odds updated in the last 10 seconds from the Sportmonks Odds API
##### Input [#input-190]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. market;bookmaker) |
| `filters` | string | No | Filters to apply (e.g. markets:1,12 or bookmakers:2,14) |
##### Output [#output-190]
| Parameter | Type | Description |
| - | - | - |
| `odds` | array | Array of in-play odd objects updated in the last 10 seconds |
| ↳ `id` | number | Unique id of the odd |
| ↳ `fixture_id` | number | Fixture the odd belongs to |
| ↳ `external_id` | number | External id of the odd |
| ↳ `market_id` | number | Market the odd belongs to |
| ↳ `bookmaker_id` | number | Bookmaker offering the odd |
| ↳ `label` | string | Outcome label (e.g. 1, X, 2) |
| ↳ `value` | string | Decimal odds value |
| ↳ `name` | string | Outcome name |
| ↳ `sort_order` | number | Sort order of the odd |
| ↳ `market_description` | string | Description of the market |
| ↳ `probability` | string | Implied probability |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds |
| ↳ `american` | string | American/moneyline odds |
| ↳ `winning` | boolean | Whether this is the winning outcome |
| ↳ `suspended` | boolean | Whether the odd is suspended |
| ↳ `stopped` | boolean | Whether the odd is stopped |
| ↳ `total` | string | Total line for over/under markets |
| ↳ `handicap` | string | Handicap line for handicap markets |
| ↳ `participants` | string | Participant ids related to the outcome |
#### Get Last Updated Pre-match Odds [#get-last-updated-pre-match-odds]
Retrieve pre-match odds updated in the last 10 seconds from the Sportmonks Odds API
##### Input [#input-191]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. market;bookmaker) |
| `filters` | string | No | Filters to apply (e.g. markets:1,12 or bookmakers:2,14 or winningOdds) |
##### Output [#output-191]
| Parameter | Type | Description |
| - | - | - |
| `odds` | array | Array of pre-match odd objects updated in the last 10 seconds |
| ↳ `id` | number | Unique id of the odd |
| ↳ `fixture_id` | number | Fixture the odd belongs to |
| ↳ `market_id` | number | Market the odd belongs to |
| ↳ `bookmaker_id` | number | Bookmaker offering the odd |
| ↳ `label` | string | Outcome label (e.g. 1, X, 2) |
| ↳ `value` | string | Decimal odds value |
| ↳ `name` | string | Outcome name (e.g. Home, Draw, Away) |
| ↳ `sort_order` | number | Sort order of the odd |
| ↳ `market_description` | string | Description of the market |
| ↳ `probability` | string | Implied probability (e.g. 48.78%) |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds (e.g. 31/15) |
| ↳ `american` | string | American/moneyline odds (e.g. +104) |
| ↳ `winning` | boolean | Whether this is the winning outcome |
| ↳ `stopped` | boolean | Whether the odd is stopped |
| ↳ `total` | string | Total line for over/under markets |
| ↳ `handicap` | string | Handicap line for handicap markets |
| ↳ `participants` | string | Participant ids related to the outcome |
| ↳ `original_label` | string | Original handicap value of the odd (handicap markets) |
#### Get Market by ID [#get-market-by-id]
Retrieve a single betting market by its ID from the Sportmonks Odds API
##### Input [#input-192]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `marketId` | string | Yes | The unique id of the market |
##### Output [#output-192]
| Parameter | Type | Description |
| - | - | - |
| `market` | object | The requested market object |
| ↳ `id` | number | Unique id of the market |
| ↳ `name` | string | Name of the market |
| ↳ `developer_name` | string | Developer (machine-readable) name of the market |
#### Get Markets [#get-markets]
Retrieve all betting markets from the Sportmonks Odds API
##### Input [#input-193]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `filters` | string | No | Filters to apply (e.g. IdAfter:marketID) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-193]
| Parameter | Type | Description |
| - | - | - |
| `markets` | array | Array of market objects |
| ↳ `id` | number | Unique id of the market |
| ↳ `name` | string | Name of the market |
| ↳ `developer_name` | string | Developer (machine-readable) name of the market |
#### Get Pre-match Odds by Fixture [#get-pre-match-odds-by-fixture]
Retrieve pre-match odds for a fixture by fixture ID from the Sportmonks Odds API
##### Input [#input-194]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. market;bookmaker) |
| `filters` | string | No | Filters to apply (e.g. markets:1,12 or bookmakers:2,14 or winningOdds) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-194]
| Parameter | Type | Description |
| - | - | - |
| `odds` | array | Array of pre-match odd objects for the fixture |
| ↳ `id` | number | Unique id of the odd |
| ↳ `fixture_id` | number | Fixture the odd belongs to |
| ↳ `market_id` | number | Market the odd belongs to |
| ↳ `bookmaker_id` | number | Bookmaker offering the odd |
| ↳ `label` | string | Outcome label (e.g. 1, X, 2) |
| ↳ `value` | string | Decimal odds value |
| ↳ `name` | string | Outcome name (e.g. Home, Draw, Away) |
| ↳ `sort_order` | number | Sort order of the odd |
| ↳ `market_description` | string | Description of the market |
| ↳ `probability` | string | Implied probability (e.g. 48.78%) |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds (e.g. 31/15) |
| ↳ `american` | string | American/moneyline odds (e.g. +104) |
| ↳ `winning` | boolean | Whether this is the winning outcome |
| ↳ `stopped` | boolean | Whether the odd is stopped |
| ↳ `total` | string | Total line for over/under markets |
| ↳ `handicap` | string | Handicap line for handicap markets |
| ↳ `participants` | string | Participant ids related to the outcome |
| ↳ `original_label` | string | Original handicap value of the odd (handicap markets) |
#### Get Pre-match Odds by Fixture and Bookmaker [#get-pre-match-odds-by-fixture-and-bookmaker]
Retrieve pre-match odds for a fixture from a specific bookmaker via the Sportmonks Odds API
##### Input [#input-195]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `bookmakerId` | string | Yes | The unique id of the bookmaker |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. market;bookmaker) |
| `filters` | string | No | Filters to apply (e.g. markets:1,12 or winningOdds) |
##### Output [#output-195]
| Parameter | Type | Description |
| - | - | - |
| `odds` | array | Array of pre-match odd objects for the fixture and bookmaker |
| ↳ `id` | number | Unique id of the odd |
| ↳ `fixture_id` | number | Fixture the odd belongs to |
| ↳ `market_id` | number | Market the odd belongs to |
| ↳ `bookmaker_id` | number | Bookmaker offering the odd |
| ↳ `label` | string | Outcome label (e.g. 1, X, 2) |
| ↳ `value` | string | Decimal odds value |
| ↳ `name` | string | Outcome name (e.g. Home, Draw, Away) |
| ↳ `sort_order` | number | Sort order of the odd |
| ↳ `market_description` | string | Description of the market |
| ↳ `probability` | string | Implied probability (e.g. 48.78%) |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds (e.g. 31/15) |
| ↳ `american` | string | American/moneyline odds (e.g. +104) |
| ↳ `winning` | boolean | Whether this is the winning outcome |
| ↳ `stopped` | boolean | Whether the odd is stopped |
| ↳ `total` | string | Total line for over/under markets |
| ↳ `handicap` | string | Handicap line for handicap markets |
| ↳ `participants` | string | Participant ids related to the outcome |
| ↳ `original_label` | string | Original handicap value of the odd (handicap markets) |
#### Get Pre-match Odds by Fixture and Market [#get-pre-match-odds-by-fixture-and-market]
Retrieve pre-match odds for a fixture on a specific market via the Sportmonks Odds API
##### Input [#input-196]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `marketId` | string | Yes | The unique id of the market |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. market;bookmaker) |
| `filters` | string | No | Filters to apply (e.g. bookmakers:2,14 or winningOdds) |
##### Output [#output-196]
| Parameter | Type | Description |
| - | - | - |
| `odds` | array | Array of pre-match odd objects for the fixture and market |
| ↳ `id` | number | Unique id of the odd |
| ↳ `fixture_id` | number | Fixture the odd belongs to |
| ↳ `market_id` | number | Market the odd belongs to |
| ↳ `bookmaker_id` | number | Bookmaker offering the odd |
| ↳ `label` | string | Outcome label (e.g. 1, X, 2) |
| ↳ `value` | string | Decimal odds value |
| ↳ `name` | string | Outcome name (e.g. Home, Draw, Away) |
| ↳ `sort_order` | number | Sort order of the odd |
| ↳ `market_description` | string | Description of the market |
| ↳ `probability` | string | Implied probability (e.g. 48.78%) |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds (e.g. 31/15) |
| ↳ `american` | string | American/moneyline odds (e.g. +104) |
| ↳ `winning` | boolean | Whether this is the winning outcome |
| ↳ `stopped` | boolean | Whether the odd is stopped |
| ↳ `total` | string | Total line for over/under markets |
| ↳ `handicap` | string | Handicap line for handicap markets |
| ↳ `participants` | string | Participant ids related to the outcome |
| ↳ `original_label` | string | Original handicap value of the odd (handicap markets) |
#### Get Premium Odds by Fixture [#get-premium-odds-by-fixture]
Retrieve premium (historical) pre-match odds for a fixture from the Sportmonks Odds API
##### Input [#input-197]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. market;bookmaker) |
| `filters` | string | No | Filters to apply (e.g. markets:1,12 or bookmakers:2,14) |
##### Output [#output-197]
| Parameter | Type | Description |
| - | - | - |
| `premiumOdds` | array | Array of premium odd objects for the fixture |
| ↳ `id` | number | Unique id of the odd |
| ↳ `fixture_id` | number | Fixture the odd belongs to |
| ↳ `market_id` | number | Market the odd belongs to |
| ↳ `bookmaker_id` | number | Bookmaker offering the odd |
| ↳ `label` | string | Outcome label |
| ↳ `value` | string | Decimal odds value |
| ↳ `name` | string | Outcome name |
| ↳ `sort_order` | number | Sort order of the odd |
| ↳ `market_description` | string | Description of the market |
| ↳ `probability` | string | Implied probability (e.g. 29.85%) |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds |
| ↳ `american` | string | American/moneyline odds |
| ↳ `stopped` | boolean | Whether the odd is stopped |
| ↳ `total` | string | Total line for over/under markets |
| ↳ `handicap` | string | Handicap line for handicap markets |
| ↳ `created_at` | string | Timestamp the odd was created (UTC) |
| ↳ `updated_at` | string | Timestamp the odd was last updated (UTC) |
| ↳ `latest_bookmaker_update` | string | Bookmaker's own last-update timestamp (UTC) |
#### Get Premium Odds by Fixture and Bookmaker [#get-premium-odds-by-fixture-and-bookmaker]
Retrieve premium pre-match odds for a fixture from a specific bookmaker via the Sportmonks Odds API
##### Input [#input-198]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `bookmakerId` | string | Yes | The unique id of the bookmaker |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. market;bookmaker) |
| `filters` | string | No | Filters to apply (e.g. markets:1,12) |
##### Output [#output-198]
| Parameter | Type | Description |
| - | - | - |
| `premiumOdds` | array | Array of premium odd objects for the fixture and bookmaker |
| ↳ `id` | number | Unique id of the odd |
| ↳ `fixture_id` | number | Fixture the odd belongs to |
| ↳ `market_id` | number | Market the odd belongs to |
| ↳ `bookmaker_id` | number | Bookmaker offering the odd |
| ↳ `label` | string | Outcome label |
| ↳ `value` | string | Decimal odds value |
| ↳ `name` | string | Outcome name |
| ↳ `sort_order` | number | Sort order of the odd |
| ↳ `market_description` | string | Description of the market |
| ↳ `probability` | string | Implied probability (e.g. 29.85%) |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds |
| ↳ `american` | string | American/moneyline odds |
| ↳ `stopped` | boolean | Whether the odd is stopped |
| ↳ `total` | string | Total line for over/under markets |
| ↳ `handicap` | string | Handicap line for handicap markets |
| ↳ `created_at` | string | Timestamp the odd was created (UTC) |
| ↳ `updated_at` | string | Timestamp the odd was last updated (UTC) |
| ↳ `latest_bookmaker_update` | string | Bookmaker's own last-update timestamp (UTC) |
#### Get Premium Odds by Fixture and Market [#get-premium-odds-by-fixture-and-market]
Retrieve premium pre-match odds for a fixture on a specific market via the Sportmonks Odds API
##### Input [#input-199]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fixtureId` | string | Yes | The unique id of the fixture |
| `marketId` | string | Yes | The unique id of the market |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. market;bookmaker) |
| `filters` | string | No | Filters to apply (e.g. bookmakers:2,14) |
##### Output [#output-199]
| Parameter | Type | Description |
| - | - | - |
| `premiumOdds` | array | Array of premium odd objects for the fixture and market |
| ↳ `id` | number | Unique id of the odd |
| ↳ `fixture_id` | number | Fixture the odd belongs to |
| ↳ `market_id` | number | Market the odd belongs to |
| ↳ `bookmaker_id` | number | Bookmaker offering the odd |
| ↳ `label` | string | Outcome label |
| ↳ `value` | string | Decimal odds value |
| ↳ `name` | string | Outcome name |
| ↳ `sort_order` | number | Sort order of the odd |
| ↳ `market_description` | string | Description of the market |
| ↳ `probability` | string | Implied probability (e.g. 29.85%) |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds |
| ↳ `american` | string | American/moneyline odds |
| ↳ `stopped` | boolean | Whether the odd is stopped |
| ↳ `total` | string | Total line for over/under markets |
| ↳ `handicap` | string | Handicap line for handicap markets |
| ↳ `created_at` | string | Timestamp the odd was created (UTC) |
| ↳ `updated_at` | string | Timestamp the odd was last updated (UTC) |
| ↳ `latest_bookmaker_update` | string | Bookmaker's own last-update timestamp (UTC) |
#### Get Updated Historical Odds Between Time Range [#get-updated-historical-odds-between-time-range]
Retrieve historical (premium) odds updated between two UNIX timestamps (max 5 minutes) from the Sportmonks Odds API
##### Input [#input-200]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fromTimestamp` | string | Yes | Start of the range as a UNIX timestamp (e.g. 1767225600) |
| `toTimestamp` | string | Yes | End of the range as a UNIX timestamp (max 5 minutes after the start) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. odd) |
| `filters` | string | No | Filters to apply (e.g. winningOdds) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-200]
| Parameter | Type | Description |
| - | - | - |
| `historicalOdds` | array | Array of historical premium odd value records updated within the time range |
| ↳ `id` | number | Unique id of the history record |
| ↳ `odd_id` | number | Premium odd this history record belongs to |
| ↳ `value` | string | Historical decimal odds value |
| ↳ `probability` | string | Implied probability at this point in time |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds |
| ↳ `american` | string | American/moneyline odds |
| ↳ `bookmaker_update` | string | Bookmaker's update timestamp for this record (UTC) |
#### Get Updated Premium Odds Between Time Range [#get-updated-premium-odds-between-time-range]
Retrieve premium odds updated between two UNIX timestamps (max 5 minutes) from the Sportmonks Odds API
##### Input [#input-201]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `fromTimestamp` | string | Yes | Start of the range as a UNIX timestamp (e.g. 1767225600) |
| `toTimestamp` | string | Yes | End of the range as a UNIX timestamp (max 5 minutes after the start) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. market;bookmaker) |
| `filters` | string | No | Filters to apply (e.g. markets:1,12 or bookmakers:2,14) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-201]
| Parameter | Type | Description |
| - | - | - |
| `premiumOdds` | array | Array of premium odd objects updated within the time range |
| ↳ `id` | number | Unique id of the odd |
| ↳ `fixture_id` | number | Fixture the odd belongs to |
| ↳ `market_id` | number | Market the odd belongs to |
| ↳ `bookmaker_id` | number | Bookmaker offering the odd |
| ↳ `label` | string | Outcome label |
| ↳ `value` | string | Decimal odds value |
| ↳ `name` | string | Outcome name |
| ↳ `sort_order` | number | Sort order of the odd |
| ↳ `market_description` | string | Description of the market |
| ↳ `probability` | string | Implied probability (e.g. 29.85%) |
| ↳ `dp3` | string | Decimal odds to 3 decimal places |
| ↳ `fractional` | string | Fractional odds |
| ↳ `american` | string | American/moneyline odds |
| ↳ `stopped` | boolean | Whether the odd is stopped |
| ↳ `total` | string | Total line for over/under markets |
| ↳ `handicap` | string | Handicap line for handicap markets |
| ↳ `created_at` | string | Timestamp the odd was created (UTC) |
| ↳ `updated_at` | string | Timestamp the odd was last updated (UTC) |
| ↳ `latest_bookmaker_update` | string | Bookmaker's own last-update timestamp (UTC) |
#### Search Bookmakers [#search-bookmakers]
Search for bookmakers by name from the Sportmonks Odds API
##### Input [#input-202]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The bookmaker name to search for (e.g. bet365) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-202]
| Parameter | Type | Description |
| - | - | - |
| `bookmakers` | array | Array of bookmaker objects matching the search query |
| ↳ `id` | number | Unique id of the bookmaker |
| ↳ `name` | string | Name of the bookmaker |
| ↳ `logo` | string | Logo of the bookmaker |
#### Search Markets [#search-markets]
Search for betting markets by name from the Sportmonks Odds API
##### Input [#input-203]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The market name to search for (e.g. Over/Under) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-203]
| Parameter | Type | Description |
| - | - | - |
| `markets` | array | Array of market objects matching the search query |
| ↳ `id` | number | Unique id of the market |
| ↳ `name` | string | Name of the market |
| ↳ `developer_name` | string | Developer (machine-readable) name of the market |
### Core (Reference) [#actions-sportmonks_core_get_cities]
#### Get Cities [#get-cities]
Retrieve all cities from the Sportmonks Core API
##### Input [#input-204]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. region) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-204]
| Parameter | Type | Description |
| - | - | - |
| `cities` | array | Array of city objects |
| ↳ `id` | number | Unique id of the city |
| ↳ `country_id` | number | Country of the city |
| ↳ `region_id` | number | Region id of the city |
| ↳ `name` | string | Name of the city |
| ↳ `latitude` | string | Latitude of the city |
| ↳ `longitude` | string | Longitude of the city |
| ↳ `geonameid` | number | Official geonameid of the city |
#### Get City by ID [#get-city-by-id]
Retrieve a single city by its ID from the Sportmonks Core API
##### Input [#input-205]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `cityId` | string | Yes | The unique id of the city |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. region) |
##### Output [#output-205]
| Parameter | Type | Description |
| - | - | - |
| `city` | object | The requested city object |
| ↳ `id` | number | Unique id of the city |
| ↳ `country_id` | number | Country of the city |
| ↳ `region_id` | number | Region id of the city |
| ↳ `name` | string | Name of the city |
| ↳ `latitude` | string | Latitude of the city |
| ↳ `longitude` | string | Longitude of the city |
| ↳ `geonameid` | number | Official geonameid of the city |
#### Get Continent by ID [#get-continent-by-id]
Retrieve a single continent by its ID from the Sportmonks Core API
##### Input [#input-206]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `continentId` | string | Yes | The unique id of the continent |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. countries) |
##### Output [#output-206]
| Parameter | Type | Description |
| - | - | - |
| `continent` | object | The requested continent object |
| ↳ `id` | number | Unique id of the continent |
| ↳ `name` | string | Name of the continent |
| ↳ `code` | string | Short code of the continent |
#### Get Continents [#get-continents]
Retrieve all continents from the Sportmonks Core API
##### Input [#input-207]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. countries) |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-207]
| Parameter | Type | Description |
| - | - | - |
| `continents` | array | Array of continent objects |
| ↳ `id` | number | Unique id of the continent |
| ↳ `name` | string | Name of the continent |
| ↳ `code` | string | Short code of the continent |
#### Get Countries [#get-countries]
Retrieve all countries from the Sportmonks Core API
##### Input [#input-208]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. continent;regions) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-208]
| Parameter | Type | Description |
| - | - | - |
| `countries` | array | Array of country objects |
| ↳ `id` | number | Unique id of the country |
| ↳ `continent_id` | number | Continent of the country |
| ↳ `name` | string | Name of the country |
| ↳ `official_name` | string | Official name of the country |
| ↳ `fifa_name` | string | Official FIFA short code name |
| ↳ `iso2` | string | Two letter country code |
| ↳ `iso3` | string | Three letter country code |
| ↳ `latitude` | string | Latitude position of the country |
| ↳ `longitude` | string | Longitude position of the country |
| ↳ `geonameid` | number | Official geonameid |
| ↳ `borders` | array | Neighbouring countries (ISO3 codes) |
| ↳ `image_path` | string | Image path to the country flag |
#### Get Country by ID [#get-country-by-id]
Retrieve a single country by its ID from the Sportmonks Core API
##### Input [#input-209]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `countryId` | string | Yes | The unique id of the country |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. continent;regions) |
##### Output [#output-209]
| Parameter | Type | Description |
| - | - | - |
| `country` | object | The requested country object |
| ↳ `id` | number | Unique id of the country |
| ↳ `continent_id` | number | Continent of the country |
| ↳ `name` | string | Name of the country |
| ↳ `official_name` | string | Official name of the country |
| ↳ `fifa_name` | string | Official FIFA short code name |
| ↳ `iso2` | string | Two letter country code |
| ↳ `iso3` | string | Three letter country code |
| ↳ `latitude` | string | Latitude position of the country |
| ↳ `longitude` | string | Longitude position of the country |
| ↳ `geonameid` | number | Official geonameid |
| ↳ `borders` | array | Neighbouring countries (ISO3 codes) |
| ↳ `image_path` | string | Image path to the country flag |
#### Get All Entity Filters [#get-all-entity-filters]
Retrieve all available filters grouped per entity from the Sportmonks Core API
##### Input [#input-210]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
##### Output [#output-210]
| Parameter | Type | Description |
| - | - | - |
| `entityFilters` | json | Map of entity name to its available filter names, e.g. \{fixture: \["fixtureLeagues", "fixtureSeasons"], event: \["eventTypes"]} |
#### Get My Usage [#get-my-usage]
Retrieve your Sportmonks API usage aggregated per 5 minutes
##### Input [#input-211]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-211]
| Parameter | Type | Description |
| - | - | - |
| `usage` | array | Array of API usage records aggregated per 5-minute period |
| ↳ `id` | number | Identifier of the usage record |
| ↳ `endpoint` | string | Identifier of the requested endpoint |
| ↳ `count` | number | Total calls for the given timeframe |
| ↳ `entity` | string | The entity the rate limit applies on |
| ↳ `remaining_requests` | number | Amount of requests remaining for the entity in the hourly rate limit |
| ↳ `period_start` | number | Timestamp representing the aggregation start time |
| ↳ `period_end` | number | Timestamp representing the aggregation end time |
#### Get Region by ID [#get-region-by-id]
Retrieve a single region by its ID from the Sportmonks Core API
##### Input [#input-212]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `regionId` | string | Yes | The unique id of the region |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;cities) |
##### Output [#output-212]
| Parameter | Type | Description |
| - | - | - |
| `region` | object | The requested region object |
| ↳ `id` | number | Unique id of the region |
| ↳ `country_id` | number | Country of the region |
| ↳ `name` | string | Name of the region |
#### Get Regions [#get-regions]
Retrieve all regions from the Sportmonks Core API
##### Input [#input-213]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;cities) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-213]
| Parameter | Type | Description |
| - | - | - |
| `regions` | array | Array of region objects |
| ↳ `id` | number | Unique id of the region |
| ↳ `country_id` | number | Country of the region |
| ↳ `name` | string | Name of the region |
#### Get Timezones [#get-timezones]
Retrieve all supported time zones (IANA names) from the Sportmonks Core API
##### Input [#input-214]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
##### Output [#output-214]
| Parameter | Type | Description |
| - | - | - |
| `timezones` | array | Array of supported IANA time zone names (e.g. Europe/London) |
#### Get Type by ID [#get-type-by-id]
Retrieve a single type by its ID from the Sportmonks Core API
##### Input [#input-215]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `typeId` | string | Yes | The unique id of the type |
##### Output [#output-215]
| Parameter | Type | Description |
| - | - | - |
| `type` | object | The requested type object |
| ↳ `id` | number | Unique id of the type |
| ↳ `parent_id` | number | Parent type of the type |
| ↳ `name` | string | Name of the type |
| ↳ `code` | string | Code of the type |
| ↳ `developer_name` | string | Developer name of the type |
| ↳ `group` | string | Group the type falls under |
| ↳ `description` | string | Description of the type |
#### Get Type by Entity [#get-type-by-entity]
Retrieve the available types grouped per entity from the Sportmonks Core API
##### Input [#input-216]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
##### Output [#output-216]
| Parameter | Type | Description |
| - | - | - |
| `typesByEntity` | json | Map of entity name to its available types, e.g. \{CoachStatisticDetail: \{updated\_at, types: \[\{id, name, code, developer\_name, model\_type, stat\_group}]}} |
#### Get Types [#get-types]
Retrieve all types (reference data describing events, statistics, positions, etc.) from the Sportmonks Core API
##### Input [#input-217]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-217]
| Parameter | Type | Description |
| - | - | - |
| `types` | array | Array of type objects |
| ↳ `id` | number | Unique id of the type |
| ↳ `parent_id` | number | Parent type of the type |
| ↳ `name` | string | Name of the type |
| ↳ `code` | string | Code of the type |
| ↳ `developer_name` | string | Developer name of the type |
| ↳ `group` | string | Group the type falls under |
| ↳ `description` | string | Description of the type |
#### Search Cities [#search-cities]
Search for cities by name from the Sportmonks Core API
##### Input [#input-218]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The city name to search for (e.g. London) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. region) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-218]
| Parameter | Type | Description |
| - | - | - |
| `cities` | array | Array of city objects matching the search query |
| ↳ `id` | number | Unique id of the city |
| ↳ `country_id` | number | Country of the city |
| ↳ `region_id` | number | Region id of the city |
| ↳ `name` | string | Name of the city |
| ↳ `latitude` | string | Latitude of the city |
| ↳ `longitude` | string | Longitude of the city |
| ↳ `geonameid` | number | Official geonameid of the city |
#### Search Countries [#search-countries]
Search for countries by name from the Sportmonks Core API
##### Input [#input-219]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The country name to search for (e.g. Brazil) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. continent;regions) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-219]
| Parameter | Type | Description |
| - | - | - |
| `countries` | array | Array of country objects matching the search query |
| ↳ `id` | number | Unique id of the country |
| ↳ `continent_id` | number | Continent of the country |
| ↳ `name` | string | Name of the country |
| ↳ `official_name` | string | Official name of the country |
| ↳ `fifa_name` | string | Official FIFA short code name |
| ↳ `iso2` | string | Two letter country code |
| ↳ `iso3` | string | Three letter country code |
| ↳ `latitude` | string | Latitude position of the country |
| ↳ `longitude` | string | Longitude position of the country |
| ↳ `geonameid` | number | Official geonameid |
| ↳ `borders` | array | Neighbouring countries (ISO3 codes) |
| ↳ `image_path` | string | Image path to the country flag |
#### Search Regions [#search-regions]
Search for regions by name from the Sportmonks Core API
##### Input [#input-220]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Sportmonks API token |
| `query` | string | Yes | The region name to search for (e.g. Utrecht) |
| `include` | string | No | Semicolon-separated relations to enrich the response (e.g. country;cities) |
| `filters` | string | No | Filters to apply |
| `per_page` | string | No | Number of results per page (max 50, default 25) |
| `page` | string | No | Page number to retrieve |
| `order` | string | No | Order direction (asc or desc) |
##### Output [#output-220]
| Parameter | Type | Description |
| - | - | - |
| `regions` | array | Array of region objects matching the search query |
| ↳ `id` | number | Unique id of the region |
| ↳ `country_id` | number | Country of the region |
| ↳ `name` | string | Name of the region |