View Source PropOddsAPI.Api.V1 (PropOddsApi v0.0.2)

This module provides functionality to interact with V1 of the PropOdds API.

Summary

Functions

get_fantasy_lines(connection, game_id, market, api_key, opts \\ [])

Fetches fantasy lines for a given game and market.

get_fantasy_snapshot(connection, league, market, api_key, opts \\ [])

Retrieves a snapshot of fantasy data for a given league and market.

get_league_fantasy_snapshot(connection, league, api_key, opts \\ [])

Retrieves a league-wide fantasy snapshot.

get_odds(connection, game_id, market, api_key, opts \\ [])

Fetches odds for a given game and market.

Functions

get_fantasy_lines(connection, game_id, market, api_key, opts \\ [])

@spec get_fantasy_lines(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, PropOddsAPI.Model.FantasyBooks.t()}
  | {:ok, PropOddsAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Fetches fantasy lines for a given game and market.

Parameters

connection: The Tesla.Env.client() used to make the HTTP request.
game_id: The unique identifier for the game, as a String.t().
market: The market type for which the fantasy lines are being requested, as a String.t().
api_key: The API key used for authorization, as a String.t().
opts: Optional parameters provided as a keyword list. Can include :active_only and :end_datetime to filter the results.

Returns

{:ok, PropOddsAPI.Model.FantasyBooks.t()}: On success, returns the fantasy books data.
{:ok, PropOddsAPI.Model.HttpValidationError.t()}: If there's a validation error with the HTTP request.
{:error, Tesla.Env.t()}: On failure, returns the error within the Tesla environment.

get_fantasy_snapshot(connection, league, market, api_key, opts \\ [])

@spec get_fantasy_snapshot(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, PropOddsAPI.Model.FantasySnapshot.t()}
  | {:ok, PropOddsAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Retrieves a snapshot of fantasy data for a given league and market.

Parameters

connection: The Tesla.Env.client() used to make the HTTP request.
league: The identifier for the league, as a String.t().
market: The market type for which the fantasy snapshot is being requested, as a String.t().
api_key: The API key used for authorization, as a String.t().
opts: Optional parameters provided as a keyword list. Can include :active_only to filter the results.

Returns

{:ok, PropOddsAPI.Model.FantasySnapshot.t()}: On success, returns the fantasy snapshot data.
{:ok, PropOddsAPI.Model.HttpValidationError.t()}: If there's a validation error with the HTTP request.
{:error, Tesla.Env.t()}: On failure, returns the error within the Tesla environment.

get_league_fantasy_snapshot(connection, league, api_key, opts \\ [])

@spec get_league_fantasy_snapshot(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, PropOddsAPI.Model.FantasyLeagueSnapshot.t()}
  | {:ok, PropOddsAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Retrieves a league-wide fantasy snapshot.

Parameters

connection: The Tesla.Env.client() used to make the HTTP request.
league: The identifier for the league, as a String.t().
api_key: The API key used for authorization, as a String.t().
opts: Optional parameters provided as a keyword list. Can include :active_only to filter the results.

Returns

{:ok, PropOddsAPI.Model.FantasyLeagueSnapshot.t()}: On success, returns the fantasy league snapshot data.
{:ok, PropOddsAPI.Model.HttpValidationError.t()}: If there's a validation error with the HTTP request.
{:error, Tesla.Env.t()}: On failure, returns the error within the Tesla environment.

get_odds(connection, game_id, market, api_key, opts \\ [])

@spec get_odds(Tesla.Env.client(), String.t(), String.t(), String.t(), keyword()) ::
  {:ok, PropOddsAPI.Model.SportsBooks.t()}
  | {:ok, PropOddsAPI.Model.HttpValidationError.t()}
  | {:error, Tesla.Env.t()}

Fetches odds for a given game and market.

Parameters

connection: The Tesla.Env.client() used to make the HTTP request.
game_id: The unique identifier for the game, as a String.t().
market: The market type for which the odds are being requested, as a String.t().
api_key: The API key used for authorization, as a String.t().
opts: Optional parameters provided as a keyword list. Can include :active_only and :end_datetime to filter the results.

Returns

{:ok, PropOddsAPI.Model.SportsBooks.t()}: On success, returns the odds from various sportsbooks.
{:ok, PropOddsAPI.Model.HttpValidationError.t()}: If there's a validation error with the HTTP request.
{:error, Tesla.Env.t()}: On failure, returns the error within the Tesla environment.