Matches
This endpoint allows you to retrieve the matches.
You can use id
from the seasons
, tournaments
, rounds
, arenas
, referees
and teams
endpoint to get the matches.
Matches status codes:
type | description |
---|---|
canceled | Abandoned |
canceled | Canceled |
finished | Walkover |
finished | Removed |
finished | Ended |
finished | Coverage canceled |
finished | AP |
finished | AET |
interrupted | Interrupted |
postponed | Postponed |
upcoming | Not started |
live | 1st period |
live | 2nd period |
live | 3rd period |
live | 4th period |
live | 1st extra |
live | 2nd extra |
For scores we have fields for covering that: current
, display
, period1
, period2
, period3
, period4
, period5
, normaltime
, overtime
, penalties
, series
, aggregated
, extra1
, extra2
, team
.
For time extras or injuries we have fields for covering that: current, period1, period2, period3, overtime, current_period_start_timestamp.
Multi-language: This feature allows the user to manually change the language of the API response by adding value to the
lang
attribute. Example:lang=en
.
Pagination: The endpoint uses an offset and limit system. Specify the offset and limit parameters to fetch the desired range of results. The maximum and default number of results per request is 50.
Update Period: The endpoint is updated every 10 seconds.
Recommended Calls: Limit calls to 1 every 10 seconds.
Use Cases
Get matcheshttps://hockey.sportdevs.com/matches
Get match based on the idhttps://hockey.sportdevs.com/matches?id=eq.{id}
Get matches based on the start_timestamp (gte = greater than or equal to, lt = lower than)https://hockey.sportdevs.com/matches?start_timestamp=gte.2023-04-27&start_timestamp=lt.2023-04-28
Get matches based on the status_typehttps://hockey.sportdevs.com/matches?status_type=eq.{status_type}
Get matches based on the season_idhttps://hockey.sportdevs.com/matches?season_id=eq.{season_id}
Get matches based on the tournament_idhttps://hockey.sportdevs.com/matches?tournament_id=eq.{tournament_id}
Get matches based on the round_idhttps://hockey.sportdevs.com/matches?round_id=eq.{round_id}
Get matches based on the arena_idhttps://hockey.sportdevs.com/matches?arena_id=eq.{arena_id}
Get matches based on the referee_idhttps://hockey.sportdevs.com/matches?referee_id=eq.{referee_id}
H2H - Get head to head matches with teams ex.(home_team_id, away_team_id)https://hockey.sportdevs.com/matches?or=(home_team_id.eq.{home_team_id}, away_team_id.eq.{home_team_id}, home_team_id.eq.{away_team_id}, away_team_id.eq.{away_team_id})
Get home team matches based on the home_team_idhttps://hockey.sportdevs.com/matches?home_team_id=eq.{home_team_id}
Get away team matches based on the away_team_idhttps://hockey.sportdevs.com/matches?away_team_id=eq.{away_team_id}
Query Parameters
- id integer
Default value:
eq.6
The id of the match
- tournament_id integer
Default value:
eq.12971
The id of the tournament
- season_id integer
Default value:
eq.36
The id of the season
- arena_id integer
Default value:
eq.2962
The id of the arena
- referee_id integer
Default value:
eq.123
The id of the referee
- home_team_id integer
Default value:
eq.7231
The id of the home team
- away_team_id integer
Default value:
eq.7362
The id of the away team
- offset string
Default value:
0
Limiting and Pagination
- limit string
Default value:
50
Limiting and Pagination
- lang string
Default value:
en
Multi-language
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema array
- id integer
The id of the match
Note: This is a Primary Key.
- name character varying
Home team name vs away team name
- tournament_id integer
The id of the tournament
Note: This is a Foreign Key to
seasons-by-tournament.tournament_id
. - tournament_name text
The name of the tournament
- tournament_importance integer
The importance of the tournament
- season_id integer
The id of the season
Note: This is a Foreign Key to
seasons.id
. - season_name text
The name of the season
- rounds jsonb
The rounds
- status jsonb
The status of the match
- status_type text
The type of the match
- attendance integer
The number of people watching the match at the arena
- arena_id integer
The id of the arena
Note: This is a Foreign Key to
arenas.id
. - arena_name text
The name of the arena
- arena_hash_image character varying
Possible values:
<= 64 characters
The name image of the arena
- referee_id integer
The id of the referee
Note: This is a Foreign Key to
referees.id
. - referee_name text
The name of the referee
- referee_hash_image character varying
Possible values:
<= 64 characters
The name image of the referee
- home_team_id integer
The id of the home team
Note: This is a Foreign Key to
teams.id
. - home_team_name text
The name of the home team
- home_team_hash_image character varying
Possible values:
<= 64 characters
The name image of the home team
- away_team_id integer
The id of the away team
Note: This is a Foreign Key to
teams.id
. - away_team_name text
The name of the away team
- away_team_hash_image character varying
Possible values:
<= 64 characters
The name image of the away team
- home_team_score jsonb
The score of the home team
- away_team_score jsonb
The score of the away team
- times jsonb
The time of the match
- coaches jsonb
The coaches
- specific_start_time timestamp with time zone
The real start time of the match
- start_time timestamp with time zone
The official start time of the match
- end_time timestamp with time zone
The end of the match
- last_period text
The last period of the match
- season_statistics_type text
The type of the season's statistics
- lineups_id integer
The id of the lineup
- graphs_id integer
The id of the graph
- coaches_id integer
The id of the coaches
- class_id integer
The id of the class
- class_name text
The name of the class
- class_hash_image character varying
Possible values:
<= 64 characters
The name of the class image
- league_id integer
The id of the league
- league_name text
The name of the league
- league_hash_image character varying
Possible values:
<= 64 characters
The name of the league image
- previous_leg_match_id integer
The id of the previous leg match
- weather_id integer
The id of the weather
- weather_main text
The main weather
- weather_icon text
The name icon of the weather
[
{
"id": 6,
"name": "Sporting Kansas City vs San Jose Earthquakes",
"tournament_id": 12971,
"tournament_name": "MLS, Playoffs",
"tournament_importance": 345,
"season_id": 36,
"season_name": "Major League Soccer 2023",
"status": [
{
"type": "finished",
"reason": "AP"
}
],
"status_type": "finished",
"attendance": 17437,
"arena_id": 2962,
"arena_name": "Children's Mercy Park",
"arena_hash_image": "b6336e52b9dbe14de01de361b7d3f28f12ca35b526da7b9398a5394f01340484",
"referee_id": 123,
"referee_name": "Allen Chapman",
"referee_hash_image": "1d4e5d31d9284aadf3c1c104cc3952f75aadef02a41abfbed70ac2279b49a1f5",
"home_team_id": 7231,
"home_team_name": "Sporting Kansas City",
"home_team_hash_image": "e2e6b7bdff458f2f9de5f5408eb7f0cc2b4364f6e688502d768e0e76521aab2c",
"away_team_id": 7362,
"away_team_name": "San Jose Earthquakes",
"away_team_hash_image": "da70b056d35517ae9dd24464eca1515d5a5177c1c788ca9bb4a2a7c9c0dcc3bc",
"home_team_score": [
{
"current": 4,
"display": 0,
"period_1": 0,
"period_2": 0,
"penalties": 4,
"default_time": 0
}
],
"away_team_score": [
{
"current": 2,
"display": 0,
"period_1": 0,
"period_2": 0,
"penalties": 2,
"default_time": 0
}
],
"times": [
{
"extend_time_1": 0,
"extend_time_2": 5,
"specific_start_time": "2023-10-26T02:40:50+00:00"
}
],
"coaches": [
{
"away_coach_id": 2225,
"home_coach_id": 2197,
"away_coach_name": "Luchi Gonzalez",
"home_coach_name": "Peter Joseph Vermes",
"away_coach_hash_image": "8dcdc853117b550117ba6dfa413920a2d4cc79c679f09066780af16418ca2c6a",
"home_coach_hash_image": "7614e40b2e7a574e5bdf33627c11f0dac7fb401716ce8814c5fc090dc3be5c54"
}
],
"specific_start_time": "2023-10-26T02:40:50+00:00",
"start_time": "2023-10-26T01:30:00+00:00",
"end_time": "2023-10-26T02:40:50+00:00",
"last_period": "period2",
"season_statistics_type": "overall",
"lineups_id": 335340,
"graphs_id": 151101,
"coaches_id": 6942,
"class_id": 133,
"class_name": "USA",
"class_hash_image": "e53e0fb3c55a28a318bccf6b7a5c78afe4fe9f22181c922fcab556349db72cf4",
"league_id": 60,
"league_name": "MLS",
"league_hash_image": "56a1b1c2e462971ca920a9daadb4c20e608e083eb410c550ba96a962b666ecfc"
}
]