REST API

The REST API can be queried at api.ftcscout.org/rest/v1 . You do not need to add any additional headers. Please do not abuse the API or we may have to add rate limiting. If you need to make large volumes of queries, use the GraphQL API. The available routes are listed below.

General Notes

Seasons are always given as a year number. For example Centerstage would be 2023.
All query parameters are optional. The shown value is the equivalent GraphQL type.
Response code 400 is used for an invalid type for any variable.

Teams

/teams/:number

Get a team by their number.

Returns all scalar fields of the Team GraphQL type.

404s if the team does not exist.

/teams/:number/events/:season

Can be used to get all the team event participations for the given season.

Returns all scalar fields and the stats field of the TeamEventParticipation GraphQL type.

Does not 404 if the team does not exist.

/teams/:number/awards?season=Int&eventCode=String

Gets a list of all the teams awards. Optionally specify the season or event.

Returns all scalar fields of the Award GraphQL type.

Does not 404 if the team does not exist.

/teams/:number/matches?season=Int&eventCode=String

Get all the matches a team has played optionally in a specific season or at a specific event.

Returns all scalar fields of the TeamMatchParticipation GraphQL type.

404s if the team does not exist.

/teams/:number/quick-stats?season=Int&region=RegionOption

Get the quick stats for a team in a specific season and region. If the season is not specified defaults to the current season. If the region is not specified defaults to the whole world.

Returns all fields of the QuickStats GraphQL type.

404s if the team does not exist or has no events in the specified season.

/teams/search?region=RegionOption&limit=Int&searchText=String

Get a list of teams. This is the correct query to get a list of all teams.

Returns all scalar fields of the Team GraphQL type.

Events

/events/:season/:code

Get an event with a certain code.

Returns all scalar fields of the Event GraphQL type except for hasMatches.

404s if the event does not exist.

/events/:season/:code/matches

Get all the matches, the scores of those matches, and the teams playing in the matches.

Returns all scalar fields, the scores field, and the teams field from the Match GraphQL type.

404s if the event does not exist.

/events/:season/:code/awards

Gets a list of all the awards from the event.

Returns all scalar fields of the Award GraphQL type.

Does not 404 if the event does not exist.

/events/:season/:code/teams

Get all the team event participations for the event.

Returns all scalar fields and the stats field of the TeamEventParticipation GraphQL type.

Does not 404 if the event does not exist.

/events/search?region=RegionOption&type=EventType&hasMatches=Boolean&start=Date&end=Date&limit=Int&searchText=String

Get a list of events. This is the correct query to get a list of all events.

Returns all scalar fields of the Event GraphQL type except for hasMatches.