FIRST/FMS FRC Events API is a service to return relevant information about the FIRST Robotics Competition (FRC). Information is made available from events operating around the world.
\nFor FRC, information is made available by the Field Management System (FMS) server operating at each event site. The FMS will attempt to sync all data from the event to \"the cloud\" as long as internet is available at the venue. If internet is unavailable, or \"goes down\" during the event, the FMS will automatically sync all data from the time the system was offline as soon as the connection is restored. The API will provide data as soon as it has synced, and we do not add any artificial delays. If you are receiving \"stale\" data, it may be because of connectivity problems at the venue. We recommend you try again later, and post on the FIRST FMS TeamForge site if the problem persists. (Note: FMS does not sync while a match is running, so data that has to do with a particular match should become available once the score has been revealed to the audience at the event.)
\nPay close attention to the addresses for calling the various endpoints- as well as the notes regarding endpoints with multiple possible responses (i.e. score details and rankings).
\nAll times are listed in the local time to the event venue. HTTP-date values will show their timezone.
\nIf you specify a parameter, but no value for that parameter, it will be ignored. For example, if you request URL?teamNumber= the teamNumber parameter would be ignored.
\nWe will continue to support the current version of the API plus one version older. Old APIs are depricated once a version \"two times newer\" is available, at minimum 6 months. For example, version 2.0 and 1.0 are supported right now, but 1.0 will not be supported once 2.1 (or 3.0) is available. Versions may also be retired earlier with prior notice here in the documentation.
\nThe full host address of the API is needed in all calls. The version number is required in each call in order to ensure your requests are made (and responses are returned) in the formats you anticipate. The version number for this documentation is found on the top of the page, in the title. If you call this version number, the API responses will match the formats listed below.
\nAll of the APIs are capable of accepting the Accept HTTP header with either application/xml or application/json based on the desired return type. Any API call that results in an HTTP Status Code other than 200 (OK) will only be shown here as an application/json response to save space, but the content is the same regardless of the request type. All response will have a Content-Length and Date response header, but those are not shown in the documentaiton.
\nFor all APIs that accept a query string in addition to the URI base, the order of parameters do not matter, but the name shown in the documentation must match exactly, as does the associated value format as described in details.
\nFor response codes that are not HTTP 200 (OK), the documentation will show a body message that represents a possible response value. While the \"title\" of the HTTP Status Code will match those shown in the response codes documentation section exactly, the body of the response will be a more detailed explanation of why that status code is being returned and may not always be exactly as shown in the examples.
\nNone of the APIs will show possible return here in the documentation of HTTP 401 (Unauthorized), but that code applies to all APIs as a possible response if the request is made without a valid token.
\nThe FRC Events API utilizes the Last-Modified and If-Modified-Since Headers to communicate with consumers regarding the age of the data they are requesting. With a couple of exceptions, all calls will return a Last-Modified Header set with the time at which the data at that endpoint was last modified. The Header will always be set in the HTTP-date format, as described in the HTTP Protocol. There are two exceptions: the Last-Modified Header is not set if the endpoint returns no results (such as a request for a schedule with no matches) and will also not be set if the request was an HTTP DELETE.
\nConsumers should keep track of the Last-Modified Header, and return it on subsequent calls to the same endpoint as the If-Modified-Since. The server will recognize this request, and will only return a result if the data has been modified since the last request. If no changes have been made, an HTTP 304 will be returned. If data has been modified, ALL data on that call will be returned (for \"only modified\" data, see below).
\nThe FRC Events API also allows a custom header used to filter the return data to a specific subset. This is done by specifying a FMS-OnlyModifiedSince header with each call. As with the If-Modified-Since header, consumers should keep track of the Last-Modified Header, and return it on subsequent calls to the same endpoint as the FMS-OnlyModifiedSince Header. The server will recognize this request, and will only return a result if the data has been modified since the last request, and, if returned, the data will only be those portions modified since the included date. If no changes, have been made, an HTTP 304 will be returned. Using this method, the server and consumer save processing time by only receiving modified data that is in need of update on the consumer side.
\nIf the Headers are improperly passed (such as the wrong Day of Week for the matching date, or a date in the future), the endpoint will simply ignore the Header and return all results. If both headers are specified, the request will be denied.
\nThe FRC Events API HTTP Status Codes correspond with the common codes, but occasionally with different \"titles\". The \"title\" used by the API is shown next to each of the below possible response HTTP Status Codes. Throughout the documentation, Apiary may automatically show the common \"title\" in example returns (like \"Not Found\" for 404) but on the production server, the \"title\" will instead match those listed below.
\nHTTP 200 - \"OK\"\n\nThe request has succeeded. An entity corresponding to the requested resource is sent in the response. This will be returned as the HTTP Status Code for all request that succeed, even if the body is empty (such as an event that has no rankings, but with a valid season and event code were used)
\nHTTP 304 - \"Not Modified\"\n\nWhen utilizing a Header that allows filtered data returns, such as If-Modified-Since, this response indicates that no data meets the request.
\nHTTP 400 - \"Invalid Season Requested\"/\"Malformed Parameter Format In Request\"/\"Missing Parameter In Request\"/\"Invalid API Version Requested\":\n\nThe request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. Specifically for this API, a 400 response indicates that the requested URI matches with a valid API, but one or more required parameter was malformed or invalid. Examples include an event code that is too short or team number that contains a letter.
\nHTTP 401 - \"Unauthorized\"\n\nAll requests against the API require authentication via a valid user token. Failing to provide one, or providing an invalid one, will warrant a 401 response. The client MAY repeat the request with a suitable Authorization header field.
\nHTTP 404 - \"Invalid Event Requested\"\n\nEven though the 404 code usually indicates any not found status, a 404 will only be issued in this API when an event cannot be found for the requested season and event code. If the request didn't match a valid API or there were malformed parameters, the response would not receive a 404 but rather a 400 or 501. If this HTTP code is received, the season was a valid season and the event code matched the acceptable style of an event code, but there were no records of an event matching the combination of that season and event code. For example, HTTP 404 would be issued when the event had a different code in the requested season (the codes can change year to year based on event location).
\nHTTP 500 - \"Internal Server Error\"\n\nThe server encountered an unexpected condition which prevented it from fulfilling the request. This is a code sent directly by the server, and has no special alternate definition specific to this API.
\nHTTP 501 - \"Request Did Not Match Any Current API Pattern\"\n\nThe server does not support the functionality required to fulfill the request. Specifically, the request pattern did not match any of the possible APIs, and thus processing was discontinued. This code is also issued when too many optional parameters were included in a single request and fulfilling it would make the result confusing or misleading. Each API will specify which parameters or combination of parameters can be used at the same time.
\nHTTP 503 - \"Service Unavailable\"\n\nThe server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a Retry-After header. This code will not always appear, sometimes the server may outright refuse the connection instead. This is a code sent directly by the server, and has no special alternate definition specific to this API.
\nSee the notes at the top of this documentation for important information about HTTP Status Codes.
\nIn order to make calls against the FRC Events API, you must include an HTTP Header called Authorization with the value set as specified below. If a request is made without this header, processing stops and an HTTP 401 is issued. All Authorization headers follow the same format:
\nAuthorization: Basic 000000000000000000000000000000000000000000000000000000000000
\nWhere the Zeros are replaced by your Token. The Token can be formed by taking your username and your AuthorizationKey and adding a colon. For example, if your username is sampleuser and your AuthorizationKey is 7eaa6338-a097-4221-ac04-b6120fcc4d49 you would have this string:
\nsampleuser:7eaa6338-a097-4221-ac04-b6120fcc4d49
\nThis string must then be encoded using Base64 Encoded to form the Token, which will be the same length as the example above, but include letters and numbers. For our example, we would have:
\nc2FtcGxldXNlcjo3ZWFhNjMzOC1hMDk3LTQyMjEtYWMwNC1iNjEyMGZjYzRkNDk=
\nNOTICE: Publicly distributing an application, code snippet, etc, that has your username and token in it, encoded or not, WILL result in your token being blocked from the API. Each user should apply for their own token.
\nIf you wish to acquire a token for your development, you may do so by requesting a token through our automated system on this website.
\nAUTOMATED REMOVAL: If you do not activate your account within 72 hours of making your request for a token, or if you do not make at least one API request every twelve (12) months, your account/token will be marked as disabled for inactivity and subject to being deleted. (This policy does not apply to accounts with special operating agreements with FIRST)
\nEach Token can be individually enabled and disabled by FIRST. As such, a normally valid combination of username and AuthorizationToken could still be rejected. The possible return messages you may see in these instances are:
\nIncorrect Token (You supplied an AuthorizationToken, but it wasn't correct)
\nAccount Disabled, Contact Support (You have been disabled for excessive traffic or abuse. Contact support)
\nUsername Not Found (A username was found, but didn't match any on file)
\nUnable To Determine Authorization Token (The format of the Authorization header was incorrect)
\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Documentation Notes","slug":"documentation-notes"},{"content":"Response Codes","slug":"response-codes"},{"content":"Authorization","slug":"authorization"},{"content":"Webhooks","slug":"webhooks"}],"owner":"13920602","collectionId":"51a3938d-2026-4a5c-9f17-d87d035584cd","publishedId":"TW6zHTEi","public":true,"customColor":{"top-bar":"003974","right-sidebar":"003974","highlight":"337AB7"},"publishDate":"2024-02-11T00:48:15.000Z"},"item":[{"name":"Ancillary","item":[{"name":"API Index","id":"f05db20e-424d-47a8-a8f7-24db0c412de2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://frc-api.firstinspires.org/v3.0/","description":"COMING SOON
\n
Root level call with no parameters.
\n","urlObject":{"path":[""],"host":["https://frc-api.firstinspires.org/v3.0"],"query":[],"variable":[]}},"response":[{"id":"d8f52ed7-b885-4309-a35f-b8e615338044","name":"Details about the API","originalRequest":{"method":"GET","header":[],"url":"https://frc-api.firstinspires.org/v3.0/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\t\n \"currentSeason\": 2021,\n \"maxSeason\": 2021,\n \"name\": \"FIRST ROBOTICS COMPETITION API\",\n \"apiVersion\": \"2.0\",\n \"status\": \"normal\"\n}"},{"id":"f2b32f3b-9e86-4f0c-a2ef-620f6ced1157","name":"unexpected error","originalRequest":{"method":"GET","header":[],"url":"https://frc-api.firstinspires.org/v3.0/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"code\": 500,\n\t\"message\": \"Internal Server Error\"\n}"}],"_postman_id":"f05db20e-424d-47a8-a8f7-24db0c412de2"}],"id":"5b6ec9e4-c6c6-49d5-8178-8d8733e3eab7","_postman_id":"5b6ec9e4-c6c6-49d5-8178-8d8733e3eab7","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"51a3938d-2026-4a5c-9f17-d87d035584cd","id":"51a3938d-2026-4a5c-9f17-d87d035584cd","name":"FRC Events","type":"collection"}}},{"name":"Season Data","item":[{"name":"Season Summary","id":"aee3716a-a9ff-4388-b5ed-0fd8b3899d08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(Required)
\n","key":"If-Modified-Since","value":""}],"url":"https://frc-api.firstinspires.org/v3.0/:season","description":"The season summary API returns a high level glance of a particular FRC season.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"51a3938d-2026-4a5c-9f17-d87d035584cd","id":"51a3938d-2026-4a5c-9f17-d87d035584cd","name":"FRC Events","type":"collection"}},"urlObject":{"path":[":season"],"host":["https://frc-api.firstinspires.org/v3.0"],"query":[],"variable":[{"description":{"content":"[REQUIRED] (int) Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"string","value":"2022","key":"season"}]}},"response":[{"id":"14ad543b-a2c4-4b4c-8749-81ebfac82970","name":"unexpected error","originalRequest":{"method":"GET","header":[{"description":{"content":"Added as a part of security scheme: basic","type":"text/plain"},"key":"Authorization","value":"BasicThe event listings API returns all FRC official district and regional events in a particular season. You can specify an eventCode if you would only like data about one specific event. If you specify an eventCode you cannot specify any other optional parameters. Alternately, you can specify a teamNumber to retrieve only the listings of events being attended by the particular team. If you specify a teamNumber you cannot specify an eventCode. The districtCode parameter can be added to filter the response to only thos events from a particular district. If you specify the districtCode parameter, you cannot specify an eventCode or the excludeDistrict parameters. The excludeDistrict parameter can be used to prevent the response from including district events. If you specify the excludeDistrict parameter, you cannot specify an eventCode or districtCode.
Values on this endpoint are \"pass through\" values from the MyEvents registration system. As such, if the event does not specify a value for a field, it may be presented in the API as null.
The response for event listings contains a special field called divisionCode. Starting with the 2015 season, some events are considered to be divisions of others. For example, the FIRST Championship contains four Divisions and each Division contains two Subdivisions. As an example of a reponse, the event listings for a subdivision will contain a divisionCode of the Division from which they belong. In turn, the Division will then have a divisionCode that matches the FIRST Championship event code (as they are divisions of that event). This allows you to see the full structure of events, and how they relate to each other.
Important Note: For events with the type ChampionshipDivision, you cannot request match results, rankings, schedules or alliances. These event types do not have those results, only Subdivisions. As such, you would receive an HTTP 404 (not found) if you request results that are not applicable to the event. However, they do have awards, and those can be requested.
(string) Case insensitive alphanumeric eventCode of the event about which details are requested.
\n","type":"text/plain"},"key":"eventCode","value":""},{"description":{"content":"(int) Numeric teamNumber of the team from which the attending event listings are requested.
\n","type":"text/plain"},"key":"teamNumber","value":""},{"description":{"content":"(string) Case insensitive districtCode of the district from which event listings are requested.
\nDistrict Codes:
\nFMA\nPNW\nNE\nFIN\nFNC\nONT\nISR\nCHS\nFIT\nPCH\nFIM\n(bool) Boolean to specify whether or not to exclude district events in the event listings. true means exclude, but if no value is specified, false will be used (include district events). Excluding district events also excludes district championships.
\n","type":"text/plain"},"key":"excludeDistrict","value":""},{"description":{"content":"(int) Week during the FRC season that the event takes place.
\n","type":"text/plain"},"key":"weekNumber","value":null},{"description":{"content":"(string) Type of event to perform the calculation on.
\nEnum values:
\n1. None\n2. Regional\n3. DistrictEvent\n4. DistrictChampionship\n5. DistrictChampionshipWithLevels\n6. DistrictChampionshipDivision\n7. ChampionshipSubdivision\n8. ChampionshipDivision\n9. Championship\n10. OffSeason\n11. OffSeasonWithAzureSync\n[REQUIRED] (int) Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"string","value":"2022","key":"season"}]}},"response":[{"id":"5a78001c-dfb8-4f10-8063-88a822483498","name":"Response","originalRequest":{"method":"GET","header":[{"description":{"content":"Added as a part of security scheme: basic","type":"text/plain"},"key":"Authorization","value":"BasicThe district listings API returns all FRC official districts of a particular season.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"51a3938d-2026-4a5c-9f17-d87d035584cd","id":"51a3938d-2026-4a5c-9f17-d87d035584cd","name":"FRC Events","type":"collection"}},"urlObject":{"path":[":season","districts"],"host":["https://frc-api.firstinspires.org/v3.0"],"query":[],"variable":[{"description":{"content":"[REQUIRED] (int) Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"string","value":"2022","key":"season"}]}},"response":[{"id":"12941a55-7fe2-42ec-8ae2-3b9a73d9dc63","name":"unexpected error","originalRequest":{"method":"GET","header":[{"description":{"content":"Added as a part of security scheme: basic","type":"text/plain"},"key":"Authorization","value":"BasicThe team listings API returns all FRC official teams in a particular season. If specified, the teamNumber parameter will return only one result with the details of the requested teamNumber. Alternately, the eventCode parameter allows sorting of the team list to only those teams attending a particular event in the particular season. Further, the district parameter allows results to be returned only when the team is a member of the requested district based on the district code. If you specify a teamNumber parameter, you cannot additionally specify an eventCode and/or districtCode and/or state in the same request, or you will receive an HTTP 501. You can however request a districtCode and an eventCode together. If you specify the state parameter, it should be the full legal name of the US state or international state/prov, such as New Hampshire or Ontario. Values on this endpoint are \"pass through\" values from the TIMS registration system. As such, if the team does not specify a value for a field, it may be presented in the API as null.
(int) Numeric teamNumber of the team about which information is requested. Must be 1 to 4 digits.
\n","type":"text/plain"},"key":"teamNumber","value":""},{"description":{"content":"(string) Case insensitive alphanumeric eventCode of the event from which details are requested.
\n","type":"text/plain"},"key":"eventCode","value":""},{"description":{"content":"(string) Case insensitive districtCode code of the district from which team listings are requested.
\nDistrict Codes:
\nFMA\nPNW\nNE\nFIN\nFNC\nONT\nISR\nCHS\nFIT\nPCH\nFIM\n(string) Name of the state or province the desired teams are located.
\n","type":"text/plain"},"key":"state","value":""},{"description":{"content":"(int) Numeric page of results to return. If not included, page 1 will be returned.
\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"description":{"content":"[REQUIRED] (int) Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"string","value":"2022","key":"season"}]}},"response":[{"id":"651cc1f3-654c-49e1-bc6f-796d59793b79","name":"unexpected error","originalRequest":{"method":"GET","header":[{"description":{"content":"Added as a part of security scheme: basic","type":"text/plain"},"key":"Authorization","value":"BasicThis endpoint applies only to the 2018 or later seasons. Requests for other seasons will result in a Bad Season error. The team avatar listings API returns all FRC official teams in a particular season with, if applicable, their Avatar. If specified, the teamNumber parameter will return only one result with the details of the requested teamNumber. Alternately, the eventCode parameter allows sorting of the team list to only those teams attending a particular event in the particular season. If you specify a teamNumber parameter, you cannot additionally specify an eventCode or you will receive an HTTP 501. If a team does not have an Avatar, the return value will be null. Please note that the returned Avatar is encoded in the reply, and would need to be properly handled in order to render a PNG image.
(int) Numeric teamNumber of the team about which information is requested. Must be 1 to 4 digits.
\n","type":"text/plain"},"key":"teamNumber","value":""},{"description":{"content":"(string) Case insensitive alphanumeric eventCode of the event from which details are requested.
\n","type":"text/plain"},"key":"eventCode","value":""},{"description":{"content":"(int) Numeric page of results to return. If not included, page 1 will be returned.
\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"description":{"content":"[REQUIRED] (int) Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"string","value":"2022","key":"season"}]}},"response":[{"id":"1414448d-aede-4e61-ba9c-fd9d12c67174","name":"unexpected error","originalRequest":{"method":"GET","header":[{"description":{"content":"Added as a part of security scheme: basic","type":"text/plain"},"key":"Authorization","value":"BasicThe event awards API returns details about awards presented at a particular event in a particular season. Return values may contain either teamNumber or person values, and if the winner was a person, and that person is from a team, the teamNumber value might be set with their teamNumber.
[REQUIRED] (int) Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"string","value":"2022","key":"season"},{"description":{"content":"(Required) (string) Optional case insensitive alphanumeric eventCode of the event from which the awards are requested. Must be at least 3 characters.
\n","type":"text/plain"},"type":"string","value":"","key":"eventCode"}]}},"response":[{"id":"6bce36f9-bdfa-4cfd-85c2-3b1c640b2d8b","name":"Response","originalRequest":{"method":"GET","header":[{"description":{"content":"Added as a part of security scheme: basic","type":"text/plain"},"key":"Authorization","value":"BasicThe award listings API returns a listing of the various awards that can be distributed in the requested season. This is especially useful in order to avoid having to use the name field of the event awards API to know which award was won. Instead the awardId field can be matched between the two APIs.
[REQUIRED] (int) Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"string","value":"2022","key":"season"}]}},"response":[{"id":"0382a3b5-01ed-4a4f-89dc-413ea36f684c","name":"unexpected error","originalRequest":{"method":"GET","header":[{"description":{"content":"Added as a part of security scheme: basic","type":"text/plain"},"key":"Authorization","value":"BasicThe team awards API returns details about awards presented for a particular team in a particular season. Return values may contain either teamNumber or person values, and if the winner was a person, and that person is from a team, the teamNumber value might be set with their teamNumber.
[REQUIRED] (int) Numeric year of the team from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"any","value":"2022","key":"season"},{"description":{"content":"[REQUIRED] (int) Numeric teamNumber of the team about which information is requested. Must be 1 to 4 digits.
\n","type":"text/plain"},"type":"any","value":"","key":"teamNumber"}]}},"response":[{"id":"d67dbf49-4ebf-4465-9228-48ad99984ba2","name":"Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://frc-api.firstinspires.org/v3.0/:season/awards/team/:teamNumber","host":["https://frc-api.firstinspires.org/v3.0"],"path":[":season","awards","team",":teamNumber"],"variable":[{"key":"season","value":"2022"},{"key":"teamNumber","value":"4265"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Last-Modified","value":"Wed, 04 Mar 2020 20:15:20 GMT"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 04 Jan 2022 20:01:58 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Awards\": [\n {\n \"awardId\": 397,\n \"teamId\": 1023300,\n \"eventId\": 44122,\n \"eventDivisionId\": null,\n \"eventCode\": \"ARLI\",\n \"name\": \"Regional Chairman's Award\",\n \"series\": 1,\n \"teamNumber\": 4265,\n \"schoolName\": \"Oak Ridge High School\",\n \"fullTeamName\": \"Bechtel/UT Battelle & Oak Ridge National Labs/CNS, Consolidated Nucear Security LLC/Leidos/Oak Ridge Schools/Oak Ridge Public Schools Education Foundation/Oak Ridge Tool and Engineering/ARC Machining/RT Coating/ARMEC/Axis Fabrication & Machine/Technical Machining/Centrus/MS Technology, Inc./Engineering Services Group, Inc./UCOR URS CH2M Oak Ridge LLC/ORAU/Fastenal/Roane State Foundation/Bob Eby/FIRST Place Finish&Oak Ridge High School\",\n \"person\": null\n }\n ]\n}"},{"id":"25b52c95-d91e-4b68-93e6-43eab3046a67","name":"unexpected error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://frc-api.firstinspires.org/v3.0/:season/awards/team/:teamNumber","host":["https://frc-api.firstinspires.org/v3.0"],"path":[":season","awards","team",":teamNumber"],"variable":[{"key":"season","value":"2022"},{"key":"teamNumber","value":null}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 500,\n \"message\": \"Internal Server Error\"\n}"}],"_postman_id":"ce5c2d11-9e49-4a73-9c47-16b1aecd7a9b"},{"name":"Event Team Awards","id":"81ad59ba-1bac-42b6-9d47-2558ad8fdbcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://frc-api.firstinspires.org/v3.0/:season/awards/eventteam/:eventCode/:teamNumber","description":"The event team awards API returns details about awards presented at a particular event in a particular season for a particular team. Return values may contain either teamNumber or person values, and if the winner was a person, and that person is from a team, the teamNumber value might be set with their teamNumber.
[REQUIRED] (int) Numeric year of the team and event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"any","value":"2022","key":"season"},{"description":{"content":"[Required] (string) Optional case insensitive alphanumeric eventCode of the event from which the awards are requested. Must be at least 3 characters.
\n","type":"text/plain"},"type":"any","value":"","key":"eventCode"},{"description":{"content":"[REQUIRED] (int) Numeric teamNumber of the team about which information is requested. Must be 1 to 4 digits.
\n","type":"text/plain"},"type":"any","value":"","key":"teamNumber"}]}},"response":[{"id":"e21f5835-1213-4a37-99a5-978a2a0416d5","name":"Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://frc-api.firstinspires.org/v3.0/:season/awards/eventteam/:eventCode/:teamNumber","host":["https://frc-api.firstinspires.org/v3.0"],"path":[":season","awards","eventteam",":eventCode",":teamNumber"],"variable":[{"key":"season","value":"2022"},{"key":"eventCode","value":"ARLI"},{"key":"teamNumber","value":"4265"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Last-Modified","value":"Wed, 04 Mar 2020 20:15:20 GMT"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 04 Jan 2022 19:49:46 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Awards\": [\n {\n \"awardId\": 397,\n \"teamId\": 1023300,\n \"eventId\": 44122,\n \"eventDivisionId\": null,\n \"eventCode\": \"ARLI\",\n \"name\": \"Regional Chairman's Award\",\n \"series\": 1,\n \"teamNumber\": 4265,\n \"schoolName\": \"Oak Ridge High School\",\n \"fullTeamName\": \"Bechtel/UT Battelle & Oak Ridge National Labs/CNS, Consolidated Nucear Security LLC/Leidos/Oak Ridge Schools/Oak Ridge Public Schools Education Foundation/Oak Ridge Tool and Engineering/ARC Machining/RT Coating/ARMEC/Axis Fabrication & Machine/Technical Machining/Centrus/MS Technology, Inc./Engineering Services Group, Inc./UCOR URS CH2M Oak Ridge LLC/ORAU/Fastenal/Roane State Foundation/Bob Eby/FIRST Place Finish&Oak Ridge High School\",\n \"person\": null\n }\n ]\n}"},{"id":"1178a67b-0b42-42a4-a8fc-ec7bde05280b","name":"unexpected error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://frc-api.firstinspires.org/v3.0/:season/awards/eventteam/:eventCode/:teamNumber","host":["https://frc-api.firstinspires.org/v3.0"],"path":[":season","awards","eventteam",":eventCode",":teamNumber"],"variable":[{"key":"season","value":"2022"},{"key":"eventCode","value":null},{"key":"teamNumber","value":null}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 500,\n \"message\": \"Internal Server Error\"\n}"}],"_postman_id":"81ad59ba-1bac-42b6-9d47-2558ad8fdbcb"}],"id":"97acf81a-18fb-43bc-b712-20fc6f8e3db8","_postman_id":"97acf81a-18fb-43bc-b712-20fc6f8e3db8","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"51a3938d-2026-4a5c-9f17-d87d035584cd","id":"51a3938d-2026-4a5c-9f17-d87d035584cd","name":"FRC Events","type":"collection"}}},{"name":"Match Results","item":[{"name":"Score Details","id":"58da7b76-4b47-4ee3-903d-1571897e0a09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"If-Modified-Since","value":""}],"url":"https://frc-api.firstinspires.org/v3.0/:season/scores/:eventCode/:tournamentLevel?matchNumber=&start=&end=","description":"The score details API returns the score detail for all matches of a particular event in a particular season and a particular tournament level. Score details are only available once a match has been played, retrieving info about future matches requires the event schedule API. You cannot receive data about a match that is in progress.
\nIMPORTANT: This endpoint returns differently depending on the season requested. The response details are listed multiple times, representing the different seasons possible in the return. Additionally, the scores shown in the example returns are not necessarily realistic- like the points may not add up.
\nIf you specify the teamNumber parameter, you cannot specify a matchNumber parameter. If you specify the matchNumber, you cannot define a start or end.
Note: If you specify start, and it is higher than the maximum match number at the event, you will not receive any match results in the response. The same is true in reverse for the end parameter.
\n\n\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"51a3938d-2026-4a5c-9f17-d87d035584cd","id":"51a3938d-2026-4a5c-9f17-d87d035584cd","name":"FRC Events","type":"collection"}},"urlObject":{"path":[":season","scores",":eventCode",":tournamentLevel"],"host":["https://frc-api.firstinspires.org/v3.0"],"query":[{"description":{"content":"Click the \"20XX Score Details\" drop down in the example request/response pane (to the right or below) to view example score details responses for each of the available seasons.
\n
(int) Optional specific single matchNumber of result.
\n","type":"text/plain"},"key":"matchNumber","value":""},{"description":{"content":"(int) Optional start match number for subset of results to return (includsive).
\n","type":"text/plain"},"key":"start","value":""},{"description":{"content":"(int) Optional end match number for subset of results to return (inclusive).
\n","type":"text/plain"},"key":"end","value":""}],"variable":[{"description":{"content":"[REQUIRED] (int) Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"string","value":"2022","key":"season"},{"description":{"content":"(Required) [REQUIRED] (string) Case insensitive alphanumeric eventCode of the event from which the details are requested. Must be at least 3 characters.
\n","type":"text/plain"},"type":"string","value":"","key":"eventCode"},{"description":{"content":"(Required) [REQUIRED] (string) Required tournamentLevel of desired score details.
\nEnum values:
\n1. None\n2. Practice\n3. Qualification\n4. Playoff\nThe match results API returns the match results for all matches of a particular event in a particular season. Match results are only available once a match has been played, retrieving info about future matches requires the event schedule API. You cannot receive data about a match that is in progress.
\nIf you specify the matchNumber, start and/or end optional parameters, you must also specify a tournamentLevel. If you specify the teamNumber parameter, you cannot specify a matchNumber parameter. If you specify the matchNumber, you cannot define a start or end.
Note: If you specify start, and it is higher than the maximum match number at the event, you will not receive any match results in the response. The same is true in reverse for the end parameter.
Starting in the 2015 season, Elimination matches were renamed to Playoff matches. As such, you must request Playoff matches from the API, and \"elim\" will not return any results. In Playoffs, match numbers 1-8 are \"Quarterfinal\" matches, 9-14 are \"Semifinal\" and 15-17 are \"Finals\" matches. The \"level\" response however, will always just show \"Playoff\" regardless of the portion of the Playoff tournament.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"51a3938d-2026-4a5c-9f17-d87d035584cd","id":"51a3938d-2026-4a5c-9f17-d87d035584cd","name":"FRC Events","type":"collection"}},"urlObject":{"path":[":season","matches",":eventCode"],"host":["https://frc-api.firstinspires.org/v3.0"],"query":[{"description":{"content":"(string) Optional tournamentLevel of desired match results.
\nEnum values:
\n1. None\n2. Practice\n3. Qualification\n4. Playoff\n(int) Optional teamNumber to search for within the results. Only returns match results in which the requested team was a participant.
\n","type":"text/plain"},"key":"teamNumber","value":""},{"description":{"content":"(int) Optional specific single matchNumber of result.
\n","type":"text/plain"},"key":"matchNumber","value":""},{"description":{"content":"(int) Optional start match number for subset of results to return.
\n","type":"text/plain"},"key":"start","value":""},{"description":{"content":"(int) Optional end match number for subset of results to return (inclusive).
\n","type":"text/plain"},"key":"end","value":""}],"variable":[{"description":{"content":"[REQUIRED] (int) Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"string","value":"2022","key":"season"},{"description":{"content":"(Required) [REQUIRED] (string) Case insensitive alphanumeric eventCode of the event from which the results are requested. Must be at least 3 characters.
\n","type":"text/plain"},"type":"string","value":"","key":"eventCode"}]}},"response":[{"id":"1d596744-e7d5-4cf4-91fe-bed54b35426b","name":"Response","originalRequest":{"method":"GET","header":[{"description":{"content":"Added as a part of security scheme: basic","type":"text/plain"},"key":"Authorization","value":"BasicQual Performance Points is one of three endpoints to assist teams in figuring out how to improve their performance to achieve the desired district ranking placement. It is to determine the Event Total points.
\ntournamentType, sizeType, allianceNumber, and allianceRole are all required parameters for the calculation to occur.
[REQUIRED] (enum string) Type of event to perform the calculation on.
\nEnum values:
\n1. None\n2. Regional\n3. DistrictEvent\n4. DistrictChampionship\n5. DistrictChampionshipWithLevels\n6. DistrictChampionshipDivision\n7. ChampionshipSubdivision\n8. ChampionshipDivision\n9. Championship\n10. OffSeason\n11. OffSeasonWithAzureSync\n12. Remote\n[REQUIRED] (int) Numbered rank of the desired team in the qualification matches.
\n","type":"text/plain"},"key":"qualificationRank","value":""},{"disabled":true,"description":{"content":"[REQUIRED] (int) Number of teams in the event.
\n","type":"text/plain"},"key":"teamsAtEvent","value":""}],"variable":[{"description":{"content":"[REQUIRED] (int) Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"any","value":"2022","key":"season"}]}},"response":[{"id":"07aec974-623a-4203-b056-209d9ce79465","name":"Qual Performance Points","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://frc-api.firstinspires.org/v3.0/:season/rankings/district/qualPerformanceCalculation?tournamentType=Regional&qualificationRank=1&teamsAtEvent=64","host":["https://frc-api.firstinspires.org/v3.0"],"path":[":season","rankings","district","qualPerformanceCalculation"],"query":[{"key":"tournamentType","value":"Regional","description":"**[REQUIRED] (enum string)** Type of event to perform the calculation on.\n\nEnum values:\n```\n1. None\n2. Regional\n3. DistrictEvent\n4. DistrictChampionship\n5. DistrictChampionshipWithLevels\n6. DistrictChampionshipDivision\n7. ChampionshipSubdivision\n8. ChampionshipDivision\n9. Championship\n10. OffSeason\n11. OffSeasonWithAzureSync\n12. Remote\n```"},{"key":"qualificationRank","value":"1","description":"**[REQUIRED] (int)** Numbered rank of the desired team in the qualification matches."},{"key":"teamsAtEvent","value":"64","description":"**[REQUIRED] (int)** Number of teams in the event."}],"variable":[{"key":"season","value":"2022","description":"**[REQUIRED] (int)** Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Wed, 28 Jul 2021 19:40:53 GMT"}],"cookie":[],"responseTime":null,"body":"22"}],"_postman_id":"b94a39ea-7905-4f77-ab42-da5bc717ab00"},{"name":"Alliance Selection Points","id":"4ce07e4f-74d5-45d7-8632-d659cb79ba89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://frc-api.firstinspires.org/v3.0/:season/rankings/district/allianceSelectionCalculation","description":"Alliance Selection Points is one of three endpoints to assist teams in figuring out how to improve their performance to achieve the desired district ranking placement. It is to determine the Event Total points.
\ntournamentType, sizeType, allianceNumber, and allianceRole are all required parameters for the calculation to occur.
[REQUIRED] (string) Type of event to perform the calculation on.
\nEnum values:
\n1. None\n2. Regional\n3. DistrictEvent\n4. DistrictChampionship\n5. DistrictChampionshipWithLevels\n6. DistrictChampionshipDivision\n7. ChampionshipSubdivision\n8. ChampionshipDivision\n9. Championship\n10. OffSeason\n11. OffSeasonWithAzureSync\n[REQUIRED] (string) Number of alliances in the playoffs for the event.
\nEnum values:
\n1. TwoAlliance\n2. FourAlliance\n3. SixAlliance\n4. EightAlliance\n5. SixteenAlliance\n[REQUIRED] (int) The number of the playoff alliance the team is on.
\n","type":"text/plain"},"key":"allianceNumber","value":""},{"disabled":true,"description":{"content":"[REQUIRED] (string) Team's role in the playoff alliance.
\nEnum values:
\n1. None\n2. Captain\n3. Round1\n4. Round2\n5. Round3\n6. Backup\n[REQUIRED] (int) Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"any","value":"2022","key":"season"}]}},"response":[{"id":"cce4e4bf-1940-47d4-a9cf-f1af6e129819","name":"Alliance Selection Points","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://frc-api.firstinspires.org/v3.0/:season/rankings/district/allianceSelectionCalculation?tournamentType=Regional&sizeType=EightAlliance&allianceNumber=2&allianceRole=Captain","host":["https://frc-api.firstinspires.org/v3.0"],"path":[":season","rankings","district","allianceSelectionCalculation"],"query":[{"key":"tournamentType","value":"Regional","description":"**[REQUIRED] (string)** Type of event to perform the calculation on.\n\nEnum values:\n```\n1. None\n2. Regional\n3. DistrictEvent\n4. DistrictChampionship\n5. DistrictChampionshipWithLevels\n6. DistrictChampionshipDivision\n7. ChampionshipSubdivision\n8. ChampionshipDivision\n9. Championship\n10. OffSeason\n11. OffSeasonWithAzureSync\n```"},{"key":"sizeType","value":"EightAlliance","description":"**[REQUIRED] (string)** Number of alliances in the playoffs for the event.\n\nEnum values:\n```\n1. TwoAlliance\n2. FourAlliance\n3. SixAlliance\n4. EightAlliance\n5. SixteenAlliance\n```"},{"key":"allianceNumber","value":"2","description":"**[REQUIRED] (int)** The number of the playoff alliance the team is on."},{"key":"allianceRole","value":"Captain","description":"**[REQUIRED] (string)** Team's role in the playoff alliance.\n\nEnum values:\n```\n1. None\n2. Captain\n3. Round1\n4. Round2\n5. Round3\n6. Backup\n```"}],"variable":[{"key":"season","value":"2022","description":"**[REQUIRED] (int)** Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Wed, 28 Jul 2021 19:39:28 GMT"}],"cookie":[],"responseTime":null,"body":"15"}],"_postman_id":"4ce07e4f-74d5-45d7-8632-d659cb79ba89"},{"name":"Playoff Advancement Points","id":"5752dcb4-7eb9-444b-8886-7a8cb2941b5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://frc-api.firstinspires.org/v3.0/:season/rankings/district/playoffAdvancementCalculation","description":"Playoff Advancement Points is one of three endpoints to assist teams in figuring out how to improve their performance to achieve the desired district ranking placement. It is to determine the Event Total points.
\ntournamentType, quarterFinalWins, semiFinalWins, and finalWins are all required parameters for the calculation to occur.
[REQUIRED] (string) Type of event to perform the calculation on.
\nEnum values:
\n1. None\n2. Regional\n3. DistrictEvent\n4. DistrictChampionship\n5. DistrictChampionshipWithLevels\n6. DistrictChampionshipDivision\n7. ChampionshipSubdivision\n8. ChampionshipDivision\n9. Championship\n10. OffSeason\n11. OffSeasonWithAzureSync\n[REQUIRED] (int) Number of Quarterfinal matches the team has won.
\n","type":"text/plain"},"key":"quarterFinalWins","value":""},{"disabled":true,"description":{"content":"[REQUIRED] (int) Number of Semifinal matches the team has won.
\n","type":"text/plain"},"key":"semiFinalWins","value":""},{"disabled":true,"description":{"content":"[REQUIRED] (int) Number of Final matches the team has won.
\n","type":"text/plain"},"key":"finalWins","value":""}],"variable":[{"description":{"content":"[REQUIRED] (int) Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"any","value":"2022","key":"season"}]}},"response":[{"id":"751a2a54-9ab5-42db-8cd3-99b8397034f0","name":"Playoff Advancement Points","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://frc-api.firstinspires.org/v3.0/:season/rankings/district/playoffAdvancementCalculation?tournamentType=Regional&quarterFinalWins=4&semiFinalWins=4&finalWins=4","host":["https://frc-api.firstinspires.org/v3.0"],"path":[":season","rankings","district","playoffAdvancementCalculation"],"query":[{"key":"tournamentType","value":"Regional","description":"**[REQUIRED] (string)** Type of event to perform the calculation on.\n\nEnum values:\n```\n1. None\n2. Regional\n3. DistrictEvent\n4. DistrictChampionship\n5. DistrictChampionshipWithLevels\n6. DistrictChampionshipDivision\n7. ChampionshipSubdivision\n8. ChampionshipDivision\n9. Championship\n10. OffSeason\n11. OffSeasonWithAzureSync\n```"},{"key":"quarterFinalWins","value":"4","description":"**[REQUIRED] (int)** Number of Quarterfinal matches the team has won."},{"key":"semiFinalWins","value":"4","description":"**[REQUIRED] (int)** Number of Semifinal matches the team has won."},{"key":"finalWins","value":"4","description":"**[REQUIRED] (int)** Number of Final matches the team has won."}],"variable":[{"key":"season","value":"2022","description":"**[REQUIRED] (int)** Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Wed, 28 Jul 2021 19:53:48 GMT"}],"cookie":[],"responseTime":null,"body":"60"}],"_postman_id":"5752dcb4-7eb9-444b-8886-7a8cb2941b5b"}],"id":"25060e88-4f28-44b2-85ba-043712d36939","description":"District Ranking Calculation endpoints only represent part of the District Ranking Calculation in FMS. Using these endpoints will not represent your team's ranking.
\nTo see your team's actual Event Total points, Qual Performance points, Alliance Selection points, and Playoff Advancement points for their District Ranking, follow the below instructions:
\nhttps://frc-events.firstinspires.org/team/[teamNumber]These endpoints do NOT require authorization with a user/auth token.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"810bb63a-41f9-48ea-9956-4c9fcaf945b4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1525d975-9f00-44b5-820d-d80fea867568","type":"text/javascript","exec":[""]}}],"_postman_id":"25060e88-4f28-44b2-85ba-043712d36939"},{"name":"Event Rankings","id":"92624bba-036e-4bca-ada1-f591b1c9b5da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"If-Modified-Since","value":""}],"url":"https://frc-api.firstinspires.org/v3.0/:season/rankings/:eventCode?teamNumber=&top=","description":"The rankings API returns team ranking detail from a particular event in a particular season. Optionally, the top parameter can be added to the query string to request a subset of the rankings based on the highest ranked teams at the time of the request. Alternately, you can specify the teamNumber parameter to retrieve the ranking on one specific team. You cannot specify both a top and teamNumber in the same call.
IMPORTANT: This endpoint use to return differently for 2015 vs other seasons. In the fall 2016 updates, this was changed, and all seasons of data now return in the genericized format specified below.
\nIn all response details, the \"team\" refers to the FRC Team that the ranking represents, as well as their various alliance partners in the matches they have played (i.e. scores in a single match are not calcualted by team, but by alliance). See the FRC Game Manual for more information.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"51a3938d-2026-4a5c-9f17-d87d035584cd","id":"51a3938d-2026-4a5c-9f17-d87d035584cd","name":"FRC Events","type":"collection"}},"urlObject":{"path":[":season","rankings",":eventCode"],"host":["https://frc-api.firstinspires.org/v3.0"],"query":[{"description":{"content":"(int) Optional team number of the team whose ranking is requested.
\n","type":"text/plain"},"key":"teamNumber","value":""},{"description":{"content":"(int) Optional number of requested top ranked teams to return in result.
\n","type":"text/plain"},"key":"top","value":""}],"variable":[{"description":{"content":"[REQUIRED] (int) Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"string","value":"2022","key":"season"},{"description":{"content":"(Required) [REQUIRED] (string) Case insensitive alphanumeric eventCode of the event from which the rankings are requested. Must be at least 3 characters.
\n","type":"text/plain"},"type":"string","value":"","key":"eventCode"}]}},"response":[{"id":"131e21c1-c097-43a2-9e8e-46e68f35ae8b","name":"Response","originalRequest":{"method":"GET","header":[{"description":{"content":"Added as a part of security scheme: basic","type":"text/plain"},"key":"Authorization","value":"BasicThe district rankings API returns team ranking detail from a particular team in a particular season. You must specify a districtCode unless a teamNumber is being specified. If a teamNumber is specified, do not include any other paramaters. Optionally, the top parameter can be added to the query string to request a subset of the rankings based on the highest ranked teams at the time of the request. Alternately, you can specify the teamNumber parameter to retrieve the ranking on one specific team. You cannot specify both a top and teamNumber in the same call. If you specify a page, you cannot specify a top.
This endpoint is only updated periodically, and may not reflect final rankings for an event/district until a period of time after a given event is completed. The final authority on teams advancing tournament levels is the District Ranking website and communications from FIRST, not this API. See the FRC Game Manual for more information.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"51a3938d-2026-4a5c-9f17-d87d035584cd","id":"51a3938d-2026-4a5c-9f17-d87d035584cd","name":"FRC Events","type":"collection"}},"urlObject":{"path":[":season","rankings","district"],"host":["https://frc-api.firstinspires.org/v3.0"],"query":[{"description":{"content":"(string) Case insensitive alphanumeric districtCode of the district from which the rankings are requested. Must be at least 2 characters.
\nDistrict Codes:
\nFMA\nPNW\nNE\nFIN\nFNC\nONT\nISR\nCHS\nFIT\nPCH\nFIM\n(int) Optional team number of the team whose ranking is requested.
\n","type":"text/plain"},"key":"teamNumber","value":""},{"description":{"content":"(int) Optional number of requested top ranked teams to return in result.
\n","type":"text/plain"},"key":"top","value":""},{"description":{"content":"(int) Numeric page of results to return. If not included, page 1 will be returned.
\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"description":{"content":"[REQUIRED] (int) Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"string","value":"2022","key":"season"}]}},"response":[{"id":"2ca52d3c-ca73-4592-84e1-30eda395244d","name":"Response","originalRequest":{"method":"GET","header":[{"description":{"content":"Added as a part of security scheme: basic","type":"text/plain"},"key":"Authorization","value":"BasicThe schedule API returns the match schedule for the desired tournament level of a particular event in a particular season. You must also specify a tournamentLevel from which to return the results. Alternately, you can specify a teamNumber to filter the results to only those in which a particular team is participating. There is no validation that the teamNumber you request is actually competing at the event, if they are not, the response will be empty. You can also specify the parameters together, but cannot make a request without at least one of the two.
(string) tournamentLevel of desired match schedule.
\nEnum values:
\n1. None\n2. Practice\n3. Qualification\n4. Playoff\n(int) Optional teamNumber to search for within the schedule. Only returns matches in which the requested team participated.
\n","type":"text/plain"},"key":"teamNumber","value":""},{"description":{"content":"(int) Optional start match number for subset of results to return (inclusive).
\n","type":"text/plain"},"key":"start","value":""},{"description":{"content":"(int) Optional end match number for subset of results to return (inclusive).
\n","type":"text/plain"},"key":"end","value":""}],"variable":[{"description":{"content":"[REQUIRED] (int) Numeric year of the event from which the award listings are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"string","value":"2022","key":"season"},{"description":{"content":"[REQUIRED] (string) Case insensitive alphanumeric eventCode of the event from which the schedule are requested. Must be at least 3 characters.
\n","type":"text/plain"},"type":"string","value":"","key":"eventCode"}]}},"response":[{"id":"0370b745-5251-4137-975e-9805c525d236","name":"Response","originalRequest":{"method":"GET","header":[{"description":{"content":"Added as a part of security scheme: basic","type":"text/plain"},"key":"Authorization","value":"BasicThe alliances API returns details about alliance selection at a particular event in a particular season.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"51a3938d-2026-4a5c-9f17-d87d035584cd","id":"51a3938d-2026-4a5c-9f17-d87d035584cd","name":"FRC Events","type":"collection"}},"urlObject":{"path":[":season","alliances",":eventCode"],"host":["https://frc-api.firstinspires.org/v3.0"],"query":[],"variable":[{"description":{"content":"[REQUIRED] (int) Numeric year of the event from which the event alliances are requested. Must be 4 digits and greater than or equal to 2015, and less than or equal to the current year.
\n","type":"text/plain"},"type":"any","value":"2022","key":"season"},{"description":{"content":"[REQUIRED] (string) Case insensitive alphanumeric eventCode of the event from which the alliance selection results are requested. Must be at least 3 characters.
\n","type":"text/plain"},"type":"any","value":"","key":"eventCode"}]}},"response":[],"_postman_id":"8e0d4491-e991-4345-b864-2e10e3c9ccc0"}],"id":"fd2e39ba-1674-4b0a-88b7-33120db5a79b","_postman_id":"fd2e39ba-1674-4b0a-88b7-33120db5a79b","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"51a3938d-2026-4a5c-9f17-d87d035584cd","id":"51a3938d-2026-4a5c-9f17-d87d035584cd","name":"FRC Events","type":"collection"}}}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"6528b2ec-ae88-420e-98b1-842cf1519f61","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"45dbf9cb-dd90-4cc9-a485-7ecdf4133686","type":"text/javascript","exec":[""]}}],"variable":[{"key":"season","value":"2022"},{"key":"baseUrl","value":"https://frc-api.firstinspires.org/v3.0"},{"key":"username","value":""},{"key":"authToken","value":""}]}