Games

GET

/v1/games

Overview

The Games endpoint is part of the Provider API for Aggregators. Its main purpose is to return a list of available games along with key metadata about each game, allowing an Aggregator to display these games in its lobby and let users select one to play.

The Games method allows the Aggregator to:

Retrieve a full list of games offered by the Game Provider.

Display game options — including names, categories, odds information, and lobby images — to end users in the Aggregator’s interface.

Dynamically update the lobby based on the available games without manual intervention.

This endpoint does not require a request body since it is a read-only operation.

Security and Authentication

Even though the Games method does not include a request body, the request must still be authenticated using the required HTTP headers. Please see the required headers below in the Header Params section.

📌

Signature of the request shall be calculated using HMAC-SHA256 algorithm and sent in "X-Sign" header of the request.
Please see How to calculate the X-Sign value.

Request

Header Params

X-Counterparty-Id

string

required

The public identifier of the subject provided during the onboarding process.

Example:

933a215f-a9e6-4f88-9d91-52a87cd50499

X-Timestamp

number

required

13 digits Unix epoch timestamp. Request generation time. All requests longer than 30 seconds will be considered expired.

Example:

1719766120806

X-Request-Id

string

required

A random sequence of 32 hexadecimal digits (Nonce) representing a unique request identifier.

Example:

5a0679b6e5fa48f6892c777b0fa92392

X-Sign

string

required

HMAC.SHA256 message signature.

Example:

c4d62f77cdfaadb6690b3bcbe5a0ca9ef1e5bf41d746d361a1269558eeb7ccd1

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://mock.apidog.com/m1/820627-0-default/v1/games' \
--header 'X-Counterparty-Id: 933a215f-a9e6-4f88-9d91-52a87cd50499' \
--header 'X-Timestamp: 1719766120806' \
--header 'X-Request-Id: 5a0679b6e5fa48f6892c777b0fa92392' \
--header 'X-Sign: c4d62f77cdfaadb6690b3bcbe5a0ca9ef1e5bf41d746d361a1269558eeb7ccd1'

Responses

🟢200Success

application/json

Body

gameId

integer

required

Game type ID.

name

string

required

Game name.

gameCategory

string

required

Category of game provided by the Game Provider (crash).

maxOdd

number

optional

The maximum possible game coefficient from the Game Provider, if applicable to the game category and mechanics.

Note: Not applicable for crash games!

lobbyImgUrl

string

required

Game image URL for lobby.

Image parameters:
• Size: 500 x 300
• Format: .jpg.

Example

[
  {
    "gameId": 1,
    "name": "FirstGame"
    "gameCategory": "crash",
    "maxOdd": 1000,
    "lobbyImgUrl": "https://providers-domain/first-game-logo.jpg"
  },
  {
    "gameId": 1,
    "name": "SecondGame"
    "gameCategory": "slot",
    "maxOdd": 50,
    "lobbyImgUrl": "https://providers-domain/second-game-logo.jpg"
  }
]

Provider API for Aggregator

Launch

Games

Overview#

Security and Authentication#

Request

Request samples

Responses

Overview

Security and Authentication