events.index

Resource information

URL	https://api.statscore.com/v2/events
Method	GET
Description	Returns the events related with competitions, seasons, stages and groups
Cache	30 seconds
Authorization required	Yes

Method parameters

Name	Type	Description

Name	Type	Description
There are no method parameters in this resource

Query parameters

Name	Type	Description

Name	Type	Description
token	xsd:string	REQUIRED. There is more information concerning authorization in the API introduction section
lang	xsd:string	Determines the language for the output data. The complete list of possible languages can be retrieved using the API resource: languages.index
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 50. Possible values: 5, 10, 25, 50, 100
date_from	xsd:string	REQUIRED. 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_to	xsd:string	REQUIRED. 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_id	xsd:int	Determines 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_id	xsd:int	Determines 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_id	xsd:int	Determines 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_id	xsd:int	Determines 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_id	xsd:int	Determines 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_id	xsd:int	Determines 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_id	xsd:int	Determines the identifier of the participant. The complete list of possible participants can be retrieved using the API resource: participants.index
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)
venue_type	xsd: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_id	xsd:string	Determines the identifier of the venue. The complete list of possible participants can be retrieved using the API resource: venues.index
sort_type	xsd: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_order	xsd: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_status	xsd:string	Determines the status of the relation. Possible values: not_started 30_min_left 5_min_left in_progress finished
status_id	xsd:string	Determines the identifier of the event status. The complete list of possible statuses can be retrieved using the API resource: statuses.index
status_type	xsd: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_type	xsd: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)
scoutsfeed	xsd: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_details	xsd:string	Determines if subnodes of events will be visible. Possible values: yes - events subnodes will be shown no - events subnodes will not be shown Available for SportsAPI clients only
competitions_details	xsd: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_status	xsd: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_range	xsd:string	Determines the minimum range for displayed events (e.g. min_range=2).
max_range	xsd:string	Determines the maximum range for displayed events (e.g. max_range=10).
verified_result	xsd:string	Possible value: yes - result is verified with official source no - result is not verified with official source
product	xsd:string	Possible values: scoutsfeed livescorepro prematchcenter Required with booked (in the case of 'ScoutSfeed' product with the 'scoutsfeed' parameter)
booked	xsd:string	Possible value: yes - result is booked in selected product no - result is not booked in selected product Required with product.
any_scout_id	xsd:int	Used for internal purposes. Determines scout identifier. Only events related to provided scout will be returned.
tz	xsd:string	Determines timezone for the output data. The complete list of possible time zones is included in the API introduction section
timestamp	xsd:unix_timestamp	Selection date, format UNIX_TIMESTAMP. Only changes in events that occurred or were updated after this timestamp will be returned.