Betslips

Betslips related endpoints

get
/api/sports/betslips/popular

Returns popular betslips.

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.

Generation failure

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
200

OK

application/json
get
/api/sports/betslips/popular
GET /api/sports/betslips/popular HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
  "data": {
    "betslips": [
      {
        "betslip": [
          {
            "begin": "2021-07-15T19:45:00Z",
            "bet_offer_id": null,
            "count": 16,
            "country": "Uruguay",
            "country_id": "sr:category:57",
            "event_id": "sr:match:28050238",
            "event_type": null,
            "league": "Segunda Division",
            "league_id": "sr:tournament:1908",
            "market": null,
            "market_id": null,
            "market_type": null,
            "market_type_id": 1,
            "outcome": null,
            "outcome_id": 2,
            "participant_ids": [
              "sr:competitor:25010",
              "sr:competitor:3232"
            ],
            "participants": [
              "Racing Club Montevideo",
              "Central Espanol FC"
            ],
            "period": null,
            "period_id": null,
            "quote": 1.95,
            "quote_group": "1.8-2.6",
            "selection_id": "30bae70a328c583d4e95a95adf9b831e",
            "side": "back",
            "sport": "Soccer",
            "sport_id": "sr:sport:1",
            "status": "closed",
            "uof_external_id": "uof:1/sr:sport:1/1/2"
          },
          {
            "begin": "2021-07-15T20:30:00Z",
            "bet_offer_id": null,
            "count": 7,
            "country": "Peru",
            "country_id": "sr:category:20",
            "event_id": "sr:match:27887784",
            "event_type": null,
            "league": "Segunda Division",
            "league_id": "sr:tournament:15235",
            "market": "total=1.5",
            "market_id": null,
            "market_type": null,
            "market_type_id": 18,
            "outcome": null,
            "outcome_id": 13,
            "participant_ids": [
              "sr:competitor:241860",
              "sr:competitor:655209"
            ],
            "participants": [
              "Comerciantes Unidos",
              "FC Carlos Stein"
            ],
            "period": null,
            "period_id": null,
            "quote": 1.4,
            "quote_group": "1.4-1.8",
            "selection_id": "c2ce507bbec320289fe1715f74621372",
            "side": "back",
            "sport": "Soccer",
            "sport_id": "sr:sport:1",
            "status": "closed",
            "uof_external_id": "uof:1/sr:sport:1/18/13?total=1.5"
          },
          {
            "begin": "2021-07-15T20:00:00Z",
            "bet_offer_id": null,
            "count": 10,
            "country": "Venezuela",
            "country_id": "sr:category:281",
            "event_id": "sr:match:27544044",
            "event_type": null,
            "league": "Primera Division",
            "league_id": "sr:tournament:231",
            "market": "total=1.5",
            "market_id": null,
            "market_type": null,
            "market_type_id": 18,
            "outcome": null,
            "outcome_id": 13,
            "participant_ids": [
              "sr:competitor:324069",
              "sr:competitor:6232"
            ],
            "participants": [
              "Ucv FC",
              "Mineros de Guayana"
            ],
            "period": null,
            "period_id": null,
            "quote": 1.47,
            "quote_group": "1.4-1.8",
            "selection_id": "d5c4ecc9bea489e86e316bf4ba1908f7",
            "side": "back",
            "sport": "Soccer",
            "sport_id": "sr:sport:1",
            "status": "closed",
            "uof_external_id": "uof:1/sr:sport:1/18/13?total=1.5"
          }
        ],
        "betslip_count": 36
      },
      {
        "betslip": [
          {
            "begin": "2021-07-15T09:00:00Z",
            "bet_offer_id": null,
            "count": 45,
            "country": "Simulated Reality League",
            "country_id": "sr:category:2123",
            "event_id": "sr:match:28111672",
            "event_type": null,
            "league": "Summer Srl Friendlies",
            "league_id": "sr:simple_tournament:104482",
            "market": null,
            "market_id": null,
            "market_type": null,
            "market_type_id": 1,
            "outcome": null,
            "outcome_id": 3,
            "participant_ids": [
              "sr:competitor:697115",
              "sr:competitor:696851"
            ],
            "participants": [
              "Fiorentina SRL",
              "Atalanta BC SRL"
            ],
            "period": null,
            "period_id": null,
            "quote": 1.25,
            "quote_group": "1.2-1.4",
            "selection_id": "8c4456022fbe11b4fa576528f8f437a7",
            "side": "back",
            "sport": "Soccer",
            "sport_id": "sr:sport:1",
            "status": "closed",
            "uof_external_id": "uof:1/sr:sport:1/1/3"
          },
          {
            "begin": "2021-07-15T09:00:00Z",
            "bet_offer_id": null,
            "count": 38,
            "country": "Australia",
            "country_id": "sr:category:34",
            "event_id": "sr:match:27998320",
            "event_type": null,
            "league": "Gold Coast Coast League, Reserves",
            "league_id": "sr:simple_tournament:31289",
            "market": null,
            "market_id": null,
            "market_type": null,
            "market_type_id": 1,
            "outcome": null,
            "outcome_id": 3,
            "participant_ids": [
              "sr:competitor:788302",
              "sr:competitor:342868"
            ],
            "participants": [
              "Tallebudgera Valley FC Reserves",
              "Mudgeeraba Reserve"
            ],
            "period": null,
            "period_id": null,
            "quote": 1.8,
            "quote_group": "1.8-2.6",
            "selection_id": "95c46de78cdbc7e471166c2929289322",
            "side": "back",
            "sport": "Soccer",
            "sport_id": "sr:sport:1",
            "status": "ended",
            "uof_external_id": "uof:1/sr:sport:1/1/3"
          },
          {
            "begin": "2021-07-15T09:00:00Z",
            "bet_offer_id": null,
            "count": 93,
            "country": "Australia",
            "country_id": "sr:category:34",
            "event_id": "sr:match:27901944",
            "event_type": null,
            "league": "Gold Coast Premier League, Reserves",
            "league_id": "sr:simple_tournament:31287",
            "market": null,
            "market_id": null,
            "market_type": null,
            "market_type_id": 1,
            "outcome": null,
            "outcome_id": 1,
            "participant_ids": [
              "sr:competitor:436408",
              "sr:competitor:266463"
            ],
            "participants": [
              "Palm Beach SC",
              "Broadbeach United"
            ],
            "period": null,
            "period_id": null,
            "quote": 1.52,
            "quote_group": "1.4-1.8",
            "selection_id": "cad0e2eaca5fa63aacf03bbb5cddbd1a",
            "side": "back",
            "sport": "Soccer",
            "sport_id": "sr:sport:1",
            "status": "ended",
            "uof_external_id": "uof:1/sr:sport:1/1/1"
          }
        ],
        "betslip_count": 21
      }
    ],
    "count": 2
  },
  "status": "success"
}
get
/api/sports/betslips/recommended

Returns personalized betslip recommendations.

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.

Partial betslip generation

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. 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:
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:
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/sports/betslips/recommended
GET /api/sports/betslips/recommended?user=text HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
  "data": {
    "betslips": [
      [
        {
          "event_id": "sr:match:27897346",
          "selection_id": "ffb48774a281a5594810b2d4b13bb950",
          "sport": "Soccer"
        },
        {
          "event_id": "sr:match:21516115",
          "selection_id": "6e5ca16e34855702209f267dd513d7c5",
          "sport": "Soccer"
        },
        {
          "event_id": "sr:match:21514507",
          "selection_id": "a694be6af2f10e7afbfa06c55e86d9ab",
          "sport": "Soccer"
        },
        {
          "event_id": "sr:match:24719116",
          "selection_id": "97139b2fcf98bcdb751e7cec6dea31af",
          "sport": "Rugby"
        },
        {
          "event_id": "sr:match:24726184",
          "selection_id": "8b70890a580369b169f85879541daefa",
          "sport": "Handball"
        }
      ]
    ],
    "count": 1
  },
  "status": "success"
}

Was this helpful?