Wait Time Calculator API Documentation

This document defines the Wait Time Calculator API, which can be used by developers to create applications that report polling location wait times. Currently, the API returns results in JSON format only.

Available API Methods

polllocations: Look up poll locations by address or latitude and longitude, optionally returning wait times.
waittimes: Get national wait time statistics, by state, or for a specific poll location.
record: Record a wait time for a specific poll location.

Resource URL

http://wtc.votinginfoproject.org

Method Details

polllocations

Example Request

GET /api/polllocations?api_key=[YOUR_API_KEY]&latitude=40.2411&longitude=-76.9261

Parameters

address: Postal address for which to find a polling location. Address or latitude/longitude required.
latitude: Latitude near which to search for polling locations. Address or latitude/longitude required.
longitude: Longitude near which to search for polling locations. Address or latitude/longitude required.
radius: Radius (in miles) around the latitude/longitude within which to search for polling locations. Optional, default is 1.
include_times: Whether or not to include wait times for each polling location returned. Optional, default is false.
callback: Callback function name for JSONP. Optional.

Example Response

{
    "success": true,
    "response": [
        {
            "id": "43",
            "locationName": "MUNICIPAL SERVICES CENTER",
            "line1": "2233 GETTYSBURG RD",
            "line2": "",
            "city": "CAMP HILL",
            "state": "PA",
            "zip": "17011",
            "latitude": "40.2303",
            "longitude": "-76.9189"
        },
        {
            "id": "1",
            "locationName": "FREDRICKSEN LIBRARY",
            "line1": "100 N 19TH ST",
            "line2": "",
            "city": "CAMP HILL",
            "state": "PA",
            "zip": "17011",
            "latitude": "40.2309",
            "longitude": "-76.9101"
        },
        ...
    ]
}

waittimes

Example Request

GET /api/waittimes?api_key=[YOUR_API_KEY]

Parameters

Calling this method with no parameters will return wait time statistics for the entire country. All wait times are returned in seconds.

state: State for which to return wait time statistics. Optional.
by_city: Group wait times by city and state. Optional, default is false.
poll_location_id: ID of poll location for which to return wait time statistics. Optional.
callback: Callback function name for JSONP. Optional.

Example Response

{
    "success": true,
    "response": {
        "average_wait_time": "1893.13",
        "max_wait_time": "3764.8",
        "min_wait_time": "120.11",
        "record_count": "12085"
    }
}

record

Example Request

POST /api/record?api_key=[YOUR_API_KEY]&wait_time=180.7&poll_location_id=5

Parameters

wait_time: Wait time to report (in seconds). Required.
poll_location_id: ID of poll location for which to record a wait time. Required.
latitude: Current latitude of wait time reporter. Optional.
longitude: Current longitude of wait time reporter. Optional.

Example Response

{
    "success": true,
    "response": "Wait time recorded successfully."
}