Lobby API

This method returns a list of games to display in the lobby. The list of games might vary depending on whether or not the player is logged in (x-auth-token). The list might also vary by the type of platform and marketing segment. use gateway.[msdomain]. If user is logged in, games will be filtered out by the user’s country, both current logged in country and registration country.

Request (GET)

/gateway/site-management/{version}/lobby/{brand_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. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token header string false player logged in session.

Response

Status 200

{
  "structure": [
    {
      "name": "mobile.gameCategory.featuredGames",
      "category_id": "featured-games",
      "games": [
        "80879",
        "80836"
      ]
    },
    {
      "name": "mobile.gameCategory.slots",
      "category_id": "slots",
      "games": [
        "70147",
        "70071",
        "181053",
        "70007",
        "1193"
      ]
    },
    {
      "name": "mobile.gameCategory.tableGames",
      "category_id": "table-games",
      "games": [
        "181025",
        "181055",
        "120008"
      ]
    },
    {
      "name": "mobile.gameCategory.scratchCards",
      "category_id": "scratch-card",
      "games": [
        "70140",
        "70132",
        "70130"
      ]
    },
    {
      "name": "mobile.gameCategory.other",
      "category_id": "virtualgames",
      "games": [
        "181011",
        "182013"
      ]
    },
    {
      "name": "mobile.gameCategory.hiddenTab",
      "category_id": "hiddenTab",
      "games": [
        "181011",
        "182013"
      ]
    }
  ],
  "games": [
    {
      "id": "181025",
      "spec": {
        "provider_name": "Groove",
        "sub_provider_name": "Groove_QMG",
        "name": "European Roulette",
        "image_url": "[PROMO_URL]/lobby_images/nyx/1x2-gaming/european-roulette.png",
        "fun_real": "BOTH"
      }
    },
    {
      "id": "70132",
      "spec": {
        "provider_name": "Groove",
        "sub_provider_name": "Groove_QMG",
        "name": "Pixie Gold",
        "image_url": "[PROMO_URL]/lobby_images/nyx/lightningbox/pixie-gold.png",
        "fun_real": "BOTH"
      }
    }
  ]
}

Status 500

{
  "errMsg": "internal_error"
}

Response Parameters:

Name Type Description
structure.name string game category tag.
structure.category_id string game category name.
structure.games array list of game ids under the category.
games.id string game id unique identifier.
games.spec.name string game name.
games.spec.image_url string game logo.
games.spec.fun_real string indication if game supports fun play mode, options are: ‘REAL’/ ‘BOTH’.
games.spec.provider_name string the provider which game comes from.
games.spec.sub_provider_name string actual vendor game is be launched from.