Welcome to betiq’s documentation!

betiq.get_event_odds(api_key: str, event_id: str, sports: list = ['upcoming'], regions: list = ['us', 'us2', 'uk', 'au', 'eu'], markets: list = ['h2h'], date_format: str = 'iso', odds_format: str = 'decimal', event_ids: list = None, bookmakers: list = None)

Make a GET request to the event odds endpoint for The Odds API.

See: https://the-odds-api.com/liveapi/guides/v4/#get-event-odds.

Parameters:

• api_key (str) – A valid The Odds API API key.

• event_id (str) – The id of an upcoming or live game. Event ids can be found in the “id” field in the response of a get_odds() call.

• sports (list, optional) – A sport key. See a list of available keys with get_sports(), by default “upcoming”

• regions (list, optional) – A list of regions to include bookmakers from, by default [“us”, “us2”, “uk”, “au”, “eu”]

• markets (list, optional) – A list of which odds markets to return. Valid markets are “h2h” (moneyline), “spreads” (points handicaps), “totals” (over/under) and “outrights” (futures), by default [“h2h”]

• date_format (str, optional) – A string specifying the desired format of the timestamps in the response. Valid formats are “unix” and “iso”, by default “iso”

• odds_format (str, optional) – A string specifying the desired format of the odds in the response. Valid formats are “decimal” and “american”, by default “decimal”

• event_ids (list, optional) – A list of game ids to filter the response by, by default None

• bookmakers (list, optional) – A list of bookmakers to filter the response by, by default None

Returns:

The return of the GET request.

Return type:

dict

betiq.get_historical_odds(api_key: str, date: str, sports: list = ['upcoming'], regions: list = ['us', 'us2', 'uk', 'au', 'eu'], markets: list = ['h2h'], date_format: str = 'iso', odds_format: str = 'decimal', event_ids: list = None, bookmakers: list = None)

Make a GET request to the historical odds endpoint for The Odds API.

See: https://the-odds-api.com/liveapi/guides/v4/#get-historical-odds.

Parameters:

• api_key (str) – A valid The Odds API API key.

• date (str) – The timestamp of the data snapshot to be returned, specified in ISO8601 format, for example 2021-10-18T12:00:00Z.

• sports (list, optional) – A sport key. See a list of available keys with get_sports(), by default “upcoming”

• regions (list, optional) – A list of regions to include bookmakers from, by default [“us”, “us2”, “uk”, “au”, “eu”]

• markets (list, optional) – A list of which odds markets to return. Valid markets are “h2h” (moneyline), “spreads” (points handicaps), “totals” (over/under) and “outrights” (futures), by default [“h2h”]

• date_format (str, optional) – A string specifying the desired format of the timestamps in the response. Valid formats are “unix” and “iso”, by default “iso”

• odds_format (str, optional) – A string specifying the desired format of the odds in the response. Valid formats are “decimal” and “american”, by default “decimal”

• event_ids (list, optional) – A list of game ids to filter the response by, by default None

• bookmakers (list, optional) – A list of bookmakers to filter the response by, by default None

Returns:

The return of the GET request.

Return type:

dict

betiq.get_odds(api_key: str, sports: list = ['upcoming'], regions: list = ['us', 'us2', 'uk', 'au', 'eu'], markets: list = ['h2h'], date_format: str = 'iso', odds_format: str = 'decimal', event_ids: list = None, bookmakers: list = None) → dict

Make a GET request to the odds endpoint for The Odds API.

See: https://the-odds-api.com/liveapi/guides/v4/#get-odds.

Parameters:

• api_key (str) – A valid The Odds API API key.

• sports (list, optional) – A sport key. See a list of available keys with get_sports(), by default “upcoming”

• regions (list, optional) – A list of regions to include bookmakers from, by default [“us”, “us2”, “uk”, “au”, “eu”]

• markets (list, optional) – A list of which odds markets to return. Valid markets are “h2h” (moneyline), “spreads” (points handicaps), “totals” (over/under) and “outrights” (futures), by default [“h2h”]

• date_format (str, optional) – A string specifying the desired format of the timestamps in the response. Valid formats are “unix” and “iso”, by default “iso”

• odds_format (str, optional) – A string specifying the desired format of the odds in the response. Valid formats are “decimal” and “american”, by default “decimal”

• event_ids (list, optional) – A list of game ids to filter the response by, by default None

• bookmakers (list, optional) – A list of bookmakers to filter the response by, by default None

Returns:

The return of the GET request.

Return type:

dict

betiq.get_quota_stats(api_key: str) → dict

Returns API usage stats dictionary with requests used and requests remaining.

See: https://the-odds-api.com/liveapi/guides/v4/#response-headers.

Parameters:

api_key (str) – A valid The Odds API API key.

Returns:

A dictionary with requests used and requests remaining for the usage period.

Return type:

dict

betiq.get_request(endpoint: str, api_key: str, **kwargs) → dict | str

Make a GET request to The Odds API for the given endpoint.

Parameters:

• endpoint (str) – The GET endpoint you wish to call. Options are “sports”, “odds”, “scores”, “historical_odds”, and “event_odds”.

• api_key (str) – A valid The Odds API API key.

Returns:

The return of the GET request.

Return type:

dict

betiq.get_requests_remaining(api_key: str) → int

Returns the number of requests remaining for the usage period.

See: https://the-odds-api.com/liveapi/guides/v4/#response-headers.

Parameters:

api_key (str) – A valid The Odds API API key.

Returns:

The number of requests remaining for the usage period.

Return type:

int

betiq.get_requests_used(api_key: str) → int

Returns the number of requests used for the usage period.

See: https://the-odds-api.com/liveapi/guides/v4/#response-headers.

Parameters:

api_key (str) – A valid The Odds API API key.

Returns:

The number of requests used for the usage period.

Return type:

int

betiq.get_scores(api_key: str, sport: str, days_from: int = None, date_format: str = 'iso', event_ids: list = None) → dict

Make a GET request to the scores endpoint for The Odds API.

See: https://the-odds-api.com/liveapi/guides/v4/#get-scores.

Parameters:

• api_key (str) – A valid The Odds API API key.

• sport (str) – A sport key. See a list of available keys with get_sports()

• days_from (int, optional) – A number 1 to 3 specifying the number of days ine the past from which to return completed games, by default None

• date_format (str, optional) – A string specifying the desired format of the timestamps in the response. Valid formats are “unix” and “iso”, by default “iso”

• event_ids (list, optional) – A list of game ids to filter the response by, by default None

Returns:

The return of the GET request.

Return type:

dict

betiq.get_sports(api_key: str, all: bool = False) → dict

Make a GET request to the sports endpoint for The Odds API.

See: https://the-odds-api.com/liveapi/guides/v4/#get-sports.

Parameters:

• api_key (str) – A valid The Odds API API key.

• all (bool) – Whether or not to include both in and out of season sports in the response, by default False

Returns:

The return of the GET request.

Return type:

dict