Method parameters
| Name | Type | Description |
|---|
| There are no method parameters in this resource |
Query parameters
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 | 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 requested date |
| date_to | xsd:string | Selection 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_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. 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
|
| sort_type | xsd: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_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
|
| 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
- cancelled
- 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)
|
| 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
|
| latency | xsd:string | Information about the expected latency. Possible values: - null (for the event with scoutsfeed=no parameter)
- 1-2s
- 3-6s
- 7-15s
|
| event_stats_lvl | xsd:string | Information about the statistics level. Possible values: |
| event_stats_lvl_live | xsd:string | Information about expected statistics level when the match is LIVE. Possible values: |
| event_stats_lvl_after | xsd:string | Information about expected statistics level after the end of the match. Possible values: |
| 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
|
| 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
|
| 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: Required with booked. |
| booked | xsd:string | Possible value: - yes - result is booked in selected product
- no - result is not booked in selected product
Required with product. |
| 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. |
Method calling examples
Output elements
| competitions |
|---|
| competitions > competition |
|---|
| id | Unique identifier for the competition | | ls_id | For internal purposes | | name | Name of the the competition e.g. U19 World Champ. Possible translation of the attribute | | source | For internal purposes | | source_dc | For internal purposes | | source_super | For internal purposes | | short_name | Abbreviated 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: | | 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_id | Unique identifier for area in which competitions are played. The complete list of possible areas can be retrieved using the API resource: areas.index | | area_name | Name of area in which competitions are played. Possible translation of the attribute | | area_type | Type of area in which competitions are played. Possible values: | | area_sort | The 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_code | Max 3 characters, area in which competitions are played | | overall_sort | The parameter used to sort competitions. Sorting direction is ascending | | sport_id | Unique 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_name | Name of the sport in which the competition is played. Possible translation of the attribute | | tour_id | Unique 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_name | Name of the tour in which the competition is played | | ut | Information about when the date and time of the competition record was last updated. Format UNIX_TIMESTAMP | | old_competition_id | DEPRECATED. The attribute will be removed in the next API version | | slug | friendly url for competition | | status | Possible values: - active
- inactive
- archived (for competitions that no longer take place)
|
|
|
|---|
|
|---|
| id | Unique identifier for the season. | | name | Name 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: | | ut | Information about the date and time of when the season record was last updated. Format UNIX_TIMESTAMP | | old_season_id | deprecated. The attribute will be removed in the next API version | | stats_lvl | Season's stats level. Possible values: vip, gold, silver, bronze | | team_connection | For internal usage |
|
|
|---|
|
|---|
| Unique identifier for the stage |
| stage_name_id | Unique identifier for the stage's name |
| name | Name of the stage. Possible translation of the attribute |
| start_date | Date when stage begins. Format YYYY-MM-DD |
| end_date | Date when stage ends. Format YYYY-MM-DD |
| show_standings | Determines if the stage contains standings. Possible values: |
| groups_nr | The number of groups that are part of the stage |
| sort | The sort order for the stage. The sorting direction is ascending |
| is_current | Possible values: |
| ut | Information about the date and time of when the stage record was last updated. Format UNIX_TIMESTAMP |
| old_stage_id | deprecated. The attribute will be removed in the next API version |
| has_brackets | Information about the availability of tournament bracket for the stage. Possible values: |
|
|---|
|
|---|
| id | Unique identifier for the group | | name | Name of the group | | ut | Information about the date and time of when the group record was last updated. Format UNIX_TIMESTAMP |
|
|
|---|
|
|---|
| id | Unique identifier for the event | | ls_id | Internal | | name | Name of the event e.g. Spain - Italy | | source | Identificator of scout related to the event. Attribute for internal purposes | | source_dc | Internal | | source_super | Internal | | 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_date | Date 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_id | Internal | | channel_name | Internal | | 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_id | Unique 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_id | Unique 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_name | Name of the sport in which event is played | | day | Day of the season | | clock_time | How many seconds have passed in the current event period. Possible empty value | | clock_status | Clock status. Possible value: | | winner_id | Who is the winner of the match | | progress_id | Who advanced to the next round | | bet_status | Possible value: | | bet_cards | Changed when there is a possibility of a card. Possible value: | | bet_corners | Changed when there is a possibility of a corner. Possible value: | | neutral_venue | Determines if the event is played at a neutral venue. Possible values: | | 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
| | ut | Information about when the date and time of the event record was last updated. Format UNIX_TIMESTAMP | | old_event_id | deprecated. The attribute will be removed in the next API version | | slug | friendly 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_by | Internal | | result_verified_at | Internal | | is_protocol_verified | Internal | | protocol_verified_by | Internal | | protocol_verified_at | Internal | | round_id | Unique identifier for the round in which event is played. Possible null value. | | round_name | Name of the round | | competition_id | Unique identifier for the competition | | competition_short_name | Abbreviated name of the competition | | client_event_id | Unique 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_participants | Internal | | venue_id | Deprecated | | bfs | Internal | | event_stats_lvl | Information about the statistics level. Possible values: | | event_stats_lvl_live | Information about expected statistics level when the match is LIVE. Possible values: | | event_stats_lvl_after | Information about expected statistics level after the end of the match. Possible values: | | due_to | Internal | | latency | Information about the expected latency. Possible values: - null (for the event with scoutsfeed=no parameter)
- 1-2s
- 3-6s
- 7-15s
| | event_stats_level | Internal | | verified_result | Possible value: - yes - result is verified with an official source
- no - result is not verified with an official source
| | is_coverage_limited | Determines if event has limited information about players statistics | | played_time | Shows how many seconds have passed in the event (including additional time). Possible empty value. |
|
|
|---|
|
|---|
| additional information related to event |
|---|
| id | Unique identifier for the detail | | name | Name of the detail. Possible values are different depending on the sport | | value | Value related to the detail |
|
|
|---|
|
|---|
| counter | Number of participant in the event. Participant with counter="1" is the home team. |
| id | Unique identifier of the participant | | type | Participant type. Possible values: | | name | Participants name | | short_name | Participants abbreviated name, max length: 20 characters | | acronym | Max 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_id | Unique identifier for the area represented by the participant. | | area_name | Area name represented by the participant. | | area_code | Max 3 characters in length for the abbreviated area name e.g. GER, POL, FRA. | | sport_id | Unique identifier for the sport in which the participant is involved. | | sport_name | Name of the sport in which the participant is involved. | | national | Determines if participant is a national team. Possible values: | | website | Participants official website | | ut | Information about when the date and time of the record was last updated. Format UNIX_TIMESTAMP | | old_participant_id | deprecated. The attribute will be removed in the next API version | | slug | friendly url for participant | | logo | Attribute for internal purpose | | virtual | Determines if the participant is real player / team or virtual. Possible values: | | shirt_nr | Information about player's season number |
|
|
|---|
|
|---|
| id | Unique identifier for the result | | short_name | Abbreviated name of the result. | | name | Name of the result. Possible values are different depending on the sport | | value | Value related to the result | | data_type | Defines type of field generated on front (internal purpose only) - integer
- decimal
- binary_text
- binary
- text
- signed_integer
|
|
|
|---|
|
|---|
| id | Unique identifier for the statistic | | short_name | Abbreviated name of the statistic. | | name | Name of the statistic. Possible values are different depending on the sport | | value | Value related to the statistic | | data_type | Defines type of field generated on front (internal purpose only) - integer
- decimal
- binary_text
- binary
- text
- signed_integer
|
|