wheredoivote.co.uk Beta API

Open access to the data powering wheredoivote.co.uk: A website to help people in the UK find their polling station, built by Democracy Club.

More information about the project is available on our website

Note this API is currently in beta and outputs are subject to change.

Usage restrictions

Anonymous users are limited to 1,000 requests per day. If you need a higher limit, please contact us to discuss your usage and obtain an API key.

API Root ¶

The initial API entry point for discovering endpoints.

Retrieve the Entry Point
GET`/.json`

Example URI

GET https://wheredoivote.co.uk/api/beta/.json

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "councils": "https://wheredoivote.co.uk/api/beta/councils.json",
  "pollingstations": "https://wheredoivote.co.uk/api/beta/pollingstations.json",
  "pollingdistricts": "https://wheredoivote.co.uk/api/beta/pollingdistricts.json"
}

Polling Station Finder ¶

The /postcode and /address endpoints find a user’s polling station based on their home address. This allows you to leverage Democracy Club’s data to integrate a polling station finder into your website or app.

A 200 OK response from /postcode or /address is an object containing the following top-level keys:

polling_station_known: (boolean) - Do we know where this user should vote?
postcode_location: (object, nullable) - A GeoJSON Feature containing a Point object describing the centroid of the input postcode.
polling_station: (object, nullable) - A GeoJSON polling station feature
addresses: (array) - An array of address objects listing the addresses applicable to this request (if necessary).
council: (object, nullable) - A Council object describing the local authority which covers this postcode. If we do not know the user’s polling station, this can be used to provide contact info for their local council. Council may be null if we are not able to determine the user’s council.
custom_finder: (string, nullable) - If we don’t know a user’s polling station, sometimes we can provide the URL of a polling station finder provided by their local council.

Postcode search ¶

The entry point to a polling station search is a call to the /postcode endpoint. A valid postcode search may result in one of 3 outcomes:

We hold data for this area and all voters with this postcode vote at the same polling station.
We hold data for this area but voters with this postcode don’t all vote at the same polling station. To find the user’s polling station, we must make a second API call to the /address endpoint.
We do not hold data for this area.

Postcode search
GET`/postcode/{postcode}.json`

Example URI

GET https://wheredoivote.co.uk/api/beta/postcode/SW1A1AA.json

URI Parameters

HideShow

postcode: string (required) Example: SW1A1AA
Whitespace in postcodes is ignored, so format may be SW1A1AA or SW1A 1AA

Response 200

HideShow

When we hold data for this area and all voters with this postcode vote at the same polling station, the following conditions can be observed in the response body:

polling_station_known is true
polling_station is a GeoJSON polling station feature
addresses is an empty array

Headers

Content-Type: application/json

Body

{
  "polling_station_known": true,
  "postcode_location": {
    "geometry": {
      "point": {
        "type": "Point",
        "coordinates": [
          -1.2491514412601963,
          53.09878716696975
        ]
      }
    },
    "type": "Feature"
  },
  "custom_finder": null,
  "addresses": [],
  "polling_station": {
    "geometry": {
      "type": "Point",
      "coordinates": [
        -1.248013,
        53.100064
      ]
    },
    "type": "Feature",
    "id": "E07000170.KXP3",
    "properties": {
      "address": "Councillors' Room, ADC Offices\nUrban Road, Kirkby in Ashfield",
      "station_id": "KXP3",
      "council": "https://wheredoivote.co.uk/api/beta/councils/W06000015/",
      "urls": {
        "geo": "https://wheredoivote.co.uk/api/beta/pollingstations/geo/?station_id=KXP3&council_id=E07000170",
        "detail": "https://wheredoivote.co.uk/api/beta/pollingstations/?station_id=KXP3&council_id=E07000170"
      },
      "postcode": ""
    }
  },
  "council": {
    "url": "https://wheredoivote.co.uk/api/beta/councils/E07000170/",
    "council_id": "E07000170",
    "council_type": "DIS",
    "name": "Ashfield District Council",
    "email": "regelec@ashfield-dc.gov.uk",
    "phone": "01623 457321",
    "website": "http://www.ashfield-dc.gov.uk/residents/democracy,-elections-and-legal/elections/registering-to-vote.aspx",
    "postcode": "NG17 8DA",
    "address": "Ashfield District Council\nCouncil Offices\nUrban Road\nKirkby-in-Ashfield\nNottingham"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "polling_station_known": {
      "type": "boolean",
      "description": "Do we know where this user should vote?"
    },
    "postcode_location": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "geometry": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string"
            },
            "coordinates": {}
          },
          "description": "A GeoJSON Point object describing the centroid of the input postcode"
        },
        "type": {
          "type": "string"
        }
      },
      "description": "A GeoJSON Feature containing a Point object describing the centroid of the input postcode."
    },
    "polling_station": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "geometry": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "type": {
              "type": "string"
            },
            "coordinates": {
              "type": "array"
            }
          },
          "description": "A GeoJSON Point object describing the location of this polling station. Optionally null if we do not hold this information"
        },
        "type": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "properties": {
          "type": "object",
          "properties": {
            "urls": {
              "type": "object",
              "properties": {
                "detail": {
                  "type": "string",
                  "description": "URL to retrieve JSON meta-data about this polling station"
                },
                "geo": {
                  "type": "string",
                  "description": "URL to retrieve GeoJSON feature describing this polling station"
                }
              }
            },
            "council": {
              "type": "string",
              "description": "URL to retrieve JSON meta-data about the council which administers this polling station"
            },
            "station_id": {
              "type": "string",
              "description": "An identifier for this polling station. Station IDs are unique within councils, but are not unique nationally"
            },
            "address": {
              "type": "string",
              "description": "Address for this polling station"
            },
            "postcode": {
              "type": "string",
              "description": "Postcode for this polling station"
            }
          }
        }
      },
      "description": "A GeoJSON polling station feature"
    },
    "addresses": {
      "description": "An array of address objects listing the addresses applicable to this request (if necessary)."
    },
    "council": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "url": {
          "type": "string",
          "description": "URL for this resource"
        },
        "council_id": {
          "type": "string",
          "description": "GSS code for this council"
        },
        "name": {
          "type": "string",
          "description": "Name of this council"
        },
        "council_type": {
          "type": "string",
          "enum": [
            "DIS",
            "LBO",
            "LGD",
            "MTD",
            "UTA",
            "COI"
          ],
          "description": "One of: DIS (District council), LBO (London borough), LGD (Northern Ireland council), MTD (Metropolitan district), UTA (Unitary authority), COI (Isles of Scilly)"
        },
        "address": {
          "type": "string",
          "description": "Contact address for this council"
        },
        "postcode": {
          "type": "string",
          "description": "Postcode component of contact address for this council"
        },
        "email": {
          "type": "string",
          "description": "Contact email address for this council's Electoral Services team"
        },
        "phone": {
          "type": "string",
          "description": "Telephone number for this council's Electoral Services team"
        },
        "website": {
          "type": "string",
          "description": "URL for this council's website"
        }
      },
      "description": "A Council object describing the local authority which covers this postcode. If we do not know the user's polling station, this can be used to provide contact info for their local council."
    },
    "custom_finder": {
      "type": [
        "string",
        "null"
      ],
      "description": "If we don't know a user's polling station, sometimes we can provide the URL of a polling station finder provided by their local council."
    }
  }
}

