Documentation
API Endpoints
Get an Election
Get a specific Election.
HTTP Request
GET /v1/elections/{id}
Examples
- Get a specific Election:
- https://api.ballotapi.org/v1/elections/a12345
- Include Contests in the Election:
- https://api.ballotapi.org/v1/elections/a12345?include=contests
Query Parameters
| Parameter | Format | Description | Example |
|---|---|---|---|
include
|
String |
A comma separated list of resources to include
for each Election object response. Options are:
"contests"
and
"precincts".
|
include=contests |
Response
We will return an Election object for the specified id.
Example response:
{
"type": "election",
"id": "123-4",
"ocd_id": null,
"election_type": "general",
"election_name": "Midterm Election",
"date": "2018-11-05",
"short_info": "This is a major national election that..."
}
HTTP Response Codes
| Code | Response Format | Description |
|---|---|---|
200
|
Response | Successful request. |
400
|
Error Response | The query parameters you included were invalid. The Error Response will include a message describing exactly was invalid. |
404
|
Error Response | We could not find an Election with that id. |
429
|
N/A |
You are making too many requests to the API. Check the
Retry-After header for how many seconds to
wait until trying the request again. See our docs on
Rate Limiting.
|
500
|
N/A | An internal server error occurred. We log these errors and try to fix them quickly, so if you keep getting 500 errors for a few days, please email us. |
503
|
N/A | We are down for maintenance. Please try your request again in a few minutes. |
504
|
N/A | Your request timed out. Please try your request again in a few minutes. |