actionGETv1.0.0
getDistrictEvents
Gets a list of events in the given district.
actionGETv1.0.0
getDistrictEventsKeys
Gets a list of event keys for events in the given district.
actionGETv1.0.0
getDistrictEventsSimple
Gets a short-form list of events in the given district.
actionGETv1.0.0
getDistrictRankings
Gets a list of team district rankings for the given district.
actionGETv1.0.0
getDistrictsByYear
Gets a list of districts and their corresponding district key, for the given year.
actionGETv1.0.0
getDistrictTeams
Gets a list of `Team` objects that competed in events in the given district.
actionGETv1.0.0
getDistrictTeamsKeys
Gets a list of `Team` objects that competed in events in the given district.
actionGETv1.0.0
getDistrictTeamsSimple
Gets a short-form list of `Team` objects that competed in events in the given district.
actionGETv1.0.0
getEvent
Gets an Event.
actionGETv1.0.0
getEventAlliances
Gets a list of Elimination Alliances for the given Event.
actionGETv1.0.0
getEventAwards
Gets a list of awards from the given event.
actionGETv1.0.0
getEventDistrictPoints
Gets a list of team rankings for the Event.
actionGETv1.0.0
getEventInsights
Gets a set of Event-specific insights for the given Event.
actionGETv1.0.0
getEventMatches
Gets a list of matches for the given event.
actionGETv1.0.0
getEventMatchesKeys
Gets a list of match keys for the given event.
actionGETv1.0.0
getEventMatchesSimple
Gets a short-form list of matches for the given event.
actionGETv1.0.0
getEventMatchTimeseries
Gets an array of Match Keys for the given event key that have timeseries data. Returns an empty array if no matches have timeseries data. *WARNING:* This is *not* official data, and is subject to a significant possibility of error, or missing data. Do not rely on this data for any purpose. In fact, pretend we made it up. *WARNING:* This endpoint and corresponding data models are under *active development* and may change at any time, including in breaking ways.
actionGETv1.0.0
getEventOPRs
Gets a set of Event OPRs (including OPR, DPR, and CCWM) for the given Event.
actionGETv1.0.0
getEventPredictions
Gets information on TBA-generated predictions for the given Event. Contains year-specific information. *WARNING* This endpoint is currently under development and may change at any time.
actionGETv1.0.0
getEventRankings
Gets a list of team rankings for the Event.
actionGETv1.0.0
getEventsByYear
Gets a list of events in the given year.
actionGETv1.0.0
getEventsByYearKeys
Gets a list of event keys in the given year.
actionGETv1.0.0
getEventsByYearSimple
Gets a short-form list of events in the given year.
actionGETv1.0.0
getEventSimple
Gets a short-form Event.
actionGETv1.0.0
getEventTeams
Gets a list of `Team` objects that competed in the given event.
actionGETv1.0.0
getEventTeamsKeys
Gets a list of `Team` keys that competed in the given event.
actionGETv1.0.0
getEventTeamsSimple
Gets a short-form list of `Team` objects that competed in the given event.
actionGETv1.0.0
getEventTeamsStatuses
Gets a key-value list of the event statuses for teams competing at the given event.
actionGETv1.0.0
getMatch
Gets a `Match` object for the given match key.
actionGETv1.0.0
getMatchSimple
Gets a short-form `Match` object for the given match key.
actionGETv1.0.0
getMatchTimeseries
Gets an array of game-specific Match Timeseries objects for the given match key or an empty array if not available. *WARNING:* This is *not* official data, and is subject to a significant possibility of error, or missing data. Do not rely on this data for any purpose. In fact, pretend we made it up. *WARNING:* This endpoint and corresponding data models are under *active development* and may change at any time, including in breaking ways.
actionGETv1.0.0
getMatchZebra
Gets Zebra MotionWorks data for a Match for the given match key.
actionGETv1.0.0
getStatus
Returns API status, and TBA status information.
actionGETv1.0.0
getTeam
Gets a `Team` object for the team referenced by the given key.
actionGETv1.0.0
getTeamAwards
Gets a list of awards the given team has won.
actionGETv1.0.0
getTeamAwardsByYear
Gets a list of awards the given team has won in a given year.
actionGETv1.0.0
getTeamDistricts
Gets an array of districts representing each year the team was in a district. Will return an empty array if the team was never in a district.
actionGETv1.0.0
getTeamEventAwards
Gets a list of awards the given team won at the given event.
actionGETv1.0.0
getTeamEventMatches
Gets a list of matches for the given team and event.
actionGETv1.0.0
getTeamEventMatchesKeys
Gets a list of match keys for matches for the given team and event.
actionGETv1.0.0
getTeamEventMatchesSimple
Gets a short-form list of matches for the given team and event.
actionGETv1.0.0
getTeamEvents
Gets a list of all events this team has competed at.
actionGETv1.0.0
getTeamEventsByYear
Gets a list of events this team has competed at in the given year.
actionGETv1.0.0
getTeamEventsByYearKeys
Gets a list of the event keys for events this team has competed at in the given year.
actionGETv1.0.0
getTeamEventsByYearSimple
Gets a short-form list of events this team has competed at in the given year.
actionGETv1.0.0
getTeamEventsKeys
Gets a list of the event keys for all events this team has competed at.
actionGETv1.0.0
getTeamEventsSimple
Gets a short-form list of all events this team has competed at.
actionGETv1.0.0
getTeamEventsStatusesByYear
Gets a key-value list of the event statuses for events this team has competed at in the given year.
actionGETv1.0.0
getTeamEventStatus
Gets the competition rank and status of the team at the given event.
actionGETv1.0.0
getTeamMatchesByYear
Gets a list of matches for the given team and year.
actionGETv1.0.0
getTeamMatchesByYearKeys
Gets a list of match keys for matches for the given team and year.
actionGETv1.0.0
getTeamMatchesByYearSimple
Gets a short-form list of matches for the given team and year.
actionGETv1.0.0
getTeamMediaByTag
Gets a list of Media (videos / pictures) for the given team and tag.
actionGETv1.0.0
getTeamMediaByTagYear
Gets a list of Media (videos / pictures) for the given team, tag and year.
actionGETv1.0.0
getTeamMediaByYear
Gets a list of Media (videos / pictures) for the given team and year.
actionGETv1.0.0
getTeamRobots
Gets a list of year and robot name pairs for each year that a robot name was provided. Will return an empty array if the team has never named a robot.
actionGETv1.0.0
getTeams
Gets a list of `Team` objects, paginated in groups of 500.
actionGETv1.0.0
getTeamsByYear
Gets a list of `Team` objects that competed in the given year, paginated in groups of 500.
actionGETv1.0.0
getTeamsByYearKeys
Gets a list Team Keys that competed in the given year, paginated in groups of 500.
actionGETv1.0.0
getTeamsByYearSimple
Gets a list of short form `Team_Simple` objects that competed in the given year, paginated in groups of 500.
actionGETv1.0.0
getTeamSimple
Gets a `Team_Simple` object for the team referenced by the given key.
actionGETv1.0.0
getTeamsKeys
Gets a list of Team keys, paginated in groups of 500. (Note, each page will not have 500 teams, but will include the teams within that range of 500.)
actionGETv1.0.0
getTeamSocialMedia
Gets a list of Media (social media) for the given team.
actionGETv1.0.0
getTeamsSimple
Gets a list of short form `Team_Simple` objects, paginated in groups of 500.
actionGETv1.0.0
getTeamYearsParticipated
Gets a list of years in which the team participated in at least one competition.
Beyond the catalog
Any provider, on request.
01
Request it
Tell us which provider you need, and we will ship it in the registry.
02
Generate it
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec