# Table of Contents - [SportMonks-Py documentation — SportMonks-Py v0.0.3 documentation](#sportmonks-py-documentation-sportmonks-py-v0-0-3-documentation) - [SportMonks-Py documentation — SportMonks-Py v0.0.3 documentation](#sportmonks-py-documentation-sportmonks-py-v0-0-3-documentation) - [Unknown](#unknown) - [src — SportMonks-Py v0.0.3 documentation](#src-sportmonks-py-v0-0-3-documentation) - [utils package — SportMonks-Py v0.0.3 documentation](#utils-package-sportmonks-py-v0-0-3-documentation) - [Unknown](#unknown) - [utils package — SportMonks-Py v0.0.3 documentation](#utils-package-sportmonks-py-v0-0-3-documentation) - [sportmonks_py.utils package — SportMonks-Py v0.0.3 documentation](#sportmonks-py-utils-package-sportmonks-py-v0-0-3-documentation) - [src — SportMonks-Py v0.0.3 documentation](#src-sportmonks-py-v0-0-3-documentation) - [sportmonks_py package — SportMonks-Py v0.0.3 documentation](#sportmonks-py-package-sportmonks-py-v0-0-3-documentation) - [sportmonks_py package — SportMonks-Py v0.0.3 documentation](#sportmonks-py-package-sportmonks-py-v0-0-3-documentation) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [Unknown](#unknown) - [sportmonks_py.utils package — SportMonks-Py v0.0.3 documentation](#sportmonks-py-utils-package-sportmonks-py-v0-0-3-documentation) - [Unknown](#unknown) --- # SportMonks-Py documentation — SportMonks-Py v0.0.3 documentation * [](https://sportmonks-py.readthedocs.io/en/stable/#) * SportMonks-Py documentation * [View page source](https://sportmonks-py.readthedocs.io/en/stable/_sources/index.rst.txt) * * * SportMonks-Py documentation[](https://sportmonks-py.readthedocs.io/en/stable/#sportmonks-py-documentation "Link to this heading") =================================================================================================================================== Add your content using `reStructuredText` syntax. See the [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html) documentation for details. Contents: * [sportmonks\_py package](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html) * [Subpackages](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#subpackages) * [Submodules](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#submodules) * [sportmonks\_py.api\_client module](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks-py-api-client-module) * [sportmonks\_py.base\_client module](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks-py-base-client-module) * [sportmonks\_py.core module](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.core) * [sportmonks\_py.fixture module](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.fixture) * [sportmonks\_py.leagues module](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.leagues) * [sportmonks\_py.misc module](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.misc) * [sportmonks\_py.my module](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.my) * [sportmonks\_py.odds module](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.odds) * [sportmonks\_py.standings module](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.standings) * [sportmonks\_py.statistics module](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.statistics) * [sportmonks\_py.teams module](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.teams) * [Module contents](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py) * [src](https://sportmonks-py.readthedocs.io/en/stable/modules.html) * [utils package](https://sportmonks-py.readthedocs.io/en/stable/utils.html) * [Submodules](https://sportmonks-py.readthedocs.io/en/stable/utils.html#submodules) * [utils.common\_types module](https://sportmonks-py.readthedocs.io/en/stable/utils.html#module-utils.common_types) * [utils.config module](https://sportmonks-py.readthedocs.io/en/stable/utils.html#module-utils.config) * [utils.errors module](https://sportmonks-py.readthedocs.io/en/stable/utils.html#module-utils.errors) * [utils.helper module](https://sportmonks-py.readthedocs.io/en/stable/utils.html#module-utils.helper) * [Module contents](https://sportmonks-py.readthedocs.io/en/stable/utils.html#module-utils) --- # SportMonks-Py documentation — SportMonks-Py v0.0.3 documentation * [](https://sportmonks-py.readthedocs.io/en/latest/#) * SportMonks-Py documentation * [View page source](https://sportmonks-py.readthedocs.io/en/latest/_sources/index.rst.txt) * * * SportMonks-Py documentation[](https://sportmonks-py.readthedocs.io/en/latest/#sportmonks-py-documentation "Link to this heading") =================================================================================================================================== Add your content using `reStructuredText` syntax. See the [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html) documentation for details. Contents: * [sportmonks\_py package](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html) * [Subpackages](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#subpackages) * [Submodules](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#submodules) * [sportmonks\_py.api\_client module](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks-py-api-client-module) * [sportmonks\_py.base\_client module](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks-py-base-client-module) * [sportmonks\_py.core module](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.core) * [sportmonks\_py.fixture module](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.fixture) * [sportmonks\_py.leagues module](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.leagues) * [sportmonks\_py.misc module](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.misc) * [sportmonks\_py.my module](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.my) * [sportmonks\_py.odds module](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.odds) * [sportmonks\_py.standings module](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.standings) * [sportmonks\_py.statistics module](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.statistics) * [sportmonks\_py.teams module](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.teams) * [Module contents](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py) * [src](https://sportmonks-py.readthedocs.io/en/latest/modules.html) * [utils package](https://sportmonks-py.readthedocs.io/en/latest/utils.html) * [Submodules](https://sportmonks-py.readthedocs.io/en/latest/utils.html#submodules) * [utils.common\_types module](https://sportmonks-py.readthedocs.io/en/latest/utils.html#module-utils.common_types) * [utils.config module](https://sportmonks-py.readthedocs.io/en/latest/utils.html#module-utils.config) * [utils.errors module](https://sportmonks-py.readthedocs.io/en/latest/utils.html#module-utils.errors) * [utils.helper module](https://sportmonks-py.readthedocs.io/en/latest/utils.html#module-utils.helper) * [Module contents](https://sportmonks-py.readthedocs.io/en/latest/utils.html#module-utils) --- # Unknown .. SportMonks-Py documentation master file, created by sphinx-quickstart on Sun Dec 15 12:23:24 2024. You can adapt this file completely to your liking, but it should at least contain the root \`toctree\` directive. SportMonks-Py documentation =========================== Add your content using \`\`reStructuredText\`\` syntax. See the \`reStructuredText \`\_ documentation for details. .. toctree:: :maxdepth: 2 :caption: Contents: sportmonks\_py modules utils --- # src — SportMonks-Py v0.0.3 documentation * [](https://sportmonks-py.readthedocs.io/en/stable/index.html) * src * [View page source](https://sportmonks-py.readthedocs.io/en/stable/_sources/modules.rst.txt) * * * src[](https://sportmonks-py.readthedocs.io/en/stable/modules.html#src "Link to this heading") =============================================================================================== --- # utils package — SportMonks-Py v0.0.3 documentation * [](https://sportmonks-py.readthedocs.io/en/stable/index.html) * utils package * [View page source](https://sportmonks-py.readthedocs.io/en/stable/_sources/utils.rst.txt) * * * utils package[](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils-package "Link to this heading") ================================================================================================================= Submodules[](https://sportmonks-py.readthedocs.io/en/stable/utils.html#submodules "Link to this heading") ----------------------------------------------------------------------------------------------------------- utils.common\_types module[](https://sportmonks-py.readthedocs.io/en/stable/utils.html#module-utils.common_types "Link to this heading") ------------------------------------------------------------------------------------------------------------------------------------------ Types used for clearer documentation and type hinting utils.config module[](https://sportmonks-py.readthedocs.io/en/stable/utils.html#module-utils.config "Link to this heading") ----------------------------------------------------------------------------------------------------------------------------- _class_ utils.config.Config[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/config.html#Config) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.config.Config "Link to this definition") Bases: `object` BASE\_URL _\= 'https://api.sportmonks.com/v3/'_[](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.config.Config.BASE_URL "Link to this definition") utils.errors module[](https://sportmonks-py.readthedocs.io/en/stable/utils.html#module-utils.errors "Link to this heading") ----------------------------------------------------------------------------------------------------------------------------- _exception_ utils.errors.ApiTokenMissingError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/errors.html#ApiTokenMissingError) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.errors.ApiTokenMissingError "Link to this definition") Bases: `Exception` Raised when API key is not provided. _exception_ utils.errors.BadRequestsError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/errors.html#BadRequestsError) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.errors.BadRequestsError "Link to this definition") Bases: `Exception` Raised when a bad request is made _exception_ utils.errors.BaseUrlMissingError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/errors.html#BaseUrlMissingError) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.errors.BaseUrlMissingError "Link to this definition") Bases: `Exception` Raised when base url is not provided. _exception_ utils.errors.ForbiddenError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/errors.html#ForbiddenError) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.errors.ForbiddenError "Link to this definition") Bases: `Exception` Raised when a forbidden request is made _exception_ utils.errors.IncompatibleDictionarySchema[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/errors.html#IncompatibleDictionarySchema) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.errors.IncompatibleDictionarySchema "Link to this definition") Bases: `Exception` Raised when a dictionary cannot be unnested. _exception_ utils.errors.InternalServerError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/errors.html#InternalServerError) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.errors.InternalServerError "Link to this definition") Bases: `Exception` Raised when an internal server error occurs _exception_ utils.errors.InvalidDateFormat[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/errors.html#InvalidDateFormat) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.errors.InvalidDateFormat "Link to this definition") Bases: `Exception` Raised when the date provided is in an incorrect or unsupported format _exception_ utils.errors.InvalidIncludes[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/errors.html#InvalidIncludes) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.errors.InvalidIncludes "Link to this definition") Bases: `Exception` Raised when an invalid object is passed as an includes argument _exception_ utils.errors.InvalidTimezoneError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/errors.html#InvalidTimezoneError) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.errors.InvalidTimezoneError "Link to this definition") Bases: `Exception` Raised when an unrecognized or invalid timezone is provided _exception_ utils.errors.MalformedResponseError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/errors.html#MalformedResponseError) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.errors.MalformedResponseError "Link to this definition") Bases: `Exception` Raised when the response from the API does not contain ‘data’. _exception_ utils.errors.ParameterException[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/errors.html#ParameterException) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.errors.ParameterException "Link to this definition") Bases: `Exception` Raised when an incorrect parameter type is provided _exception_ utils.errors.ParameterLengthException[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/errors.html#ParameterLengthException) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.errors.ParameterLengthException "Link to this definition") Bases: `Exception` Raised when the number of parameters requested in a single API call exceeds the allow amount _exception_ utils.errors.SportMonksAPIError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/errors.html#SportMonksAPIError) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.errors.SportMonksAPIError "Link to this definition") Bases: `Exception` Raised when SportMonks returns an API error. _exception_ utils.errors.TooManyRequestsError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/errors.html#TooManyRequestsError) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.errors.TooManyRequestsError "Link to this definition") Bases: `Exception` Raised when too many requests are made _exception_ utils.errors.UnauthorizedError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/errors.html#UnauthorizedError) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.errors.UnauthorizedError "Link to this definition") Bases: `Exception` Raised when an unauthorized request is made utils.helper module[](https://sportmonks-py.readthedocs.io/en/stable/utils.html#module-utils.helper "Link to this heading") ----------------------------------------------------------------------------------------------------------------------------- utils.helper.validate\_date\_format(_date\_str: str_) → bool[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/helper.html#validate_date_format) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.helper.validate_date_format "Link to this definition") Validates if the provided date is in the format ‘YYYY-mm-dd’ that SportMonks requires. Args: date\_str (str): The date string to validate. Returns: bool: True if the date is valid and in the correct format, False otherwise. utils.helper.validate\_date\_order(_date1: str_, _date2: str_) → bool[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/helper.html#validate_date_order) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.helper.validate_date_order "Link to this definition") Validates if the first date is not after the second date. A range of more than 100 days is also invalid. Args: date1 (str): The first date in ‘YYYY-mm-dd’ format. date2 (str): The second date in ‘YYYY-mm-dd’ format. Returns: bool: True if date1 <= date2, False if not, False if the range exeeds 100 days. utils.helper.validate\_positive\_id(_value: int_, _name: str_) → None[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/utils/helper.html#validate_positive_id) [](https://sportmonks-py.readthedocs.io/en/stable/utils.html#utils.helper.validate_positive_id "Link to this definition") Validates that a given value is a positive integer. Parameters: * **value** – The value to validate. * **name** – The parameter name for error messages. Module contents[](https://sportmonks-py.readthedocs.io/en/stable/utils.html#module-utils "Link to this heading") ------------------------------------------------------------------------------------------------------------------ Core endpoints common to all sports within SportMonks included in all subscriptions --- # Unknown .. SportMonks-Py documentation master file, created by sphinx-quickstart on Sun Dec 15 12:23:24 2024. You can adapt this file completely to your liking, but it should at least contain the root \`toctree\` directive. SportMonks-Py documentation =========================== Add your content using \`\`reStructuredText\`\` syntax. See the \`reStructuredText \`\_ documentation for details. .. toctree:: :maxdepth: 2 :caption: Contents: sportmonks\_py modules utils --- # utils package — SportMonks-Py v0.0.3 documentation * [](https://sportmonks-py.readthedocs.io/en/latest/index.html) * utils package * [View page source](https://sportmonks-py.readthedocs.io/en/latest/_sources/utils.rst.txt) * * * utils package[](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils-package "Link to this heading") ================================================================================================================= Submodules[](https://sportmonks-py.readthedocs.io/en/latest/utils.html#submodules "Link to this heading") ----------------------------------------------------------------------------------------------------------- utils.common\_types module[](https://sportmonks-py.readthedocs.io/en/latest/utils.html#module-utils.common_types "Link to this heading") ------------------------------------------------------------------------------------------------------------------------------------------ Types used for clearer documentation and type hinting utils.config module[](https://sportmonks-py.readthedocs.io/en/latest/utils.html#module-utils.config "Link to this heading") ----------------------------------------------------------------------------------------------------------------------------- _class_ utils.config.Config[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/config.html#Config) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.config.Config "Link to this definition") Bases: `object` BASE\_URL _\= 'https://api.sportmonks.com/v3/'_[](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.config.Config.BASE_URL "Link to this definition") utils.errors module[](https://sportmonks-py.readthedocs.io/en/latest/utils.html#module-utils.errors "Link to this heading") ----------------------------------------------------------------------------------------------------------------------------- _exception_ utils.errors.ApiTokenMissingError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/errors.html#ApiTokenMissingError) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.errors.ApiTokenMissingError "Link to this definition") Bases: `Exception` Raised when API key is not provided. _exception_ utils.errors.BadRequestsError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/errors.html#BadRequestsError) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.errors.BadRequestsError "Link to this definition") Bases: `Exception` Raised when a bad request is made _exception_ utils.errors.BaseUrlMissingError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/errors.html#BaseUrlMissingError) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.errors.BaseUrlMissingError "Link to this definition") Bases: `Exception` Raised when base url is not provided. _exception_ utils.errors.ForbiddenError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/errors.html#ForbiddenError) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.errors.ForbiddenError "Link to this definition") Bases: `Exception` Raised when a forbidden request is made _exception_ utils.errors.IncompatibleDictionarySchema[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/errors.html#IncompatibleDictionarySchema) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.errors.IncompatibleDictionarySchema "Link to this definition") Bases: `Exception` Raised when a dictionary cannot be unnested. _exception_ utils.errors.InternalServerError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/errors.html#InternalServerError) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.errors.InternalServerError "Link to this definition") Bases: `Exception` Raised when an internal server error occurs _exception_ utils.errors.InvalidDateFormat[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/errors.html#InvalidDateFormat) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.errors.InvalidDateFormat "Link to this definition") Bases: `Exception` Raised when the date provided is in an incorrect or unsupported format _exception_ utils.errors.InvalidIncludes[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/errors.html#InvalidIncludes) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.errors.InvalidIncludes "Link to this definition") Bases: `Exception` Raised when an invalid object is passed as an includes argument _exception_ utils.errors.InvalidTimezoneError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/errors.html#InvalidTimezoneError) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.errors.InvalidTimezoneError "Link to this definition") Bases: `Exception` Raised when an unrecognized or invalid timezone is provided _exception_ utils.errors.MalformedResponseError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/errors.html#MalformedResponseError) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.errors.MalformedResponseError "Link to this definition") Bases: `Exception` Raised when the response from the API does not contain ‘data’. _exception_ utils.errors.ParameterException[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/errors.html#ParameterException) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.errors.ParameterException "Link to this definition") Bases: `Exception` Raised when an incorrect parameter type is provided _exception_ utils.errors.ParameterLengthException[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/errors.html#ParameterLengthException) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.errors.ParameterLengthException "Link to this definition") Bases: `Exception` Raised when the number of parameters requested in a single API call exceeds the allow amount _exception_ utils.errors.SportMonksAPIError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/errors.html#SportMonksAPIError) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.errors.SportMonksAPIError "Link to this definition") Bases: `Exception` Raised when SportMonks returns an API error. _exception_ utils.errors.TooManyRequestsError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/errors.html#TooManyRequestsError) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.errors.TooManyRequestsError "Link to this definition") Bases: `Exception` Raised when too many requests are made _exception_ utils.errors.UnauthorizedError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/errors.html#UnauthorizedError) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.errors.UnauthorizedError "Link to this definition") Bases: `Exception` Raised when an unauthorized request is made utils.helper module[](https://sportmonks-py.readthedocs.io/en/latest/utils.html#module-utils.helper "Link to this heading") ----------------------------------------------------------------------------------------------------------------------------- utils.helper.validate\_date\_format(_date\_str: str_) → bool[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/helper.html#validate_date_format) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.helper.validate_date_format "Link to this definition") Validates if the provided date is in the format ‘YYYY-mm-dd’ that SportMonks requires. Args: date\_str (str): The date string to validate. Returns: bool: True if the date is valid and in the correct format, False otherwise. utils.helper.validate\_date\_order(_date1: str_, _date2: str_) → bool[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/helper.html#validate_date_order) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.helper.validate_date_order "Link to this definition") Validates if the first date is not after the second date. A range of more than 100 days is also invalid. Args: date1 (str): The first date in ‘YYYY-mm-dd’ format. date2 (str): The second date in ‘YYYY-mm-dd’ format. Returns: bool: True if date1 <= date2, False if not, False if the range exeeds 100 days. utils.helper.validate\_positive\_id(_value: int_, _name: str_) → None[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/utils/helper.html#validate_positive_id) [](https://sportmonks-py.readthedocs.io/en/latest/utils.html#utils.helper.validate_positive_id "Link to this definition") Validates that a given value is a positive integer. Parameters: * **value** – The value to validate. * **name** – The parameter name for error messages. Module contents[](https://sportmonks-py.readthedocs.io/en/latest/utils.html#module-utils "Link to this heading") ------------------------------------------------------------------------------------------------------------------ Core endpoints common to all sports within SportMonks included in all subscriptions --- # sportmonks_py.utils package — SportMonks-Py v0.0.3 documentation * [](https://sportmonks-py.readthedocs.io/en/stable/index.html) * [sportmonks\_py package](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html) * sportmonks\_py.utils package * [View page source](https://sportmonks-py.readthedocs.io/en/stable/_sources/sportmonks_py.utils.rst.txt) * * * sportmonks\_py.utils package[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks-py-utils-package "Link to this heading") ============================================================================================================================================================ Submodules[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#submodules "Link to this heading") ------------------------------------------------------------------------------------------------------------------------- sportmonks\_py.utils.common\_types module[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#module-sportmonks_py.utils.common_types "Link to this heading") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Types used for clearer documentation and type hinting sportmonks\_py.utils.config module[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#module-sportmonks_py.utils.config "Link to this heading") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ _class_ sportmonks\_py.utils.config.Config[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/config.html#Config) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.config.Config "Link to this definition") Bases: `object` BASE\_URL _\= 'https://api.sportmonks.com/v3/'_[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.config.Config.BASE_URL "Link to this definition") sportmonks\_py.utils.errors module[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#module-sportmonks_py.utils.errors "Link to this heading") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ _exception_ sportmonks\_py.utils.errors.ApiTokenMissingError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/errors.html#ApiTokenMissingError) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.ApiTokenMissingError "Link to this definition") Bases: `Exception` Raised when API key is not provided. _exception_ sportmonks\_py.utils.errors.BadRequestsError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/errors.html#BadRequestsError) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.BadRequestsError "Link to this definition") Bases: `Exception` Raised when a bad request is made _exception_ sportmonks\_py.utils.errors.BaseUrlMissingError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/errors.html#BaseUrlMissingError) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.BaseUrlMissingError "Link to this definition") Bases: `Exception` Raised when base url is not provided. _exception_ sportmonks\_py.utils.errors.ForbiddenError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/errors.html#ForbiddenError) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.ForbiddenError "Link to this definition") Bases: `Exception` Raised when a forbidden request is made _exception_ sportmonks\_py.utils.errors.IncompatibleDictionarySchema[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/errors.html#IncompatibleDictionarySchema) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.IncompatibleDictionarySchema "Link to this definition") Bases: `Exception` Raised when a dictionary cannot be unnested. _exception_ sportmonks\_py.utils.errors.InternalServerError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/errors.html#InternalServerError) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.InternalServerError "Link to this definition") Bases: `Exception` Raised when an internal server error occurs _exception_ sportmonks\_py.utils.errors.InvalidDateFormat[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/errors.html#InvalidDateFormat) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat "Link to this definition") Bases: `Exception` Raised when the date provided is in an incorrect or unsupported format _exception_ sportmonks\_py.utils.errors.InvalidIncludes[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/errors.html#InvalidIncludes) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidIncludes "Link to this definition") Bases: `Exception` Raised when an invalid object is passed as an includes argument _exception_ sportmonks\_py.utils.errors.InvalidTimezoneError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/errors.html#InvalidTimezoneError) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidTimezoneError "Link to this definition") Bases: `Exception` Raised when an unrecognized or invalid timezone is provided _exception_ sportmonks\_py.utils.errors.MalformedResponseError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/errors.html#MalformedResponseError) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.MalformedResponseError "Link to this definition") Bases: `Exception` Raised when the response from the API does not contain ‘data’. _exception_ sportmonks\_py.utils.errors.ParameterException[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/errors.html#ParameterException) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.ParameterException "Link to this definition") Bases: `Exception` Raised when an incorrect parameter type is provided _exception_ sportmonks\_py.utils.errors.ParameterLengthException[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/errors.html#ParameterLengthException) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.ParameterLengthException "Link to this definition") Bases: `Exception` Raised when the number of parameters requested in a single API call exceeds the allow amount _exception_ sportmonks\_py.utils.errors.SportMonksAPIError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/errors.html#SportMonksAPIError) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.SportMonksAPIError "Link to this definition") Bases: `Exception` Raised when SportMonks returns an API error. _exception_ sportmonks\_py.utils.errors.TooManyRequestsError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/errors.html#TooManyRequestsError) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.TooManyRequestsError "Link to this definition") Bases: `Exception` Raised when too many requests are made _exception_ sportmonks\_py.utils.errors.UnauthorizedError[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/errors.html#UnauthorizedError) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.UnauthorizedError "Link to this definition") Bases: `Exception` Raised when an unauthorized request is made sportmonks\_py.utils.helper module[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#module-sportmonks_py.utils.helper "Link to this heading") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ sportmonks\_py.utils.helper.validate\_date\_format(_date\_str: str_) → bool[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/helper.html#validate_date_format) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.helper.validate_date_format "Link to this definition") Validates if the provided date is in the format ‘YYYY-mm-dd’ that SportMonks requires. Args: date\_str (str): The date string to validate. Returns: bool: True if the date is valid and in the correct format, False otherwise. sportmonks\_py.utils.helper.validate\_date\_order(_date1: str_, _date2: str_) → bool[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/helper.html#validate_date_order) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.helper.validate_date_order "Link to this definition") Validates if the first date is not after the second date. A range of more than 100 days is also invalid. Args: date1 (str): The first date in ‘YYYY-mm-dd’ format. date2 (str): The second date in ‘YYYY-mm-dd’ format. Returns: bool: True if date1 <= date2, False if not, False if the range exeeds 100 days. sportmonks\_py.utils.helper.validate\_positive\_id(_value: int_, _name: str_) → None[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/utils/helper.html#validate_positive_id) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.helper.validate_positive_id "Link to this definition") Validates that a given value is a positive integer. Parameters: * **value** – The value to validate. * **name** – The parameter name for error messages. Module contents[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#module-sportmonks_py.utils "Link to this heading") ---------------------------------------------------------------------------------------------------------------------------------------------- Core endpoints common to all sports within SportMonks included in all subscriptions [**Augment Code Review** Beats Copilot, Cursor & Claude on Code Review **Install Now**](https://server.ethicalads.io/proxy/click/10129/019c906b-e197-7771-850e-38b675730eea/) [Ads by EthicalAds](https://www.ethicalads.io/advertisers/topics/backend-web/?ref=ea-text) Close Ad ![](https://server.ethicalads.io/proxy/view/10129/019c906b-e197-7771-850e-38b675730eea/) --- # src — SportMonks-Py v0.0.3 documentation * [](https://sportmonks-py.readthedocs.io/en/latest/index.html) * src * [View page source](https://sportmonks-py.readthedocs.io/en/latest/_sources/modules.rst.txt) * * * src[](https://sportmonks-py.readthedocs.io/en/latest/modules.html#src "Link to this heading") =============================================================================================== --- # sportmonks_py package — SportMonks-Py v0.0.3 documentation * [](https://sportmonks-py.readthedocs.io/en/latest/index.html) * sportmonks\_py package * [View page source](https://sportmonks-py.readthedocs.io/en/latest/_sources/sportmonks_py.rst.txt) * * * sportmonks\_py package[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks-py-package "Link to this heading") ========================================================================================================================================== Subpackages[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#subpackages "Link to this heading") --------------------------------------------------------------------------------------------------------------------- * [sportmonks\_py.utils package](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html) * [Submodules](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#submodules) * [sportmonks\_py.utils.common\_types module](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#module-sportmonks_py.utils.common_types) * [sportmonks\_py.utils.config module](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#module-sportmonks_py.utils.config) * [`Config`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.config.Config) * [`Config.BASE_URL`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.config.Config.BASE_URL) * [sportmonks\_py.utils.errors module](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#module-sportmonks_py.utils.errors) * [`ApiTokenMissingError`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.ApiTokenMissingError) * [`BadRequestsError`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.BadRequestsError) * [`BaseUrlMissingError`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.BaseUrlMissingError) * [`ForbiddenError`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.ForbiddenError) * [`IncompatibleDictionarySchema`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.IncompatibleDictionarySchema) * [`InternalServerError`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.InternalServerError) * [`InvalidDateFormat`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat) * [`InvalidIncludes`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidIncludes) * [`InvalidTimezoneError`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidTimezoneError) * [`MalformedResponseError`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.MalformedResponseError) * [`ParameterException`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.ParameterException) * [`ParameterLengthException`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.ParameterLengthException) * [`SportMonksAPIError`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.SportMonksAPIError) * [`TooManyRequestsError`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.TooManyRequestsError) * [`UnauthorizedError`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.UnauthorizedError) * [sportmonks\_py.utils.helper module](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#module-sportmonks_py.utils.helper) * [`validate_date_format()`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.helper.validate_date_format) * [`validate_date_order()`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.helper.validate_date_order) * [`validate_positive_id()`](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.helper.validate_positive_id) * [Module contents](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#module-sportmonks_py.utils) Submodules[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#submodules "Link to this heading") ------------------------------------------------------------------------------------------------------------------- sportmonks\_py.api\_client module[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks-py-api-client-module "Link to this heading") --------------------------------------------------------------------------------------------------------------------------------------------------------------- sportmonks\_py.base\_client module[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks-py-base-client-module "Link to this heading") ----------------------------------------------------------------------------------------------------------------------------------------------------------------- sportmonks\_py.core module[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.core "Link to this heading") -------------------------------------------------------------------------------------------------------------------------------------------------- _class_ sportmonks\_py.core.CoreClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/core.html#CoreClient) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.core.CoreClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/core.html#CoreClient.get_all_cities) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.core.CoreClient.get_all_cities "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/core.html#CoreClient.get_all_continents) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.core.CoreClient.get_all_continents "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/core.html#CoreClient.get_all_countries) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.core.CoreClient.get_all_countries "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/core.html#CoreClient.get_all_regions) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.core.CoreClient.get_all_regions "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/core.html#CoreClient.get_all_types) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.core.CoreClient.get_all_types "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/core.html#CoreClient.get_city_by_id) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.core.CoreClient.get_city_by_id "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/core.html#CoreClient.get_continent_by_id) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.core.CoreClient.get_continent_by_id "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/core.html#CoreClient.get_country_by_id) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.core.CoreClient.get_country_by_id "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/core.html#CoreClient.get_region_by_id) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.core.CoreClient.get_region_by_id "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/core.html#CoreClient.get_type_by_id) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.core.CoreClient.get_type_by_id "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/core.html#CoreClient.search_cities) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.core.CoreClient.search_cities "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/core.html#CoreClient.search_countries) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.core.CoreClient.search_countries "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/core.html#CoreClient.search_regions) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.core.CoreClient.search_regions "Link to this definition") 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[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.fixture "Link to this heading") -------------------------------------------------------------------------------------------------------------------------------------------------------- _class_ sportmonks\_py.fixture.FixturesClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/fixture.html#FixturesClient) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.fixture.FixturesClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/fixture.html#FixturesClient.get_all_fixtures) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_all_fixtures "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/fixture.html#FixturesClient.get_all_livescores) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_all_livescores "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/fixture.html#FixturesClient.get_fixtures) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_fixtures "Link to this definition") 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: * **ValueError** – If no fixture IDs are provided. * [**ParameterLengthException**](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.ParameterLengthException "sportmonks_py.utils.errors.ParameterLengthException") – If more than 50 fixture IDs are provided. 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/fixture.html#FixturesClient.get_fixtures_by_date) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_fixtures_by_date "Link to this definition") 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**](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat "sportmonks_py.utils.errors.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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/fixture.html#FixturesClient.get_fixtures_by_market) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_fixtures_by_market "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/fixture.html#FixturesClient.get_fixtures_by_station) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_fixtures_by_station "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/fixture.html#FixturesClient.get_fixtures_by_updates) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_fixtures_by_updates "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/fixture.html#FixturesClient.get_h2h) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_h2h "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/fixture.html#FixturesClient.get_inplay_livescores) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_inplay_livescores "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/fixture.html#FixturesClient.get_livescore_updates) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_livescore_updates "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/fixture.html#FixturesClient.search_fixtures) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.search_fixtures "Link to this definition") 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[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.leagues "Link to this heading") -------------------------------------------------------------------------------------------------------------------------------------------------------- _class_ sportmonks\_py.leagues.LeaguesClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_all_leagues) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_all_leagues "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_all_leagues_by_team) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_all_leagues_by_team "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_all_rounds) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_all_rounds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_all_seasons) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_all_seasons "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_all_stages) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_all_stages "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_current_leagues_by_team) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_current_leagues_by_team "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_league) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_league "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_league_by_fixture_date) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_league_by_fixture_date "Link to this definition") 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**](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat "sportmonks_py.utils.errors.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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_leagues_by_country_id) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_leagues_by_country_id "Link to this definition") 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**](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat "sportmonks_py.utils.errors.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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_live_leagues) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_live_leagues "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_round) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_round "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_round_by_season_id) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_round_by_season_id "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_season) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_season "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_season_by_team_id) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_season_by_team_id "Link to this definition") 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**](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat "sportmonks_py.utils.errors.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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_stage_by_id) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_stage_by_id "Link to this definition") 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**](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat "sportmonks_py.utils.errors.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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.get_stages_by_season_id) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_stages_by_season_id "Link to this definition") 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**](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat "sportmonks_py.utils.errors.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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.search_leagues) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.search_leagues "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.search_rounds) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.search_rounds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.search_seasons) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.search_seasons "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/leagues.html#LeaguesClient.search_stages) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.search_stages "Link to this definition") 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[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.misc "Link to this heading") -------------------------------------------------------------------------------------------------------------------------------------------------- _class_ sportmonks\_py.misc.OtherClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/misc.html#OtherClient) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.misc.OtherClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/misc.html#OtherClient.get_commentaries) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_commentaries "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/misc.html#OtherClient.get_fixture_commentary) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_fixture_commentary "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/misc.html#OtherClient.get_postmatch_news) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_postmatch_news "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/misc.html#OtherClient.get_postmatch_news_by_season) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_postmatch_news_by_season "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/misc.html#OtherClient.get_prematch_news) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_prematch_news "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/misc.html#OtherClient.get_prematch_news_by_season) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_prematch_news_by_season "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/misc.html#OtherClient.get_rivals) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_rivals "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/misc.html#OtherClient.get_team_rivals) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_team_rivals "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/misc.html#OtherClient.get_upcoming_prematch_news) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_upcoming_prematch_news "Link to this definition") 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[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.my "Link to this heading") ---------------------------------------------------------------------------------------------------------------------------------------------- _class_ sportmonks\_py.my.MyClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/my.html#MyClient) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.my.MyClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/my.html#MyClient.enrichments) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.my.MyClient.enrichments "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/my.html#MyClient.leagues) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.my.MyClient.leagues "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/my.html#MyClient.resources) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.my.MyClient.resources "Link to this definition") 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[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.odds "Link to this heading") -------------------------------------------------------------------------------------------------------------------------------------------------- _class_ sportmonks\_py.odds.OddsClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/odds.html#OddsClient) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.odds.OddsClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/odds.html#OddsClient.get_all_inplay_odds) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.odds.OddsClient.get_all_inplay_odds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/odds.html#OddsClient.get_all_prematch_odds) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.odds.OddsClient.get_all_prematch_odds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/odds.html#OddsClient.get_fixture_inplay_odds) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.odds.OddsClient.get_fixture_inplay_odds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/odds.html#OddsClient.get_fixture_prematch_odds) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.odds.OddsClient.get_fixture_prematch_odds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/odds.html#OddsClient.get_latest_inplay_odds) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.odds.OddsClient.get_latest_inplay_odds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/odds.html#OddsClient.get_latest_prematch_odds) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.odds.OddsClient.get_latest_prematch_odds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/odds.html#OddsClient.get_premium_fixture_prematch_odds) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.odds.OddsClient.get_premium_fixture_prematch_odds "Link to this definition") 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](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[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.standings "Link to this heading") ------------------------------------------------------------------------------------------------------------------------------------------------------------ _class_ sportmonks\_py.standings.StandingsClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/standings.html#StandingsClient) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.standings.StandingsClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/standings.html#StandingsClient.get_all_standings) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.standings.StandingsClient.get_all_standings "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/standings.html#StandingsClient.get_live_standings_by_league) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.standings.StandingsClient.get_live_standings_by_league "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/standings.html#StandingsClient.get_season_standings) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.standings.StandingsClient.get_season_standings "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/standings.html#StandingsClient.get_standings_by_round) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.standings.StandingsClient.get_standings_by_round "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/standings.html#StandingsClient.get_standings_corrections) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.standings.StandingsClient.get_standings_corrections "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/standings.html#StandingsClient.get_topscorers_by_season) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.standings.StandingsClient.get_topscorers_by_season "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/standings.html#StandingsClient.get_topscorers_by_stage) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.standings.StandingsClient.get_topscorers_by_stage "Link to this definition") 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[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.statistics "Link to this heading") -------------------------------------------------------------------------------------------------------------------------------------------------------------- sportmonks\_py.teams module[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py.teams "Link to this heading") ---------------------------------------------------------------------------------------------------------------------------------------------------- _class_ sportmonks\_py.teams.TeamsClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/teams.html#TeamsClient) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.teams.TeamsClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/teams.html#TeamsClient.get_coaches) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_coaches "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/teams.html#TeamsClient.get_coaches_latest) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_coaches_latest "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/teams.html#TeamsClient.get_players) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_players "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/teams.html#TeamsClient.get_players_latest) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_players_latest "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/teams.html#TeamsClient.get_referee) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_referee "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/teams.html#TeamsClient.get_team_squad) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_team_squad "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/teams.html#TeamsClient.get_teams) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_teams "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/teams.html#TeamsClient.get_venues) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_venues "Link to this definition") 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[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html#module-sportmonks_py "Link to this heading") ---------------------------------------------------------------------------------------------------------------------------------- [**Augment Code Review** Beats Copilot, Cursor & Claude on Code Review **Install Now**](https://server.ethicalads.io/proxy/click/10129/019c906b-e197-7771-850e-38b675730eea/) [Ads by EthicalAds](https://www.ethicalads.io/advertisers/topics/backend-web/?ref=ea-text) Close Ad ![](https://server.ethicalads.io/proxy/view/10129/019c906b-e197-7771-850e-38b675730eea/) --- # sportmonks_py package — SportMonks-Py v0.0.3 documentation * [](https://sportmonks-py.readthedocs.io/en/stable/index.html) * sportmonks\_py package * [View page source](https://sportmonks-py.readthedocs.io/en/stable/_sources/sportmonks_py.rst.txt) * * * sportmonks\_py package[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks-py-package "Link to this heading") ========================================================================================================================================== Subpackages[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#subpackages "Link to this heading") --------------------------------------------------------------------------------------------------------------------- * [sportmonks\_py.utils package](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html) * [Submodules](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#submodules) * [sportmonks\_py.utils.common\_types module](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#module-sportmonks_py.utils.common_types) * [sportmonks\_py.utils.config module](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#module-sportmonks_py.utils.config) * [`Config`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.config.Config) * [`Config.BASE_URL`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.config.Config.BASE_URL) * [sportmonks\_py.utils.errors module](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#module-sportmonks_py.utils.errors) * [`ApiTokenMissingError`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.ApiTokenMissingError) * [`BadRequestsError`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.BadRequestsError) * [`BaseUrlMissingError`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.BaseUrlMissingError) * [`ForbiddenError`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.ForbiddenError) * [`IncompatibleDictionarySchema`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.IncompatibleDictionarySchema) * [`InternalServerError`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.InternalServerError) * [`InvalidDateFormat`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat) * [`InvalidIncludes`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidIncludes) * [`InvalidTimezoneError`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidTimezoneError) * [`MalformedResponseError`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.MalformedResponseError) * [`ParameterException`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.ParameterException) * [`ParameterLengthException`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.ParameterLengthException) * [`SportMonksAPIError`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.SportMonksAPIError) * [`TooManyRequestsError`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.TooManyRequestsError) * [`UnauthorizedError`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.UnauthorizedError) * [sportmonks\_py.utils.helper module](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#module-sportmonks_py.utils.helper) * [`validate_date_format()`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.helper.validate_date_format) * [`validate_date_order()`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.helper.validate_date_order) * [`validate_positive_id()`](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.helper.validate_positive_id) * [Module contents](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#module-sportmonks_py.utils) Submodules[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#submodules "Link to this heading") ------------------------------------------------------------------------------------------------------------------- sportmonks\_py.api\_client module[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks-py-api-client-module "Link to this heading") --------------------------------------------------------------------------------------------------------------------------------------------------------------- sportmonks\_py.base\_client module[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks-py-base-client-module "Link to this heading") ----------------------------------------------------------------------------------------------------------------------------------------------------------------- sportmonks\_py.core module[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.core "Link to this heading") -------------------------------------------------------------------------------------------------------------------------------------------------- _class_ sportmonks\_py.core.CoreClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/core.html#CoreClient) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.core.CoreClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/core.html#CoreClient.get_all_cities) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.core.CoreClient.get_all_cities "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/core.html#CoreClient.get_all_continents) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.core.CoreClient.get_all_continents "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/core.html#CoreClient.get_all_countries) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.core.CoreClient.get_all_countries "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/core.html#CoreClient.get_all_regions) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.core.CoreClient.get_all_regions "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/core.html#CoreClient.get_all_types) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.core.CoreClient.get_all_types "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/core.html#CoreClient.get_city_by_id) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.core.CoreClient.get_city_by_id "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/core.html#CoreClient.get_continent_by_id) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.core.CoreClient.get_continent_by_id "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/core.html#CoreClient.get_country_by_id) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.core.CoreClient.get_country_by_id "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/core.html#CoreClient.get_region_by_id) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.core.CoreClient.get_region_by_id "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/core.html#CoreClient.get_type_by_id) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.core.CoreClient.get_type_by_id "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/core.html#CoreClient.search_cities) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.core.CoreClient.search_cities "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/core.html#CoreClient.search_countries) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.core.CoreClient.search_countries "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/core.html#CoreClient.search_regions) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.core.CoreClient.search_regions "Link to this definition") 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[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.fixture "Link to this heading") -------------------------------------------------------------------------------------------------------------------------------------------------------- _class_ sportmonks\_py.fixture.FixturesClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/fixture.html#FixturesClient) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.fixture.FixturesClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/fixture.html#FixturesClient.get_all_fixtures) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_all_fixtures "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/fixture.html#FixturesClient.get_all_livescores) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_all_livescores "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/fixture.html#FixturesClient.get_fixtures) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_fixtures "Link to this definition") 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: * **ValueError** – If no fixture IDs are provided. * [**ParameterLengthException**](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.ParameterLengthException "sportmonks_py.utils.errors.ParameterLengthException") – If more than 50 fixture IDs are provided. 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/fixture.html#FixturesClient.get_fixtures_by_date) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_fixtures_by_date "Link to this definition") 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**](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat "sportmonks_py.utils.errors.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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/fixture.html#FixturesClient.get_fixtures_by_market) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_fixtures_by_market "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/fixture.html#FixturesClient.get_fixtures_by_station) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_fixtures_by_station "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/fixture.html#FixturesClient.get_fixtures_by_updates) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_fixtures_by_updates "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/fixture.html#FixturesClient.get_h2h) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_h2h "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/fixture.html#FixturesClient.get_inplay_livescores) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_inplay_livescores "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/fixture.html#FixturesClient.get_livescore_updates) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.get_livescore_updates "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/fixture.html#FixturesClient.search_fixtures) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.fixture.FixturesClient.search_fixtures "Link to this definition") 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[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.leagues "Link to this heading") -------------------------------------------------------------------------------------------------------------------------------------------------------- _class_ sportmonks\_py.leagues.LeaguesClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_all_leagues) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_all_leagues "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_all_leagues_by_team) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_all_leagues_by_team "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_all_rounds) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_all_rounds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_all_seasons) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_all_seasons "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_all_stages) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_all_stages "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_current_leagues_by_team) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_current_leagues_by_team "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_league) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_league "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_league_by_fixture_date) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_league_by_fixture_date "Link to this definition") 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**](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat "sportmonks_py.utils.errors.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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_leagues_by_country_id) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_leagues_by_country_id "Link to this definition") 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**](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat "sportmonks_py.utils.errors.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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_live_leagues) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_live_leagues "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_round) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_round "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_round_by_season_id) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_round_by_season_id "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_season) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_season "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_season_by_team_id) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_season_by_team_id "Link to this definition") 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**](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat "sportmonks_py.utils.errors.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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_stage_by_id) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_stage_by_id "Link to this definition") 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**](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat "sportmonks_py.utils.errors.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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.get_stages_by_season_id) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.get_stages_by_season_id "Link to this definition") 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**](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat "sportmonks_py.utils.errors.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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.search_leagues) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.search_leagues "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.search_rounds) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.search_rounds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.search_seasons) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.search_seasons "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/leagues.html#LeaguesClient.search_stages) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.leagues.LeaguesClient.search_stages "Link to this definition") 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[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.misc "Link to this heading") -------------------------------------------------------------------------------------------------------------------------------------------------- _class_ sportmonks\_py.misc.OtherClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/misc.html#OtherClient) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.misc.OtherClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/misc.html#OtherClient.get_commentaries) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_commentaries "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/misc.html#OtherClient.get_fixture_commentary) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_fixture_commentary "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/misc.html#OtherClient.get_postmatch_news) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_postmatch_news "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/misc.html#OtherClient.get_postmatch_news_by_season) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_postmatch_news_by_season "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/misc.html#OtherClient.get_prematch_news) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_prematch_news "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/misc.html#OtherClient.get_prematch_news_by_season) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_prematch_news_by_season "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/misc.html#OtherClient.get_rivals) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_rivals "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/misc.html#OtherClient.get_team_rivals) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_team_rivals "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/misc.html#OtherClient.get_upcoming_prematch_news) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.misc.OtherClient.get_upcoming_prematch_news "Link to this definition") 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[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.my "Link to this heading") ---------------------------------------------------------------------------------------------------------------------------------------------- _class_ sportmonks\_py.my.MyClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/my.html#MyClient) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.my.MyClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/my.html#MyClient.enrichments) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.my.MyClient.enrichments "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/my.html#MyClient.leagues) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.my.MyClient.leagues "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/my.html#MyClient.resources) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.my.MyClient.resources "Link to this definition") 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[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.odds "Link to this heading") -------------------------------------------------------------------------------------------------------------------------------------------------- _class_ sportmonks\_py.odds.OddsClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/odds.html#OddsClient) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.odds.OddsClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/odds.html#OddsClient.get_all_inplay_odds) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.odds.OddsClient.get_all_inplay_odds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/odds.html#OddsClient.get_all_prematch_odds) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.odds.OddsClient.get_all_prematch_odds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/odds.html#OddsClient.get_fixture_inplay_odds) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.odds.OddsClient.get_fixture_inplay_odds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/odds.html#OddsClient.get_fixture_prematch_odds) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.odds.OddsClient.get_fixture_prematch_odds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/odds.html#OddsClient.get_latest_inplay_odds) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.odds.OddsClient.get_latest_inplay_odds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/odds.html#OddsClient.get_latest_prematch_odds) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.odds.OddsClient.get_latest_prematch_odds "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/odds.html#OddsClient.get_premium_fixture_prematch_odds) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.odds.OddsClient.get_premium_fixture_prematch_odds "Link to this definition") 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](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[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.standings "Link to this heading") ------------------------------------------------------------------------------------------------------------------------------------------------------------ _class_ sportmonks\_py.standings.StandingsClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/standings.html#StandingsClient) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.standings.StandingsClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/standings.html#StandingsClient.get_all_standings) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.standings.StandingsClient.get_all_standings "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/standings.html#StandingsClient.get_live_standings_by_league) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.standings.StandingsClient.get_live_standings_by_league "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/standings.html#StandingsClient.get_season_standings) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.standings.StandingsClient.get_season_standings "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/standings.html#StandingsClient.get_standings_by_round) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.standings.StandingsClient.get_standings_by_round "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/standings.html#StandingsClient.get_standings_corrections) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.standings.StandingsClient.get_standings_corrections "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/standings.html#StandingsClient.get_topscorers_by_season) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.standings.StandingsClient.get_topscorers_by_season "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/standings.html#StandingsClient.get_topscorers_by_stage) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.standings.StandingsClient.get_topscorers_by_stage "Link to this definition") 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[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.statistics "Link to this heading") -------------------------------------------------------------------------------------------------------------------------------------------------------------- sportmonks\_py.teams module[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py.teams "Link to this heading") ---------------------------------------------------------------------------------------------------------------------------------------------------- _class_ sportmonks\_py.teams.TeamsClient(_base\_url: str_, _api\_token: str_)[\[source\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/teams.html#TeamsClient) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.teams.TeamsClient "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/teams.html#TeamsClient.get_coaches) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_coaches "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/teams.html#TeamsClient.get_coaches_latest) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_coaches_latest "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/teams.html#TeamsClient.get_players) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_players "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/teams.html#TeamsClient.get_players_latest) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_players_latest "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/teams.html#TeamsClient.get_referee) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_referee "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/teams.html#TeamsClient.get_team_squad) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_team_squad "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/teams.html#TeamsClient.get_teams) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_teams "Link to this definition") 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\]](https://sportmonks-py.readthedocs.io/en/stable/_modules/sportmonks_py/teams.html#TeamsClient.get_venues) [](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#sportmonks_py.teams.TeamsClient.get_venues "Link to this definition") 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[](https://sportmonks-py.readthedocs.io/en/stable/sportmonks_py.html#module-sportmonks_py "Link to this heading") ---------------------------------------------------------------------------------------------------------------------------------- [**Augment Code Review** Beats Copilot, Cursor & Claude on Code Review **Install Now**](https://server.ethicalads.io/proxy/click/10129/019c906b-e197-7771-850e-38b675730eea/) [Ads by EthicalAds](https://www.ethicalads.io/advertisers/topics/backend-web/?ref=ea-text) Close Ad ![](https://server.ethicalads.io/proxy/view/10129/019c906b-e197-7771-850e-38b675730eea/) --- # Unknown utils package ============= Submodules ---------- utils.common\\\_types module -------------------------- .. automodule:: utils.common\_types :members: :undoc-members: :show-inheritance: utils.config module ------------------- .. automodule:: utils.config :members: :undoc-members: :show-inheritance: utils.errors module ------------------- .. automodule:: utils.errors :members: :undoc-members: :show-inheritance: utils.helper module ------------------- .. automodule:: utils.helper :members: :undoc-members: :show-inheritance: Module contents --------------- .. automodule:: utils :members: :undoc-members: :show-inheritance: --- # Unknown utils package ============= Submodules ---------- utils.common\\\_types module -------------------------- .. automodule:: utils.common\_types :members: :undoc-members: :show-inheritance: utils.config module ------------------- .. automodule:: utils.config :members: :undoc-members: :show-inheritance: utils.errors module ------------------- .. automodule:: utils.errors :members: :undoc-members: :show-inheritance: utils.helper module ------------------- .. automodule:: utils.helper :members: :undoc-members: :show-inheritance: Module contents --------------- .. automodule:: utils :members: :undoc-members: :show-inheritance: --- # Unknown sportmonks\\\_py package ====================== Subpackages ----------- .. toctree:: :maxdepth: 4 sportmonks\_py.utils Submodules ---------- sportmonks\\\_py.api\\\_client module --------------------------------- .. automodule:: sportmonks\_py.api\_client :members: :undoc-members: :show-inheritance: sportmonks\\\_py.base\\\_client module ---------------------------------- .. automodule:: sportmonks\_py.base\_client :members: :undoc-members: :show-inheritance: sportmonks\\\_py.core module -------------------------- .. automodule:: sportmonks\_py.core :members: :undoc-members: :show-inheritance: sportmonks\\\_py.fixture module ----------------------------- .. automodule:: sportmonks\_py.fixture :members: :undoc-members: :show-inheritance: sportmonks\\\_py.leagues module ----------------------------- .. automodule:: sportmonks\_py.leagues :members: :undoc-members: :show-inheritance: sportmonks\\\_py.misc module -------------------------- .. automodule:: sportmonks\_py.misc :members: :undoc-members: :show-inheritance: sportmonks\\\_py.my module ------------------------ .. automodule:: sportmonks\_py.my :members: :undoc-members: :show-inheritance: sportmonks\\\_py.odds module -------------------------- .. automodule:: sportmonks\_py.odds :members: :undoc-members: :show-inheritance: sportmonks\\\_py.standings module ------------------------------- .. automodule:: sportmonks\_py.standings :members: :undoc-members: :show-inheritance: sportmonks\\\_py.statistics module -------------------------------- .. automodule:: sportmonks\_py.statistics :members: :undoc-members: :show-inheritance: sportmonks\\\_py.teams module --------------------------- .. automodule:: sportmonks\_py.teams :members: :undoc-members: :show-inheritance: Module contents --------------- .. automodule:: sportmonks\_py :members: :undoc-members: :show-inheritance: --- # Unknown sportmonks\\\_py package ====================== Subpackages ----------- .. toctree:: :maxdepth: 4 sportmonks\_py.utils Submodules ---------- sportmonks\\\_py.api\\\_client module --------------------------------- .. automodule:: sportmonks\_py.api\_client :members: :undoc-members: :show-inheritance: sportmonks\\\_py.base\\\_client module ---------------------------------- .. automodule:: sportmonks\_py.base\_client :members: :undoc-members: :show-inheritance: sportmonks\\\_py.core module -------------------------- .. automodule:: sportmonks\_py.core :members: :undoc-members: :show-inheritance: sportmonks\\\_py.fixture module ----------------------------- .. automodule:: sportmonks\_py.fixture :members: :undoc-members: :show-inheritance: sportmonks\\\_py.leagues module ----------------------------- .. automodule:: sportmonks\_py.leagues :members: :undoc-members: :show-inheritance: sportmonks\\\_py.misc module -------------------------- .. automodule:: sportmonks\_py.misc :members: :undoc-members: :show-inheritance: sportmonks\\\_py.my module ------------------------ .. automodule:: sportmonks\_py.my :members: :undoc-members: :show-inheritance: sportmonks\\\_py.odds module -------------------------- .. automodule:: sportmonks\_py.odds :members: :undoc-members: :show-inheritance: sportmonks\\\_py.standings module ------------------------------- .. automodule:: sportmonks\_py.standings :members: :undoc-members: :show-inheritance: sportmonks\\\_py.statistics module -------------------------------- .. automodule:: sportmonks\_py.statistics :members: :undoc-members: :show-inheritance: sportmonks\\\_py.teams module --------------------------- .. automodule:: sportmonks\_py.teams :members: :undoc-members: :show-inheritance: Module contents --------------- .. automodule:: sportmonks\_py :members: :undoc-members: :show-inheritance: --- # Unknown sportmonks\\\_py.utils package ============================ Submodules ---------- sportmonks\\\_py.utils.common\\\_types module ----------------------------------------- .. automodule:: sportmonks\_py.utils.common\_types :members: :undoc-members: :show-inheritance: sportmonks\\\_py.utils.config module ---------------------------------- .. automodule:: sportmonks\_py.utils.config :members: :undoc-members: :show-inheritance: sportmonks\\\_py.utils.errors module ---------------------------------- .. automodule:: sportmonks\_py.utils.errors :members: :undoc-members: :show-inheritance: sportmonks\\\_py.utils.helper module ---------------------------------- .. automodule:: sportmonks\_py.utils.helper :members: :undoc-members: :show-inheritance: Module contents --------------- .. automodule:: sportmonks\_py.utils :members: :undoc-members: :show-inheritance: --- # sportmonks_py.utils package — SportMonks-Py v0.0.3 documentation * [](https://sportmonks-py.readthedocs.io/en/latest/index.html) * [sportmonks\_py package](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.html) * sportmonks\_py.utils package * [View page source](https://sportmonks-py.readthedocs.io/en/latest/_sources/sportmonks_py.utils.rst.txt) * * * sportmonks\_py.utils package[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks-py-utils-package "Link to this heading") ============================================================================================================================================================ Submodules[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#submodules "Link to this heading") ------------------------------------------------------------------------------------------------------------------------- sportmonks\_py.utils.common\_types module[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#module-sportmonks_py.utils.common_types "Link to this heading") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Types used for clearer documentation and type hinting sportmonks\_py.utils.config module[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#module-sportmonks_py.utils.config "Link to this heading") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ _class_ sportmonks\_py.utils.config.Config[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/config.html#Config) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.config.Config "Link to this definition") Bases: `object` BASE\_URL _\= 'https://api.sportmonks.com/v3/'_[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.config.Config.BASE_URL "Link to this definition") sportmonks\_py.utils.errors module[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#module-sportmonks_py.utils.errors "Link to this heading") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ _exception_ sportmonks\_py.utils.errors.ApiTokenMissingError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/errors.html#ApiTokenMissingError) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.ApiTokenMissingError "Link to this definition") Bases: `Exception` Raised when API key is not provided. _exception_ sportmonks\_py.utils.errors.BadRequestsError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/errors.html#BadRequestsError) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.BadRequestsError "Link to this definition") Bases: `Exception` Raised when a bad request is made _exception_ sportmonks\_py.utils.errors.BaseUrlMissingError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/errors.html#BaseUrlMissingError) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.BaseUrlMissingError "Link to this definition") Bases: `Exception` Raised when base url is not provided. _exception_ sportmonks\_py.utils.errors.ForbiddenError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/errors.html#ForbiddenError) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.ForbiddenError "Link to this definition") Bases: `Exception` Raised when a forbidden request is made _exception_ sportmonks\_py.utils.errors.IncompatibleDictionarySchema[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/errors.html#IncompatibleDictionarySchema) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.IncompatibleDictionarySchema "Link to this definition") Bases: `Exception` Raised when a dictionary cannot be unnested. _exception_ sportmonks\_py.utils.errors.InternalServerError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/errors.html#InternalServerError) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.InternalServerError "Link to this definition") Bases: `Exception` Raised when an internal server error occurs _exception_ sportmonks\_py.utils.errors.InvalidDateFormat[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/errors.html#InvalidDateFormat) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidDateFormat "Link to this definition") Bases: `Exception` Raised when the date provided is in an incorrect or unsupported format _exception_ sportmonks\_py.utils.errors.InvalidIncludes[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/errors.html#InvalidIncludes) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidIncludes "Link to this definition") Bases: `Exception` Raised when an invalid object is passed as an includes argument _exception_ sportmonks\_py.utils.errors.InvalidTimezoneError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/errors.html#InvalidTimezoneError) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.InvalidTimezoneError "Link to this definition") Bases: `Exception` Raised when an unrecognized or invalid timezone is provided _exception_ sportmonks\_py.utils.errors.MalformedResponseError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/errors.html#MalformedResponseError) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.MalformedResponseError "Link to this definition") Bases: `Exception` Raised when the response from the API does not contain ‘data’. _exception_ sportmonks\_py.utils.errors.ParameterException[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/errors.html#ParameterException) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.ParameterException "Link to this definition") Bases: `Exception` Raised when an incorrect parameter type is provided _exception_ sportmonks\_py.utils.errors.ParameterLengthException[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/errors.html#ParameterLengthException) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.ParameterLengthException "Link to this definition") Bases: `Exception` Raised when the number of parameters requested in a single API call exceeds the allow amount _exception_ sportmonks\_py.utils.errors.SportMonksAPIError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/errors.html#SportMonksAPIError) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.SportMonksAPIError "Link to this definition") Bases: `Exception` Raised when SportMonks returns an API error. _exception_ sportmonks\_py.utils.errors.TooManyRequestsError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/errors.html#TooManyRequestsError) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.TooManyRequestsError "Link to this definition") Bases: `Exception` Raised when too many requests are made _exception_ sportmonks\_py.utils.errors.UnauthorizedError[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/errors.html#UnauthorizedError) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.errors.UnauthorizedError "Link to this definition") Bases: `Exception` Raised when an unauthorized request is made sportmonks\_py.utils.helper module[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#module-sportmonks_py.utils.helper "Link to this heading") ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ sportmonks\_py.utils.helper.validate\_date\_format(_date\_str: str_) → bool[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/helper.html#validate_date_format) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.helper.validate_date_format "Link to this definition") Validates if the provided date is in the format ‘YYYY-mm-dd’ that SportMonks requires. Args: date\_str (str): The date string to validate. Returns: bool: True if the date is valid and in the correct format, False otherwise. sportmonks\_py.utils.helper.validate\_date\_order(_date1: str_, _date2: str_) → bool[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/helper.html#validate_date_order) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.helper.validate_date_order "Link to this definition") Validates if the first date is not after the second date. A range of more than 100 days is also invalid. Args: date1 (str): The first date in ‘YYYY-mm-dd’ format. date2 (str): The second date in ‘YYYY-mm-dd’ format. Returns: bool: True if date1 <= date2, False if not, False if the range exeeds 100 days. sportmonks\_py.utils.helper.validate\_positive\_id(_value: int_, _name: str_) → None[\[source\]](https://sportmonks-py.readthedocs.io/en/latest/_modules/sportmonks_py/utils/helper.html#validate_positive_id) [](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#sportmonks_py.utils.helper.validate_positive_id "Link to this definition") Validates that a given value is a positive integer. Parameters: * **value** – The value to validate. * **name** – The parameter name for error messages. Module contents[](https://sportmonks-py.readthedocs.io/en/latest/sportmonks_py.utils.html#module-sportmonks_py.utils "Link to this heading") ---------------------------------------------------------------------------------------------------------------------------------------------- Core endpoints common to all sports within SportMonks included in all subscriptions [**Augment Code Review** Beats Copilot, Cursor & Claude on Code Review **Install Now**](https://server.ethicalads.io/proxy/click/10129/019c906b-e197-7771-850e-38b675730eea/) [Ads by EthicalAds](https://www.ethicalads.io/advertisers/topics/backend-web/?ref=ea-text) Close Ad ![](https://server.ethicalads.io/proxy/view/10129/019c906b-e197-7771-850e-38b675730eea/) --- # Unknown sportmonks\\\_py.utils package ============================ Submodules ---------- sportmonks\\\_py.utils.common\\\_types module ----------------------------------------- .. automodule:: sportmonks\_py.utils.common\_types :members: :undoc-members: :show-inheritance: sportmonks\\\_py.utils.config module ---------------------------------- .. automodule:: sportmonks\_py.utils.config :members: :undoc-members: :show-inheritance: sportmonks\\\_py.utils.errors module ---------------------------------- .. automodule:: sportmonks\_py.utils.errors :members: :undoc-members: :show-inheritance: sportmonks\\\_py.utils.helper module ---------------------------------- .. automodule:: sportmonks\_py.utils.helper :members: :undoc-members: :show-inheritance: Module contents --------------- .. automodule:: sportmonks\_py.utils :members: :undoc-members: :show-inheritance: ---