Response 200

HideShow

When we hold data for this area but voters with this postcode don’t all vote at the same polling station, the following conditions can be observed in the response body:

polling_station_known is false
polling_station is null
addresses is an array of address objects covered by the input postcode. This can be used to request the user’s address and make a second API call to the /address endpoint.

Headers

Content-Type: application/json

Body

{
  "polling_station_known": false,
  "postcode_location": {
    "geometry": {
      "point": {
        "type": "Point",
        "coordinates": [
          -0.26353977212676555,
          50.84477241345472
        ]
      }
    },
    "type": "Feature"
  },
  "custom_finder": null,
  "addresses": [
    {
      "url": "https://wheredoivote.co.uk/api/beta/address/e07000223-527-5-truleigh-way-shoreham-by-sea-west-sussex-bn436hw/",
      "polling_station_id": "527",
      "postcode": "BN436HW",
      "council": "https://wheredoivote.co.uk/api/beta/councils/E07000223/",
      "address": "5 Truleigh Way, Shoreham-by-Sea, West Sussex"
    },
    {
      "url": "https://wheredoivote.co.uk/api/beta/address/e07000223-524-2-truleigh-way-shoreham-by-sea-west-sussex-bn436hw/",
      "polling_station_id": "524",
      "postcode": "BN436HW",
      "council": "https://wheredoivote.co.uk/api/beta/councils/E07000223/",
      "address": "2 Truleigh Way, Shoreham-by-Sea, West Sussex"
    },
    {
      "url": "https://wheredoivote.co.uk/api/beta/address/e07000223-527-3-truleigh-way-shoreham-by-sea-west-sussex-bn436hw/",
      "polling_station_id": "527",
      "postcode": "BN436HW",
      "council": "https://wheredoivote.co.uk/api/beta/councils/E07000223/",
      "address": "3 Truleigh Way, Shoreham-by-Sea, West Sussex"
    },
    {
      "url": "https://wheredoivote.co.uk/api/beta/address/e07000223-527-1-truleigh-way-shoreham-by-sea-west-sussex-bn436hw/",
      "polling_station_id": "527",
      "postcode": "BN436HW",
      "council": "https://wheredoivote.co.uk/api/beta/councils/E07000223/",
      "address": "1 Truleigh Way, Shoreham-by-Sea, West Sussex"
    },
    {
      "url": "https://wheredoivote.co.uk/api/beta/address/e07000223-524-4-truleigh-way-shoreham-by-sea-west-sussex-bn436hw/",
      "polling_station_id": "524",
      "postcode": "BN436HW",
      "council": "https://wheredoivote.co.uk/api/beta/councils/E07000223/",
      "address": "4 Truleigh Way, Shoreham-by-Sea, West Sussex"
    },
    {
      "url": "https://wheredoivote.co.uk/api/beta/address/e07000223-524-6-truleigh-way-shoreham-by-sea-west-sussex-bn436hw/",
      "polling_station_id": "524",
      "postcode": "BN436HW",
      "council": "https://wheredoivote.co.uk/api/beta/councils/E07000223/",
      "address": "6 Truleigh Way, Shoreham-by-Sea, West Sussex"
    }
  ],
  "polling_station": null,
  "council": {
    "website": "http://adur-worthing.gov.uk/elections-and-voting/register-to-vote/",
    "name": "Adur District Council",
    "phone": "01903 221014/5/6",
    "url": "https://wheredoivote.co.uk/api/beta/councils/E07000223/",
    "council_id": "E07000223",
    "council_type": "DIS",
    "postcode": "BN11 1HA",
    "address": "Adur District Council\nTown Hall\nChapel Road\nWorthing\nWest Sussex",
    "email": "elections@adur-worthing.gov.uk"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "polling_station_known": {
      "type": "boolean",
      "description": "Do we know where this user should vote?"
    },
    "postcode_location": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "geometry": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string"
            },
            "coordinates": {}
          },
          "description": "A GeoJSON Point object describing the centroid of the input postcode"
        },
        "type": {
          "type": "string"
        }
      },
      "description": "A GeoJSON Feature containing a Point object describing the centroid of the input postcode."
    },
    "polling_station": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "geometry": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "type": {
              "type": "string"
            },
            "coordinates": {
              "type": "array"
            }
          },
          "description": "A GeoJSON Point object describing the location of this polling station. Optionally null if we do not hold this information"
        },
        "type": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "properties": {
          "type": "object",
          "properties": {
            "urls": {
              "type": "object",
              "properties": {
                "detail": {
                  "type": "string",
                  "description": "URL to retrieve JSON meta-data about this polling station"
                },
                "geo": {
                  "type": "string",
                  "description": "URL to retrieve GeoJSON feature describing this polling station"
                }
              }
            },
            "council": {
              "type": "string",
              "description": "URL to retrieve JSON meta-data about the council which administers this polling station"
            },
            "station_id": {
              "type": "string",
              "description": "An identifier for this polling station. Station IDs are unique within councils, but are not unique nationally"
            },
            "address": {
              "type": "string",
              "description": "Address for this polling station"
            },
            "postcode": {
              "type": "string",
              "description": "Postcode for this polling station"
            }
          }
        }
      },
      "description": "A GeoJSON polling station feature"
    },
    "addresses": {
      "description": "An array of address objects listing the addresses applicable to this request (if necessary)."
    },
    "council": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "url": {
          "type": "string",
          "description": "URL for this resource"
        },
        "council_id": {
          "type": "string",
          "description": "GSS code for this council"
        },
        "name": {
          "type": "string",
          "description": "Name of this council"
        },
        "council_type": {
          "type": "string",
          "enum": [
            "DIS",
            "LBO",
            "LGD",
            "MTD",
            "UTA",
            "COI"
          ],
          "description": "One of: DIS (District council), LBO (London borough), LGD (Northern Ireland council), MTD (Metropolitan district), UTA (Unitary authority), COI (Isles of Scilly)"
        },
        "address": {
          "type": "string",
          "description": "Contact address for this council"
        },
        "postcode": {
          "type": "string",
          "description": "Postcode component of contact address for this council"
        },
        "email": {
          "type": "string",
          "description": "Contact email address for this council's Electoral Services team"
        },
        "phone": {
          "type": "string",
          "description": "Telephone number for this council's Electoral Services team"
        },
        "website": {
          "type": "string",
          "description": "URL for this council's website"
        }
      },
      "description": "A Council object describing the local authority which covers this postcode. If we do not know the user's polling station, this can be used to provide contact info for their local council."
    },
    "custom_finder": {
      "type": [
        "string",
        "null"
      ],
      "description": "If we don't know a user's polling station, sometimes we can provide the URL of a polling station finder provided by their local council."
    }
  }
}

