Versions Compared

Old Version 15

changes.mady.by.user Adam Kotwicki

Saved on

compared with

New Version Current

changes.mady.by.user Adam Działach

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Resource information

URLhttps://api.
softnetsport
statscore.com/v2
/livescoreXSDhttps://api.softnetsport.com/assets/API/docs
/
xsd/
livescore
.index.xsd
MethodGET

Description

Returns
the
LIVE events related
with
to competitions, seasons, stages and groups

PackageThis resource is included in the LIVESCORE package

Cache
0
30 seconds
Authorization requiredYes

Method parameters

NameTypeDescription
There are
not
no method parameters in this resource 

Query parameters

...

Name

Type

Description

tokenxsd:stringREQUIRED.
More
 There is more information concerning
oAuth token: oAuth 2.0 authorization
authorization in the API introduction section
langxsd:string

Determines the language for the output data.

softnetSPORT API provides the following languages:

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 100

is 50. 

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

, 250, 500

date_fromxsd:stringSelection 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 requested date
date_toxsd:stringSelection datetime, format 'yyyy-mm-dd hh:mm:ss'. End date of returned events. The maximum period beetwen date_from and date_to parameter 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
sport_idxsd:intDetermines the sport identifier in which the events are played
. softnetSPORT API provides the following sports:
. 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
. softnetSPORT API provides the following sports:
. 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
. softnetSPORT API provides the following sports:
. 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.
softnetSPORT API provides the following sports:
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
. softnetSPORT API provides the following sports:
. 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
. softnetSPORT API provides the following sports:
. 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.
softnetSPORT API provides the following statuses:
The complete list of possible participants can be retrieved using the API resource: participants.index
events
multi_
detailscompetitions_details
idsxsd:string

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

  • yes - events subnodes will be shown
  • no - events subnodes will not be hidden
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_typexsd:string
Determines if parent nodes of events will be visible

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:

  • yes - events parent nodes will be shown
  • no - events parent nodes will not be hidden
tzxsd:stringDetermines timezone for the output data. softnetSPORT API provides the following timezones: timezones

Method calling examples

LinkDescription
https://api.softnetsport.com/v2/livescore.xml?token={{YOUR_TOKEN}}Returns list of all in progress (live) events in XML format
https://api.softnetsport.com/v2/livescore?token={{YOUR_TOKEN}}Returns list of all in progress (live) events in JSON format

Output elements

.competitions 
..competition 
idUnique identifier for the competition
nameName of the the competition i.e.: U19 World Champ
short_nameShorter name of the competition i.e.: U19 WCH, Max 20 characters
mini_name

Mini name of the competition. Max 3 characters length i.e.: U19

gender

Competition gender. Possible values:

  • male
  • female
  • mixed
  • undefined
type

Competitions type. Possible values:

  • country_league - i.e.: Premier Division
  • country_cups - i.e.: FA Cup
  • international - i.e.: World Cup
  • international_clubs - i.e.: 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 of area in which competitions are played. softnetSPORT API provides the following areas: areas.index
area_nameName of area in which competitions are played
area_type

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

  • country
  • international
area_sortThe parameter used to sort competitions in the country, i.e. Premier League is 1st and the Championship is 2nd in English competitions. Sorting direction is ascending
area_codeMax 3 characters length of area in which competitions are played
overall_sortThe parameter used to sort competitions. Sorting direction is ascending
sport_idUnique identifier of the sport in which competition is played. softnetSPORT API provides the following sports: sports.index
sport_nameName of the sport in which competition is played
tour_idUnique identifier of the tour in which competition is played. softnetSPORT API provides the following tours: tours.index
tour_nameName of the tour in which competition is played
utInformation about date and time when the competition record was last updated. Format UNIX_TIMESTAMP
old_competition_iddeprecated. The attribute will be removed in the next API version
...seasons
 
....season
 
idUnique identifier for the season
nameName of the season f.e: Premiership 2014/15
year

Determines the season year f.e:

  • 1970
  • 1970/71
  • 1971
  • 1971/72
  • 2000
  • 2000/01
  • 2014
  • 2014/15
utInformation about date and time when the season record was last updated. Format UNIX_TIMESTAMP
old_season_iddeprecated. The attribute will be removed in the next API version
.....stages
 
