Participants
Sport participants related endpoints
Returns trending participants for the given time frame.
The participants are sorted by trending score.
Trending score
To calculate trending score for a participant, each bet placed on each event of participant contributes a value determined by how recently the bet was placed.
Recent bets add more value than older ones.
The normalized value of its score is also assigned to each participant as its confidence.
The user to get recommendations for.
The minimum event's starting datetime. If not explicitly set it defaults to now.
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].
0Example: -3hPattern: ^[+-]?[0-9]+([.][0-9]+)?[smhd]?$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].
2dExample: 2dPattern: ^[+-]?[0-9]+([.][0-9]+)?[smhd]?$DEPRECATED: Considers events starting till the from timestamp plus the given
hours. If not set defaults to one day (24 hours).
Number of participants to return.
100Example: 5Optional 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.
sport:in:Soccer,BasketballPossible values: 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.
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.
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.
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.
match,forced_eventsPossible values: 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. id,name.
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_confidence.
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.
Applies a limit to a group of items. For more information, head to
Limiting -> Group Limiting section of the docs.
sport:5,sport_id:2.
The location of the page where the request takes place.
inplay_widgetConsiders bets placed 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].
2dExample: 3hPattern: ^[+-]?[0-9]+([.][0-9]+)?[smhd]?$Custom client header, the value should be the name of the group the user belongs to
Authentication method to be used, supported values [vaix, iam]. Defaults to vaix
OK
Bad Request
Unauthorized
Forbidden
Not Acceptable
Request Entity Too Large
Unprocessable Entity
Too Early
Internal Server Error
GET /api/sports/participants/trending HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
"data": [
{
"abbreviation": "MIL",
"confidence": 1,
"country": "USA",
"country_code": "USA",
"gender": "male",
"id": "sr:competitor:3410",
"name": "Milwaukee Bucks",
"score": 20.6456,
"sport": "Basketball",
"sport_id": "sr:sport:2",
"state": "WI"
},
{
"abbreviation": "ATL",
"confidence": 1,
"country": "USA",
"country_code": "USA",
"gender": "male",
"id": "sr:competitor:3423",
"name": "Atlanta Hawks",
"score": 20.6456,
"sport": "Basketball",
"sport_id": "sr:sport:2",
"state": "GA"
},
{
"abbreviation": "URU",
"confidence": 0.8121052427635912,
"country": "Uruguay",
"country_code": "URY",
"gender": "male",
"id": "sr:competitor:36225",
"name": "Uruguay",
"score": 16.7664,
"sport": "Basketball",
"sport_id": "sr:sport:2",
"state": null
},
{
"abbreviation": "CZE",
"confidence": 0.8121052427635912,
"country": "Czech Republic",
"country_code": "CZE",
"gender": "male",
"id": "sr:competitor:7494",
"name": "Czech Republic",
"score": 16.7664,
"sport": "Basketball",
"sport_id": "sr:sport:2",
"state": null
},
{
"abbreviation": "SIN",
"confidence": 0.5997016313403339,
"country": null,
"country_code": null,
"gender": "male",
"id": "sr:competitor:595958",
"name": "Sinkovskiy, Vladimir",
"score": 12.3812,
"sport": "Table Tennis",
"sport_id": "sr:sport:20",
"state": null
}
],
"status": "success"
}Returns personalized participant recommendations.
Only participants playing in events starting between the requested time range will be considered.
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 participants 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.
The user to get recommendations for.
The minimum event's starting datetime. If not explicitly set it defaults to now.
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].
0Example: -3hPattern: ^[+-]?[0-9]+([.][0-9]+)?[smhd]?$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].
2dExample: 2dPattern: ^[+-]?[0-9]+([.][0-9]+)?[smhd]?$DEPRECATED: Considers events starting till the from timestamp plus the given
hours. If not set defaults to one day (24 hours).
Number of participants to return.
100Example: 5Optional 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.
sport:in:Soccer,BasketballPossible values: 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.
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.
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.
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.
match,forced_eventsPossible values: 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. id,name.
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_confidence.
Applies a limit to a group of items. For more information, head to
Limiting -> Group Limiting section of the docs.
sport:5,sport_id:2.
The location of the page where the request takes place.
inplay_widgetCustom client header, the value should be the name of the group the user belongs to
Authentication method to be used, supported values [vaix, iam]. Defaults to vaix
OK
Bad Request
Unauthorized
Forbidden
Not Acceptable
Request Entity Too Large
Unprocessable Entity
Too Early
Internal Server Error
GET /api/sports/participants/recommended?user=text HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
"data": [
{
"abbreviation": "ITA",
"confidence": 1,
"country": "Italy",
"country_code": "ITA",
"gender": "male",
"id": "sr:competitor:4707",
"name": "Italy",
"sport": "Soccer",
"sport_id": "sr:sport:1",
"state": null
},
{
"abbreviation": "BEL",
"confidence": 1,
"country": "Belgium",
"country_code": "BEL",
"gender": "male",
"id": "sr:competitor:4717",
"name": "Belgium",
"sport": "Soccer",
"sport_id": "sr:sport:1",
"state": null
},
{
"abbreviation": "ESP",
"confidence": 0.900405588102749,
"country": "Spain",
"country_code": "ESP",
"gender": "male",
"id": "sr:competitor:4698",
"name": "Spain",
"sport": "Soccer",
"sport_id": "sr:sport:1",
"state": null
},
{
"abbreviation": "SUI",
"confidence": 0.900405588102749,
"country": "Switzerland",
"country_code": "CHE",
"gender": "male",
"id": "sr:competitor:4699",
"name": "Switzerland",
"sport": "Soccer",
"sport_id": "sr:sport:1",
"state": null
},
{
"abbreviation": "BRA",
"confidence": 0.6056782334384858,
"country": "Brazil",
"country_code": "BRA",
"gender": "male",
"id": "sr:competitor:4748",
"name": "Brazil",
"sport": "Soccer",
"sport_id": "sr:sport:1",
"state": null
}
],
"status": "success"
}Returns popular participants for the given time frame.
The participants are sorted by popularity.
Popularity
The metric used to measure popularity is the number of bets placed on each participant of each event.
The normalized value of its total bets is also assigned to each participant as its confidence.
The user to get recommendations for.
The minimum event's starting datetime. If not explicitly set it defaults to now.
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].
0Example: -3hPattern: ^[+-]?[0-9]+([.][0-9]+)?[smhd]?$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].
2dExample: 2dPattern: ^[+-]?[0-9]+([.][0-9]+)?[smhd]?$DEPRECATED: Considers events starting till the from timestamp plus the given
hours. If not set defaults to one day (24 hours).
Number of participants to return.
100Example: 5Optional 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.
sport:in:Soccer,BasketballPossible values: 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.
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.
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.
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.
match,forced_eventsPossible values: 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. id,name.
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_confidence.
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.
Applies a limit to a group of items. For more information, head to
Limiting -> Group Limiting section of the docs.
sport:5,sport_id:2.
The location of the page where the request takes place.
inplay_widgetCustom client header, the value should be the name of the group the user belongs to
Authentication method to be used, supported values [vaix, iam]. Defaults to vaix
OK
Bad Request
Unauthorized
Forbidden
Not Acceptable
Request Entity Too Large
Unprocessable Entity
Too Early
Internal Server Error
GET /api/sports/participants/popular HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*
{
"data": [
{
"abbreviation": "URU",
"confidence": 1,
"country": "Uruguay",
"country_code": "URY",
"gender": "male",
"id": "sr:competitor:36225",
"name": "Uruguay",
"sport": "Basketball",
"sport_id": "sr:sport:2",
"state": null,
"total_bets": 82
},
{
"abbreviation": "CZE",
"confidence": 1,
"country": "Czech Republic",
"country_code": "CZE",
"gender": "male",
"id": "sr:competitor:7494",
"name": "Czech Republic",
"sport": "Basketball",
"sport_id": "sr:sport:2",
"state": null,
"total_bets": 82
},
{
"abbreviation": "MIL",
"confidence": 0.6875,
"country": "USA",
"country_code": "USA",
"gender": "male",
"id": "sr:competitor:3410",
"name": "Milwaukee Bucks",
"sport": "Basketball",
"sport_id": "sr:sport:2",
"state": "WI",
"total_bets": 57
},
{
"abbreviation": "ATL",
"confidence": 0.6875,
"country": "USA",
"country_code": "USA",
"gender": "male",
"id": "sr:competitor:3423",
"name": "Atlanta Hawks",
"sport": "Basketball",
"sport_id": "sr:sport:2",
"state": "GA",
"total_bets": 57
},
{
"abbreviation": "WEL",
"confidence": 0.625,
"country": "New Zealand",
"country_code": "NZL",
"gender": "male",
"id": "sr:competitor:565939",
"name": "Wellington Saints",
"sport": "Basketball",
"sport_id": "sr:sport:2",
"state": null,
"total_bets": 52
}
],
"status": "success"
}Was this helpful?