Response 200

HideShow

When we do not hold data for the area described by the postcode provided, the following conditions can be observed in the response body:

polling_station_known is false
polling_station is null
addresses is an empty array

Headers

Content-Type: application/json

Body

{
  "polling_station_known": false,
  "postcode_location": {
    "geometry": {
      "point": {
        "type": "Point",
        "coordinates": [
          -0.14320717529002294,
          51.50086373251905
        ]
      }
    },
    "type": "Feature"
  },
  "custom_finder": null,
  "addresses": [],
  "polling_station": null,
  "council": {
    "website": "https://www.westminster.gov.uk/contact-electoral-services",
    "name": "Westminster City Council",
    "phone": "020 7641 2730",
    "url": "https://wheredoivote.co.uk/api/beta/councils/E09000033/",
    "council_id": "E09000033",
    "council_type": "LBO",
    "postcode": "SW1E 6QP",
    "address": "Westminster City Council\nElectoral Services\nWestminster City Hall\n64 Victoria Street\nLondon",
    "email": "electoralservices@westminster.gov.uk"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "polling_station_known": {
      "type": "boolean",
      "description": "Do we know where this user should vote?"
    },
    "postcode_location": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "geometry": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string"
            },
            "coordinates": {}
          },
          "description": "A GeoJSON Point object describing the centroid of the input postcode"
        },
        "type": {
          "type": "string"
        }
      },
      "description": "A GeoJSON Feature containing a Point object describing the centroid of the input postcode."
    },
    "polling_station": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "geometry": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "type": {
              "type": "string"
            },
            "coordinates": {
              "type": "array"
            }
          },
          "description": "A GeoJSON Point object describing the location of this polling station. Optionally null if we do not hold this information"
        },
        "type": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "properties": {
          "type": "object",
          "properties": {
            "urls": {
              "type": "object",
              "properties": {
                "detail": {
                  "type": "string",
                  "description": "URL to retrieve JSON meta-data about this polling station"
                },
                "geo": {
                  "type": "string",
                  "description": "URL to retrieve GeoJSON feature describing this polling station"
                }
              }
            },
            "council": {
              "type": "string",
              "description": "URL to retrieve JSON meta-data about the council which administers this polling station"
            },
            "station_id": {
              "type": "string",
              "description": "An identifier for this polling station. Station IDs are unique within councils, but are not unique nationally"
            },
            "address": {
              "type": "string",
              "description": "Address for this polling station"
            },
            "postcode": {
              "type": "string",
              "description": "Postcode for this polling station"
            }
          }
        }
      },
      "description": "A GeoJSON polling station feature"
    },
    "addresses": {
      "description": "An array of address objects listing the addresses applicable to this request (if necessary)."
    },
    "council": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "url": {
          "type": "string",
          "description": "URL for this resource"
        },
        "council_id": {
          "type": "string",
          "description": "GSS code for this council"
        },
        "name": {
          "type": "string",
          "description": "Name of this council"
        },
        "council_type": {
          "type": "string",
          "enum": [
            "DIS",
            "LBO",
            "LGD",
            "MTD",
            "UTA",
            "COI"
          ],
          "description": "One of: DIS (District council), LBO (London borough), LGD (Northern Ireland council), MTD (Metropolitan district), UTA (Unitary authority), COI (Isles of Scilly)"
        },
        "address": {
          "type": "string",
          "description": "Contact address for this council"
        },
        "postcode": {
          "type": "string",
          "description": "Postcode component of contact address for this council"
        },
        "email": {
          "type": "string",
          "description": "Contact email address for this council's Electoral Services team"
        },
        "phone": {
          "type": "string",
          "description": "Telephone number for this council's Electoral Services team"
        },
        "website": {
          "type": "string",
          "description": "URL for this council's website"
        }
      },
      "description": "A Council object describing the local authority which covers this postcode. If we do not know the user's polling station, this can be used to provide contact info for their local council."
    },
    "custom_finder": {
      "type": [
        "string",
        "null"
      ],
      "description": "If we don't know a user's polling station, sometimes we can provide the URL of a polling station finder provided by their local council."
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
  "detail": "Mapit error 400: Postcode 'FOOBAR' is not valid."
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
  "detail": "Mapit error 403: Rate limit exceeded"
}

