mapped-events.index

Owned by Adam Działach
Last updated: 29.11.2023 by Adam Kotwicki
2 min read

Resource information

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

Description

Returns a list of events booked and mapped 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 5 days.
The default order for returned data is: start date - ascending. 

Cache300 seconds (5 min.)
Authorization required
  • IP whitelisting (preferred)
    OR
  • Auth Token

Method parameters

NameTypeDescription
  • client_id required when IP whitelisted
  • token required when no client_id used

Query parameters

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

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

  • livescorepro
  • scoutsfeed 
  • scoreframe
  • prematchcenter
client_idxsd:intAssigned by the API administrator
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 the customer
  • all - display all events (mapped and unmapped)
bookedxsd:string

Determines if events are booked for you. Possible values:

  • yes
  • no
pagexsd:intDetermines offset of paginated data. The default value is 1 which means the first page
limitxsd:int

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

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

Method calling examples

LinkDescription
https://api.statscore.com/v2/mapped-events?product=livescorepro&token=Returns a list of mapped events for the LMP product

Output elements

mapped_events
mapped_events > events


idUnique identifier for the event
client_event_idUnique event identifier for the client.
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
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
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
competition_idUnique identifier for the competition
competition_short_nameAbbreviated name of the competition
inverted_participants

Information about inverted order of participants (e.g. Team B - Team A instead of Team A - Team B). Possible values:

  • yes
  • no
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
latency

Information about the expected latency. Possible values:

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