Casino Games

Casino games related endpoints

Get all casino games

get
/api/casino/games

Returns all casino games and their info. The result is paginated so you will need to query the endpoint multiple times in order to fetch all the available games

Cache utilization

To best utilize the caching functionality, it is recommended to use a page_size of 100 (default value) for possible multiple queries on this endpoint.

Example

In this example we get the 100 first games on game_name ascending order.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/games?&page=1&page_size=100&order_by=%2Bgame_name'
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
filtersstring · enumOptional

Optional filtering of the games to retrieve. Can contain filters related to game, user, game properties or game statistics. It expects a string adhering to the filtering format, as described in the filtering section, e.g. enabled:eq:1.

Example: enabled:eq:1Possible values:
order_bystring · enumOptional

The columns to sort the results by. It expects a string adhering to the ordering format, as described in the ordering section, e.g. +game_name,-game_studio.

Possible values:
operatorstringOptional

The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.

bookmaker_idintegerOptional

The bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the sub_bookmaker_id parameter.

sub_bookmaker_idintegerOptional

The sub-bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the bookmaker_id parameter.

fieldsstring · enumOptional

Optional selection of the object fields to retrieve. It expects a comma separated list of strings, as described in the field selection section, e.g. game_id,game_name.

Default: game_idPossible values:
pageinteger · min: 1Optional

The page to retrieve. Notice that if set the random access pagination mechanism will be used. If not set the pagination mechanism default to the keyset mode.

page_sizeinteger · min: 1 · max: 1000Optional

The number of items ot include in each page.

Default: 100
page_cursorstringOptional

The cursor to get data from. It should be retrieved from the pagination section of a previous response in case of keyset pagination.

This value will be ignored if the page parameter has been provided and random access pagination will be used instead.

Notice that the the cursor is cryptographically signed and verified, make sure to set the exact value it was returned.

locationstringOptional

The location of the page where the request takes place.

Example: inplay_widget
Header parameters
x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses
200

OK

application/json
get
/api/casino/games
GET /api/casino/games HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
  "data": [
    {
      "category": "text",
      "channels": [
        "text"
      ],
      "enabled": 1,
      "first_transaction": "2025-11-18T15:03:13.885Z",
      "game_id": "text",
      "game_image_url": "text",
      "game_link": "text",
      "game_name": "text",
      "game_studio": "text",
      "has_avalanche": true,
      "has_bonus": true,
      "has_buy": true,
      "has_jackpot": true,
      "has_megaways": true,
      "has_sticky": true,
      "images": [
        {
          "type": "text",
          "url": "text"
        }
      ],
      "internal_game_id": "text",
      "is_live": true,
      "max_bet": 1,
      "min_bet": 1,
      "release_date": "2025-11-18T15:03:13.885Z",
      "vaix_category": "text",
      "vaix_game_studio": "text",
      "vaix_tags": [
        "text"
      ]
    }
  ],
  "status": "success"
}

Get frequently combined games

get
/api/casino/games/combined

Returns games that the users who have played the game with the given game_id have also played.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
game_idstringRequired

The game id for which we seek frequently combined games.

Example: MERGEyeofHorus
userstringOptional

The user to get recommendations for.

Default: 0
exclude_last_n_playedintegerOptional

The number of last games that user played to exclude from recommendations. This functionality works as expected only if the user parameter is given.

Default: 0
exclude_last_n_clickedintegerOptional

The number of last games that user clicked to exclude from recommendations. This functionality works as expected only if the user parameter is given.

Default: 0
countinteger · min: 1Optional

Number of games to return.

Default: 100Example: 5
dynamic_filtersstring · enumOptional

Optional dynamic filtering of the items to retrieve. If any dynamic filter is set, the filter's value will be dynamically calculated and used. Notice that for user related filters, the user query parameter must be provided. For example, dynamic_filters=user_country will return data related only to the user's specific country.

Possible values:
filtersstring · enumOptional

Optional filtering of the games to retrieve. Can contain filters related to game, user, game properties or game statistics. It expects a string adhering to the filtering format, as described in the filtering section, e.g. enabled:eq:1.

