Sports Offering

Sports offering related endpoints

Get available leagues

get
/api/sports/offering/leagues

Returns available leagues for the given time frame.

Leagues are extracted from the available events. Only events starting between the requested time range will be considered.

Count

If count is not specified, the endpoint will return up to 5000 leagues.

Filtering example

In this example we get all Soccer leagues.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/sports/offering/leagues?filters=sport%3Aeq%3ASoccer'

Ordering example

In this example we get all leagues ordered by sport.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/sports/offering/leagues/?order_by=%2Bsport'
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
fromstring · date-timeOptional

Leagues with events starting after this datetime will be returned.

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: -180mPattern: ^[+-]?[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).

filtersstring · enumOptional

Optional filtering of the leagues to retrieve. It expects a string adhering to the filtering format, as described in the filtering section, e.g. sport:eq:Soccer.

Example: country:eq:EnglandPossible values:
countinteger · min: 1 · max: 5000Optional

Number of leagues to return.

Default: 5000
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:
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. +country,-country_id.

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. country,country_id.

Possible 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/sports/offering/leagues
GET /api/sports/offering/leagues HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
  "data": [
    {
      "country": "International",
      "country_id": "sr:category:1715",
      "league": "3X3 Challengers, Poitiers",
      "league_id": "sr:simple_tournament:103832",
      "sport": "Basketball 3x3",
      "sport_id": "sr:sport:155"
    },
    {
      "country": "New Zealand",
      "country_id": "sr:category:148",
      "league": "Mainland Premier League",
      "league_id": "sr:simple_tournament:20462",
      "sport": "Soccer",
      "sport_id": "sr:sport:1"
    },
    {
      "country": "Iceland",
      "country_id": "sr:category:10",
      "league": "4 Deild, Group C",
      "league_id": "sr:simple_tournament:25543",
      "sport": "Soccer",
      "sport_id": "sr:sport:1"
    },
    {
      "country": "Portugal",
      "country_id": "sr:category:286",
      "league": "2A Divisao",
      "league_id": "sr:simple_tournament:29547",
      "sport": "Handball",
      "sport_id": "sr:sport:6"
    },
    {
      "country": "Gambia",
      "country_id": "sr:category:957",
      "league": "Gfa League First Division",
      "league_id": "sr:simple_tournament:32174",
      "sport": "Soccer",
      "sport_id": "sr:sport:1"
    }
  ],
  "status": "success"
}

Get available events

get
/api/sports/offering/events

Returns available events for the given time frame.

Pagination

The endpoint supports both keyset-based and offset-based pagination.

For keyset-based pagination, use the page_size parameter to specify the number of events per page. If page_size is not specified, the default value is 100.

For offset-based pagination, use the page_size and page parameters to specify the number of events per page and the page number, respectively.

Filtering example

In this example we get 5 Soccer events beginning after 2020-07-02 19:00:00.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/sports/offering/events?from=2020-07-02%2019%3A00%3A00&page_size=5&filters=sport%3Aneq%3ASoccer'

Ordering example

In this example we get 5 events beginning after 2020-07-02 19:00:00 ordered by sport.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/sports/offering/events?from=2020-07-02%2019%3A00%3A00&page_size=5&sorting=%2Bsport'
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
fromstring · date-timeOptional

