HIhify
Tournament Matches

List matches for a tournament

Returns matches for the tournament, filtered by scope, court number, and/or search term. Searches player names (including an anonymous participant's feed or linked-account name) and side team names. Results are deduplicated and ordered by sequence number.

get/v1/tournaments/{tournament_id}/matches

Request

  • Base URL
    https://api.hify.club
  • Auth
    API key in header X-User-Token

Query parameters

scope'past' | 'claimed' | 'unclaimed'

Filter matches by scope. "past" returns completed matches the current user had claimed. "claimed" returns active matches the current user has claimed. "unclaimed" returns non-completed matches with no active claim. Default (omitted) returns all non-completed matches.

court_numberinteger

Filter by arena court number (in_facility_id).

searchstring

Search by player name (including an anonymous participant's feed or linked-account name) or a side's team name. Case-insensitive partial match.

Response

List of matches

idinteger
game_idinteger
sequence_numberinteger nullable
round_numberinteger nullable
stage'league' | 'quarterfinal' | 'semifinal' | 'knockout' | 'final' | 'third_place'

Where the match sits in the tournament

status'pending' | 'in_progress' | 'completed'
status_label'UPCOMING' | 'LIVE' | 'DONE'
winner_side'side_a' | 'side_b' | 'draw' nullable
court_numberinteger nullable
game_start_timestring date-time nullable
game_end_timestring date-time nullable
category_labelstring nullable

Display category, e.g. "Open Mixed Doubles"

score_summarystring nullable
score_detailobject nullable
winner_namesstring nullable
started_atstring date-time nullable
duration_secondsinteger nullable
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.