events.index

Resource information

URLhttps://api.statscore.com/v2/events
MethodGET

Description

Returns the events related with competitions, seasons, stages and groups
Cache30 seconds
Authorization requiredYes

Method parameters

NameTypeDescription
There are no method parameters in this resource 

Query parameters

NameTypeDescription
tokenxsd:stringREQUIRED. There is more information concerning authorization in the API introduction section
langxsd:string

Determines the language for the output data. The complete list of possible languages can be retrieved using the API resource: languages.index

pagexsd:intDetermines offset of paginated data. Default value is 1 which means first page
limitxsd:int

Determines maximum number of returned records on page. Used in paginated data. Default value is 50

Possible values: 5, 10, 25, 50, 100

date_fromxsd:stringREQUIRED. If not used, the date will be automatically set for the current day. Selection datetime, format 'yyyy-mm-dd hh:mm:ss'. Date from which events should be returned. If you use a single date_from parameter you will receive all events that start in the 24 hours from the requested date
date_toxsd:stringREQUIRED. If not used, the date will be automatically set for the current day. Selection datetime, format 'yyyy-mm-dd hh:mm:ss'. End date of returned events. The maximum period between date_from and date_to parameters is 30 days. This rule is not valid when you use the following query parameter in your request: season_id, stage_id, group_id, participant_id. If you use a single date_to parameter you will receive all events that start in the 24 hours from the requested date
sport_idxsd:intDetermines the sport identifier in which the events are played. Possibility to input multiple identifiers, separated by comma. The complete list of possible sports can be retrieved using the API resource: sports.index
area_idxsd:intDetermines the area identifier in which the events are played. Possibility to input multiple identifiers, separated by comma. The complete list of possible areas can be retrieved using the API resource: areas.index
competition_idxsd:intDetermines the competition identifier in which the events are played. Possibility to input multiple identifiers, separated by comma. The complete list of possible competitions can be retrieved using the API resource: competitions.index
season_idxsd:intDetermines the season identifier in which the events are played. Possibility to input multiple identifiers, separated by comma. The complete list of possible seasons can be retrieved using the API resource: seasons.index
stage_idxsd:intDetermines the stage identifier in which the events are played. Possibility to input multiple identifiers, separated by comma. The complete list of possible stages can be retrieved using the API resource: stages.index
group_idxsd:intDetermines the group identifier in which the events are played. Possibility to input multiple identifiers, separated by comma. The complete list of possible groups can be retrieved using the API resource: groups.index
participant_idxsd:intDetermines the identifier of the participant. The complete list of possible participants can be retrieved using the API resource: participants.index
multi_idsxsd:stringList 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)
venue_typexsd:string

Additional parameter for participant filter. Works only when participant_id query is used. Determines if the provided participant plays as the home or away team.
By default the value of "all" is set. Possible values:

  • home - filters events in which the selected participant plays as the home team
  • away - filters events in which the selected participant plays as the away team
  • all - filters events in which the selected participant plays as the home team or the away team
venue_idxsd:stringDetermines the identifier of the venue. The complete list of possible participants can be retrieved using the API resource: venues.index
sort_typexsd:string

Determines sort order of data. Possible values:

  • day - events are sorted by:
    • country.name ascending
    • competition.country_sort ascending
    • event.day ascending
    • event.competition_id ascending
    • event.stage_id ascending
    • event.group_id ascending
    • event.start_date ascending
    • event.id ascending

  • competition - (default) events are sorted by:
    • country.name
    • competition.country_sort ascending
    • event.competition_id ascending
    • event.day ascending
    • event.stage_id ascending
    • event.group_id ascending
    • event.start_date ascending
    • event.id ascending

  • start_date - events are sorted by
    • event.start_date
    • country.name ascending
    • competition.country_sort ascending
    • event.day ascending
    • event.competition_id ascending
    • event.stage_id ascending
    • event.group_id ascending
    • event.id ascending

  • most_popular - events are sorted by
    • the competition.overall_sort (most popular)
    • country.name ascending
    • competition.country_sort ascending
    • event.competition_id ascending
    • event.day ascending
    • event.stage_id ascending
    • event.start_date ascending
    • event.group_id ascending
    • event.id ascending
sort_orderxsd:string

Additional parameter for sort_type which determines the direction of sorting (ascending, descending)
By default the value of "desc" is set. Possible values:

  • asc - sort ascending
  • desc - sort descending
relation_statusxsd:string

Determines the status of the relation. Possible values:

  • not_started
  • 30_min_left
  • 5_min_left
  • in_progress
  • finished
status_idxsd:stringDetermines the identifier of the event status. The complete list of possible statuses can be retrieved using the API resource: statuses.index
status_typexsd:string

Determines the identifier of the status type. Can be comma separated string. Possible values:

