Sign in

v2

latestOpenAPI 3.1.12026-07-2685124366.6 KB
event

Gets a list of events in the given year.

get/events/{year}

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.

short_namestring nullable required

Same as name but doesn't include event specifiers, such as 'Regional' or 'District'. May be null.

event_type_stringstring required

Event Type, eg Regional, District, or Offseason.

weekinteger nullable required

Week of the event relative to the first official season event, zero-indexed. Only valid for Regionals, Districts, and District Championships. Null otherwise. (Eg. A season with a week 0 'preseason' event does not count, and week 1 events will show 0 here. Seasons with a week 0.5 regional event will show week 0 for those event(s) and week 1 for week 1 events and so on.)

addressstring nullable required

Address of the event's venue, if available.

postal_codestring nullable required

Postal code from the event address.

gmaps_place_idstring nullable required

Google Maps Place ID for the event address. Will be NULL, for future development.

gmaps_urlstring url nullable required

Link to address location on Google Maps. Will be NULL, for future development.

latnumber double nullable required

Latitude for the event address. Will be NULL, for future development.

lngnumber double nullable required

Longitude for the event address. Will be NULL, for future development.

location_namestring nullable required

Name of the location at the address for the event, eg. Blue Alliance High School.

timezonestring nullable required

IANA Timezone identifier.

websitestring nullable required

The event's website, if any.

first_event_idstring nullable required

The FIRST internal Event ID, used to link to the event on the FRC webpage.

first_event_codestring nullable required

Public facing event code used by FIRST (on frc-events.firstinspires.org, for example)

division_keysstring[] required

An array of event keys for the divisions at this event.

parent_event_keystring nullable required

The TBA Event key that represents the event's parent. Used to link back to the event from a division event. It is also the inverse relation of divison_keys.

playoff_type1 | 0 | 2 | 9 | 3 | 4 | 5 | 10 | 11 | 6 | 7 | 8 required

Playoff bracket format. See https://github.com/the-blue-alliance/the-blue-alliance/blob/main/src/backend/common/consts/playoff_type.py for definitions.

playoff_type_stringstring nullable required

String representation of the playoff_type, or null.

remap_teamsobject nullable required

Map of temporary "off-season demo" team numbers to pre-rookie and B teams. Both keys and values are team keys in the format 'frc####'. Key is the old team key ('frc' + numeric only), value is the new team key ('frc' + numeric + may include a letter suffix).