Skip to content

Get valid free-round stakes for a game

GET
/games/{game_id}/stakes

The valid stakes you may use to issue free rounds on this game in a given currency (POST /v1/free-rounds). Stakes are per game, per currency. Branch on mode, not on provider:

  • enumerated — we hold the authoritative stake list for this game in this currency, so stakes is populated; pick one entry and send it via stake_field. (TrueLabs always returns its stakes; Apparat returns them per-currency where its API exposes them.)
  • provider_validated — we don’t have the exact stakes for this game in this currency, because the provider’s API exposes no list for it. stakes is empty: submit any bet_amount, and the provider checks it on its own side when the round is issued — we mirror its accept/reject response back to you. Provider capabilities differ, so the same game may be enumerated in one currency and provider_validated in another.
  • unsupported — the provider has no free-round stake model at all (stake_field is null).
game_id
required
string format: uuid
currency
required
string
>= 3 characters <= 10 characters

ISO-4217 currency the stakes are quoted in (e.g. EUR). Stakes are per-currency.

Valid free-round stakes for the game in the requested currency.

object
game_id
required
string format: uuid
provider_code
required
string
truelabs
currency
required
string
EUR
stake_field
required

Which field to send to POST /v1/free-rounds for this game. coin_level — pick a stakes entry and send its coin_level (e.g. TrueLabs). bet_amount — send a money amount; when stakes is non-empty pick one of its amount values, otherwise send any valid amount (e.g. Apparat). null for unsupported.

string
nullable
Allowed values: coin_level bet_amount
mode
required

How to choose a stake. enumerated — we hold the authoritative list for this game+currency; stakes is populated, pick one and send it via stake_field. provider_validated — we don’t know the exact stakes in this currency for this provider (its API has no endpoint that returns them); stakes is empty, so send any bet_amount and the provider validates it on its own side when the round is issued, mirroring its accept/reject back to you. unsupported — the provider has no free-round stake model at all. Provider capabilities differ: TrueLabs always returns its stakes (enumerated), while a provider like Apparat may be provider_validated for currencies it doesn’t enumerate.

string
Allowed values: enumerated provider_validated unsupported
stakes
required

For enumerated, the valid stakes (pick one). Empty for the other modes.

Array<object>
object
coin_level

1-based level to send as coin_level. Present only when stake_field is coin_level.

integer
amount
required

The money stake, in currency. Send it as bet_amount when stake_field is bet_amount.

number

Invalid game_id or missing/invalid currency.

object
error
required
object
code
required

Machine-parseable error code. See https://docs.aggregator.gg/resources/error-codes/.

string
/^E[0-9A-F][0-9]{3}$/
E0001
type

Snake-case mnemonic for the code (e.g. game_blocked_jurisdiction, player_self_excluded). Branch on code; type is for readability.

string
game_blocked_jurisdiction
message
required
string
request_id

Correlation ID for support escalation.

string
details
object
key
additional properties
any

Missing, invalid, or revoked API key.

object
error
required
object
code
required

Machine-parseable error code. See https://docs.aggregator.gg/resources/error-codes/.

string
/^E[0-9A-F][0-9]{3}$/
E0001
type

Snake-case mnemonic for the code (e.g. game_blocked_jurisdiction, player_self_excluded). Branch on code; type is for readability.

string
game_blocked_jurisdiction
message
required
string
request_id

Correlation ID for support escalation.

string
details
object
key
additional properties
any

No game found with that ID.

object
error
required
object
code
required

Machine-parseable error code. See https://docs.aggregator.gg/resources/error-codes/.

string
/^E[0-9A-F][0-9]{3}$/
E0001
type

Snake-case mnemonic for the code (e.g. game_blocked_jurisdiction, player_self_excluded). Branch on code; type is for readability.

string
game_blocked_jurisdiction
message
required
string
request_id

Correlation ID for support escalation.

string
details
object
key
additional properties
any

Stakes temporarily unavailable (the provider stakes source was unreachable). Retry.

object
error
required
object
code
required

Machine-parseable error code. See https://docs.aggregator.gg/resources/error-codes/.

string
/^E[0-9A-F][0-9]{3}$/
E0001
type

Snake-case mnemonic for the code (e.g. game_blocked_jurisdiction, player_self_excluded). Branch on code; type is for readability.

string
game_blocked_jurisdiction
message
required
string
request_id

Correlation ID for support escalation.

string
details
object
key
additional properties
any