Example: enabled:eq:1Possible values:
operatorstringOptional

The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.

bookmaker_idintegerOptional

The bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the sub_bookmaker_id parameter.

sub_bookmaker_idintegerOptional

The sub-bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the bookmaker_id parameter.

fieldsstring · enumOptional

Optional selection of the object fields to retrieve. It expects a comma separated list of strings, as described in the field selection section, e.g. game_id,game_name.

Default: game_id,confidencePossible values:
locationstringOptional

The location of the page where the request takes place.

Example: inplay_widget
Header parameters
x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses
200

OK

application/json
get
/api/casino/games/combined
GET /api/casino/games/combined?game_id=text HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
  "data": [
    {
      "confidence": 1,
      "game_id": "top_cat_ogs_ogs"
    },
    {
      "confidence": 0.6666666666666666,
      "game_id": "king_kong_cash_ogs"
    },
    {
      "confidence": 0.3333333333333333,
      "game_id": "el_jackpotto_ogs"
    },
    {
      "confidence": 0.3333333333333333,
      "game_id": "ted_ogs"
    },
    {
      "confidence": 0,
      "game_id": "wish_upon_a_leprechaun_ogs"
    }
  ],
  "status": "success"
}

Get hot games

get
/api/casino/games/hot

Returns games with high playing rtp for the given time frame.

The games are sorted by the rtp ratio.

Rtp

The ratio of sum(total_winning_amount)/sum(total_wagering_amount) over the game sessions of a given time frame for each game.

Filtering example

In this example we get all hot games where game_studio is NetEnt.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/games/hot?filters=game_studio%3Aeq%3ANetEnt'
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
userstringOptional

The user to get recommendations for.

Default: 0
exclude_last_n_playedintegerOptional

The number of last games that user played to exclude from recommendations. This functionality works as expected only if the user parameter is given.

Default: 0
exclude_last_n_clickedintegerOptional

The number of last games that user clicked to exclude from recommendations. This functionality works as expected only if the user parameter is given.

Default: 0
countinteger · min: 1Optional

Number of games to return.

Default: 100Example: 5
filtersstring · enumOptional

Optional filtering of the games to retrieve. Can contain filters related to game, user, game properties or game statistics. It expects a string adhering to the filtering format, as described in the filtering section, e.g. enabled:eq:1.

Example: enabled:eq:1Possible values:
dynamic_filtersstring · enumOptional

Optional dynamic filtering of the items to retrieve. If any dynamic filter is set, the filter's value will be dynamically calculated and used. Notice that for user related filters, the user query parameter must be provided. For example, dynamic_filters=user_country will return data related only to the user's specific country.

Possible values:
reorder_bystring · enumOptional

Optional re ordering of the results based on one or more metrics. Expected format is a comma separated list of keywords where each value should be a float in the range [0,1]. e.g. recommended:0.3. For more information head to the ordering documentation section.

Possible values:
ranking_filterstring · enumOptional

Optional filtering of the results based on the ranking of the given entities. It expects a string adhering to the ranking format, as described in the ranking filtering section, e.g. game_studio_recommended:1.

Possible values:
ignore_user_filter_thresholdbooleanOptional

When user related filters are defined they get applied only if one of the following conditions are met:

  • ignore_user_filter_threshold=true
  • The count of game sessions when applying those filters is statistically significant.
Default: false
group_limitstring · enumOptional

Applies a limit to a group of items. For more information, head to Limiting -> Group Limiting section of the docs. game_studio:5,category:2.

Possible values:
operatorstringOptional

The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.

bookmaker_idintegerOptional

The bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the sub_bookmaker_id parameter.

sub_bookmaker_idintegerOptional

The sub-bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the bookmaker_id parameter.

fieldsstring · enumOptional

Optional selection of the object fields to retrieve. It expects a comma separated list of strings, as described in the field selection section, e.g. game_id,game_name.

Default: game_id,confidencePossible values:
locationstringOptional

The location of the page where the request takes place.

Example: inplay_widget
Header parameters
x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses
200

