Migration guide for deprecated fields
Learn how to migrate your apps to handle deprecated fields
Release date
Changes will be live on October 10th 2022. All deprecated endpoints and fields will be removed from the REST API.
Response headers
Deprecated endpoints return the following response headers:
Deprecated: trueandSunset: 10 October 2022 00:00:00 UTC.
A note on video game–specific endpoints
Video game–specific endpoints will be deprecated in the same fashion as the generic one. These endpoints are not listed here to keep the list clean.
In practice, this means that any change to a /resource endpoint will also affect all /{videogame}/resource endpoints, eg. /csgo/resource, /dota2/resource, etc.
Deprecated endpoints
The following endpoints are currently deprecated and will be entirely removed from the API on 10 October 2022:
| Deprecated endpoints |
|---|
/series/{series_id_or_slug}/players |
/tournaments/{tournament_id_or_slug}/players |
Video game–specific endpoints
Keep in mind that video game–specific endpoints will also be removed.
Migration guide
To retrieve the list of players from a tournament, we recommend using the Get a tournament rosters endpoint.
Using the list of team rosters, you can aggregate the complete list of players by concatenating all players array.
For more information on tournaments participants, see tournaments in-depth.
Why this change?
Tournament rosters is central to our API design. Endpoints like
/tournaments/:id/playersand/series/:id/playersencourage alternative usages that can lead to knowledge gaps in the community.
Deprecated fields
Video game–specific endpoints
Keep in mind that fields in video game–specific endpoints will also be removed.
Leagues
The following League fields are currently deprecated and will be entirely removed from the API on October 10th 2022:
- Deprecated fields in
seriesarray, see Series > Other affected endpoints
Series
The following Series fields are currently deprecated and will be entirely removed from the API on October 10th 2022:
description— this has always beennull😬tier— moved to tournament level, see changelog
Affected series endpoints
| Affected endpoints |
|---|
/series |
/series/{series_id_or_slug} |
/series/running |
/series/past |
/series/upcoming |
/teams/{team_id_or_slug}/series |
/leagues/{league_id_or_slug}/series |
/videogames/{videogame_id_or_slug}/series |
Other affected endpoints
Series are also contained in other endpoints responses. In these endpoints too, the description and tiers fields will be removed from the Series objects.
| Affected endpoint | Field |
|---|---|
/leagues | series (array) |
/leagues/{league_id_or_slug} | series (array) |
/teams/{team_id_or_slug}/leagues | series (array) |
/videogames/{videogame_id_or_slug}/leagues | series (array) |
/tournaments | series |
/tournaments/past | series |
/tournaments/running | series |
/tournaments/upcoming | series |
/tournaments/{tournament_id_or_slug} | series |
/series/{series_id_or_slug}/tournaments | series |
/teams/{team_id_or_slug}/tournaments | series |
/leagues/{league_id_or_slug}/tournaments | series |
/videogames/{videogame_id_or_slug}/tournaments | series |
Tournaments
The following Tournaments fields are currently deprecated and will be entirely removed from the API on October 10th 2022:
- Deprecated fields in
expected_roster[].players[], see Players > Other affected endpoints - Deprecated fields in
matches, see Matches > Other affected endpoints - Deprecated fields in
serie, Series > Other affected endpoints
Matches
The following Matches fields are currently deprecated and will be entirely removed from the API on October 10th 2022:
live_embed_urlofficial_stream_urlstreams— replaced bystreams_list, see changelog- Deprecated fields in
games[], see Games > Other affected endpoints - Deprecated fields in
serie, see Series > Other affected endpoints
Affected match endpoints
| Affected endpoints |
|---|
/matches |
/matches/past |
/matches/running |
/matches/upcoming |
/matches/{match_id_or_slug} |
/leagues/{league_id_or_slug}/matches |
/leagues/{league_id_or_slug}/matches/past |
/leagues/{league_id_or_slug}/matches/running |
/leagues/{league_id_or_slug}/matches/upcoming |
/series/{series_id_or_slug}/matches |
/series/{series_id_or_slug}/matches/past |
/series/{series_id_or_slug}/matches/running |
/series/{series_id_or_slug}/matches/upcoming |
/tournaments/{tournament_id_or_slug}/matches |
/teams/{team_id_or_slug}/matches |
/players/{player_id_or_slug}/matches |
Other affected endpoints
Matches are also contained in other endpoints responses. In these endpoints too, the aforementioned fields will be removed from Matches objects.
| Affected endpoint | Field |
|---|---|
/lives | matches (array) |
/tournaments | matches (array) |
/tournaments/past | matches (array) |
/tournaments/running | matches (array) |
/tournaments/upcoming | matches (array) |
/tournaments/{tournament_id_or_slug} | matches (array) |
/tournaments/{tournament_id_or_slug}/brackets | matches (array) |
/series/{series_id_or_slug}/tournaments | matches (array) |
/teams/{team_id_or_slug}/tournaments | matches (array) |
/leagues/{league_id_or_slug}/tournaments | matches (array) |
/videogames/{videogame_id_or_slug}/tournaments | matches (array) |
Games
The following Games fields is currently deprecated and will be entirely removed from the API on October 10th 2022:
video_url— usestreams_listat the match-level
Affected game endpoints
| Affected endpoints |
|---|
/csgo/games/{csgo_game_id} |
/csgo/matches/{match_id_or_slug}/games |
/dota2/games/{dota2_game_id} |
/dota2/matches/{match_id_or_slug}/games |
/lol/games/{lol_game_id} |
/lol/matches/{match_id_or_slug}/games |
/valorant/games/{valorant_game_id} |
/valorant/matches/{match_id_or_slug}/games |
Other affected endpoints
Games are also contained in other endpoints responses. In these endpoints too, the aforementioned fields will be removed from Games objects.
| Affected endpoints | Field |
|---|---|
/matches | games (array) |
/matches/past | games (array) |
/matches/running | games (array) |
/matches/upcoming | games (array) |
/matches/{match_id_or_slug} | games (array) |
/leagues/{league_id_or_slug}/matches | games (array) |
/leagues/{league_id_or_slug}/matches/past | games (array) |
/leagues/{league_id_or_slug}/matches/running | games (array) |
/leagues/{league_id_or_slug}/matches/upcoming | games (array) |
/series/{series_id_or_slug}/matches | games (array) |
/series/{series_id_or_slug}/matches/past | games (array) |
/series/{series_id_or_slug}/matches/running | games (array) |
/series/{series_id_or_slug}/matches/upcoming | games (array) |
/tournaments/{tournament_id_or_slug}/matches | games (array) |
/teams/{team_id_or_slug}/matches | games (array) |
/players/{player_id_or_slug}/matches | games (array) |
/tournaments/{tournament_id_or_slug}/brackets | games (array) |
Lives
The following Lives fields is currently deprecated and will be entirely removed from the API on October 10th 2022:
event
Affected live endpoints
| Affected endpoints |
|---|
/lives |
Teams
The following Teams fields are currently deprecated and will be entirely removed from the API on October 10th 2022:
- Deprecated fields in
playersarray, see Players > Other affected endpoints
Players
The following Players fields are currently deprecated and will be entirely removed from the API on October 10th 2022:
birth_year— usebirthdayinstead, and read About players' agehometown— usenationalityinstead
Affected players endpoints
| Affected endpoints |
|---|
/players |
/players/{player_id_or_slug} |
/series/{series_id_or_slug}/players |
/tournaments/{tournament_id_or_slug}/players |
Other affected endpoints
Players are also contained in other endpoints responses. In these endpoints too, the aforementioned fields will be removed from Players objects.
| Affected endpoints | Field |
|---|---|
/teams | players array |
/teams/{team_id_or_slug} | players array |
/tournaments/{tournament_id_or_slug} | players array |
/tournaments/{tournament_id_or_slug}/teams | players array |
Stats
There are two types of stats endpoints: team stats and players stats. These endpoints will also be affected by the removal of previously mentioned fields.
Depending on the endpoint type (player or team) and the aggregated period for statistics (eg. over a match, tournament, series, or specified time range), the removed fields will be different.
| Affected endpoints | Affected by |
|---|---|
/{videogame}/players/{player_id_or_slug}/stats | Players |
/{videogame}/matches/{match_id_or_slug}/players/stats | Players, Matches |
/{videogame}/tournament/{tournament_id_or_slug}/players/{player_id_or_slug}/stats | Players, Tournaments |
/{videogame}/series/{series_id_or_slug}/players/{player_id_or_slug}/stats | Players, Series |
/{videogame}/teams/{team_id_or_slug}/stats | Teams |
/{videogame}/tournament/{tournament_id_or_slug}/teams/{team_id_or_slug}/stats | Teams, Tournaments |
/{videogame}/series/{series_id_or_slug}/teams/{team_id_or_slug}/stats | Teams, Series |
Updated almost 2 years ago