| key |
str |
TBA event key with the format yyyy[EVENT_CODE], where yyyy is the year, and EVENT_CODE is the event code of the event. |
|
| name |
str |
Official name of event on record either provided by FIRST or organizers of offseason event. |
|
| event_code |
str |
Event short code, as provided by FIRST. |
|
| event_type |
int |
Event Type, as defined here: https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/event_type.py#L2 |
|
| district |
DistrictList |
|
[optional] |
| city |
str |
City, town, village, etc. the event is located in. |
[optional] |
| state_prov |
str |
State or Province the event is located in. |
[optional] |
| country |
str |
Country the event is located in. |
[optional] |
| start_date |
date |
Event start date in `yyyy-mm-dd` format. |
|
| end_date |
date |
Event end date in `yyyy-mm-dd` format. |
|
| year |
int |
Year the event data is for. |
|
| short_name |
str |
Same as `name` but doesn't include event specifiers, such as 'Regional' or 'District'. May be null. |
[optional] |
| event_type_string |
str |
Event Type, eg Regional, District, or Offseason. |
|
| week |
int |
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.) |
[optional] |
| address |
str |
Address of the event's venue, if available. |
[optional] |
| postal_code |
str |
Postal code from the event address. |
[optional] |
| gmaps_place_id |
str |
Google Maps Place ID for the event address. |
[optional] |
| gmaps_url |
str |
Link to address location on Google Maps. |
[optional] |
| lat |
float |
Latitude for the event address. |
[optional] |
| lng |
float |
Longitude for the event address. |
[optional] |
| location_name |
str |
Name of the location at the address for the event, eg. Blue Alliance High School. |
[optional] |
| timezone |
str |
Timezone name. |
[optional] |
| website |
str |
The event's website, if any. |
[optional] |
| first_event_id |
str |
The FIRST internal Event ID, used to link to the event on the FRC webpage. |
[optional] |
| first_event_code |
str |
Public facing event code used by FIRST (on frc-events.firstinspires.org, for example) |
[optional] |
| webcasts |
list[Webcast] |
|
[optional] |
| division_keys |
list[str] |
An array of event keys for the divisions at this event. |
[optional] |
| parent_event_key |
str |
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`. |
[optional] |
| playoff_type |
int |
Playoff Type, as defined here: https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/playoff_type.py#L4, or null. |
[optional] |
| playoff_type_string |
str |
String representation of the `playoff_type`, or null. |
[optional] |