The minimum event's starting datetime. If not explicitly set it defaults to now.

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: -3hPattern: ^[+-]?[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: 1Optional

Number of events to return.

Default: 100Example: 5
filtersstring · enumOptional

Optional filtering of the events to retrieve. It expects a string adhering to the filtering format, as described in the filtering section, e.g. sport:eq:Soccer.

Example: sport:in:Soccer,BasketballPossible 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:
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. +event_id,-event_type.

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"]Possible values:
locationstringOptional

The location of the page where the request takes place.

Example: inplay_widget
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.

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/offering/events
GET /api/sports/offering/events HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
  "data": [
    {
      "begin": "2020-08-02T19:00:00Z",
      "country": "Sweden",
      "country_id": "sr:category:9",
      "event_id": "sr:match:20719039",
      "event_type": null,
      "league": "Allsvenskan",
      "league_id": "sr:tournament:40",
      "participant_ids": [
        "sr:competitor:1793",
        "sr:competitor:1783"
      ],
      "participants": [
        "IK Sirius FK",
        "Mjallby AIF"
      ],
      "sport": "Soccer",
      "sport_id": "sr:sport:1",
      "status": "cancelled"
    },
    {
      "begin": "2020-08-02T19:00:00Z",
      "country": "Sweden",
      "country_id": "sr:category:9",
      "event_id": "sr:match:20719041",
      "event_type": null,
      "league": "Allsvenskan",
      "league_id": "sr:tournament:40",
      "participant_ids": [
        "sr:competitor:1760",
        "sr:competitor:1762"
      ],
      "participants": [
        "BK Hacken",
        "IF Elfsborg"
      ],
      "sport": "Soccer",
      "sport_id": "sr:sport:1",
      "status": "cancelled"
    },
    {
      "begin": "2020-08-02T19:00:00Z",
      "country": "Sweden",
      "country_id": "sr:category:9",
      "event_id": "sr:match:20719045",
      "event_type": null,
      "league": "Allsvenskan",
      "league_id": "sr:tournament:40",
      "participant_ids": [
        "sr:competitor:1812",
        "sr:competitor:1768"
      ],
      "participants": [
        "Falkenbergs FF",
        "Orebro SK"
      ],
      "sport": "Soccer",
      "sport_id": "sr:sport:1",
      "status": "cancelled"
    },
    {
      "begin": "2020-08-02T19:00:00Z",
      "country": "Sweden",
      "country_id": "sr:category:9",
      "event_id": "sr:match:20719047",
      "event_type": null,
      "league": "Allsvenskan",
      "league_id": "sr:tournament:40",
      "participant_ids": [
        "sr:competitor:1764",
        "sr:competitor:1890"
      ],
      "participants": [
        "AIK",
        "Helsingborgs IF"
      ],
      "sport": "Soccer",
      "sport_id": "sr:sport:1",
      "status": "cancelled"
    },
    {
      "begin": "2020-08-02T19:00:00Z",
      "country": "Sweden",
      "country_id": "sr:category:9",
      "event_id": "sr:match:20719051",
      "event_type": null,
      "league": "Allsvenskan",
      "league_id": "sr:tournament:40",
      "participant_ids": [
        "sr:competitor:1892",
        "sr:competitor:1758"
      ],
      "participants": [
        "Malmo FF",
        "Hammarby IF"
      ],
      "sport": "Soccer",
      "sport_id": "sr:sport:1",
      "status": "cancelled"
    }
  ],
  "pagination": {
    "next": "g3QAAAABaAJ3BmV2ZW50c3cCaWRtAAAAEXNyOm1hdGNoOjIwNzE5MDUx",
    "page_size": 5,
    "total_count": 2184
  },
  "status": "success"
}

Get info for the given competitors

get
/api/sports/offering/competitors

Returns various information for the given competitor ids.

Multiple competitor ids input

In case multiple competitor ids are given as input, the results for each one are returned in the order their ids were provided.

Competitor id provider

By default it is considered that the given ids refers to sportradar competitors. If this is not the case then the provider query parameter should be given.

Note that currently only sportradar and kambi ids are supported.

Invalid input

If a competitor id is invalid or no info is found then an empty map will be returned.

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

Comma separated list of competitor ids for which to return information.

Example: sr:competitor:3202
providerstring · enumOptional

The data provider of the given competitor ids.

