FRC Division Notifier API

An API to retrieve information regarding the status of division assignments for the 2017 FIRST© Robotics Competition World Championships. This API provides division data in a simpler and easier to use format than the official FRC API.

Recommended minimum polling interval is 1 minute due to server side caching, although 5 minutes or longer should be sufficient for most use cases.

No authentication is currently required, however if unmanageable high volume occurs an API key will be required for continued use and rate limits may be enforced.

FIRST and FIRST Robotics Competition are registered trademarks of FIRST (www.firstinspires.org) which is not overseeing, involved with, or responsible for this API.

I provide no guarantee for this product. Use it at your own risk.


Base path: http://frc.divisions.co/api/v2/
Contact Info: frc@evanforbes.net
Version: 2.0.0
All rights reserved

Methods

Up
get /status
Gets the current status of the division release

URL

http://frc.divisions.co/api/v2/status

Return type

Status

Responses

200

Successful response

401

Unauthorized

500

Server error

get /team_list
Gets the current list of teams registered for the FRC World Championship

URL

http://frc.divisions.co/api/v2/team_list

Return type

[Team]

Responses

200

Successful response

401

Unauthorized

500

Server error

Models

Team

team_number
Integer
team_name
String AKA nickname
location
String City, State, Country
division_name
String The division this team has been assigned to, or null if it has not yet been assigned
Enum:
Archimedes
Carson
Carver
Curie
Daly
Darwin
Galileo
Hopper
Newton
Roebling
Tesla
Turing
region
String The region key for the championship this team is registered for
Enum:
north
south

Status

north
RegionStatus status information for the St. Louis championship
south
RegionStatus status information for the Houston championship
world
WorldStatus status information for all championships

RegionStatus

out
Boolean true when at least one team has been assigned to a division in this championship, otherwise false
state
String The current state of the division release for this championship
Enum:
none
some
all
description
String The current state of the division release for this championship, in human-friendly text
Enum:
{Houston | St. Louis} divisions are out
{Houston | St. Louis} divisions are coming out
{Houston | St. Louis} divisions are not out yet
team_count
Integer Total number of teams on the registration list for this championship
team_count_with_divisions
Integer Total number of teams on the registration list for this championship that have been assigned to a division

WorldStatus

out
Boolean true when at least one team has been assigned to a division in a championship, otherwise false
state
String The current state of the division release for all championships
Enum:
none
some
all