Games

Games Endpoints

This section will display all available endpoints to get games data.

Subsections of Games

Games Categories

This method returns all of the game IDs for the games that a player played. use gateway.[msdomain] mode: You can retrieve the data in two formats:

  • By default, the data is formatted by categories only.
  • mode=category: When you add this parameter, the data is formatted as two JSON objects: one for the game IDs and names, and one for the categories to which the games belong.

Request (GET)

/gateway/history/{version}/games/{brand_id}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path string true The ID of the casino.
mode query string false You can retrieve the data in two formats:
x-auth-token header string false The player’s authentication token, in UUID format.

Response

Status 200

[
  {
    "Table": [
      {
        "name": "European Blackjack",
        "id": "1191"
      }
    ]
  },
  {
    "Classic Slots": [
      {
        "name": "Angel Slot",
        "id": "134"
      },
      {
        "name": "Fashion Slot",
        "id": "152"
      }
    ]
  }
]

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
html Game launch url, if platform is desktop, will be wrapped in iframe.
htmlIndicator indication if platform is desktop.
provideRC indication if RC check should be performed on our side, if yes, need to continue to call player status.
isIframe indication if game can be opened in iframe(in mobile).
game_url uri for game launch without iframe.
game_html Game launch url, if platform is desktop, will be wrapped in iframe.

Start Game

This method sends a request to start a new game. use gateway.[msdomain]

Request (POST)

/gateway/games/{version}/start-game/{brand_id}/{game_id}/{lang}

Parameters:

{
  "auth_token": "string",
  "return_url": "string"
}
Name In Type Required Description
brand_id path string true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
version path string true API version.
auth_token body string true Player login session.
return_url body string true Indication to where need to return when players closes the game.

Response

Status 200

{
  "html": "",
  "htmlIndicator": false,
  "provideRC": false,
  "isIframe": false,
  "game_url": "",
  "game_html": ""
}

Status 303

