Sign in

v2

latestOpenAPI 3.1.12026-07-2685124366.6 KB
event

Gets a short-form list of events in the given year.

get/events/{year}/simple

Path parameters

yearinteger required

Competition Year (or Season). Must be 4 digits.

Headers

If-None-Matchstring

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

Response

Successful response

keystring required

TBA event key with the format yyyy[EVENT_CODE], where yyyy is the year, and EVENT_CODE is the event code of the event.

namestring required

Official name of event on record either provided by FIRST or organizers of offseason event.

event_codestring required

Event short code, as provided by FIRST.

event_type0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 99 | 100 | -1 required

Event Type. See https://github.com/the-blue-alliance/the-blue-alliance/blob/main/src/backend/common/consts/event_type.py for definitions.

citystring nullable required

City, town, village, etc. the event is located in.

state_provstring nullable required

State or Province the event is located in.

countrystring nullable required

Country the event is located in.

start_datestring date required

Event start date in yyyy-mm-dd format.

end_datestring date required

Event end date in yyyy-mm-dd format.

yearinteger required

Year the event data is for.