# The Blue Alliance API v3

**Provider:** The Blue Alliance API v3
**Category:** communication
**Base URL:** `https://www.thebluealliance.com/api/v3`
**Auth:** api-key — `X-TBA-Auth-Key: YOUR_API_KEY`
**Rate Limit:** Not officially published
**Free Tier:** Yes — available
**Pricing:** Enterprise / contact sales (subscription)
**Docs:** https://www.thebluealliance.com/api/v3

## Description

Overview 

 Information and statistics about FIRST Robotics Competition teams and events. 

Authentication 

All endpoints require an Auth Key to be passed in the header X-TBA-Auth-Key. If you do not have an auth key yet, you can obtain one from your Account Page.

## Endpoints

| Method | Endpoint | Description |
|--------|----------|-------------|
| GET | `https://www.thebluealliance.com/api/v3/district/{district_key}/events` | Gets a list of events in the given district. |
| GET | `https://www.thebluealliance.com/api/v3/district/{district_key}/events/keys` | Gets a list of event keys for events in the given district. |
| GET | `https://www.thebluealliance.com/api/v3/district/{district_key}/events/simple` | Gets a short-form list of events in the given district. |
| GET | `https://www.thebluealliance.com/api/v3/district/{district_key}/rankings` | Gets a list of team district rankings for the given district. |
| GET | `https://www.thebluealliance.com/api/v3/district/{district_key}/teams` | Gets a list of `Team` objects that competed in events in the given district. |
| GET | `https://www.thebluealliance.com/api/v3/district/{district_key}/teams/keys` | Gets a list of `Team` objects that competed in events in the given district. |
| GET | `https://www.thebluealliance.com/api/v3/district/{district_key}/teams/simple` | Gets a short-form list of `Team` objects that competed in events in the given di |
| GET | `https://www.thebluealliance.com/api/v3/districts/{year}` | Gets a list of districts and their corresponding district key, for the given yea |

## Authentication

API key in the request header (X-TBA-Auth-Key)

```
X-TBA-Auth-Key: YOUR_API_KEY
```

## Sample Request

```bash
curl -X GET 'https://www.thebluealliance.com/api/v3/district/{district_key}/events' \
  -H 'X-TBA-Auth-Key: YOUR_API_KEY'
```

## Sample Response

```json
{}
```

## Pricing Details

Free with API key. FIRST Robotics Competition data; community maintained.

---

*Source: [API Map](https://apimap.dev/apis/the-blue-alliance-api-v3/) — CC BY 4.0*