API docs v1
Aggregator API · v1

Game Catalogue

Find launch identifiers and capability flags with the currency-filtered getGameList command.

POST/v1/commandsgetGameListOmit idempotency key
On this page

Request#

Call getGameList with scope proxy:getGameList or proxy:*. Omit Idempotency-Key.

json
{
  "method": "getGameList",
  "currency": "USD",
  "list_type": 2
}
FieldRequiredAccepted value
currencyYesThree-letter uppercase code enabled for your workspace
list_typeNo1 or 2; default 1
show_additionalNoBoolean; default true
show_systemsNo0 or 1; default 0

The current connection returns compact records regardless of these legacy presentation options. It filters inventory by provider currency coverage; the gateway also applies workspace game entitlements.

Response#

json
{
  "error": 0,
  "response": [
    {
      "n": "Example game",
      "p": "Example provider",
      "s": "12/737",
      "fs": false,
      "fb": false,
      "d": false,
      "id": 737
    }
  ]
}

The example is illustrative. In compact records, n is the game name, p the provider, s the launch ID, fs the free-round flag, fb the feature-buy flag, and d the demo flag. The current connection sets fb and d to false; do not treat them as a complete capability inventory. Demo availability is confirmed by a successful demo request.

The compatibility contract can also return a map of records or detailed records. In detailed records, the launch identifier is id_hash. Preserve identifiers exactly; never substitute the numeric id field.

Use the catalogue#

Use a returned <brand_id>/<game_uid> identifier to launch a game or grant free rounds. Your currency entitlement and provider availability still apply at launch. Cache catalogue metadata as appropriate, refresh it regularly, and handle removed or unavailable games.