Address search ¶

In the event that the addresses described by a postcode are not all assigned to the same polling station, an array of address objects will be returned, each of which corresponds to a call to the /address endpoint.

Address search
GET`/address/{slug}.json`

Example URI

GET https://wheredoivote.co.uk/api/beta/address/e07000223-527-5-truleigh-way-shoreham-by-sea-west-sussex-bn436hw.json

URI Parameters

HideShow

slug: string (required) Example: e07000223-527-5-truleigh-way-shoreham-by-sea-west-sussex-bn436hw
A unique slug describing a residential address

Response 200

HideShow

When we make a valid call to the /address endpoint, the following conditions can be observed in the response body:

polling_station_known is true
polling_station is a GeoJSON polling station feature
addresses is an array of length one containing a single address object describing the requested address

Headers

Content-Type: application/json

Body

{
  "polling_station_known": true,
  "postcode_location": {
    "geometry": {
      "point": {
        "type": "Point",
        "coordinates": [
          -0.26353977212676555,
          50.84477241345472
        ]
      }
    },
    "type": "Feature"
  },
  "custom_finder": null,
  "addresses": [
    {
      "url": "https://wheredoivote.co.uk/api/beta/address/e07000223-527-5-truleigh-way-shoreham-by-sea-west-sussex-bn436hw/",
      "address": "5 Truleigh Way, Shoreham-by-Sea, West Sussex",
      "postcode": "BN436HW",
      "council": "https://wheredoivote.co.uk/api/beta/councils/E07000223/",
      "polling_station_id": "527"
    }
  ],
  "polling_station": {
    "id": "E07000223.527",
    "type": "Feature",
    "geometry": {
      "type": "Point",
      "coordinates": [
        -0.2693240568181819,
        50.83494864772728
      ]
    },
    "properties": {
      "urls": {
        "detail": "https://wheredoivote.co.uk/api/beta/pollingstations/?station_id=527&council_id=E07000223",
        "geo": "https://wheredoivote.co.uk/api/beta/pollingstations/geo/?station_id=527&council_id=E07000223"
      },
      "council": "https://wheredoivote.co.uk/api/beta/councils/E07000223/",
      "station_id": "527",
      "postcode": "BN43 6WF",
      "address": "Shoreham Free Church Hall\nBuckingham Road/Gordon Road\nShoreham-by-Sea"
    }
  },
  "council": {
    "url": "https://wheredoivote.co.uk/api/beta/councils/E07000223/",
    "council_id": "E07000223",
    "council_type": "DIS",
    "name": "Adur District Council",
    "email": "elections@adur-worthing.gov.uk",
    "phone": "01903 221014/5/6",
    "website": "http://adur-worthing.gov.uk/elections-and-voting/register-to-vote/",
    "postcode": "BN11 1HA",
    "address": "Adur District Council\nTown Hall\nChapel Road\nWorthing\nWest Sussex"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "polling_station_known": {
      "type": "boolean",
      "description": "Do we know where this user should vote?"
    },
    "postcode_location": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "geometry": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string"
            },
            "coordinates": {}
          },
          "description": "A GeoJSON Point object describing the centroid of the input postcode"
        },
        "type": {
          "type": "string"
        }
      },
      "description": "A GeoJSON Feature containing a Point object describing the centroid of the input postcode."
    },
    "polling_station": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "geometry": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "type": {
              "type": "string"
            },
            "coordinates": {
              "type": "array"
            }
          },
          "description": "A GeoJSON Point object describing the location of this polling station. Optionally null if we do not hold this information"
        },
        "type": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "properties": {
          "type": "object",
          "properties": {
            "urls": {
              "type": "object",
              "properties": {
                "detail": {
                  "type": "string",
                  "description": "URL to retrieve JSON meta-data about this polling station"
                },
                "geo": {
                  "type": "string",
                  "description": "URL to retrieve GeoJSON feature describing this polling station"
                }
              }
            },
            "council": {
              "type": "string",
              "description": "URL to retrieve JSON meta-data about the council which administers this polling station"
            },
            "station_id": {
              "type": "string",
              "description": "An identifier for this polling station. Station IDs are unique within councils, but are not unique nationally"
            },
            "address": {
              "type": "string",
              "description": "Address for this polling station"
            },
            "postcode": {
              "type": "string",
              "description": "Postcode for this polling station"
            }
          }
        }
      },
      "description": "A GeoJSON polling station feature"
    },
    "addresses": {
      "description": "An array of address objects listing the addresses applicable to this request (if necessary)."
    },
    "council": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "url": {
          "type": "string",
          "description": "URL for this resource"
        },
        "council_id": {
          "type": "string",
          "description": "GSS code for this council"
        },
        "name": {
          "type": "string",
          "description": "Name of this council"
        },
        "council_type": {
          "type": "string",
          "enum": [
            "DIS",
            "LBO",
            "LGD",
            "MTD",
            "UTA",
            "COI"
          ],
          "description": "One of: DIS (District council), LBO (London borough), LGD (Northern Ireland council), MTD (Metropolitan district), UTA (Unitary authority), COI (Isles of Scilly)"
        },
        "address": {
          "type": "string",
          "description": "Contact address for this council"
        },
        "postcode": {
          "type": "string",
          "description": "Postcode component of contact address for this council"
        },
        "email": {
          "type": "string",
          "description": "Contact email address for this council's Electoral Services team"
        },
        "phone": {
          "type": "string",
          "description": "Telephone number for this council's Electoral Services team"
        },
        "website": {
          "type": "string",
          "description": "URL for this council's website"
        }
      },
      "description": "A Council object describing the local authority which covers this postcode. If we do not know the user's polling station, this can be used to provide contact info for their local council."
    },
    "custom_finder": {
      "type": [
        "string",
        "null"
      ],
      "description": "If we don't know a user's polling station, sometimes we can provide the URL of a polling station finder provided by their local council."
    }
  }
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
  "detail": "Address not found"
}

Councils ¶

Retrieve details of UK councils/local authorities.

