sportmonks_py package

Subpackages

Submodules

sportmonks_py.api_client module

sportmonks_py.base_client module

sportmonks_py.core module

class sportmonks_py.core.CoreClient(base_url: str, api_token: str)[source]

Bases: BaseClient

A client for accessing common endpoints data from the SportMonks API.

get_all_cities(async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all available filters for the entities. :param async_mode: Whether to use async mode. :param locale: Locale to use for the response. :param order: Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_all_continents(async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all available filters for the entities. :param async_mode: Whether to use async mode. :param locale: Locale to use for the response. :param order: Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_all_countries(async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all available filters for the entities. :param async_mode: Whether to use async mode. :param locale: Locale to use for the response. :param order: Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_all_regions(async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all available filters for the entities. :param async_mode: Whether to use async mode. :param locale: Locale to use for the response. :param order: Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_all_types(async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all available filters for the entities. :param async_mode: Whether to use async mode. :param locale: Locale to use for the response. :param order: Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_city_by_id(city_id: int, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns a city by its ID.

Parameters:

  • city_id – ID of the city.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_continent_by_id(continent_id: int, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns a continent by its ID.

Parameters:

  • continent_id – ID of the continent.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_country_by_id(country_id: int, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns a country by its ID.

Parameters:

  • country_id – ID of the country.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_region_by_id(region_id: int, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns a region by its ID.

Parameters:

  • region_id – ID of the region.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_type_by_id(type_id: int, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns a type by its ID.

Parameters:

  • type_id – ID of the type.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

search_cities(search: str, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all available filters for the entities. :param search: Search string to search for. :param async_mode: Whether to use async mode. :param locale: Locale to use for the response. :param order: Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

search_countries(search: str, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all available filters for the entities. :param search: string to search for. :param async_mode: Whether to use async mode. :param locale: Locale to use for the response. :param order: Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

search_regions(search: str, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all available filters for the entities. :param search: string to search for. :param async_mode: Whether to use async mode. :param locale: Locale to use for the response. :param order: Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

sportmonks_py.fixture module

class sportmonks_py.fixture.FixturesClient(base_url: str, api_token: str)[source]

Bases: BaseClient

A client for accessing fixture-related data from the SportMonks API.

get_all_fixtures(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve all fixtures from the SportMonks database.

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Language to return the data in.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_all_livescores(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns the fixtures 15 minutes before the game starts. It will also disappear 15 minutes after the game is finished.

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Language to return the data in.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_fixtures(fixture_ids: List[int], includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve specific fixtures by their IDs.

Parameters:

  • fixture_ids – List of fixture IDs to retrieve.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Language to return the data in.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:
get_fixtures_by_date(date1: str, date2: str | None = None, team_id: int | None = None, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve fixtures for a specific date or date range.

Parameters:

  • date1 – Start date in ‘YYYY-MM-DD’ format.

  • date2 – End date in ‘YYYY-MM-DD’ format (optional).

  • team_id – Filter by a specific team ID (optional).

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Language to return the data in.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

  • InvalidDateFormat – If a date is in an invalid format.

  • ValueError – If the start date is after the end date.

get_fixtures_by_market(market_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve upcoming fixtures for a specific market.

Parameters:

  • market_id – Market ID.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Language to return the data in.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_fixtures_by_station(station_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve upcoming fixtures for a specific TV station.

Parameters:

  • station_id – TV station ID.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Language to return the data in.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_fixtures_by_updates(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve fixtures updated within the last 10 seconds.

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Language to return the data in.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_h2h(team1: int, team2: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve head-to-head fixtures for two teams.

Parameters:

  • team1 – First team ID.

  • team2 – Second team ID.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Language to return the data in.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

ValueError – If team IDs are not positive integers.

get_inplay_livescores(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

GET All Inplay Livescores: returns all the inplay fixtures.

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Language to return the data in.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_livescore_updates(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns you all livescores that have received updates within 10 seconds.

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Language to return the data in.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

search_fixtures(search: int | str, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Search fixtures by string or int.

Parameters:

  • search – String or ID to search.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Language to return the data in.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

sportmonks_py.leagues module

class sportmonks_py.leagues.LeaguesClient(base_url: str, api_token: str)[source]

Bases: BaseClient

A client for accessing league-related data from the SportMonks API.

get_all_leagues(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns all the leagues available within your subscription

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_all_leagues_by_team(team_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns all the current and historical leagues from your requested team id.

Parameters:

  • team_id – Team ID to search.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_all_rounds(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns all the rounds available within your subscription.

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_all_seasons(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns all the seasons available within your subscription

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_all_stages(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns all stages available within your subscription

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_current_leagues_by_team(team_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns all the current leagues of your requested team id.

Parameters:

  • team_id – Team ID to search.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_league(league_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns the league you’ve requested by ID.

Parameters:

  • league_id – Int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

ValueError – If no fixture IDs are provided.

get_league_by_fixture_date(date: str, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns all the leagues with fixtures from your requested fixture date.

Parameters:

  • date – Date in ‘YYYY-MM-DD’ format.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

InvalidDateFormat – If a date is in an invalid format.

get_leagues_by_country_id(country_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns all the leagues with fixtures from your requested fixture date.

Parameters:

  • country_id – Int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

InvalidDateFormat – If a date is in an invalid format.

get_live_leagues(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns all the leagues that with fixtures that are currently being played.

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_round(round_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns round information from your requested round ID.

Parameters:

  • round_id – Int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_round_by_season_id(season_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns round information from your requested round ID.

Parameters:

  • season_id – Int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_season(season_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns the league you’ve requested by ID.

Parameters:

  • season_id – Int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

ValueError – If no fixture IDs are provided.

get_season_by_team_id(team_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns seasons by team ID.

Parameters:

  • team_id – Int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

InvalidDateFormat – If a date is in an invalid format.

get_stage_by_id(stage_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns stage information from your requested stage ID.

Parameters:

  • stage_id – Int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

InvalidDateFormat – If a date is in an invalid format.

get_stages_by_season_id(season_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns stage information from your requested stage ID.

Parameters:

  • season_id – Int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

InvalidDateFormat – If a date is in an invalid format.

search_leagues(search: int | str, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns all the leagues that match your search.

Parameters:

  • search – String or ID to search.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

search_rounds(search: int | str, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns all stages that matches your search

Parameters:

  • search – String or ID to search.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

search_seasons(search: int | str, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns all the seasons that match your search.

Parameters:

  • search – String or ID to search.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

search_stages(search: int | str, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns all stages that matches your search.

Parameters:

  • search – String or ID to search.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Boolean flag for asynchronous mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

sportmonks_py.misc module

class sportmonks_py.misc.OtherClient(base_url: str, api_token: str)[source]

Bases: BaseClient

A client for accessing fixture-related data from the SportMonks API.

get_commentaries(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns a textual representation of commentaries

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_fixture_commentary(fixture_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

RReturns a textual representation from the requested fixture ID.

Parameters:

  • fixture_id – int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

ValueError – If fixture_id is not provided.

get_postmatch_news(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all the available post-match news articles within your subscription.

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_postmatch_news_by_season(season_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all post-match news articles from your requested season ID.

Parameters:

  • season_id – ID to retrieve.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

ValueError – If season_id is not provided.

get_prematch_news(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all the available pre-match news articles within your subscription

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_prematch_news_by_season(season_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all pre-match news articles from your requested season ID.

Parameters:

  • season_id – ID to retrieve.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

ValueError – If season_id is not provided.

get_rivals(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all the teams within your subscription with the rivals information (if available).

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

Returns:

StdResponse | AsyncResponse

get_team_rivals(team_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns the rivals of your requested team ID (if available).

Parameters:

  • team_id – Int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

ValueError – If team_id is not provided.

get_upcoming_prematch_news(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all pre-match news articles for the upcoming fixtures within your subscription.

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

Returns:

StdResponse | AsyncResponse

sportmonks_py.my module

class sportmonks_py.my.MyClient(base_url: str, api_token: str)[source]

Bases: BaseClient

A client for accessing common endpoints data from the SportMonks API.

enrichments(async_mode: bool = False, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all available enrichments for the entities. :param async_mode: Whether to use async mode. :param order: Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

leagues(async_mode: bool = False, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all available leagues for the entities. :param async_mode: Whether to use async mode. :param order: Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

resources(async_mode: bool = False, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all available resources for the entities. :param async_mode: Whether to use async mode. :param order: Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

sportmonks_py.odds module

class sportmonks_py.odds.OddsClient(base_url: str, api_token: str)[source]

Bases: BaseClient

A client for accessing odds-related data from the SportMonks API.

get_all_inplay_odds(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve all available in-play odds.

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_all_prematch_odds(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve all available pre-match odds.

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_fixture_inplay_odds(fixture_id: int, bookmaker_id: int | None = None, market_id: int | None = None, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve in-play odds for a specific fixture. Optionally filter by bookmaker or market.

Parameters:

  • fixture_id – ID of the fixture.

  • bookmaker_id – (Optional) ID of the bookmaker.

  • market_id – (Optional) ID of the market.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_fixture_prematch_odds(fixture_id: int, bookmaker_id: int | None = None, market_id: int | None = None, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve pre-match odds for a specific fixture. Optionally filter by bookmaker or market.

Parameters:

  • fixture_id – ID of the fixture.

  • bookmaker_id – (Optional) ID of the bookmaker.

  • market_id – (Optional) ID of the market.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_latest_inplay_odds(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve in-play odds for fixtures updated within the last 10 seconds.

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_latest_prematch_odds(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve pre-match odds for fixtures updated within the last 10 seconds.

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_premium_fixture_prematch_odds(fixture_id: int, bookmaker_id: int | None = None, market_id: int | None = None, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve pre-match odds for a specific fixture from the Premium feed. Optionally filter by bookmaker or market.

For more information about the Premium feed, visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed

Parameters:

  • fixture_id – ID of the fixture.

  • bookmaker_id – (Optional) ID of the bookmaker.

  • market_id – (Optional) ID of the market.

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

sportmonks_py.standings module

class sportmonks_py.standings.StandingsClient(base_url: str, api_token: str)[source]

Bases: BaseClient

A client for accessing standings-related data from the SportMonks API.

get_all_standings(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns all standings

Parameters:

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_live_standings_by_league(league_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns the LIVE league standing table from your requested league ID.

Parameters:

  • league_id – Int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

ValueError – If league_id is not provided.

get_season_standings(season_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns the full league standing table from your requested season ID.

Parameters:

  • season_id – Int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

ValueError – If season_id is not provided.

get_standings_by_round(round_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns the full league standing table from your requested round ID.

Parameters:

  • round_id – Int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

ValueError – If round_id is not provided.

get_standings_corrections(season_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Returns the standing corrections from your requested season ID.

Parameters:

  • season_id – Int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

Returns:

StdResponse | AsyncResponse

Raises:

ValueError – If season_id is not provided.

get_topscorers_by_season(season_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all the topscorers per stage of the requested season

Parameters:

  • season_id – Int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

ValueError – If season_id is not provided.

get_topscorers_by_stage(stage_id: int, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

This endpoint returns all the topscorers from your requested stage ID.

Parameters:

  • stage_id – Int

  • includes – Objects to include in the response.

  • selects – Fields to include or exclude in the response.

  • filters – Filters to apply to the results.

  • async_mode – Whether to use async mode.

  • locale – Locale to use for the response.

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Raises:

ValueError – If stage_id is not provided.

sportmonks_py.statistics module

sportmonks_py.teams module

class sportmonks_py.teams.TeamsClient(base_url: str, api_token: str)[source]

Bases: BaseClient

Client for accessing team, player, coach, squad, and referee data via the SportMonks API.

get_coaches(coach_id: int | None = None, country_id: int | None = None, search: str | None = None, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve coach information based on various criteria.

Parameters:

  • coach_id – ID of the coach (optional).

  • country_id – ID of the country to filter coaches by (optional).

  • search – Search string for coach names (optional).

  • includes – Objects to include in the response (optional).

  • selects – Fields to include or exclude in the response (optional).

  • filters – Filters to apply to the results (optional).

  • async_mode – Whether to use async mode.

  • locale – Language to use for the response (optional).

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_coaches_latest(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve all coaches updated within the last two hours.

Parameters:

  • includes – Objects to include in the response (optional).

  • selects – Fields to include or exclude in the response (optional).

  • filters – Filters to apply to the results (optional).

  • async_mode – Whether to use async mode.

  • locale – Language to use for the response (optional).

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_players(player_id: int | None = None, country_id: int | None = None, search: str | None = None, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve player information based on various criteria.

Parameters:

  • player_id – ID of the player (optional).

  • country_id – ID of the country to filter players by (optional).

  • search – Search string for player names (optional).

  • includes – Objects to include in the response (optional).

  • selects – Fields to include or exclude in the response (optional).

  • filters – Filters to apply to the results (optional).

  • async_mode – Whether to use async mode.

  • locale – Language to use for the response (optional).

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_players_latest(includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve all players updated within the last two hours.

Parameters:

  • includes – Objects to include in the response (optional).

  • selects – Fields to include or exclude in the response (optional).

  • filters – Filters to apply to the results (optional).

  • async_mode – Whether to use async mode.

  • locale – Language to use for the response (optional).

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_referee(referee_id: int | None = None, country_id: int | None = None, season_id: int | None = None, search: str | None = None, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve referee information based on various criteria.

Parameters:

  • referee_id – ID of the referee (optional).

  • country_id – ID of the country to filter referees by (optional).

  • season_id – ID of the season to filter referees by (optional).

  • search – Search string for referee names (optional).

  • includes – Objects to include in the response (optional).

  • selects – Fields to include or exclude in the response (optional).

  • filters – Filters to apply to the results (optional).

  • async_mode – Whether to use async mode.

  • locale – Language to use for the response (optional).

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_team_squad(team_id: int, season_id: int | None = None, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve a team’s squad for a specific season.

Parameters:

  • team_id – ID of the team.

  • season_id – ID of the season (optional).

  • includes – Objects to include in the response (optional).

  • selects – Fields to include or exclude in the response (optional).

  • filters – Filters to apply to the results (optional).

  • async_mode – Whether to use async mode.

  • locale – Language to use for the response (optional).

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_teams(team_id: int | None = None, country_id: int | None = None, season_id: int | None = None, search: str | None = None, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve team information based on various criteria.

Parameters:

  • team_id – ID of the team (optional).

  • country_id – ID of the country to filter teams by (optional).

  • season_id – ID of the season to filter teams by (optional).

  • search – Search string for team names (optional).

  • includes – Objects to include in the response (optional).

  • selects – Fields to include or exclude in the response (optional).

  • filters – Filters to apply to the results (optional).

  • async_mode – Whether to use async mode.

  • locale – Language to use for the response (optional).

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

get_venues(venue_id: int | None = None, country_id: int | None = None, season_id: int | None = None, search: str | None = None, includes: List[str] | None = None, selects: dict[str | Any] | None = None, filters: dict[str | Any] | None = None, async_mode: bool = False, locale: str | None = None, order: Literal['asc', 'desc'] | None = None) → Iterable[Iterator[dict[str, Any]]] | AsyncIterator[Iterator[dict[str, Any]]][source]

Retrieve venue information based on various criteria.

Parameters:

  • venue – ID of the venue (optional).

  • season_id – ID of the season to filter venue by (optional).

  • search – Search string for venue names (optional).

  • includes – Objects to include in the response (optional).

  • selects – Fields to include or exclude in the response (optional).

  • filters – Filters to apply to the results (optional).

  • async_mode – Whether to use async mode.

  • locale – Language to use for the response (optional).

  • order – Order to sort the results in (asc or desc).

Returns:

StdResponse | AsyncResponse

Module contents