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.
//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" }
{"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:
Type | Parameter | Description | Usage |
---|---|---|---|
int | id | gameId to be used with getGame function | |
string | name | game name | |
string | type | game type: (livecasino, | |
string | subcategory | optional subcategory, name of provider | |
string | details | optional data for a game in a json format | |
boolean | new | set when the game is new in our system | |
string | system | internal shortname for game provider | |
string | position | ||
string | category | game main category | |
boolean | mobile | specifies if game is mobile | |
string | id_hash | unique string identifier | |
int | id_parent | parent game id of the current game if available | |
string | id_hash_parent | same as id_parent but identified as unique string identifier | |
boolean | freerounds_supported | specifies if game supports activation of free rounds via 'addFreeRounds' method | |
boolean | featurebuy_supported | specifies if game supports activation of game features via 'addFeatureBuy' method | |
boolean | has_jackpot | specifies if game has jackpots | |
boolean | play_for_fun_supported | set when the game supports play for fun mode | |
string | image | game thumbnail image | |
string | image_preview | game screenshot image | |
string | image_filled | direct url to the non-transparent rectangle image icon | |
string | image_portrait | direct url to the portrait image (500 x 800) | |
string | image_square | direct url to the square image (500 x 500) | |
string | image_background | direct url to the game background image | |
string | image_bw | direct url to the black and white image | |
string | currency | players currency code |
Additional game details (when applicable)
Type | Name | Description |
---|---|---|
string | aspect_ratio | Aspect ratio of the game as provided from game provider |
string | width | default width |
string | height | default height |
boolean | scale_up | whether the game scales up |
boolean | scale_down | whether the game scales down |
boolean | stretching | whether the game stretches to fit the screen/iframe |
boolean | html5 | if the game technology is html5 |
string | volatility | game volatility (low, medium, high) |
string | max_exposure | maximum bet multiplier players can win in the game |
boolean | megaways | If game is megaways game |
boolean | bonusbuy | If game supports buying bonus features. |
string | jackpot_type | type of jackpot (Non-Jackpot, Non-Progressive,...) |
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")
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).