Polling stations and districts are maintained by local councils so all of our data is attached to a council.

Councils Collection: JSON ¶

List all councils. Returns an array of council objects

List All Councils: JSON
GET`/councils.json`

Example URI

GET https://wheredoivote.co.uk/api/beta/councils.json

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "url": "https://wheredoivote.co.uk/api/beta/councils/W06000015.json",
    "council_id": "W06000015",
    "name": "Cardiff Council",
    "council_type": "DIS",
    "address": "Electoral Registration Officer\\nCity of Cardiff Council\\nCounty Hall Atlantic Wharf",
    "postcode": "CF10 4UW",
    "email": "electoralservices@cardiff.gov.uk",
    "phone": "029 2087 2034",
    "website": "http://www.cardiff.gov.uk/"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Councils: JSON ¶

Retrieve meta-data about a council in JSON format.

Retrieve a Council: JSON
GET`/councils/{council_id}.json`

Example URI

GET https://wheredoivote.co.uk/api/beta/councils/W06000015.json

URI Parameters

HideShow

council_id: string (required) Example: W06000015
GSS code for this council

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "url": "https://wheredoivote.co.uk/api/beta/councils/W06000015.json",
  "council_id": "W06000015",
  "name": "Cardiff Council",
  "council_type": "DIS",
  "address": "Electoral Registration Officer\\nCity of Cardiff Council\\nCounty Hall Atlantic Wharf",
  "postcode": "CF10 4UW",
  "email": "electoralservices@cardiff.gov.uk",
  "phone": "029 2087 2034",
  "website": "http://www.cardiff.gov.uk/"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "URL for this resource"
    },
    "council_id": {
      "type": "string",
      "description": "GSS code for this council"
    },
    "name": {
      "type": "string",
      "description": "Name of this council"
    },
    "council_type": {
      "type": "string",
      "enum": [
        "DIS",
        "LBO",
        "LGD",
        "MTD",
        "UTA",
        "COI"
      ],
      "description": "One of: DIS (District council), LBO (London borough), LGD (Northern Ireland council), MTD (Metropolitan district), UTA (Unitary authority), COI (Isles of Scilly)"
    },
    "address": {
      "type": "string",
      "description": "Contact address for this council"
    },
    "postcode": {
      "type": "string",
      "description": "Postcode component of contact address for this council"
    },
    "email": {
      "type": "string",
      "description": "Contact email address for this council's Electoral Services team"
    },
    "phone": {
      "type": "string",
      "description": "Telephone number for this council's Electoral Services team"
    },
    "website": {
      "type": "string",
      "description": "URL for this council's website"
    }
  }
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
  "detail": "Not found."
}

Councils: GeoJSON ¶

Retrieve a GeoJSON Feature containing a GIS boundary and meta-data about a council.

Retrieve a Council: GeoJSON
GET`/councils/{council_id}/geo.json`

Example URI

GET https://wheredoivote.co.uk/api/beta/councils/W06000015/geo.json

URI Parameters

HideShow

council_id: string (required) Example: W06000015
GSS code for this council

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "geometry": {
    "type": "MultiPolygon",
    "coordinates": [
      "..."
    ]
  },
  "type": "Feature",
  "id": "W06000015",
  "properties": {
    "url": "https://wheredoivote.co.uk/api/beta/councils/W06000015.json",
    "council_id": "W06000015",
    "name": "Cardiff Council",
    "council_type": "DIS",
    "address": "Electoral Registration Officer\\nCity of Cardiff Council\\nCounty Hall Atlantic Wharf",
    "postcode": "CF10 4UW",
    "email": "electoralservices@cardiff.gov.uk",
    "phone": "029 2087 2034",
    "website": "http://www.cardiff.gov.uk/"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "geometry": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "coordinates": {
          "type": "array"
        }
      },
      "description": "A GeoJSON object describing the boundary of this area"
    },
    "type": {
      "type": "string"
    },
    "id": {
      "type": "string",
      "description": "GSS code for this council"
    },
    "properties": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "description": "URL for this resource"
        },
        "council_id": {
          "type": "string",
          "description": "GSS code for this council"
        },
        "name": {
          "type": "string",
          "description": "Name of this council"
        },
        "council_type": {
          "type": "string",
          "enum": [
            "DIS",
            "LBO",
            "LGD",
            "MTD",
            "UTA",
            "COI"
          ],
          "description": "One of: DIS (District council), LBO (London borough), LGD (Northern Ireland council), MTD (Metropolitan district), UTA (Unitary authority), COI (Isles of Scilly)"
        },
        "address": {
          "type": "string",
          "description": "Contact address for this council"
        },
        "postcode": {
          "type": "string",
          "description": "Postcode component of contact address for this council"
        },
        "email": {
          "type": "string",
          "description": "Contact email address for this council's Electoral Services team"
        },
        "phone": {
          "type": "string",
          "description": "Telephone number for this council's Electoral Services team"
        },
        "website": {
          "type": "string",
          "description": "URL for this council's website"
        }
      }
    }
  }
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
  "detail": "Not found."
}

Polling Stations ¶

The /pollingstations endpoint provides access to the polling station data underpinning our polling station finder.

Polling Stations Collection: JSON ¶

List all polling stations in a local authority. Returns an array of polling station objects

List All Polling Stations in a Local Authority: JSON
GET`/pollingstations.json?council_id={council_id}`

Example URI

GET https://wheredoivote.co.uk/api/beta/pollingstations.json?council_id=E07000170

URI Parameters

HideShow

council_id: string (required) Example: E07000170
GSS code for this council

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "urls": {
      "detail": "https://wheredoivote.co.uk/api/beta/pollingstations/?council_id=E07000170&station_id=SUM4",
      "geo": "https://wheredoivote.co.uk/api/beta/pollingstations/geo/?council_id=E07000170&station_id=SUM4"
    },
    "council": "https://wheredoivote.co.uk/api/beta/councils/E07000170.json",
    "station_id": "SUM4",
    "address": "Ashwood Centre\\nPortland Street, Kirkby in Ashfield",
    "postcode": ""
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Polling Stations Collection: GeoJSON ¶

