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

This module provides functionality to interact with markets data from the PropOdds API.

Summary

Functions

get_player(connection, participant_id, api_key, opts \\ [])

Retrieves information for a specific participant by their ID.

lookup_player(connection, name, api_key, opts \\ [])

Looks up a participant by their name.

Functions

get_player(connection, participant_id, api_key, opts \\ [])

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

Retrieves information for a specific participant by their ID.

Parameters

connection: The Tesla.Env.client() used to make the HTTP request.
participant_id: The unique identifier for the participant, as an integer().
api_key: The API key used for authorization, as a String.t().
opts: Optional parameters provided as a keyword list (currently unused).

Returns

{:ok, PropOddsAPI.Model.Participant.t()}: On success, returns the participant information.
{: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.

lookup_player(connection, name, api_key, opts \\ [])

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

Looks up a participant by their name.

Parameters

connection: The Tesla.Env.client() used to make the HTTP request.
name: The name of the participant to look up, as a String.t().
api_key: The API key used for authorization, as a String.t().
opts: Optional parameters provided as a keyword list (currently unused).

Returns

{:ok, PropOddsAPI.Model.Participant.t()}: On success, returns the participant information.
{: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.