THthebluealliance
match

GET /match/{match_key}/simple

Changed on

Gets a short-form Match object for the given match key.

Request

  • Base URL
    https://www.thebluealliance.com/api/v3
  • Auth
    API key in header X-TBA-Auth-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 (pm, qm, ef, qf, sf, f), and MATCH_NUMBER is the match number in the competition level. A set number may append the competition level if more than one match in required per set.

comp_level'pm' | '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.

predicted_timeinteger nullable required

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

actual_timeinteger nullable required

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

Changes

  • a32ede23975eRevision changes
    • warning

      added the new pm enum value to the response property for the response status

  • c26cc01880d2Revision changes
    • breaking

      the response's property type changed from string to no type for status

    • info

      added to the response property allOf list for the response status

    • info

      removed the enum value from the response property for the response status

    • info

      removed the blue enum value from the response property for the response status

    • info

      removed the red enum value from the response property for the response status