List all polling stations in a local authority. Returns a GeoJSON FeatureCollection of polling station features

List All Polling Stations in a Local Authority: GeoJSON
GET`/pollingstations/geo.json?council_id={council_id}`

Example URI

GET https://wheredoivote.co.uk/api/beta/pollingstations/geo.json?council_id=E07000170

URI Parameters

HideShow

council_id: string (required) Example: E07000170
GSS code for this council

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "type": "FeatureCollection",
  "features": [
    {
      "geometry": {
        "type": "Point",
        "coordinates": [
          "..."
        ]
      },
      "type": "Feature",
      "id": "E07000170.SUM4",
      "properties": {
        "urls": {
          "detail": "https://wheredoivote.co.uk/api/beta/pollingstations/?council_id=E07000170&station_id=SUM4",
          "geo": "https://wheredoivote.co.uk/api/beta/pollingstations/geo/?council_id=E07000170&station_id=SUM4"
        },
        "council": "https://wheredoivote.co.uk/api/beta/councils/E07000170.json",
        "station_id": "SUM4",
        "address": "Ashwood Centre\\nPortland Street, Kirkby in Ashfield",
        "postcode": ""
      }
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "features": {
      "type": "array"
    }
  }
}

Polling Stations: JSON ¶

Retrieve meta-data about a polling station in JSON format.

Retrieve a Polling Station: JSON
GET`/pollingstations.json?council_id={council_id}&station_id={station_id}`

Example URI

GET https://wheredoivote.co.uk/api/beta/pollingstations.json?council_id=E07000170&station_id=SUM4

URI Parameters

HideShow

council_id: string (required) Example: E07000170
GSS code for this council
station_id: string (required) Example: SUM4
Polling Station ID. Polling Station IDs are unique within councils, but are not unique nationally

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "urls": {
    "detail": "https://wheredoivote.co.uk/api/beta/pollingstations/?council_id=E07000170&station_id=SUM4",
    "geo": "https://wheredoivote.co.uk/api/beta/pollingstations/geo/?council_id=E07000170&station_id=SUM4"
  },
  "council": "https://wheredoivote.co.uk/api/beta/councils/E07000170.json",
  "station_id": "SUM4",
  "address": "Ashwood Centre\\nPortland Street, Kirkby in Ashfield",
  "postcode": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "urls": {
      "type": "object",
      "properties": {
        "detail": {
          "type": "string",
          "description": "URL to retrieve JSON meta-data about this polling station"
        },
        "geo": {
          "type": "string",
          "description": "URL to retrieve GeoJSON feature describing this polling station"
        }
      }
    },
    "council": {
      "type": "string",
      "description": "URL to retrieve JSON meta-data about the council which administers this polling station"
    },
    "station_id": {
      "type": "string",
      "description": "An identifier for this polling station. Station IDs are unique within councils, but are not unique nationally"
    },
    "address": {
      "type": "string",
      "description": "Address for this polling station"
    },
    "postcode": {
      "type": "string",
      "description": "Postcode for this polling station"
    }
  }
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
  "detail": "Not found."
}

Polling Stations: GeoJSON ¶

Retrieve a GeoJSON Feature describing a polling station.

Retrieve a Polling Station: GeoJSON
GET`/pollingstations/geo.json?council_id={council_id}&station_id={station_id}`

Example URI

GET https://wheredoivote.co.uk/api/beta/pollingstations/geo.json?council_id=E07000170&station_id=SUM4

URI Parameters

HideShow

council_id: string (required) Example: E07000170
GSS code for this council
station_id: string (required) Example: SUM4
Polling Station ID. Polling Station IDs are unique within councils, but are not unique nationally

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "geometry": {
    "type": "Point",
    "coordinates": [
      "..."
    ]
  },
  "type": "Feature",
  "id": "E07000170.SUM4",
  "properties": {
    "urls": {
      "detail": "https://wheredoivote.co.uk/api/beta/pollingstations/?council_id=E07000170&station_id=SUM4",
      "geo": "https://wheredoivote.co.uk/api/beta/pollingstations/geo/?council_id=E07000170&station_id=SUM4"
    },
    "council": "https://wheredoivote.co.uk/api/beta/councils/E07000170.json",
    "station_id": "SUM4",
    "address": "Ashwood Centre\\nPortland Street, Kirkby in Ashfield",
    "postcode": ""
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "geometry": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "type": {
          "type": "string"
        },
        "coordinates": {
          "type": "array"
        }
      },
      "description": "A GeoJSON Point object describing the location of this polling station. Optionally null if we do not hold this information"
    },
    "type": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "properties": {
      "type": "object",
      "properties": {
        "urls": {
          "type": "object",
          "properties": {
            "detail": {
              "type": "string",
              "description": "URL to retrieve JSON meta-data about this polling station"
            },
            "geo": {
              "type": "string",
              "description": "URL to retrieve GeoJSON feature describing this polling station"
            }
          }
        },
        "council": {
          "type": "string",
          "description": "URL to retrieve JSON meta-data about the council which administers this polling station"
        },
        "station_id": {
          "type": "string",
          "description": "An identifier for this polling station. Station IDs are unique within councils, but are not unique nationally"
        },
        "address": {
          "type": "string",
          "description": "Address for this polling station"
        },
        "postcode": {
          "type": "string",
          "description": "Postcode for this polling station"
        }
      }
    }
  }
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
  "detail": "Not found."
}

Polling Districts ¶

The /pollingdistricts endpoint provides access to the polling district data underpinning our polling station finder. Where possible a polling district contains a polling station object describing the station which serves this district. This may optionally be null if this district is an orphan district. An orphan district occurrs where we hold the boundary of a polling district but we don’t know the corresponding polling station. The polling station which serves a district does not necessarily have to be located inside the district it serves.

Polling Districts Collection: JSON ¶

List all polling districts in a local authority. Returns an array of polling district objects

List All Polling Districts in a Local Authority: JSON
GET`/pollingdistricts.json?council_id={council_id}`

Example URI

GET https://wheredoivote.co.uk/api/beta/pollingdistricts.json?council_id=E07000170