OK

application/json
get
/api/casino/games/hot
GET /api/casino/games/hot HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
  "data": [
    {
      "confidence": 1,
      "game_id": "adventure_palace_micro"
    },
    {
      "confidence": 0.975268467295802,
      "game_id": "red_hot_chilli_steppa_ogs"
    },
    {
      "confidence": 0.6945687076323521,
      "game_id": "sunset_delight_ogs"
    }
  ],
  "status": "success"
}

Get new games

get
/api/casino/games/new

Returns new casino games.

Games are ordered by their newness score. Only games released within the last given days are considered.

Filtering example

In this example we get all new games where game_studio is NetEnt.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/games/new?filters=game_studio%3Aeq%3ANetEnt'
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
filtersstring · enumOptional

Optional filtering of the games to retrieve. Can contain filters related to game, user, game properties or game statistics. It expects a string adhering to the filtering format, as described in the filtering section, e.g. enabled:eq:1.

Example: enabled:eq:1Possible values:
daysinteger · min: 1 · max: 360Optional

How many days before to search for new games. Defaults to 60.

Default: 60
countinteger · min: 1Optional

Number of games to return.

Default: 100Example: 5
userstringOptional

The user to get recommendations for.

Default: 0
exclude_last_n_playedintegerOptional

The number of last games that user played to exclude from recommendations. This functionality works as expected only if the user parameter is given.

Default: 0
exclude_last_n_clickedintegerOptional

The number of last games that user clicked to exclude from recommendations. This functionality works as expected only if the user parameter is given.

Default: 0
dynamic_filtersstring · enumOptional

Optional dynamic filtering of the items to retrieve. If any dynamic filter is set, the filter's value will be dynamically calculated and used. Notice that for user related filters, the user query parameter must be provided. For example, dynamic_filters=user_country will return data related only to the user's specific country.

Possible values:
operatorstringOptional

The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.

bookmaker_idintegerOptional

The bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the sub_bookmaker_id parameter.

sub_bookmaker_idintegerOptional

The sub-bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the bookmaker_id parameter.

fieldsstring · enumOptional

Optional selection of the object fields to retrieve. It expects a comma separated list of strings, as described in the field selection section, e.g. game_id,game_name.

Default: game_id,confidencePossible values:
locationstringOptional

The location of the page where the request takes place.

Example: inplay_widget
reorder_bystring · enumOptional

Optional re ordering of the results based on one or more metrics. Expected format is a comma separated list of keywords where each value should be a float in the range [0,1]. e.g. recommended:0.3,popular:0.2. For more information head to the ordering documentation section.

Possible values:
ranking_filterstring · enumOptional

Optional filtering of the results based on the ranking of the given entities. It expects a string adhering to the ranking format, as described in the ranking filtering section, e.g. game_studio_recommended:1.

Possible values:
group_limitstring · enumOptional

Applies a limit to a group of items. For more information, head to Limiting -> Group Limiting section of the docs. game_studio:5,category:2.

Possible values:
Header parameters
x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses
200

OK

application/json
get
/api/casino/games/new
GET /api/casino/games/new HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
  "data": [
    {
      "confidence": 1,
      "game_id": "immortal_romance_micro"
    },
    {
      "confidence": 0.75,
      "game_id": "sisters_of_oz_jackpots_micro"
    },
    {
      "confidence": 0.6944,
      "game_id": "rock_the_reels_megaways_ogs"
    },
    {
      "confidence": 0,
      "game_id": "rise_of_giza_power_nudge_pragmatic"
    },
    {
      "confidence": 0,
      "game_id": "mystic_staxx_redtiger"
    }
  ],
  "status": "success"
}
get
/api/casino/games/popular

Returns popular games for the given time frame.

The games are sorted by popularity.

Popularity

The metric used to measure popularity is the number of sessions played on each game.

Filtering example

In this example we get all popular games where game_studio is NetEnt.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/games/popular?filters=game_studio%3Aeq%3ANetEnt'
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
userstringOptional

The user to get recommendations for.