Possible values:

  • live
  • scheduled
  • finished
  • canceled
  • interrupted
  • deleted
  • other
coverage_typexsd:string

Determines coverage type. 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)

Possible to determine multiple coverages (e.g. from_venue,from_tv)

scoutsfeedxsd:string

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

Required with booked of the 'ScoutsFeed' product

events_detailsxsd:string

Determines if subnodes of events will be visible. Possible values:

  • yes - events subnodes will be shown
  • no - events subnodes will not be shown
competitions_detailsxsd:string

Determines if parent nodes of events will be visible. Possible values:

  • yes - events parent nodes will be shown
  • no - events parent nodes will not be shown
item_statusxsd:string

Describes the status for the item (record). Possible values:

  • active - the record is active
  • deleted - the record was deleted by the admin. When in the case of an event being added by mistake
min_rangexsd:stringDetermines the minimum range for displayed events (e.g. min_range=2).
max_rangexsd:stringDetermines the maximum range for displayed events (e.g. max_range=10).
verified_resultxsd:string

Possible value:

  • yes - result is verified with official source
  • no - result is not verified with official source
productxsd:string

Possible values:

  • scoutsfeed
  • livescorepro
  • prematchcenter

Required with booked (in the case of 'ScoutSfeed' product with the 'scoutsfeed' parameter)

bookedxsd:string

Possible value:

  • yes - result is booked in selected product
  • no - result is not booked in selected product

Required with product.

any_scout_idxsd:int

Used for internal purposes. Determines scout identifier. Only events related to provided scout will be returned.

tzxsd:stringDetermines timezone for the output data. The complete list of possible time zones is included in the API introduction section
timestampxsd:unix_timestampSelection date, format UNIX_TIMESTAMP. Only changes in events that occurred or were updated after this timestamp will be returned.

Method calling examples

LinkDescription
https://api.statscore.com/v2/events?token={{YOUR_TOKEN}}Returns a list of all events in JSON format

Output elements

competitions
competitions > competition

idUnique identifier for the competition
ls_idFor internal purposes
nameName of the the competition e.g. U19 World Champ. Possible translation of the attribute
sourceFor internal purposes
source_dcFor internal purposes
source_superFor internal purposes
short_nameAbbreviated name of the competition e.g. U19 WCH, Max 20 characters. Possible translation of the attribute
mini_name

Mini name of the competition. Max 3 characters in length e.g. U19

gender

Competition gender. Possible values:

  • male
  • female
  • mixed
type

Competitions type. Possible values:

  • country_league - e.g Premier Division
  • country_cups - e.g. FA Cup
  • international - e.g. World Cup
  • international_clubs - e.g. Champions League 
  • friendly - friendly matches
  • individual - for speedway individual competitions such as Speedway GP
  • team - for speedway national competitions
  • single - for tennis competitions
  • double - for tennis competitions
  • mixed - for tennis competitions
  • undefined - other
area_idUnique identifier for area in which competitions are played. The complete list of possible areas can be retrieved using the API resource: areas.index
area_nameName of area in which competitions are played. Possible translation of the attribute
area_type

 Type of area in which competitions are played. Possible values:

  • country
  • international
area_sortThe parameter used to sort competitions in a country e.g. Premier League is 1st and the Championship is 2nd in English competitions. Sorting direction is ascending
area_codeMax 3 characters, area in which competitions are played
overall_sortThe parameter used to sort competitions. Sorting direction is ascending
sport_idUnique identifier for the sport in which the competition is played. The complete list of possible sports can be retrieved using the API resource: sports.index 
sport_nameName of the sport in which the competition is played. Possible translation of the attribute
tour_idUnique identifier for the tour in which thecompetition is played. The complete list of possible tours can be retrieved using the API resource: tours.index
tour_nameName of the tour in which the competition is played
utInformation about when the date and time of the competition record was last updated. Format UNIX_TIMESTAMP
old_competition_idDEPRECATED. The attribute will be removed in the next API version
slugfriendly url for competition
status

Possible values:

  • active
  • inactive
  • archived (for competitions that no longer take place)

competitions > competition > seasons
competitions > competition > seasons > season

idUnique identifier for the season.
nameName of the season e.g. Premiership 2014/15
year

Determines the season year e.g.

  • 1970
  • 1970/71
  • 1971
  • 1971/72
  • 2000
  • 2000/01
  • 2014
  • 2014/15
actual

Determines if the season is actual. Possible values:

  • yes
  • no
utInformation about the date and time of when the season record was last updated. Format UNIX_TIMESTAMP
old_season_iddeprecated. The attribute will be removed in the next API version
stats_lvlSeason's stats level. Possible values: vip, gold, silver, bronze
team_connectionFor internal usage

