This API is open to all developers for reasonable use only, and should not be abused. We reserve the right to change or remove the API at any time if a need arises. While we don't expect to take any drastic action, we still reserve that right.
The current version is at v1. We may make backward compatible changes without introducing a new version, but be aware that this may not always be possible.
PLEASE NOTE: The data available by this API, and by this site in general, includes data from Missouri FTC events only. Yeah, we know a general site for all regions would be cool, but honestly we don't have the time right now to support that.
Finally, if you find this useful, please drop us a line and let us know! We'd absolutely love to hear how this data is being used.Email Us
One day the Time Fairy will come down and give us lots of extra time. When that happens, high on our priority list is to provide good documentation for this API. Since that hasn't yet occurred, unfortunately you're stuck with what we've been able to write quickly.
All requests are to be made using REST endpoints (GET requests). The data will always be returned as a JSON object as noted below.
The events request will return all of the events for a given FTC game. The game is identified by a game identifier. The game identifier must be one of: Res-Q (resq), Velocty Vortex (velocity) or Relic Recovery (relic).
The event request will return the event, team, award, and match information for a given event. The event is identified in the form gameid_eventid. As in the Events request, the game identifier must be one of: Res-Q (resq), Velocty Vortex (velocity) or Relic Recovery (relic). The eventid is is usually in the form of a two or three character identifier. Valid values for gameid and eventid can be found using the Events request.
The teams request will return all of the teams registered and participating for a given year. Currently, only two games are supported: Res-Q (resq) and Velocty Vortex (velocity).
The team request will return detailed information on a specified team for every game where the team has participated (back to the resq season only). This includes team information, events, awards, and matches played. The team is identified by their team number.
The match request will return detailed match data for a specified match. The match requested is identifed by a match_id which takes the following format: gameid_eventid_divisionid_match, where:
The data returned for the match will include detailed scoring data recorded by the scoring software. Most of the fields returned are self explanitory and will not be covered in detail, however the data contained within "score_details" will be different depending upon which game is being requested (resq or velocity) and those fields follow the convention used used in the scoring software. The values returned are documented below to help with clarity:
Currently this API is available as-is. We make no promises that we'll ever update this beyond what is necessary to help support this site. However, we are tired right now and it's late, so perhaps our mood will improve after some sleep. If you have a specific request that would make this API easier to use, please do get in touch. No promises, but we do keep a list and if it doesn't take us too far out of the way we might just be able to get it in.
Last Major Update: 2016-Oct-04