Versions Compared

Old Version 14

changes.mady.by.user Adam Działach

Saved on

compared with

New Version 15

changes.mady.by.user Adam Działach

Saved on

Key

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

Resource information

...

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: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 between 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. If you use a single date_from to parameter you will receive all events that start in the 24 hours from 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_idascending
    • event.dayascending
    • event.stage_idascending
    • event.group_idascending
    • event.start_dateascending
    • event.idascending

  • start_date - events are sorted by
    • event.start_date
    • country.nameascending
    • competition.country_sortascending
    • event.dayascending
    • event.competition_idascending
    • event.stage_idascending
    • event.group_idascending
    • event.idascending

  • most_popular - events are sorted by
    • the competition.overall_sort (most popular)
    • country.nameascending
    • competition.country_sortascending
    • event.competition_idascending
    • event.dayascending
    • event.stage_idascending
    • event.start_dateascending
    • event.group_idascending
    • event.idascending
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
  • cancelledcanceled
  • 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
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.

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.

...