Sign in

v2

latestOpenAPI 3.1.12026-07-2685124366.6 KB
match

Gets a Match object for the given match key.

get/match/{match_key}

Path parameters

match_keystring required

TBA Match Key, eg 2016nytr_qm1

Headers

If-None-Matchstring

Value of the ETag header in the most recently cached response by the client.

Response

Successful response

keystring required

TBA match key with the format yyyy[EVENT_CODE]_[COMP_LEVEL]m[MATCH_NUMBER], where yyyy is the year, and EVENT_CODE is the event code of the event, COMP_LEVEL is (qm, ef, qf, sf, f), and MATCH_NUMBER is the match number in the competition level. A set number may be appended to the competition level if more than one match in required per set.

comp_level'qm' | 'ef' | 'qf' | 'sf' | 'f' required

The competition level the match was played at.

set_numberinteger required

The set number in a series of matches where more than one match is required in the match series.

match_numberinteger required

The match number of the match in the competition level.

winning_alliance'red' | 'blue' | '' required

The color of an alliance, or an empty string when there is no winning alliance (e.g. tie or no result). See https://github.com/the-blue-alliance/the-blue-alliance/blob/main/src/backend/common/consts/alliance_color.py for red/blue definitions.

event_keystring required

Event key of the event the match was played at.

timeinteger nullable required

UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of the scheduled match time, as taken from the published schedule.

actual_timeinteger nullable required

UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of actual match start time.

predicted_timeinteger nullable required

UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of the TBA predicted match start time.

post_result_timeinteger nullable required

UNIX timestamp (seconds since 1-Jan-1970 00:00:00) when the match result was posted.