Default: 0
exclude_last_n_playedintegerOptional

The number of last games that user played to exclude from recommendations. This functionality works as expected only if the user parameter is given.

Default: 0
exclude_last_n_clickedintegerOptional

The number of last games that user clicked to exclude from recommendations. This functionality works as expected only if the user parameter is given.

Default: 0
countinteger · min: 1Optional

Number of games to return.

Default: 100Example: 5
filtersstring · enumOptional

Optional filtering of the games to retrieve. Can contain filters related to game, user, game properties or game statistics. It expects a string adhering to the filtering format, as described in the filtering section, e.g. enabled:eq:1.

Example: enabled:eq:1Possible values:
ignore_user_filter_thresholdbooleanOptional

When user related filters are defined they get applied only if one of the following conditions are met:

  • ignore_user_filter_threshold=true
  • The count of game sessions when applying those filters is statistically significant.
Default: false
reorder_bystring · enumOptional

Optional re ordering of the results based on one or more metrics. Expected format is a comma separated list of keywords where each value should be a float in the range [0,1]. e.g. recommended:0.3. For more information head to the ordering documentation section.

Possible values:
ranking_filterstring · enumOptional

Optional filtering of the results based on the ranking of the given entities. It expects a string adhering to the ranking format, as described in the ranking filtering section, e.g. game_studio_recommended:1.

Possible values:
group_limitstring · enumOptional

Applies a limit to a group of items. For more information, head to Limiting -> Group Limiting section of the docs. game_studio:5,category:2.

Possible values:
dynamic_filtersstring · enumOptional

Optional dynamic filtering of the items to retrieve. If any dynamic filter is set, the filter's value will be dynamically calculated and used. Notice that for user related filters, the user query parameter must be provided. For example, dynamic_filters=user_country will return data related only to the user's specific country.

Possible values:
operatorstringOptional

The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.

bookmaker_idintegerOptional

The bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the sub_bookmaker_id parameter.

sub_bookmaker_idintegerOptional

The sub-bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the bookmaker_id parameter.

fieldsstring · enumOptional

Optional selection of the object fields to retrieve. It expects a comma separated list of strings, as described in the field selection section, e.g. game_id,game_name.

Default: game_id,confidencePossible values:
locationstringOptional

The location of the page where the request takes place.

Example: inplay_widget
Header parameters
x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses
200

OK

application/json
get
/api/casino/games/popular
GET /api/casino/games/popular HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
  "data": [
    {
      "confidence": 1,
      "game_id": "gemix_2_playngo"
    },
    {
      "confidence": 0.7348172928461143,
      "game_id": "luck_o_the_irish_fortune_spins_ii_ogs"
    },
    {
      "confidence": 0.529336078229542,
      "game_id": "gates_of_olympus_ogs"
    }
  ],
  "status": "success"
}
get
/api/casino/games/recommended

Returns personalized game recommendations.

Confidence

Each returned item is associated with a number from 0 to 1 indicating the confidence of the system in this specific recommendation. The higher the number the more confident the recommendation of it.

Result ordering

By default games are sorted based on confidence, with the most confident one on top. The order_by parameter can be used to order the results in the desired order.

Getting recommendations for a user

In this example we get all recommended games for the user with id 0 without passing any extra parameters except the user

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/games/recommended?user=0'
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
userstringOptional

The user to get recommendations for.

Default: 0
exclude_last_n_playedintegerOptional

The number of last games that user played to exclude from recommendations. This functionality works as expected only if the user parameter is given.

Default: 0
exclude_last_n_clickedintegerOptional

The number of last games that user clicked to exclude from recommendations. This functionality works as expected only if the user parameter is given.

Default: 0
countinteger · min: 1Optional

Number of games to return.

Default: 100Example: 5
filtersstring · enumOptional

Optional filtering of the games to retrieve. Can contain filters related to game, user, game properties or game statistics. It expects a string adhering to the filtering format, as described in the filtering section, e.g. enabled:eq:1.

Example: enabled:eq:1Possible values:
dynamic_filtersstring · enumOptional

Optional dynamic filtering of the items to retrieve. If any dynamic filter is set, the filter's value will be dynamically calculated and used. Notice that for user related filters, the user query parameter must be provided. For example, dynamic_filters=user_country will return data related only to the user's specific country.

Possible values:
reorder_bystring · enumOptional

Optional re ordering of the results based on one or more metrics. Expected format is a comma separated list of keywords where each value should be a float in the range [0,1]. e.g. popular:0.3,trending:0.2. For more information head to the ordering documentation section.

Possible values:
ranking_filterstring · enumOptional

Optional filtering of the results based on the ranking of the given entities. It expects a string adhering to the ranking format, as described in the ranking filtering section, e.g. game_studio_recommended:1.

Possible values:
operatorstringOptional

The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.

bookmaker_idintegerOptional

The bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the sub_bookmaker_id parameter.

sub_bookmaker_idintegerOptional

The sub-bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the bookmaker_id parameter.

fieldsstring · enumOptional

Optional selection of the object fields to retrieve. It expects a comma separated list of strings, as described in the field selection section, e.g. game_id,game_name.

Default: game_id,confidencePossible values:
locationstringOptional

The location of the page where the request takes place.

Example: inplay_widget
Header parameters
x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses
200

OK

application/json
get
/api/casino/games/recommended
GET /api/casino/games/recommended HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
  "data": [
    {
      "confidence": 0.0904352516,
      "game_id": "rock_the_reels_megaways_ogs"
    },
    {
      "confidence": 0.00316744787,
      "game_id": "immortal_romance_micro"
    },
    {
      "confidence": 0.00187697588,
      "game_id": "mystic_staxx_redtiger"
    },
    {
      "confidence": 0.000661108294,
      "game_id": "sisters_of_oz_jackpots_micro"
    },
    {
      "confidence": 0.0000386962165,
      "game_id": "rise_of_giza_power_nudge_pragmatic"
    }
  ],
  "status": "success"
}

Get similar games

get
/api/casino/games/similar

Returns similar games for the given game id(s).

The games are sorted by distance ascending.

Distance

The metric used to measure similarity between items is called distance. It is a system indicator on how similar the item is to the input.

The smaller the number the more similar the item.

The normalized value of the item's distance to the input is also assigned to each selection as its confidence.

Query example

In this example we get the similar games to the game with id book_of_dead_play_n_go

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/games/similar?game_ids=book_of_dead_play_n_go'
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
game_idsstringRequired

Comma separated list of game ids for which to return similar games. If multiple games are provided the games returned are going to be the ones with the shortest average distance to all of the provided games.

userstringOptional

The user to get recommendations for.

Default: 0
exclude_last_n_playedintegerOptional

The number of last games that user played to exclude from recommendations. This functionality works as expected only if the user parameter is given.

Default: 0
exclude_last_n_clickedintegerOptional

The number of last games that user clicked to exclude from recommendations. This functionality works as expected only if the user parameter is given.

Default: 0
countinteger · min: 1Optional

Number of games to return.

Default: 100Example: 5
filtersstring · enumOptional

Optional filtering of the games to retrieve. Can contain filters related to game, user, game properties or game statistics. It expects a string adhering to the filtering format, as described in the filtering section, e.g. enabled:eq:1.

Example: enabled:eq:1Possible values:
dynamic_filtersstring · enumOptional

Optional dynamic filtering of the items to retrieve. If any dynamic filter is set, the filter's value will be dynamically calculated and used. Notice that for user related filters, the user query parameter must be provided. For example, dynamic_filters=user_country will return data related only to the user's specific country.

Possible values:
include_inputbooleanOptional

If it's true include input items in response. By default is set to false.

Default: false
operatorstringOptional

The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.

bookmaker_idintegerOptional

The bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the sub_bookmaker_id parameter.

sub_bookmaker_idintegerOptional

The sub-bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the bookmaker_id parameter.

fieldsstring · enumOptional

Optional selection of the object fields to retrieve. It expects a comma separated list of strings, as described in the field selection section, e.g. game_id,game_name.

