Skip to content

Game List API

The Game List API lets the Operator retrieve the full catalog of games enabled for their account. Use it to populate your lobby, search / filter, and build deep-links into the Game Launch API.

Overview

  • Endpoint: {BASE_URL}/api/v1/games
  • Method: GET
  • Direction: Operator → Game Provider
  • Cache: Server-side cached for 30 minutes; refresh is transparent.

Request Specification

Query Parameters

Parameter Type Required Description
operatorId Long Yes Your operator ID (provided during onboarding).

Required Headers

Header Description
X-Public-Key Your assigned public API key (used to identify the tenant).

[!TIP] The catalog is scoped per operator — two operators calling the same endpoint may see different games depending on their commercial configuration.

Response Specification

A successful request returns a JSON array of game objects (no envelope). Response is 200 OK with an empty array if no games are enabled.

Response Example

[
  {
    "id": "chicken-race",
    "name": "chicken-race",
    "category": "arcade",
    "gameUrl": "https://games.game-provider.com/play/chicken-race",
    "demoAvailable": true,
    "mobileSupport": true,
    "freeSpinSupport": false,
    "imageLink": "https://cdn.game-provider.com/thumbnails/chicken-race.png"
  },
  {
    "id": "aviadrone",
    "name": "aviadrone",
    "category": "crash",
    "gameUrl": "https://games.game-provider.com/play/aviadrone",
    "demoAvailable": false,
    "mobileSupport": true,
    "freeSpinSupport": false,
    "imageLink": "https://cdn.game-provider.com/thumbnails/aviadrone.png"
  }
]

Response Fields

Field Type Description
id String Unique game identifier. Use this as the {game} path parameter in the Launch API.
name String Canonical game name.
category String High-level category (e.g. arcade, crash, slot, table).
gameUrl String Reference URL of the game's landing page (not the launch URL — always launch via the Launch API for a per-player session).
demoAvailable Boolean true if the game supports portalMode=demo on launch.
mobileSupport Boolean true if the game renders on mobile devices.
freeSpinSupport Boolean true if the game supports free-spin / free-bet gifts via the Gift API.
imageLink String Thumbnail URL suitable for lobby tiles.

Error Responses

HTTP When
400 Missing or invalid operatorId.
401 Missing or invalid X-Public-Key.
404 Operator not registered.
5xx Transient failure — safe to retry.

See Error Handling for full codes.

Caching on the Operator Side

Game Provider caches the result for 30 minutes internally. You may additionally cache on your side (recommended 5–15 minutes) to reduce load on your lobby rendering path. Invalidate your cache proactively when you add or remove games from your Game Provider configuration.

Usage Example

curl -X GET "https://wallet.game-provider.com/api/v1/games?operatorId=42" \
  -H "X-Public-Key: YOUR_PUBLIC_KEY"

Once you have the list, drive a launch using the returned id:

GET /api/v1/launch/aviadrone?userToken=...&currency=USD&platform=desktop&portalMode=real&returnUrl=...&language=en

See the Game Launch API for full launch parameters.