booked-events.index

Resource information

URL	https://api.statscore.com/v2/booked-events
Method	GET
Description	Returns a list of events booked by the client for the selected product. Please note: the list will only contain events with the status: "finished", "live" and "scheduled" including events for the next 14 days. Default order for returned data is: start date - ascending.
Cache	300 seconds (5 min.)
Authorization required	No

Method parameters

Name	Type	Description
There are no method parameters in this resource

Query parameters

Name	Type	Description
client_id	xsd:int	REQUIRED. Assigned to you by the API administrator
product	xsd:string	REQUIRED. Determines product in which given events were booked. Possible values: livescorepro scoutsfeed scoreframe
client_event_id	xsd:string	Determines if clients event identifier is mapped with STATSCORE event. Values could be separated by comma (e.g. 123,234,321). If clients event is not mapped proper message will be returned.
events_details	xsd:string	Determines if subnodes of events (details, participants, results, stats) will be visible. Possible values: yes - event subnodes will be shown no - event subnodes will be hidden
mapped_status	xsd:string	Determines if events are mapped with client_event_id. Possible values: mapped - display events mapped with customer unmapped - display events unmapped with customer all - display all events (mapped and unmapped)
multi_ids	xsd:string	List of events identifiers separated by a comma (e.g. 123,234,321) for which you want to get the events details (Up to 100 ids)
lang	xsd:string	Determines language for the output data
page	xsd:int	Determines offset of paginated data. Default value is 1 which means first page
limit	xsd:int	Determines maximum number of returned records on page. Used in paginated data. Default value is 500. Possible values: 5, 10, 25, 50, 100, 250, 500

Method calling examples

Link	Description
https://api.statscore.com/v2/booked-events.xml?client_id=1&product=livescorepro&events_details=no	Returns a list of booked events without detailed node about events.

Output elements

booked_events

booked_events > events

id	Unique identifier for the event
client_event_id	Unique event identifier for the client.
booked	Possible value: yes - result is booked in selected product no - result is not booked in selected product Required with product.
booked_by	When the value is 0 then event was autobooked. Has value only when query parameter product is provided.
name	Name of the event e.g. Spain - Italy
start_date	Date when the event starts in the format DATE_TIME (2015-03-01 11:02)
ft_only	Determines when the result/score of the event is updated. Possible values: yes - result/score is updated only when the event is finished no - result/score is updated during the event
coverage_type	Type of event coverage. Possible values: from_venue - means the scout is relaying the event directly from the stadium (max. latency 1 second) from_tv - means the scout is relaying the event from TV transmission (max. latency 8 seconds) basic - for this type of coverage we don't provide detailed event incidents (max. latency around 60 seconds)
scoutsfeed	Information concerning scouts coverage. Possible values: yes - means that play by play incidents will be available for the event no - means that play by play incidents will not be available for the event
status_id	Unique identifier of the event status
status_name	Name of the event status
status_type	Type of status. Possible values: live scheduled finished cancelled interrupted deleted other
clock_time	How many seconds have passed in the current event period. Possible empty value
clock_status	Clock status. Possible value: running stopped
bet_status	Possible value: active suspended
relation_status	Relation status. Attribute for internal purposes. Possible value: not_started - for an event that has not started in_progress - for a live event finished - for an event that has finished 30_min_left - scout confirms his ability to deliver the coverage 30 min before the event 5_min_left - scout confirms his ability to deliver the coverage 5 min before the event
source	Identifier of scout related to the event. Attribute for internal purposes
winner_id	Who is the winner of the match
progress_id	Who advanced to the next round
day	Day of the season
sport_id	Unique identifier for the sport in which event is played. The complete list of possible sports can be retrieved using the API resource: sports.index
sport_name	Name of the sport in which event is played
round_id	Unique identifier for the round in which event is played. Possible null value.
round_name	Name of the round
neutral_venue	Determines if the event is played at a neutral venue. Possible values: yes no
item_status	Describes status of the item (record). Possible values: active - the record is active deleted - the record was deleted by the admin. When an event was added by mistake
verified_result	Possible value: yes - result is verified with an official source no - result is not verified with an official source
ut	Information about when the date and time of the event record was last updated. Format UNIX_TIMESTAMP
old_event_id	deprecated. The attribute will be removed in the next API version
slug	friendly url for event
competition_id	Unique identifier for the competition
competition_short_name	Abbreviated name of the competition
area_id	Unique identifier for area in which competitions are played. The complete list of possible areas can be retrieved using the API resource: areas.index
area_name	Name of area in which competitions are played. Possible translation of the attribute
season_id	Unique identifier for season
season_name	Name of the season e.g. Premiership 2014/15
stage_id	Unique identifier for stage
stage_name	Name of the stage

booked_events > events > details

booked_events > events > details > detail

id	Unique identifier for the details
name	Name of the details. Possible values are different depending on the sport
value	Value related to the details

booked_events > events > participants

booked_events > events > participants > participant

counter	Number of participants in the event. Participant with counter="1" is the home team.
id	Unique identifier of the participant
type	Participant type. Possible values: team person
name	Participants name
short_name	Participants abbreviated name, max length: 20 characters
acronym	Max 3 characters in length mini name, e.g. BAR, REA
gender	Participants gender. Possible value: male female mixed (e.g for mixed doubles in tennis )
area_id	Unique identifier for the area represented by the participant.
area_name	Area name represented by the participant.
area_code	Max 3 characters in length for the abbreviated area name e.g. GER, POL, FRA.
sport_id	Unique identifier for the sport in which the participant is involved.
sport_name	Name of the sport in which the participant is involved.
national	Determines if participant is a national team. Possible values: yes no
website	Participants official website
ut	Information about when the date and time of the record was last updated. Format UNIX_TIMESTAMP
old_participant_id	deprecated. The attribute will be removed in the next API version
slug	friendly url for participant
logo	Attribute for internal purpose
virtual	Determines if the participant is real player / team or virtual. Possible values: yes no

booked_events > events > participants > participant > details

booked_events > events > participants > participant > details > detail

founded	Date when the team was founded
phone	Phone number
email	Email address
address	Address where the team is located
venue_id	Unique identifier for the venue in which the team plays home games
venue_name	Name of the venue in which the team plays home games
weight	Participants weight
height	Participants height
nickname	Participants nickname
position_name	Name of the participants position
birthdate	Participants date of birth
born_place	Participants place of birth
is_retired	Determines if participant has retired. Possible values: yes no
subtype	Participant subtype name. Possible values: athlete coach referee director

booked_events > events > participants > participant > results

booked_events > events > participants > participant > results > result

id	Unique identifier for the result
short_name	Abbreviated name of the result.
name	Name of the result. Possible values are different depending on sport
value	Value related to the result

booked_events > events > participants > participant > stats

booked_events > events > participants > participant > stats > stat

id	Unique identifier for the statistic
short_name	Abbreviated name of the statistic.
name	Name of the statistic. Possible values are different depending on sport
value	Value related to the statistic