Skip to main content

Get list games

Request

URI: /gameList?{parameters}

Example usage: https://{base_url}/gameList?{parameters}

The request is executed using the GET method.

This method is used to retrieve a list of games.

tip

It is recommended to update game list once per day. (optional)

Request parameters

NameTypeRequiredDescription
providerstringNoThe unique ID of provider
typestringNoIf parameter is absent, return all games Live = only live games, Slot = only slot games
Accepted values: live, slot
mobilebooleanNoIf parameter is absent, return all games
If true, only mobile games
If false, only desktop games

Response parameters

NameTypeRequiredDescription
statusbooleanYesResponse status code for Call back API
Accepted values: true, false
gamesarrayYesArray with games' list and information related to them
games.idintegerYesGame ID
games.namestringYesGame name
games.providerIdintegerYesProvider ID
games.demobooleanYesIf true, game can be launched in demo-mode (i.e. can also be launched by an unauthorized users)
games.typeIdintegerYesID of game type: 1 - Live, 2 - Casino Games, 3 - Virtual Games, 4 - TV-games, 5 - Poker, 6 - SportBook
games.categorystringYesGame category, sent by provider
games.bonus_buybooleanYesIf true, bonus can be used in this game
games.typestringYesGame type (Live , Casino Games, Virtuals, TvGames, Poker, SportBook)
games.imgstringYesBanner image URL
games.img_verticalstringYesBanner vertical image URL
games.img_providerstringYesDefault image received from the provider
games.game_backgroundstringYesDefault background image
games.basicRTPfloatYesBase game RTP
Belongs to a higher threshold, if it was received with a lowerRTP
games.lowRTPfloatNoLow game RTP
Belongs to a lower threshold, if it comes with basicRTP
This parameter is used only in Live games
It is required for display of the range, where it is not possible to specify the exact RTP of the game
lowRTP will be included in the responce, if it is configured in the game
games.devicestringYesType of supported user's device (mobile, desktop, all devices)
errorsobjectNoDescription of errors in case status = false
errors.errorstringNoError description

Example of a successful response

Response: /gameList
{
"games": [
{
"id": 1,
"name": "Game Name",
"providerId": 6,
"demo": true,
"typeId": 2,
"category": "Slot",
"bonus_buy": false,
"type": "Slot",
"img": "https://url/game.jpg",
"img_vertical": "https://url/game/v.jpg",
"img_provider": "https://url/game.jpg",
"game_background": "https://url/game.jpg",
"basicRTP": 50.5,
"device": "All device"
}
]
}

Example of an unsuccessful response

Response: /gameList
{
"status": false,
"errors": {
"error": "Description"
}
}