{
  "html": "",
  "htmlIndicator": false,
  "provideRC": false,
  "isIframe": false,
  "game_url": "",
  "game_html": "",
  "game_provider": "Groove_Nolimit",
  "result": "ggr_game",
  "real_balance": 22.22
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

401 Response, in case of some addition requirement needed before proceeding

Error Code Description
INCOMPLETE_REGISTRATION The player did not complete his registration process, need to complete Registration Step Two.
TNC_APPROVAL_REQUIRED Player need to approve TnC.
PRIVACY_APPROVAL_REQUIRED Player need to approve Privacy Policy.
PASSWORD_CHANGE_REQUIRED Player has temp password and need to Change Password.
EMAIL_NOT_VERIFIED Player email is not verified and cannot continue any process till he verifies his mail. 
{
  "result": "INCOMPLETE_REGISTRATION"
}

Status 403

{
  "game_id": "",
  "html": "sdf",
  "htmlIndicator": false,
  "open_game_id": 123123,
  "result": "open_round_message",
  "game_url": "sdfsdf"
}

Status 403

{
  "result": "restricted_country"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
html Game launch url, if platform is desktop, will be wrapped in iframe.
htmlIndicator indication if platform is desktop.
provideRC indication if RC check should be performed on our side, if yes, need to continue to call player status.
isIframe indication if game can be opened in iframe(in mobile).
game_url uri for game launch without iframe.
game_html Game launch url, if platform is desktop, will be wrapped in iframe.
real_balance For GGR games, indication on how much money he can actually play in game, please not that NOT ALL that on some cases, not all real money is available in game.

Games History

Retrieve all game history. use gateway.[msdomain]

Request (GET)

/gateway/history/{version}/{brand_id}

Parameters:

Name In Type Required Description
version path string true The API version to use (pagination supported in version 3.0 and above).
brand_id path string true The ID of the casino.
x-auth-token header string false The player’s authentication token, in UUID format.
from query string false Date filter, from time, format YYYY-MM-DD.
to query string false Date filter, to time, format YYYY-MM-DD.
round_id query string false Round id to get data for.
unique_game_ids query string false Unique game ids to get data for, split by comma.
page query string false Page num to retrieve, default to 1.
games_per_page query string false records per page num to retrieve, default to 100.

Response

Status 200

{
  "response": [
    {
      "balance_after": "237.75",
      "round_balance": "-0.87",
      "balance_before": "236.88",
      "bet": "0.75",
      "game_name": "King Kong",
      "round_id": "3593543",
      "platform_name": "Desktop",
      "provider_id": "NYX_Next-gen",
      "details": false,
      "time": "2017/04/12 09:23:44",
      "category": "Video Slots",
      "win": "1.62",
      "game_id": 70160
    }
  ],
  "total_bets": 1,
  "total_wins": 1,
  "currency": "USD",
  "currency_symbol": "$",
  "page_num": 1,
  "games_per_page": 100,
  "games_count": 120
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 401

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Type Required Restrictions Description
» balance_after string false none The player’s balance after playing the round.
» round_balance string false none The calculated round balance (balance_before - balance_after).
» balance_before string false none The player’s balance before playing the round.
» bet string false none The amount of the bet.
» game_name string false none The name of the game.
» round_id string false none The ID of the round.
» platform_name string false none The name of the platform that player is using.
» provider_id string false none The ID of the game provider.
» details boolean false none Indicates if the casino has more details regarding the specific round. This parameter only applies to GS1 games.
» time string false none The time that the transaction occurred.
» category string false none The category of the game (such as slots or live casino).
» win string false none The amount of the win.
» game_id string false none The ID of the game.

Games Details

This method returns details about a round, should be sent only if indication for details is true in game history. use gateway.[msdomain]

Request (GET)

/gateway/history/{version}/games/details/{brand_id}/{provider_id}/{round_id}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino.
provider_id path string true The ID of the game provider.
round_id path string true The ID of the round.
x-auth-token header string true The player’s authentication token, in UUID format.

Response

Status 200

{
  "html": ""
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 401

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "result": "internal server error"
}

Games List

This method returns a list of all available games for a casino. Use this method if you want to manage your lobby directly rather than using the Get Current Lobby Version method. use gateway.[msdomain]

Request (GET)

/gateway/games/{version}/games/{brand_id}

Parameters:

Name In Type Required Description
version path string true The API version to use (pagination supported in version 3.0 and above).
brand_id path string true The ID of the casino.

Response

Status 200

[
  {
    "Game Name": "1 Can 2 Can",
    "Game Id": "70071",
    "Game Type": "bo.gamesGroup.videoSlots",
    "Provider name": "NYX",
    "Sub provider name": "NYX_Next-gen",
    "Image": "[PROMO_URL]/lobby_images/NYX/NextGen/1Can_2Can.jpg",
    "Support FRB": 0,
    "Support Fun": 1,
    "Revenue plan": "ngr",
    "Micro games variant": null,
    "External Game ID": 70071,
    "External Game container": "1_can_2_can",
    "Rander": "Flash",
    "Exclusion": [
      "AU",
      "CA",
      "ES",
      "GB"
    ],
    "Supported platform": "Desktop, Mobile"
  },
  {
    "Game Name": "1429 Uncharted Seas",
    "Game Id": "240005",
    "Game Type": "bo.gamesGroup.videoSlots",
    "Provider name": "NYX",
    "Sub provider name": "NYX_Thunderkick",
    "Image": "[PROMO_URL]/lobby_images/NYX/Thunderkick/1429_Uncharted_Seas.jpg",
    "Support FRB": 0,
    "Support Fun": 1,
    "Revenue plan": "ngr",
    "Micro games variant": null,
    "External Game ID": 240005,
    "External Game container": "1429_uncharted_seas",
    "Rander": "Flash",
    "Exclusion": [
      "AU",
      "CA",
      "ES",
      "GB"
    ],
    "Supported platform": "Desktop, Mobile"
  },
  {
    "Game Name": "2 Million B.C.",
    "Game Id": "1224",
    "Game Type": "bsg.gamesGroup.Slots",
    "Provider name": "General",
    "Sub provider name": "BSG",
    "Image": "[PROMO_URL]/lobby_images/2MillionBC.jpg",
    "Support FRB": 1,
    "Support Fun": 1,
    "Revenue plan": "ngr",
    "Micro games variant": null,
    "External Game ID": 224,
    "External Game container": "2 Million B.C.",
    "Rander": "Flash",
    "Exclusion": [],
    "Supported platform": "Desktop, Mobile"
  }
]

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 500

{
  "result": "internal server error"
}

Games Allowed For Player

This method retrieves a list of game IDs for all of the games that are available to a player. It excludes any games that aren’t available for the country in which the player is registered or logged in. use gateway.[msdomain]

Request (GET)

/gateway/games/{version}/player/{brand_id}

Parameters:

Name In Type Required Description
version path string true The API version to use (pagination supported in version 3.0 and above).
brand_id path string true The ID of the casino.
x-auth-token header string false The player’s authentication token, in UUID format, will be used to filter ot irrelevant games.

Response

Status 200

[
  "70071",
  "1224",
  "1064",
  "70003",
  "1637",
  "70058"
]

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 401

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "result": "internal server error"
}

Last Bet

This method retrieves the date and time of the last bet. use gateway.[msdomain]

Request (GET)

/gateway/rounds/{version}/{brand_id}/bet/last

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino.
x-auth-token header string true The player’s authentication token, in UUID format.

Response

{
  "last_bet": "2019-02-28 09:38:02.0"
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 401

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "result": "internal server error"
}