UOF.API.Descriptions (UOF_API v2.0.0)

Copy Markdown View Source

Descriptions API.

Static, mostly language-dependent metadata that describes the values used throughout the feed: market and variant descriptions, producers, sport-specific match statuses and betting statuses used in odds_change messages, betstop reasons, and void reasons used in bet_settlement messages.

Every function returns {:ok, struct} | {:error, Ecto.Changeset.t()}, where the struct is an UOF.API.Schemas.Descriptions.* embedded schema. Endpoints that vary by language take an optional lang (ISO code, default "en").

Summary

Functions

Describe all bet stop reasons.

Describes all betting statuses used in odds_change messages.

Describe all currently available markets.

Describe all sport-specific match status codes used during live matches in odds_change messages.

Describe all currently available producers and their ids.

Get a list of all variants and which markets they are used for.

Describe all possible void reasons used in bet_settlement messages.

Functions

betstop_reasons()

Describe all bet stop reasons.

betting_statuses()

Describes all betting statuses used in odds_change messages.

markets(lang \\ "en")

Describe all currently available markets.

match_statuses(lang \\ "en")

Describe all sport-specific match status codes used during live matches in odds_change messages.

producers()

Describe all currently available producers and their ids.

variants(lang \\ "en")

Get a list of all variants and which markets they are used for.

void_reasons()

Describe all possible void reasons used in bet_settlement messages.