Default: sportradarExample: sportradarPossible 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. abbreviation,age_group.

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/offering/competitors
GET /api/sports/offering/competitors?competitor_ids=text HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
  "data": [
    {
      "abbreviation": "RIV",
      "age_group": null,
      "country": "Argentina",
      "country_code": "ARG",
      "gender": "male",
      "id": "sr:competitor:3211",
      "jerseys": [
        {
          "base_color": "140101",
          "competitor_id": "sr:competitor:3211",
          "horizontal_stripes_color": null,
          "id": "e7057df88b19a75dd90c717967ae38e4",
          "number_color": "f3e9e9",
          "shirt_type": "short_sleeves",
          "sleeve_color": "f60707",
          "sleeve_detail_color": "ec0d0d",
          "split_color": null,
          "squares_color": null,
          "stripes_color": null,
          "type": "third"
        },
        {
          "base_color": "00cf88",
          "competitor_id": "sr:competitor:3211",
          "horizontal_stripes_color": null,
          "id": "f604ec23e87fdcb335d7ced5e7ec8bc7",
          "number_color": "ffffff",
          "shirt_type": "short_sleeves",
          "sleeve_color": "000000",
          "sleeve_detail_color": null,
          "split_color": null,
          "squares_color": null,
          "stripes_color": null,
          "type": "goalkeeper"
        },
        {
          "base_color": "000000",
          "competitor_id": "sr:competitor:3211",
          "horizontal_stripes_color": null,
          "id": "d7087667e04cad8a64fea85b4499c2bf",
          "number_color": "ffffff",
          "shirt_type": "short_sleeves",
          "sleeve_color": "000000",
          "sleeve_detail_color": null,
          "split_color": null,
          "squares_color": null,
          "stripes_color": null,
          "type": "away"
        },
        {
          "base_color": "ffffff",
          "competitor_id": "sr:competitor:3211",
          "horizontal_stripes_color": null,
          "id": "02dfaf828662efe2f74353be4aa76a99",
          "number_color": "000000",
          "shirt_type": "short_sleeves",
          "sleeve_color": "ffffff",
          "sleeve_detail_color": "ffffff",
          "split_color": null,
          "squares_color": null,
          "stripes_color": null,
          "type": "home"
        }
      ],
      "manager": {
        "competitor_id": "sr:competitor:3211",
        "country_code": "ARG",
        "id": "sr:player:19439",
        "name": "Gallardo, Marcelo",
        "nationality": "Argentina"
      },
      "name": "CA River Plate (ARG)",
      "players": [
        {
          "birthdate": "2002-01-16",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:2159318",
          "jersey_number": 35,
          "name": "Gomez, Agustin",
          "nationality": "Argentina",
          "nickname": null,
          "position": "goalkeeper",
          "weight": null
        },
        {
          "birthdate": "1997-05-20",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:1627216",
          "jersey_number": 33,
          "name": "Centurion, Ezequiel Ignacio",
          "nationality": "Argentina",
          "nickname": null,
          "position": "goalkeeper",
          "weight": 79
        },
        {
          "birthdate": "1996-02-01",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:928310",
          "jersey_number": 32,
          "name": "Pochettino, Tomas",
          "nationality": "Argentina",
          "nickname": null,
          "position": "midfielder",
          "weight": 71
        },
        {
          "birthdate": "2002-06-13",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:1957475",
          "jersey_number": 31,
          "name": "Simon, Santiago",
          "nationality": "Argentina",
          "nickname": null,
          "position": "forward",
          "weight": 74
        },
        {
          "birthdate": "1994-06-09",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:365862",
          "jersey_number": 29,
          "name": "Gomez, Elias Jose",
          "nationality": "Argentina",
          "nickname": null,
          "position": "defender",
          "weight": 82
        },
        {
          "birthdate": "2001-04-05",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:2159324",
          "jersey_number": 28,
          "name": "Pena Biafore, Felipe",
          "nationality": "Argentina",
          "nickname": null,
          "position": "defender",
          "weight": 77
        },
        {
          "birthdate": "1991-02-16",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:954976",
          "jersey_number": 27,
          "name": "Aliendro, Rodrigo German",
          "nationality": "Argentina",
          "nickname": null,
          "position": "midfielder",
          "weight": 70
        },
        {
          "birthdate": "1998-12-15",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:1649242",
          "jersey_number": 26,
          "name": "Paradela, Jose Antonio",
          "nationality": "Argentina",
          "nickname": null,
          "position": "midfielder",
          "weight": 71
        },
        {
          "birthdate": "1986-02-22",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:33958",
          "jersey_number": 24,
          "name": "Perez, Enzo Nicolas",
          "nationality": "Argentina",
          "nickname": null,
          "position": "midfielder",
          "weight": 77
        },
        {
          "birthdate": "1996-02-10",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:358914",
          "jersey_number": 23,
          "name": "Mammana, Emanuel",
          "nationality": "Argentina",
          "nickname": null,
          "position": "defender",
          "weight": 70
        },
        {
          "birthdate": "1983-02-24",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:8891",
          "jersey_number": 22,
          "name": "Pinola, Javier Horacio",
          "nationality": "Argentina",
          "nickname": null,
          "position": "defender",
          "weight": 79
        },
        {
          "birthdate": "1999-03-29",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:1029361",
          "jersey_number": 21,
          "name": "Barco, Ezequiel",
          "nationality": "Argentina",
          "nickname": null,
          "position": "midfielder",
          "weight": 67
        },
        {
          "birthdate": "1988-04-11",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:122710",
          "jersey_number": 20,
          "name": "Casco, Milton Oscar",
          "nationality": "Argentina",
          "nickname": null,
          "position": "defender",
          "weight": 69
        },
        {
          "birthdate": "1991-06-15",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:802520",
          "jersey_number": 19,
          "name": "Romero, Braian Ezequiel",
          "nationality": "Argentina",
          "nickname": null,
          "position": "forward",
          "weight": 75
        },
        {
          "birthdate": "2001-03-29",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:1938652",
          "jersey_number": 18,
          "name": "Beltran, Lucas",
          "nationality": "Argentina",
          "nickname": null,
          "position": "forward",
          "weight": 77
        },
        {
          "birthdate": "2000-07-09",
          "competitor_id": "sr:competitor:3211",
          "country_code": "COL",
          "gender": "male",
          "height": null,
          "id": "sr:player:2185512",
          "jersey_number": 18,
          "name": "Londono Bedoya, Flabian",
          "nationality": "Colombia",
          "nickname": null,
          "position": "forward",
          "weight": 82
        },
        {
          "birthdate": "1994-08-25",
          "competitor_id": "sr:competitor:3211",
          "country_code": "CHL",
          "gender": "male",
          "height": null,
          "id": "sr:player:803812",
          "jersey_number": 17,
          "name": "Diaz Huincales, Paulo Cesar",
          "nationality": "Chile",
          "nickname": null,
          "position": "defender",
          "weight": 76
        },
        {
          "birthdate": "1998-11-03",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:1602926",
          "jersey_number": 15,
          "name": "Herrera, Marcelo",
          "nationality": "Argentina",
          "nickname": null,
          "position": "defender",
          "weight": 75
        },
        {
          "birthdate": "1992-02-26",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:158259",
          "jersey_number": 14,
          "name": "Gonzalez Pirez, Leandro",
          "nationality": "Argentina",
          "nickname": null,
          "position": "defender",
          "weight": 90
        },
        {
          "birthdate": "1998-06-11",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:918898",
          "jersey_number": 12,
          "name": "Petroli, Franco",
          "nationality": "Argentina",
          "nickname": null,
          "position": "goalkeeper",
          "weight": 85
        },
        {
          "birthdate": "1997-06-01",
          "competitor_id": "sr:competitor:3211",
          "country_code": "URY",
          "gender": "male",
          "height": null,
          "id": "sr:player:1121369",
          "jersey_number": 11,
          "name": "De La Cruz, Nicolás",
          "nationality": "Uruguay",
          "nickname": null,
          "position": "midfielder",
          "weight": 70
        },
        {
          "birthdate": "1993-01-18",
          "competitor_id": "sr:competitor:3211",
          "country_code": "COL",
          "gender": "male",
          "height": null,
          "id": "sr:player:221162",
          "jersey_number": 10,
          "name": "Quintero, Juan",
          "nationality": "Colombia",
          "nickname": null,
          "position": "midfielder",
          "weight": 67
        },
        {
          "birthdate": "2000-01-31",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:1630398",
          "jersey_number": 9,
          "name": "Alvarez, Julian",
          "nationality": "Argentina",
          "nickname": null,
          "position": "forward",
          "weight": 71
        },
        {
          "birthdate": "1996-11-09",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:1710109",
          "jersey_number": 8,
          "name": "Palavecino Lamela, Agustin",
          "nationality": "Argentina",
          "nickname": null,
          "position": "midfielder",
          "weight": 74
        },
        {
          "birthdate": "1988-05-09",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:46007",
          "jersey_number": 7,
          "name": "Suárez, Matias",
          "nationality": "Argentina",
          "nickname": null,
          "position": "forward",
          "weight": 77
        },
        {
          "birthdate": "1998-01-21",
          "competitor_id": "sr:competitor:3211",
          "country_code": "PRY",
          "gender": "male",
          "height": null,
          "id": "sr:player:918922",
          "jersey_number": 6,
          "name": "Martinez, David",
          "nationality": "Paraguay",
          "nickname": null,
          "position": "defender",
          "weight": 82
        },
        {
          "birthdate": "1993-04-02",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:249409",
          "jersey_number": 5,
          "name": "Zuculini, Bruno",
          "nationality": "Argentina",
          "nickname": null,
          "position": "midfielder",
          "weight": 77
        },
        {
          "birthdate": "1985-07-29",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:31980",
          "jersey_number": 4,
          "name": "Maidana, Jonathan Ramon",
          "nationality": "Argentina",
          "nickname": null,
          "position": "defender",
          "weight": 80
        },
        {
          "birthdate": "1996-04-30",
          "competitor_id": "sr:competitor:3211",
          "country_code": "PRY",
          "gender": "male",
          "height": null,
          "id": "sr:player:1110779",
          "jersey_number": 2,
          "name": "Rojas, Robert",
          "nationality": "Paraguay",
          "nickname": null,
          "position": "defender",
          "weight": 75
        },
        {
          "birthdate": "1986-10-16",
          "competitor_id": "sr:competitor:3211",
          "country_code": "ARG",
          "gender": "male",
          "height": null,
          "id": "sr:player:221140",
          "jersey_number": 1,
          "name": "Armani, Franco",
          "nationality": "Argentina",
          "nickname": null,
          "position": "goalkeeper",
          "weight": 88
        }
      ],
      "sport": "Soccer",
      "sport_id": "sr:sport:1",
      "state": null,
      "type": null,
      "venue": {
        "capacity": 61321,
        "city": "Buenos Aires",
        "coordinates": "-34.54501,-58.448708",
        "country": "Argentina",
        "country_code": "ARG",
        "id": "sr:venue:1009",
        "name": "Estadio Monumental Antonio Vespucio Liberti",
        "state": null
      },
      "venue_id": "sr:venue:1009"
    }
  ],
  "status": "success"
}

