Betslips

Betslips related endpoints

get
/api/sports/betslips/recommended

Returns personalized betslip recommendations.

circle-info

Betslip generation

Each betslip consists of a recommended event for the given user, along with similar events to this recommendation. The chosen market selection for each event is also the most confident for the given user.

circle-exclamation

Partial betslip generation

circle-info

Number of produced betslips

The count field that is returned along with the betslips indicates the number of successfully generated betslips.

circle-info

Personalized betslip length

The option to dynamically calculate the betslip's length based on the user's preferences is supported, using the personalized_length parameter. If used, the length of each betslip will be calculated based on the user's historical preferences and behavior.

Notice that the above calculation respects the length parameter.

If the generated length is outside the provided length range, it will be shifted to the closest boundary. For example, if the user's preferred length is 2, but the provided length range is 3-5, the closest valid length of the length range will be used (i.e. in this case, 3).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
fromstring · date-timeOptional

The minimum event's starting datetime.

from_offsetstringOptional

Considers events starting after the from timestamp plus the given minutes/hours/days. If not set defaults to 0 minutes. The value must be in range [-7d - 7d].

Default: 0Example: -2hPattern: ^[+-]?[0-9]+([.][0-9]+)?[smhd]?$
to_offsetstringOptional

Considers events starting till the from timestamp plus the given minutes/hours/days. If not set defaults to one day (24 hours). The value must be in range [-7d - 7d].

Default: 2dExample: 2dPattern: ^[+-]?[0-9]+([.][0-9]+)?[smhd]?$
hoursinteger · min: 1 · max: 72Optional

DEPRECATED: Considers events starting till the from timestamp plus the given hours. If not set defaults to one day (24 hours).

countinteger · min: 1 · max: 20Optional

How many betslips to return.

Default: 1Example: 1
lengthstringOptional

List including the number of selections each betslip should contain. Can be a number (e.g. 5) or a range (e.g. 2-4).

Default: 2-6Example: 2-10Pattern: ^(?<from>\d+)(-(?<to>\d+))?$
personalized_lengthbooleanOptional

If true, calculates the betslip's length dynamically based on user's preferences. If the generated length is outside the provided length range, it will be shifted to the closest boundary. For example, if the length range is [3-5] and the calculated length is 2, then it will be shifted to 3. Defaults to false.

Default: falseExample: true
max_payoutnumber · min: 1Optional

The max payout each betslip should have. Notice that the returned betslip might be of less than the requested length if the max_payout is exceeded.

min_payoutnumber · min: 1Optional

The minimum payout each betslip should have. Notice that the returned betslip might be of more than the requested length for the min_payout condition to be met.

unique_participantsbooleanOptional

If true, ensures that all participants will appear only once in the betslip. Defaults to false.

Default: false
userstringRequired

The user to get recommended betslips for.

filtersstring · enumOptional

Optional filtering on the events and markets to consider for producing the betslips. It expects a string adhering to the filtering format, as described in the filtering section, e.g. sport:eq:Soccer;market:eq:1X2.

Possible values:
exclude_n_popularintegerOptional

Excludes the top n popular selections from the results.

Default: 0
group_limitstring · enumOptional

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

Possible values:
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. event_id,event_type.

Default: ["event_id","event_type","begin","country","country_id","league","league_id","sport","sport_id","participants","participant_ids","status","selection_id","bet_offer_id","market","market_id","market_type","market_type_id","uof_external_id","outcome","outcome_id","period","period_id","quote","quote_group","side","count"]Possible 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. +begin,-league.

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.

event_typesstring · enumOptional

List of event types to consider when generating recommendations. One or more types can be provided. Available options are:

  • match: Standard matches to be considered.
  • seasonal: Seasonal events to be considered.
  • forced_events: Handpicked events to be considered regardless of their start_time.
Default: match,forced_eventsPossible values:
locationstringOptional

The location of the page where the request takes place.

Example: inplay_widget
rawstring · enumOptional

Comma separated list of keywords. If given, this input will be used as user demographics data for the recommendations, e.g country:gr,city:ath.

Possible values:
exclude_topstring · enumOptional

A string in the format 'field:value', where 'field' is a supported field and 'value' is a positive integer. Used for configuration, filtering, or limiting based on field values.

Example: sport_id:1Possible 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
chevron-right
200

OK

application/json

API response

statusstring · enumOptional

The status of the request

Possible values:
get
/api/sports/betslips/recommended
get
/api/sports/betslips/popular

Returns popular betslips.

circle-info

Betslip generation

Each betslip consists of a set of selections.

Popular betslips contains the most popular event combinations played. For each event in each betslip its most popular market is selected. If user is specified the top recommended market per event will be returned.

circle-exclamation

Generation failure

circle-info

Number of produced betslips

The count field that is returned along with the betslips indicates the number of successfully generated betslips.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
fromstring · date-timeOptional

The minimum event's starting datetime.

from_offsetstringOptional

Considers events starting after the from timestamp plus the given minutes/hours/days. If not set defaults to 0 minutes. The value must be in range [-7d - 7d].

Default: 0Example: -2hPattern: ^[+-]?[0-9]+([.][0-9]+)?[smhd]?$
to_offsetstringOptional

Considers events starting till the from timestamp plus the given minutes/hours/days. If not set defaults to one day (24 hours). The value must be in range [-7d - 7d].

Default: 2dExample: 2dPattern: ^[+-]?[0-9]+([.][0-9]+)?[smhd]?$
hoursinteger · min: 1 · max: 72Optional

DEPRECATED: Considers events starting till the from timestamp plus the given hours. If not set defaults to one day (24 hours).

countinteger · min: 1 · max: 20Optional

How many betslips to return.

Default: 1Example: 1
lengthstringOptional

List including the number of selections each betslip should contain. Can be a number (e.g. 5) or a range (e.g. 2-4).

Default: 2-6Example: 2-10Pattern: ^(?<from>\d+)(-(?<to>\d+))?$
max_payoutnumber · min: 1Optional

The max payout each betslip should have.

min_payoutnumber · min: 1Optional

The minimum payout each betslip should have.

unique_participantsbooleanOptional

If true, ensures that all participants will appear only once in the betslip. Defaults to false.

Default: false
filtersstring · enumOptional

Optional filtering on the events and markets to consider for producing the betslips. It expects a string adhering to the filtering format, as described in the filtering section, e.g. sport:eq:Soccer;market:eq:1X2.

Possible values:
userstringOptional

The user to get recommended betslips for.

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. event_id,event_type.

Default: ["event_id","event_type","begin","country","country_id","league","league_id","sport","sport_id","participants","participant_ids","status","selection_id","bet_offer_id","market","market_id","market_type","market_type_id","uof_external_id","outcome","outcome_id","period","period_id","quote","quote_group","side","count"]Possible 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. +begin,-league.

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
chevron-right
200

OK

application/json

API response

statusstring · enumOptional

The status of the request

Possible values:
get
/api/sports/betslips/popular

Last updated

Was this helpful?