.....stage
 
idUnique identifier for the stage
nameName of the stage
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 a standings. Possible values:

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

Possible values:

  • yes
  • no
utInformation about date and time when the stage record was last updated. Format UNIX_TIMESTAMP
old_stage_iddeprecated. The attribute will be removed in the next API version
......groups
 
......group
 
idUnique identifier for the group
nameName of the group
utInformation about date and time when the group record was last updated. Format UNIX_TIMESTAMP
........events
 
.........event
 
idUnique identifier for the event
nameName of the event i.e. Spain - Italy
start_dateDate when the event starts in format DATE_TIME (2015-03-01 11:02)
ft_only

Determines when the result of the event is updated. Possible values:

  • yes - result updated only when event is finished 
  • no - result updated during the event
coverage_type

Type of event coverage. Possible values:

  • venue - means the scout is relating the event directly from the stadium
  • tv - means the scout is relating the event from tv transmission
scoutsfeed

Information concerning scouts coverage. Possible values:

  • yes
  • no
status_idUnique identifier of the event status. softnetSPORT API provides the following statuses: statuses.index
status_name

Name of the event status

status_type

Type of the status. Possible values:

  • live
  • scheduled
  • finished
  • cancelled
  • interrupted
  • deleted
  • other
sport_idUnique identifier of the sport in which event is played. softnetSPORT API provides the following sports: sports.index
sport_nameName of the sport in which event is played
dayDay in the season
neutral_venue

Determines if event is played on neutral venue. Possible values:

  • yes
  • no
utInformation about date and time when the event record was last updated. Format UNIX_TIMESTAMP
old_event_iddeprecated. The attribute will be removed in the next API version
.........details
 additional information related to event
..........detail
 
idUnique identifier for the detail
nameName of the detail. Possible values are different depending on the sport. For more information please find node details in the sports.show: sports.show
valueValue related to the detail
.........participants
 
..........participant
 
counterNumber of participant in the event. Participant with counter="1" is home team.
idUnique identifier of the participant
type

Participant type. Possible values:

  • team
  • person
nameParticipant name
short_nameParticipant short name, max length: 20 characters
acronymMax 3 characters length mini name, f.e: BAR, REA
gender

Participant gender. Possible value:

  • male
  • female
  • mixed (for doubles in tennis f.e)
area_idUnique identifier of the area represented by the participant. softnetSPORT API provides the following areas: areas.index
area_nameArea name represented by the participant
area_codeMax 3 characters length of the short area name f.e: GER, POL, FRA
sport_idUnique identifier of the sport in which participant occures. softnetSPORT API provides the following sports: sports.index
sport_nameName of the sport in which participant occures
national

Determines if participant is national team. Possible values:

  • yes
  • no
websiteParticipant official website
utInformation about date and time when the record was last updated. Format UNIX_TIMESTAMP
old_participant_iddeprecated. The attribute will be deprecated in next API version
...........results
 
............result
 
idUnique identifier for the result
nameName of the result. Possible values are different depending on the sport. For more information please find node details in the sports.show: sports.show
valueValue related to the result
...........stats
 
............stat
 
idUnique identifier for the statistic
nameName of the statistic. Possible values are different depending on the sport. For more information please find node details in the sports.show: sports.show
valueValue related to the statistic

 

  • 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
sort_typexsd:string

Determines sort order of data. Possible values:

  • day - events are sorted by the day of the event
  • competition - events are sorted by the name of the competitinon
  • start_date - events are sorted by the start_date
  • most_popular - competitions are sorted by the overall_sort
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
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
  • cancelled
  • 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)
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
latencyxsd:string

Information about the expected latency. Possible values:

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

Information about the statistics level. Possible values:

  • bronze
  • silver
  • gold
  • vip
event_stats_lvl_livexsd:string

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

  • bronze
  • silver
  • gold
  • vip
event_stats_lvl_afterxsd:string

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

  • bronze
  • silver
  • gold
  • vip
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
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

Required with booked.

bookedxsd:string

Possible value:

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

Required with product.

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/livescore?token={{YOUR_TOKEN}}Returns a list of all in progress (live) events in JSON format

Insert excerpt
events.index
events.index
nopaneltrue