Game Categories

Casino categories endpoints

Get popular casino categories

get

https://api.vaix.aihttps://staging-api.vaix.ai

/api/casino/categories/popular

Returns popular casino categories and their info.

Example

In this example we get the 50 most popular categories from RELAX game_studio.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/categories/popular?count=50&filters=game_studio%3Aeq%3ARELAX'

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

countinteger · min: 1Optional

Number of categories to return.

Default: 100Example: 5

filtersstring · enumOptional

Optional filtering of the games to retrieve. 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.

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

API response

statusstring · enumOptional

The status of the request

Possible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

406

Not Acceptable

application/json

413

Request Entity Too Large

application/json

422

Unprocessable Entity

application/json

425

Too Early

application/json

500

Internal Server Error

application/json

get

/api/casino/categories/popular

HTTPcURLJavaScriptPython

GET /api/casino/categories/popular HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*

{
  "data": [
    {
      "category": "slot",
      "confidence": 1
    },
    {
      "category": "blackjack",
      "confidence": 0.005784948519265471
    },
    {
      "category": "table",
      "confidence": 0.0021759898099989387
    }
  ],
  "status": "success"
}

Get recommended game categories

get

https://api.vaix.aihttps://staging-api.vaix.ai

/api/casino/categories/recommended

Returns personalized game categories 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 game categories 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 game categories for the user with id 0 without passing any extra parameters except the user

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/categories/recommended?user=0'

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

userstringOptional

The user to get recommendations for.

Default: 0

countinteger · min: 1Optional

Number of categories to return.

Default: 100Example: 5

filtersstring · enumOptional

Optional filtering of the games to retrieve. 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.

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

API response

statusstring · enumOptional

The status of the request

Possible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

406

Not Acceptable

application/json

413

Request Entity Too Large

application/json

422

Unprocessable Entity

application/json

425

Too Early

application/json

500

Internal Server Error

application/json

get

/api/casino/categories/recommended

HTTPcURLJavaScriptPython

GET /api/casino/categories/recommended HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*

{
  "data": [
    {
      "category": "slot",
      "confidence": 0.999753
    },
    {
      "category": "blackjack",
      "confidence": 0.0281452164
    },
    {
      "category": "roulette",
      "confidence": 0.0250989478
    },
    {
      "category": "na",
      "confidence": 0.00181271264
    }
  ],
  "status": "success"
}

Get trending casino categories

get

https://api.vaix.aihttps://staging-api.vaix.ai

/api/casino/categories/trending

Returns trending casino categories and their info.

Example

In this example we get the 50 most trending categories from RELAX game_studio.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/categories/trending?count=50&filters=game_studio%3Aeq%3ARELAX'

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

countinteger · min: 1Optional

Number of categories to return.

Default: 100Example: 5

filtersstring · enumOptional

Optional filtering of the games to retrieve. 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.

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

API response

statusstring · enumOptional

The status of the request

Possible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

406

Not Acceptable

application/json

413

Request Entity Too Large

application/json

422

Unprocessable Entity

application/json

425

Too Early

application/json

500

Internal Server Error

application/json

get

/api/casino/categories/trending

HTTPcURLJavaScriptPython

GET /api/casino/categories/trending HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*

{
  "data": [
    {
      "category": "slot",
      "confidence": 1
    },
    {
      "category": "baccarat",
      "confidence": 0.017424046849099196
    },
    {
      "category": "live",
      "confidence": 0.014762629419277728
    }
  ],
  "status": "success"
}

Get all casino categories

get

https://api.vaix.aihttps://staging-api.vaix.ai

/api/casino/offering/categories

Returns all casino categories and their info.

Example

In this example we get the 50 first categories from QUICKSPIN game_studio.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/offering/categories?count=50&filters=game_studio%3Aeq%3AQUICKSPIN'

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filtersstring · enumOptional

Optional filtering of the games to retrieve. 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:

typestring · enumOptional

Whether to return vaix or operator categories.

Default: operatorPossible values:

countinteger · min: 1Optional

Number of categories to return.

Default: 100Example: 5

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. +category.

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.

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

API response

statusstring · enumOptional

The status of the request

Possible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

406

Not Acceptable

application/json

413

Request Entity Too Large

application/json

422

Unprocessable Entity

application/json

425

Too Early

application/json

500

Internal Server Error

application/json

get

/api/casino/offering/categories

HTTPcURLJavaScriptPython

GET /api/casino/offering/categories HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*

{
  "data": [
    {
      "category": "baccarat"
    },
    {
      "category": "blackjack"
    },
    {
      "category": "live"
    },
    {
      "category": "na"
    },
    {
      "category": "roulette"
    }
  ],
  "status": "success"
}