Sign in

v1

latestOpenAPI 3.0.02026-07-133931,7612.0 MB
StarCraft 2 matches

Get running StarCraft 2 matches

List running StarCraft 2 matches

get/starcraft-2/matches/running

Query parameters

begin_atMatchBeginAt[]
detailed_statsboolean

Whether the match offers full stats

drawboolean

Whether result of the match is a draw

end_atMatchEndAt[]
finishedboolean
forfeitboolean

Whether match was forfeited

futureboolean

true for future matches only, false for past matches only. Filtering is done on the begin_at value, so matches with running status will not appear if true.

idMatchID[]
league_idLeagueID[]
low_latency_feedboolean

Whether to filter matches available via the Low Latency Feed. true returns only LLF-eligible matches, false excludes them.

match_typeMatchType[]
modified_atMatchModifiedAt[]
nameMatchName[]
not_startedboolean
number_of_gamesGameCount[]
opponents_filledboolean

Whether a match has opponents filled i.e. opponents are not TBD.

pastboolean
runningboolean
scheduled_atMatchScheduledAt[]
serie_idSerieID[]
slugMatchSlug[]
statusMatchStatus[]
tournament_idTournamentID[]
unscheduledboolean
winner_typeMatchWinnerType[]

Options to filter results. String fields are case sensitive For more information on filtering, see docs.

begin_atMatchBeginAt[]
detailed_statsMatchDetailedStats[]
drawMatchIsDraw[]
end_atMatchEndAt[]
forfeitMatchIsForfeit[]
idMatchID[]
match_typeMatchType[]
modified_atMatchModifiedAt[]
nameMatchName[]
number_of_gamesGameCount[]
scheduled_atMatchScheduledAt[]
slugMatchSlug[]
statusMatchStatus[]
tournament_idTournamentID[]
winner_typeMatchWinnerType[]

Options to select results within ranges For more information on ranges, see docs.

sortstring[]

Options to sort results For more information on sorting, see docs.

match_type'all_games_played' | 'best_of' | 'custom' | 'first_to' | 'ow_best_of' | 'red_bull_home_ground'
namestring
slugstring
status'canceled' | 'finished' | 'not_started' | 'postponed' | 'running'
winner_type'Player' | 'Team'

Options to search results For more information on searching, see docs.

integer
OR

Pagination in the form of page=2 or page[size]=30&page[number]=2

per_pageinteger

Equivalent to page[size]

Response

A list of StarCraft 2 matches

begin_atstring date-time nullable required
detailed_statsboolean required

Whether the match offers full stats

drawboolean required

Whether result of the match is a draw

end_atstring date-time nullable required
forfeitboolean required

Whether match was forfeited

game_advantageinteger nullable required

ID of the opponent with a game advantage

idinteger required
league_idinteger required
low_latency_feedboolean

Whether Whether the match is available via the Low Latency Feed. Important: this field is only present in the response for subscribers of a Low Latency Feed plan.

match_type'all_games_played' | 'best_of' | 'custom' | 'first_to' | 'ow_best_of' | 'red_bull_home_ground' required
modified_atstring date-time required
namestring required
number_of_gamesinteger required

Number of games

original_scheduled_atstring date-time nullable required
rescheduledboolean nullable required

Whether match has been rescheduled

scheduled_atstring date-time nullable required
serie_idinteger required
slugstring nullable required
status'canceled' | 'finished' | 'not_started' | 'postponed' | 'running' required
tournament_idinteger required
videogameCurrentVideogame ([object Object], [object Object], [object Object], [object Object], [object Object], [object Object], [object Object], [object Object], [object Object], [object Object], [object Object], [object Object], [object Object], [object Object], [object Object], [object Object], [object Object], [object Object], [object Object], [object Object]) required
winner_type'Player' | 'Team' required