booked-events.show

Resource information

URLhttps://api.statscore.com/v2/booked-events/{CLIENT_EVENT_ID}
MethodGET

Description

Return event 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. 

Cache900 seconds (15 min.)
Authorization requiredNO

Method parameters

NameTypeDescription
client_event_idxsd:intClient event id

Query parameters

NameTypeDescription
client_idxsd:intREQUIRED. Assigned to you by the API administrator
tokenxsd:stringAssigned to you by the API administrator
productxsd:string

REQUIRED. Determines product in which given events were booked. Possible values:

  • livescorepro
  • scoreframe
events_detailsxsd: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_statusxsd: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)
langxsd:stringDetermines language for the output data 

Method calling examples

LinkDescription
https://api.statscore.com/v2/booked-events/55556?client_id=1&product=livescorepro&events_details=noReturns a list of booked events without detailed node about events.

Output elements

.booked_events
..event
idUnique identifier for the event
client_event_idUnique event identifier for the client.
booked_by

When the value is 0 then event was autobooked.

Has value only when query parameter product is provided.

nameName of the event e.g. Spain - Italy
start_dateDate 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_idUnique 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_timeHow 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
sourceIdentificator of scout related to the event. Attribute for internal purposes
winner_idWho is the winner of the match
progress_idWho advanced to the next round
dayDay of the season
sport_idUnique 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_nameName of the sport in which event is played
round_idUnique identifier for the round in which event is played. Possibble null value. 
round_nameName 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 official source
  • no - result is not verified with official source
utInformation about when the date and time of the event record was last updated. Format UNIX_TIMESTAMP
old_event_iddeprecated. The attribute will be removed in the next API version
slugfriendly url for event
competition_idUnique identifier for the competition
competition_short_nameAbbreviated name of the competition
event_stats_lvl

Information about the current statistics level for the event. Possible values:

  • bronze
  • silver
  • gold
  • vip
event_stats_lvl_live

Information about expected statistics level when the match is LIVE. Possible values:

  • bronze
  • silver
  • gold
  • vip
event_stats_lvl_after

Information about expected statistics level after the end of the match. Possible values:

  • bronze
  • silver
  • gold
  • vip
latency

Information about the expected latency. Possible values:

  • null (for the event with scoutsfeed=no parameter)
  • 1-2s
  • 3-6s
  • 7-15s
...detailsadditional information related to the event
....detail

idUnique identifier for the details
nameName of the details. Possible values are different depending on sport 
valueValue related to the details
...participants
....participant
counterNumber of participants in the event. Participant with counter="1" is the home team.
idUnique identifier of the participant
type

Participant type. Possible values:

  • team
  • person
nameParticipants name
short_nameParticipanst abbreviated name, max length: 20 characters
acronymMax 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_idUnique identifier for the area represented by the participant.  
area_nameArea name represented by the participant
area_codeMax 3 characters in length for the abbreviated area name e.g. GER, POL, FRA
sport_idUnique identifier for the sport in which the participant is involved.
sport_nameName of the sport in which the participant is involved.
national

Determines if participant is a national team. Possible values:

  • yes
  • no
websiteParticipants official website
utInformation about when the date and time of the record was last updated. Format UNIX_TIMESTAMP
old_participant_iddeprecated. The attribute will be removed in the next API version
slugfriendly url for participant
logoAttribute for internal purposes
.....details
......detail
foundedDate when the team was founded
phonePhone number
emailEmail address
addressAddress where the team is located
venue_idUnique identifier for the venue in which the team plays home games
venue_nameName of the venue in which the team plays home games
weightParticipants weight
heightParticipants height
nicknameParticipants nickname
position_nameName of the participants position
birthdateParticipants date of birth
born_placeParticipants place of birth
is_retired

Determines if participant has retired. Possible values:

  • yes
  • no
subtype

Participant subtype name. Possible values:

  • athlete
  • coach
  • referee
  • director
.....results
......result
idUnique identifier for the result
short_nameAbbreviated name of the result.
nameName of the result. Possible values are different depending on sport
valueValue related to the result
.....stats
......stat
idUnique identifier for the statistic
short_nameAbbreviated name of the statistic.
nameName of the statistic. Possible values are different depending on sport
valueValue related to the statistic