competitions > competition > seasons > season > stages
competitions > competition > seasons > season > stages > stage

id

Unique identifier for the stage
stage_name_idUnique identifier for the stage's name
nameName of the stage. Possible translation of the attribute
start_dateDate when stage begins. Format YYYY-MM-DD
end_dateDate when stage ends. Format YYYY-MM-DD
show_standings

Determines if the stage contains standings. Possible values:

  • yes
  • no
groups_nrThe number of groups that are part of the stage
sortThe sort order for the stage. The sorting direction is ascending
is_current

Possible values:

  • yes
  • no
utInformation about the date and time of when the stage record was last updated. Format UNIX_TIMESTAMP
old_stage_iddeprecated. The attribute will be removed in the next API version
has_brackets

Information about the availability of tournament bracket for the stage. Possible values:

  • yes
  • no
competitions > competition > seasons > season > stages > stage > groups
competitions > competition > seasons > season > stages > stage > groups > group

idUnique identifier for the group
nameName of the group
utInformation about the date and time of when the group record was last updated. Format UNIX_TIMESTAMP

competitions > competition > seasons > season > stages > stage > groups > group > events
competitions > competition > seasons > season > stages > stage > groups > group > events > event

idUnique identifier for the event
ls_idInternal
nameName of the event e.g. Spain - Italy
sourceIdentificator of scout related to the event. Attribute for internal purposes
source_dcInternal
source_superInternal
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
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. Can be comma separated string. 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)
channel_idInternal
channel_nameInternal
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
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
dayDay of the season
clock_timeHow many seconds have passed in the current event period. Possible empty value
clock_status

Clock status. Possible value:

  • running
  • stopped
winner_idWho is the winner of the match
progress_idWho advanced to the next round
bet_status

Possible value:

  • active
  • suspended
bet_cards

Changed when there is a possibility of a card. Possible value:

  • active
  • suspended
bet_corners

Changed when there is a possibility of a corner. Possible value:

  • active
  • suspended
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
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
verified_result

Possible value:

  • yes - result is verified with an official source
  • no - result is not verified with an official source
result_verified_byInternal
result_verified_atInternal
is_protocol_verifiedInternal
protocol_verified_byInternal
protocol_verified_atInternal
round_idUnique identifier for the round in which event is played. Possible null value. 
round_nameName of the round
competition_idUnique identifier for the competition
competition_short_nameAbbreviated name of the competition
client_event_idUnique 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.

inverted_participantsInternal
venue_idDeprecated
bfsInternal
event_stats_lvl

Information about the statistics level. 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
due_toInternal
latency

Information about the expected latency. Possible values:

  • null (for the event with scoutsfeed=no parameter)
  • 1-2s
  • 3-6s
  • 7-15s
event_stats_levelInternal
verified_result

Possible value:

  • yes - result is verified with an official source
  • no - result is not verified with an official source
is_coverage_limitedDetermines if event has limited information about players statistics
played_timeShows how many seconds have passed in the event (including additional time). Possible empty value.

competitions > competition > seasons > season > stages > stage > groups > group > events > event > details
competitions > competition > seasons > season > stages > stage > groups > group > events > event > details > detail
 additional information related to event

idUnique identifier for the detail
nameName of the detail. Possible values are different depending on the sport
valueValue related to the detail

competitions > competition > seasons > season > stages > stage > groups > group > events > event > participants
competitions > competition > seasons > season > stages > stage > groups > group > events > event > participants > participant
counterNumber of participant in the event. Participant with counter="1" is the home team.

idUnique identifier of the participant
type

Participant type. Possible values:

  • team
  • person
  • double
nameParticipants name
short_nameParticipants 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 purpose
virtual

Determines if the participant is real player / team or virtual. Possible values:

  • yes
  • no
shirt_nrInformation about player's season number

competitions > competition > seasons > season > stages > stage > groups > group > events > event > participants > participant > results
competitions > competition > seasons > season > stages > stage > groups > group > events > event > participants > participant > results > result

idUnique identifier for the result
short_nameAbbreviated name of the result.
nameName of the result. Possible values are different depending on the sport
valueValue related to the result
data_type

Defines type of field generated on front (internal purpose only)

  • integer
  • decimal
  • binary_text
  • binary
  • text
  • signed_integer

competitions > competition > seasons > season > stages > stage > groups > group > events > event > participants > participant > stats
competitions > competition > seasons > season > stages > stage > groups > group > events > event > participants > participant > stats > stat

idUnique identifier for the statistic
short_nameAbbreviated name of the statistic.
nameName of the statistic. Possible values are different depending on the sport
valueValue related to the statistic
data_type

Defines type of field generated on front (internal purpose only)

  • integer
  • decimal
  • binary_text
  • binary
  • text
  • signed_integer