Get available sports

get
/api/sports/offering/sports

Returns available sports for the given time frame.

Sports are extracted from the available events. Only events starting between the requested time range will be considered.

Filtering example

In this example we get all sports happening in Nigeria

$ curl --request GET \
  --url 'https://api.vaix.ai/api/sports/offering/sports?filters=country%3Aeq%3ANigeria'
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
fromstring · date-timeOptional

Sports with events starting after this datetime will be returned.

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: 0Pattern: ^[+-]?[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: 100Optional

Number of sports to return.

Default: 50
filtersstring · enumOptional

Optional filtering of the sports to retrieve. It expects a string adhering to the filtering format, as described in the filtering section, e.g. sport:eq:Soccer.

Example: sport:eq:SoccerPossible 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:
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. +sport,-sport_id.

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. sport,sport_id.

Possible 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/sports/offering/sports
GET /api/sports/offering/sports HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
  "data": [
    {
      "sport": "Soccer",
      "sport_id": "sr:sport:1"
    },
    {
      "sport": "Counter-Strike",
      "sport_id": "sr:sport:109"
    },
    {
      "sport": "League of Legends",
      "sport_id": "sr:sport:110"
    },
    {
      "sport": "Dota 2",
      "sport_id": "sr:sport:111"
    },
    {
      "sport": "StarCraft",
      "sport_id": "sr:sport:112"
    },
    {
      "sport": "Rugby",
      "sport_id": "sr:sport:12"
    },
    {
      "sport": "Overwatch",
      "sport_id": "sr:sport:121"
    },
    {
      "sport": "Rainbow Six",
      "sport_id": "sr:sport:125"
    },
    {
      "sport": "Aussie Rules",
      "sport_id": "sr:sport:13"
    },
    {
      "sport": "Speedway",
      "sport_id": "sr:sport:131"
    },
    {
      "sport": "eSoccer",
      "sport_id": "sr:sport:137"
    },
    {
      "sport": "eBasketball",
      "sport_id": "sr:sport:153"
    },
    {
      "sport": "Basketball 3x3",
      "sport_id": "sr:sport:155"
    },
    {
      "sport": "Cycling",
      "sport_id": "sr:sport:17"
    },
    {
      "sport": "eIce Hockey",
      "sport_id": "sr:sport:195"
    },
    {
      "sport": "Basketball",
      "sport_id": "sr:sport:2"
    },
    {
      "sport": "Table Tennis",
      "sport_id": "sr:sport:20"
    },
    {
      "sport": "Cricket",
      "sport_id": "sr:sport:21"
    },
    {
      "sport": "Darts",
      "sport_id": "sr:sport:22"
    },
    {
      "sport": "Volleyball",
      "sport_id": "sr:sport:23"
    },
    {
      "sport": "Futsal",
      "sport_id": "sr:sport:29"
    },
    {
      "sport": "Baseball",
      "sport_id": "sr:sport:3"
    },
    {
      "sport": "Badminton",
      "sport_id": "sr:sport:31"
    },
    {
      "sport": "Beach Volley",
      "sport_id": "sr:sport:34"
    },
    {
      "sport": "Ice Hockey",
      "sport_id": "sr:sport:4"
    },
    {
      "sport": "Tennis",
      "sport_id": "sr:sport:5"
    },
    {
      "sport": "Handball",
      "sport_id": "sr:sport:6"
    },
    {
      "sport": "Pesapallo",
      "sport_id": "sr:sport:61"
    },
    {
      "sport": "Golf",
      "sport_id": "sr:sport:9"
    }
  ],
  "status": "success"
}

Was this helpful?