Overview and concepts
This API takes a postcode or UPRN and returns current information about elections, councils, candidates and polling stations.
High level concepts
It's important to understand that this API returns different types of response depending on the postcode entered
This is because some postcodes are "split" across council areas or polling districts, meaning that we need more information than just a postcode in order to give accurate responses.
The additional information we need is the exact UPRN for the property, and this is provided as a [list of addresses] if we detect a split postcode.
Authentication
Calls to the API must be authenticated with a valid API key.
To get a key, please log in or register and create a key.
To authenticate with a key pass in the token parameter.
curl -X GET https://api.electoralcommission.org.uk/api/[endpoint]/?token=123456'
Errors
Errors will be reported using HTTP status codes. The body of the error will be formatted as valid JSON and will give a description of the error
{ "detail": "Could not geocode from any source" }