{"note":"OpenAPI conversion -- returning structured metadata","name":"firstinspires-org","description":"FRC Events","version":"unknown","base_url":"https://frc-api.firstinspires.org/v3.0","endpoints":19,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api FRC Events\n@base https://frc-api.firstinspires.org/v3.0\n@auth Basic\n@endpoints 19\n@toc v3.0(19)\n\n@endpoint GET /v3.0/\n@desc Root level call with no parameters\n@returns(200) {currentSeason: int, maxSeason: int, name: str, apiVersion: str, status: str}\n\n@endpoint GET /v3.0/:season\n@desc The season summary API returns a high level glance of a particular FRC season\n@returns(500) {code: int, message: str}\n\n@endpoint GET /v3.0/:season/events\n@desc The event listings API returns all FRC official district and regional events in a particular season\n@returns(200) {Events: [map], eventCount: int}\n\n@endpoint GET /v3.0/:season/districts\n@desc The district listings API returns all FRC official districts of a particular season\n@returns(500) {code: int, message: str}\n\n@endpoint GET /v3.0/:season/teams\n@desc The team listings API returns all FRC official teams in a particular season\n@returns(500) {code: int, message: str}\n\n@endpoint GET /v3.0/:season/avatars\n@desc This endpoint applies only to the 2018 or later seasons\n@returns(500) {code: int, message: str}\n\n@endpoint GET /v3.0/:season/awards/event/:eventCode\n@desc The event awards API returns details about awards presented at a particular event in a particular season\n@returns(200) {Awards: [map]}\n\n@endpoint GET /v3.0/:season/awards/list\n@desc The award listings API returns a listing of the various awards that can be distributed in the requested season\n@returns(500) {code: int, message: str}\n\n@endpoint GET /v3.0/:season/awards/team/:teamNumber\n@desc The team awards API returns details about awards presented for a particular team in a particular season\n@returns(200) {Awards: [map]}\n\n@endpoint GET /v3.0/:season/awards/eventteam/:eventCode/:teamNumber\n@desc The event team awards API returns details about awards presented at a particular event in a particular season for a particular team\n@returns(200) {Awards: [map]}\n\n@endpoint GET /v3.0/:season/scores/:eventCode/:tournamentLevel\n@desc The score details API returns the score detail for all matches of a particular event in a particular season and a particular tournament level\n@returns(200) {MatchScores: [map]}\n\n@endpoint GET /v3.0/:season/matches/:eventCode\n@desc The match results API returns the match results for all matches of a particular event in a particular season\n@returns(200) {Matches: [map]}\n\n@endpoint GET /v3.0/:season/rankings/district/qualPerformanceCalculation\n@desc Qual 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\n\n@endpoint GET /v3.0/:season/rankings/district/allianceSelectionCalculation\n@desc 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\n\n@endpoint GET /v3.0/:season/rankings/district/playoffAdvancementCalculation\n@desc 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\n\n@endpoint GET /v3.0/:season/rankings/:eventCode\n@desc The rankings API returns team ranking detail from a particular event in a particular season\n@returns(200) {Rankings: [map]}\n\n@endpoint GET /v3.0/:season/rankings/district\n@desc The district rankings API returns team ranking detail from a particular team in a particular season\n@returns(200) {districtRanks: [map], rankingCountTotal: int, rankingCountPage: int, pageCurrent: int, pageTotal: int}\n\n@endpoint GET /v3.0/:season/schedule/:eventCode\n@desc The schedule API returns the match schedule for the desired tournament level of a particular event in a particular season\n@returns(200) {Schedule: [map]}\n\n@endpoint GET /v3.0/:season/alliances/:eventCode\n@desc The alliances API returns details about alliance selection at a particular event in a particular season\n\n@end\n"}