URI Parameters

HideShow

council_id: string (required) Example: E07000170
GSS code for this council

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "urls": {
      "detail": "https://wheredoivote.co.uk/api/beta/pollingdistricts/?council_id=E07000170&district_id=SUM4",
      "geo": "https://wheredoivote.co.uk/api/beta/pollingdistricts/geo/?council_id=E07000170&district_id=SUM4"
    },
    "council": "https://wheredoivote.co.uk/api/beta/councils/E07000170.json",
    "district_id": "SUM4",
    "polling_station": {
      "urls": {
        "detail": "https://wheredoivote.co.uk/api/beta/pollingstations/?council_id=E07000170&station_id=SUM4",
        "geo": "https://wheredoivote.co.uk/api/beta/pollingstations/geo/?council_id=E07000170&station_id=SUM4"
      },
      "council": "https://wheredoivote.co.uk/api/beta/councils/E07000170.json",
      "station_id": "SUM4",
      "address": "Ashwood Centre\\nPortland Street, Kirkby in Ashfield",
      "postcode": ""
    }
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Polling Districts Collection: GeoJSON ¶

List all polling districts in a local authority. Returns a GeoJSON FeatureCollection of polling district features

List All Polling Districts in a Local Authority: GeoJSON
GET`/pollingdistricts/geo.json?council_id={council_id}`

Example URI

GET https://wheredoivote.co.uk/api/beta/pollingdistricts/geo.json?council_id=E07000170

URI Parameters

HideShow

council_id: string (required) Example: E07000170
GSS code for this council

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "type": "FeatureCollection",
  "features": [
    {
      "geometry": {
        "type": "MultiPolygon",
        "coordinates": [
          "..."
        ]
      },
      "type": "Feature",
      "id": "E07000170.SUM4",
      "properties": {
        "urls": {
          "detail": "https://wheredoivote.co.uk/api/beta/pollingdistricts/?council_id=E07000170&district_id=SUM4",
          "geo": "https://wheredoivote.co.uk/api/beta/pollingdistricts/geo/?council_id=E07000170&district_id=SUM4"
        },
        "council": "https://wheredoivote.co.uk/api/beta/councils/E07000170.json",
        "district_id": "SUM4",
        "polling_station": {
          "urls": {
            "detail": "https://wheredoivote.co.uk/api/beta/pollingstations/?council_id=E07000170&station_id=SUM4",
            "geo": "https://wheredoivote.co.uk/api/beta/pollingstations/geo/?council_id=E07000170&station_id=SUM4"
          },
          "council": "https://wheredoivote.co.uk/api/beta/councils/E07000170.json",
          "station_id": "SUM4",
          "address": "Ashwood Centre\\nPortland Street, Kirkby in Ashfield",
          "postcode": ""
        }
      }
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "features": {
      "type": "array"
    }
  }
}

Polling Districts: JSON ¶

Retrieve meta-data about a polling district in JSON format.

Retrieve a Polling District: JSON
GET`/pollingdistricts.json?council_id={council_id}&district_id={district_id}`

Example URI

GET https://wheredoivote.co.uk/api/beta/pollingdistricts.json?council_id=E07000170&district_id=SUM4

URI Parameters

HideShow

council_id: string (required) Example: E07000170
GSS code for this council
district_id: string (required) Example: SUM4
Polling District ID. Polling District IDs are unique within councils, but are not unique nationally

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "urls": {
    "detail": "https://wheredoivote.co.uk/api/beta/pollingdistricts/?council_id=E07000170&district_id=SUM4",
    "geo": "https://wheredoivote.co.uk/api/beta/pollingdistricts/geo/?council_id=E07000170&district_id=SUM4"
  },
  "council": "https://wheredoivote.co.uk/api/beta/councils/E07000170.json",
  "district_id": "SUM4",
  "polling_station": {
    "urls": {
      "detail": "https://wheredoivote.co.uk/api/beta/pollingstations/?council_id=E07000170&station_id=SUM4",
      "geo": "https://wheredoivote.co.uk/api/beta/pollingstations/geo/?council_id=E07000170&station_id=SUM4"
    },
    "council": "https://wheredoivote.co.uk/api/beta/councils/E07000170.json",
    "station_id": "SUM4",
    "address": "Ashwood Centre\\nPortland Street, Kirkby in Ashfield",
    "postcode": ""
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "urls": {
      "type": "object",
      "properties": {
        "detail": {
          "type": "string",
          "description": "URL to retrieve JSON meta-data about this polling district"
        },
        "geo": {
          "type": "string",
          "description": "URL to retrieve GeoJSON feature describing this polling district"
        }
      }
    },
    "council": {
      "type": "string",
      "description": "URL to retrieve JSON meta-data about the council which administers this polling district"
    },
    "district_id": {
      "type": "string",
      "description": "An identifier for this polling district. District IDs are unique within councils, but are not unique nationally"
    },
    "polling_station": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "urls": {
          "type": "object",
          "properties": {
            "detail": {
              "type": "string",
              "description": "URL to retrieve JSON meta-data about this polling station"
            },
            "geo": {
              "type": "string",
              "description": "URL to retrieve GeoJSON feature describing this polling station"
            }
          }
        },
        "council": {
          "type": "string",
          "description": "URL to retrieve JSON meta-data about the council which administers this polling station"
        },
        "station_id": {
          "type": "string",
          "description": "An identifier for this polling station. Station IDs are unique within councils, but are not unique nationally"
        },
        "address": {
          "type": "string",
          "description": "Address for this polling station"
        },
        "postcode": {
          "type": "string",
          "description": "Postcode for this polling station"
        }
      },
      "description": "A polling station object describing the station which serves this district. Optionally null if we do not hold this information"
    }
  }
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
  "detail": "Not found."
}

Polling Districts: GeoJSON ¶

Retrieve a GeoJSON Feature containing a GIS boundary and meta-data about a polling district.

Retrieve a Polling District: GeoJSON
GET`/pollingdistricts/geo.json?council_id={council_id}&district_id={district_id}`

Example URI