Default: game_id,confidencePossible values:
locationstringOptional

The location of the page where the request takes place.

Example: inplay_widget
Header parameters
x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses
200

OK

application/json
get
/api/casino/games/similar
GET /api/casino/games/similar?game_ids=text HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
  "data": [],
  "status": "success"
}
get
/api/casino/games/trending

Returns trending games for the given time frame.

The games are sorted by trending score.

Trending score

To calculate trending score for a game, each session played on this game contributes a value determined by how recently the session was played.

Recent sessions add more value than older ones.

Filtering example

In this example we get all trending games where game_studio is NetEnt.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/games/trending?filters=game_studio%3Aeq%3ANetEnt'
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
userstringOptional

The user to get recommendations for.

Default: 0
exclude_last_n_playedintegerOptional

The number of last games that user played to exclude from recommendations. This functionality works as expected only if the user parameter is given.

Default: 0
exclude_last_n_clickedintegerOptional

The number of last games that user clicked to exclude from recommendations. This functionality works as expected only if the user parameter is given.

Default: 0
countinteger · min: 1Optional

Number of games to return.

Default: 100Example: 5
filtersstring · enumOptional

Optional filtering of the games to retrieve. Can contain filters related to game, user, game properties or game statistics. It expects a string adhering to the filtering format, as described in the filtering section, e.g. enabled:eq:1.

Example: enabled:eq:1Possible values:
reorder_bystring · enumOptional

Optional re ordering of the results based on one or more metrics. Expected format is a comma separated list of keywords where each value should be a float in the range [0,1]. e.g. recommended:0.3. For more information head to the ordering documentation section.

Possible values:
ranking_filterstring · enumOptional

Optional filtering of the results based on the ranking of the given entities. It expects a string adhering to the ranking format, as described in the ranking filtering section, e.g. game_studio_recommended:1.

Possible values:
ignore_user_filter_thresholdbooleanOptional

When user related filters are defined they get applied only if one of the following conditions are met:

  • ignore_user_filter_threshold=true
  • The count of game sessions when applying those filters is statistically significant.
Default: false
dynamic_filtersstring · enumOptional

Optional dynamic filtering of the items to retrieve. If any dynamic filter is set, the filter's value will be dynamically calculated and used. Notice that for user related filters, the user query parameter must be provided. For example, dynamic_filters=user_country will return data related only to the user's specific country.

Possible values:
group_limitstring · enumOptional

Applies a limit to a group of items. For more information, head to Limiting -> Group Limiting section of the docs. game_studio:5,category:2.

Possible values:
operatorstringOptional

The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.

bookmaker_idintegerOptional

The bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the sub_bookmaker_id parameter.

sub_bookmaker_idintegerOptional

The sub-bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the bookmaker_id parameter.

fieldsstring · enumOptional

Optional selection of the object fields to retrieve. It expects a comma separated list of strings, as described in the field selection section, e.g. game_id,game_name.

Default: game_id,confidencePossible values:
locationstringOptional

The location of the page where the request takes place.

Example: inplay_widget
trending_withinstringOptional

Considers game sessions played after the current timestamp minus the given minutes/hours/days. If not set defaults to 2 days. The value must be in range [1m - 7d].

Default: 2dExample: 3hPattern: ^[+-]?[0-9]+([.][0-9]+)?[smhd]?$
Header parameters
x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses
200

OK

application/json
get
/api/casino/games/trending
GET /api/casino/games/trending HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
  "data": [
    {
      "confidence": 1,
      "game_id": "gemix_2_playngo"
    },
    {
      "confidence": 0.7369833588565594,
      "game_id": "luck_o_the_irish_fortune_spins_ii_ogs"
    },
    {
      "confidence": 0.3201886676875957,
      "game_id": "hero_clash_quickspin"
    },
    {
      "confidence": 0.2757782542113323,
      "game_id": "coin_bash_micro"
    },
    {
      "confidence": 0.2720775906074528,
      "game_id": "tiki_infinity_reels_megaways_yggdrasil"
    }
  ],
  "status": "success"
}

Was this helpful?