Skip to content
Integration Package/RubyPlay Public API/Games/
Get Games
Last updated

Get Games

This endpoint provides GP with a list of available games and promotional details, including support for the buy feature, awarded feature, and free rounds. The returned information may vary depending on whether these features are activated for the brand, ensuring that only relevant data is provided.

API Call Sample:

curl -i -X GET \
  -u <username>:<password> \
  'https://asia.stage.rubyplay.io/api/v1/game?id=rp_140&freeRoundsEnabled=true&awardedFeatureEnabled=true&gameEventsEnabled=true'
Response
application/json
{
  "content": [
    {
      "id": "rp_140",
      "name": "Mad Hit Diamonds 96",
      "betSizes": {
        "EUR": [
          0.1,
          0.15,
          0.2,
          0.25,
          0.5,
          7.5,
          10,
          15,
          20,
          25,
          50,
          75,
          100,
          200,
          500
        ]
      },
      "freeRoundsEnabled": true,
      "awardedFeatureEnabled": true,
      "buyFeatures": [
        {
          "buyFeatureType": "freespin",
          "priceMultiplier": 50
        }
      ],
      "gameEventsEnabled": true,
      "gameEvents": [
        {
          "eventName": "ACTIVATOR",
          "probability": 1.2,
          "probabilityBuyFeature": 3.27
        }
      ]
    }
  ],
  "total": 0
}

Query Parameters:

idArray of strings

When this parameter is used only information for matching game IDs will be returned.

Example: "rp_140"
freeRoundsEnabledboolean

When this parameter is used, it filters games by whether Free Rounds are enabled or disabled.

Example: true
awardedFeatureEnabledboolean

When this parameter is used, it filters games by whether Awarded Feature is enabled or disabled.

Example: true
gameEventsEnabledboolean

When this parameter is used, it filters games by whether Game Events are enabled or disabled.

Example: true

Response Schema:

contentArray of objects(GameConfiguration)
totalinteger(int32)

Buy Feature Types

The following list of buy feature types is provided for informational purposes only. The available types and their behaviours may change over time as new game mechanics are introduced.

Feature TypeDescription
freespinA bonus feature that grants a set number of spins without wagering additional credits.
respinA feature in which specific reels or the entire grid spin again for one or more rounds without requiring additional wagers. Typically, only certain symbols appear on the reels during this feature. Each respin collects held symbols but does not award payouts until the final evaluation after all respins are completed.
minispinA smaller-scale respin mechanic that does not transition to a separate game field.
freespin_respinA hybrid feature where either free spins or respins can be awarded.
selectA choice-based mechanic in which players pick from multiple options to reveal prizes or trigger bonuses.
Previous page
Next page