/
1.1 getGameList() *

1.1 getGameList() *

Retrieves the games enabled for your agent.

Please note that this list can change over time and is different between staging and production servers! It's best practice to load this list dynamically so you always get the latest games. Please use id_hash for your game library, because it is the same between staging and production. Id will be different between staging and production.

retrieved list example
//please note that json response array returns the same game properties
Array(
	0 =>array (
		'id' => '568',
		'name' => 'The Pyramid',
        'category' => 'video-slots',
        'subcategory' => '15line',
        'details' => '{"Min bet":"0,05�","Max bet":"25�"}',
        'new' => '0',
        'system' => 'mi',
        'position' => 0,
        'type' => 'video-slots',
        'image' => 'url to game icon',
        'image_preview' => 'url to game screenshot',
        'mobile' => false,
        'play_for_fun_supported' => true,
	),
	1 =>array (
		'id' => '729',
        'name' => 'So 80\'s',
        'category' => 'video-slots',
        'subcategory' => 'classic',
        'details' => '{"Min bet":"0,05�","Max bet":"25�"}',
        'new' => '0',
        'system' => 'mi',
        'position' => 0,
        'type' => 'video-slots',
        'image' => 'url to game icon',
        'image_preview' => 'url to game screenshot',
        'mobile' => false,
        'play_for_fun_supported' => true,
	),
)
REST REQUEST
//get game list - When you copy the code from here, you need to delete the comments (char: //) !!!
{
	"api_password" : "xapitest",
	"api_login" : xapitest
	"method" : "getGameList"
	"show_systems" : 0, 
	"show_additional" : false, //only true or false.... (0 or 1 does not work)
	"currency" : "EUR"
}
REST RESPONSE
{"error":0,"response":[{id:2817,name:Example\u2122,type:video-slots,subcategory:example,details:,
new:0,system:mi,position:4,category:SLOTS1,
image:https:\/\/www.example.com\/images\/slots\/small\/mi\/mi-example.png,
image_preview:https:\/\/www.example.com\/media\/images\/popup\/mi-example.jpg,
mobile:true,play_for_fun_supported:true},...


# REST RESPONSE on show_systems = 1:
{"error":0,"response":[{"id":"775","name":"Pirates","category":"bgaming",type:"video-slots","subcategory":"other","details":"{\"minbet\":\"0.01\",\"maxbet\":\"75.00\",
\"reels\":\"5\",\"lines\":\"15\",\"freespins\":\"yes\",\"bonusgame\":\"no\"}","new":"0","position":"5","image":"http:\/\/dev.example.com:8090\/media\/images\/slots\
/small\/la\/pirates.png","image_preview":"http:\/\/dev.example.com:8090\/media\/images\/popup\/pirates.jpg","provider":"la","provider_name":"Casino Name"}

#REST RESPONSE on "show_additional" : true:
#Another field named "additional" is added with additional games data:
"error": 0,"response": [ {"id": "10497","name": "Jungle Rumble", ... "gamename": "Jungle Rumble", "report": "ha", "additional": {"aspect_ratio": "16:9","width": "1280","height": "720","scale_up": true,"scale_down": true,"stretching": false,"html5": true,"volatility": "high","max_exposure": "16200"},"id_hash": "ha_ha-jungle-rumble", ... ],
"response_provider_logos": {"livecasino": [{"name": "AsiaGaming","system": "ag","image_black": "https:\/\/stage.game-program.com\/media\/images\/providersLogos\/black_logos\/ag-dark.png","image_white": "https:\/\/stage.game-program.com\/media\/images\/providersLogos\/white_logos\/ag-light.png","image_colored": "https:\/\/stage.game-program.com\/media\/images\/providersLogos\/org_logos\/ag.png"},{"name": "BetGames","system": "be","image_black": "https:\/\/stage.game-program.com\/media\/images\/providersLogos\/black_logos\/be-dark.png","image_white": "https:\/\/stage.game-program.com\/media\/images\/providersLogos\/white_logos\/be-light.png","image_colored": "https:\/\/stage.game-program.com\/media\/images\/providersLogos\/org_logos\/be.png"},{"name": "Evolution Livecasino","system": "es","image_black": "https:\/\/stage.game-program.com\/media\/images\/providersLogos\/black_logos\/es-dark.png","image_white": "https:\/\/stage.game-program.com\/media\/images\/providersLogos\/white_logos\/es-light.png","image_colored": "https:\/\/stage.game-program.com\/media\/images\/providersLogos\/org_logos\/es.png"}],...

Info provided for each game:

TypeParameterDescription
Usage
intidgameId to be used with getGame function
stringnamegame name

stringtype

game type:

(livecasino,
poker,
virtual-sports,
sportsbook,
live-casino-table,
video-slots,
table-games,
video-poker,
virtual-games,
scratch-cards,
video-bingo,
tournaments,
livegames,
crash-games,
fast-games)

stringsubcategoryoptional subcategory, name of provider
stringdetailsoptional data for a game in a json format
booleannewset when the game is new in our system
stringsysteminternal shortname for game provider
stringposition

stringcategorygame main category


booleanmobilespecifies if game is mobile
stringid_hashunique string identifier
intid_parentparent game id of the current game if available
stringid_hash_parentsame as id_parent but identified as unique string identifier
booleanfreerounds_supportedspecifies if game supports activation of free rounds via 'addFreeRounds' method
booleanfeaturebuy_supportedspecifies if game supports activation of game features via 'addFeatureBuy' method
booleanhas_jackpotspecifies if game has jackpots
booleanplay_for_fun_supportedset when the game supports play for fun mode
stringimagegame thumbnail image
stringimage_previewgame screenshot image
stringimage_filleddirect url to the non-transparent rectangle image icon
stringimage_portraitdirect url to the portrait image (500 x 800)

stringimage_squaredirect url to the square image (500 x 500)

stringimage_backgrounddirect url to the game background image
stringimage_bwdirect url to the black and white image
stringcurrencyplayers currency code


Additional game details (when applicable)

TypeNameDescription
stringaspect_ratioAspect ratio of the game as provided from game provider
stringwidthdefault width
stringheightdefault height
booleanscale_upwhether the game scales up
booleanscale_downwhether the game scales down
booleanstretchingwhether the game stretches to fit the screen/iframe
booleanhtml5if the game technology is html5
stringvolatilitygame volatility (low, medium, high)
stringmax_exposure

maximum bet multiplier players can win in the game

booleanmegawaysIf game is megaways game
booleanbonusbuyIf game supports buying bonus features.
stringjackpot_typetype of jackpot (Non-Jackpot, Non-Progressive,...)

response_provider_logos

if we set parameter show_additional = true, it is displayed under array: response, displays an array (response_provider_logos) where the logos of all providers are located. 

show_systems

if we set parameter show_systems = 1, additional parameters are displayed in response:

provider -> abbreviation of provider (example: "ha")
provider_name (example: "habanero")


Source Code
public function getGameList($show_systems = false){
    return $this->client->getGameList($show_systems);
}

Please note that this list can change over time and is different between staging and production servers! It's best practice to load this list dynamically so you always get the latest games. We recommend to call it once a day. Slot popularity is determined by "position" (lower is better).

Related content