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

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

Summary

Functions

Retrieves the API usage statistics for the provided API key.

Functions

Link to this function

get_usage(connection, api_key, opts \\ [])

View Source

Retrieves the API usage statistics for the provided API key.

Parameters

  • connection: The Tesla.Env.client() used to make the HTTP request.
  • 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.Usage.t()}: On success, returns the API usage statistics.
  • {: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.