GET https://wheredoivote.co.uk/api/beta/pollingdistricts/geo.json?council_id=E07000170&district_id=SUM4

URI Parameters

HideShow

council_id: string (required) Example: E07000170
GSS code for this council
district_id: string (required) Example: SUM4
Polling District ID. Polling District IDs are unique within councils, but are not unique nationally

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "geometry": {
    "type": "MultiPolygon",
    "coordinates": [
      "..."
    ]
  },
  "type": "Feature",
  "id": "E07000170.SUM4",
  "properties": {
    "urls": {
      "detail": "https://wheredoivote.co.uk/api/beta/pollingdistricts/?council_id=E07000170&district_id=SUM4",
      "geo": "https://wheredoivote.co.uk/api/beta/pollingdistricts/geo/?council_id=E07000170&district_id=SUM4"
    },
    "council": "https://wheredoivote.co.uk/api/beta/councils/E07000170.json",
    "district_id": "SUM4",
    "polling_station": {
      "urls": {
        "detail": "https://wheredoivote.co.uk/api/beta/pollingstations/?council_id=E07000170&station_id=SUM4",
        "geo": "https://wheredoivote.co.uk/api/beta/pollingstations/geo/?council_id=E07000170&station_id=SUM4"
      },
      "council": "https://wheredoivote.co.uk/api/beta/councils/E07000170.json",
      "station_id": "SUM4",
      "address": "Ashwood Centre\\nPortland Street, Kirkby in Ashfield",
      "postcode": ""
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "geometry": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "coordinates": {
          "type": "array"
        }
      },
      "description": "A GeoJSON object describing the boundary of this area"
    },
    "type": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "properties": {
      "type": "object",
      "properties": {
        "urls": {
          "type": "object",
          "properties": {
            "detail": {
              "type": "string",
              "description": "URL to retrieve JSON meta-data about this polling district"
            },
            "geo": {
              "type": "string",
              "description": "URL to retrieve GeoJSON feature describing this polling district"
            }
          }
        },
        "council": {
          "type": "string",
          "description": "URL to retrieve JSON meta-data about the council which administers this polling district"
        },
        "district_id": {
          "type": "string",
          "description": "An identifier for this polling district. District IDs are unique within councils, but are not unique nationally"
        },
        "polling_station": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "urls": {
              "type": "object",
              "properties": {
                "detail": {
                  "type": "string",
                  "description": "URL to retrieve JSON meta-data about this polling station"
                },
                "geo": {
                  "type": "string",
                  "description": "URL to retrieve GeoJSON feature describing this polling station"
                }
              }
            },
            "council": {
              "type": "string",
              "description": "URL to retrieve JSON meta-data about the council which administers this polling station"
            },
            "station_id": {
              "type": "string",
              "description": "An identifier for this polling station. Station IDs are unique within councils, but are not unique nationally"
            },
            "address": {
              "type": "string",
              "description": "Address for this polling station"
            },
            "postcode": {
              "type": "string",
              "description": "Postcode for this polling station"
            }
          },
          "description": "A polling station object describing the station which serves this district. Optionally null if we do not hold this information"
        }
      }
    }
  }
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
  "detail": "Not found."
}

Usage restrictions ¶

API Root ¶

API Root ¶

Retrieve the Entry PointGET/.json

Example URI

Headers

Body

Polling Station Finder ¶

Postcode search ¶

Postcode searchGET/postcode/{postcode}.json

Example URI

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Headers

Body

Address search ¶

Address searchGET/address/{slug}.json

Example URI

Headers

Body

Schema

Headers

Body

Councils ¶

Councils Collection: JSON ¶

List All Councils: JSONGET/councils.json

Example URI

Headers

Body

Schema

Councils: JSON ¶

Retrieve a Council: JSONGET/councils/{council_id}.json

Example URI

Headers

Body

Schema

Headers

Body

Councils: GeoJSON ¶

Retrieve a Council: GeoJSONGET/councils/{council_id}/geo.json

Example URI

Headers

Body

Schema

Headers

Body

Polling Stations ¶

Polling Stations Collection: JSON ¶

List All Polling Stations in a Local Authority: JSONGET/pollingstations.json?council_id={council_id}

Example URI

Headers

Body

Schema

Polling Stations Collection: GeoJSON ¶

List All Polling Stations in a Local Authority: GeoJSONGET/pollingstations/geo.json?council_id={council_id}

Example URI

Headers

Body

Schema

Polling Stations: JSON ¶

Retrieve a Polling Station: JSONGET/pollingstations.json?council_id={council_id}&station_id={station_id}

Example URI

Headers

Body

Schema

Headers

Body

Polling Stations: GeoJSON ¶

Retrieve a Polling Station: GeoJSONGET/pollingstations/geo.json?council_id={council_id}&station_id={station_id}

Example URI

Headers

Usage restrictions

Retrieve the Entry Point
GET`/.json`

Postcode search
GET`/postcode/{postcode}.json`

Address search
GET`/address/{slug}.json`

List All Councils: JSON
GET`/councils.json`

Retrieve a Council: JSON
GET`/councils/{council_id}.json`

Retrieve a Council: GeoJSON
GET`/councils/{council_id}/geo.json`

List All Polling Stations in a Local Authority: JSON
GET`/pollingstations.json?council_id={council_id}`

List All Polling Stations in a Local Authority: GeoJSON
GET`/pollingstations/geo.json?council_id={council_id}`

Retrieve a Polling Station: JSON
GET`/pollingstations.json?council_id={council_id}&station_id={station_id}`

Retrieve a Polling Station: GeoJSON
GET`/pollingstations/geo.json?council_id={council_id}&station_id={station_id}`

List All Polling Districts in a Local Authority: JSON
GET`/pollingdistricts.json?council_id={council_id}`

List All Polling Districts in a Local Authority: GeoJSON
GET`/pollingdistricts/geo.json?council_id={council_id}`

Retrieve a Polling District: JSON
GET`/pollingdistricts.json?council_id={council_id}&district_id={district_id}`

Retrieve a Polling District: GeoJSON
GET`/pollingdistricts/geo.json?council_id={council_id}&district_id={district_id}`