Planning Data
Documentation
Downloading the data
You can download datasets in bulk in various formats from each dataset page.
Downloads are available as CSV, JSON and where applicable as GeoJSON.
Getting the data through the API
We are also developing an experimental API. Developers can use these APIs to explore our data and test services. As we are still in beta, these should not be used for building production-ready systems.
You can read about the API below. Get in touch with the team if you are interested in building a service using the planning data API.
Contents:
Planning Data API
Search entity
This endpoint searches for a subset of entities from all entities filtered by specified parameters returning the entity set in the format specified.
| Request type | URL |
|---|---|
| get | /entity.{extension} |
| Name | Required? | Type | Description |
|---|---|---|---|
|
extension
|
Required
|
string | Must be one of: json, html or geojson |
|
typology
|
Optional
|
array(string) | Search for entities by typology |
|
dataset
|
Optional
|
array(string) | Search for entities by dataset |
|
organisation_entity
|
Optional
|
array(integer) | Search for entities managed by organisation |
|
entity
|
Optional
|
array(integer) | Search for entities by entity number |
|
curie
|
Optional
|
array(string) | Search for entities by CURIE |
|
prefix
|
Optional
|
array(string) | Search for entities by prefix |
|
reference
|
Optional
|
array(string) | Search for entities by reference |
|
period
|
Optional
|
array() | Results to include current, or all entries |
|
start_date_year
|
Optional
|
integer | Search for entities by start date year before or after the given year. Depends on start_date_match |
|
start_date_month
|
Optional
|
integer | Search for entities by start date month before or after the given year. Depends on start_date_match |
|
start_date_day
|
Optional
|
integer | Search for entities by start date day before or after the given day. Depends on start_date_match |
|
start_date_match
|
Optional
|
string | Specify how to filter against the start_date_* values provided, either before, after or match |
|
end_date_year
|
Optional
|
integer | Search by end date year before or after the given year. Depends on end_date_match |
|
end_date_month
|
Optional
|
integer | Search for entities by end date month before or after the given month.Depends on end_date_match |
|
end_date_day
|
Optional
|
integer | Search for entities by end date day before or after the given day. Depends on end_date_match |
|
end_date_match
|
Optional
|
string | Specify how to filter against the end_date_* values provided, either before, after or match |
|
entry_date_year
|
Optional
|
integer | Search for entities by entry date year before or after the given year. Depends on entry_date_match |
|
entry_date_month
|
Optional
|
integer | Search for entities for entities by entry date month before or after the given month.Depends on entry_date_match |
|
entry_date_day
|
Optional
|
integer | Search for entities by entry date day before or after the given day. Depends on entry_date_match |
|
entry_date_match
|
Optional
|
string | Specify for entities how to filter against the entry_date_* values provided, either before, after or match |
|
longitude
|
Optional
|
number | Search for entity with geometries intersected by a point constructed with this longitude. Requires latitude to be provided. |
|
latitude
|
Optional
|
number | Search for entities with geometries intersected by a point constructed with this latitude. Requires longitude to be provided. |
|
geometry
|
Optional
|
array(string) | Search for entities with geometries interacting with one or more geometries provided in WKT format. The type of geometric relation can be set using the geometry relation parameter. |
|
geometry_entity
|
Optional
|
array(integer) | Search for entities with geometries interacting with one or more geometries taken from each of the provided entities. The type of geometric relation can be set using the geometry relation parameter. |
|
geometry_reference
|
Optional
|
array(string) | Search entities with geometries interacting with the geometries of entities with the provided references. The type of geometric relation can be set using the geometry relation parameter. |
|
geometry_curie
|
Optional
|
array(string) | Search for entities with geometries interacting with geometries entities matching provided curies. The type of geometric relation can be set using the geometry relation parameter. |
|
geometry_relation
|
Optional
|
string | DE-9IM spatial relationship, default is 'within' |
|
limit
|
Optional
|
integer | limit for the number of results |
|
offset
|
Optional
|
integer | paginate results from this entity |
|
field
|
Optional
|
array(string) | fields to be included in response |
|
exclude_field
|
Optional
|
array(string) | field parameter will take over any fields specified in the exclude_field parameter |
Get entity
This endpoint returns data on one specific entity matching the specified ID in the format requested.
| Request type | URL |
|---|---|
| get | /entity/{entity}.{extension} |
| Name | Required? | Type | Description |
|---|---|---|---|
|
entity
|
Required
|
integer | Entity id |
|
extension
|
Required
|
string | Must be one of: json, html or geojson |
List datasets
This endpoint lists all datasets, returning the results in the file format specified.
| Request type | URL |
|---|---|
| get | /dataset.{extension} |
| Name | Required? | Type | Description |
|---|---|---|---|
|
extension
|
Required
|
string | Must be one of: json or html |
Get dataset
This endpoint returns a specific dataset in the file format specified.
| Request type | URL |
|---|---|
| get | /dataset/{dataset}.{extension} |
| Name | Required? | Type | Description |
|---|---|---|---|
|
dataset
|
Required
|
string | Specify which dataset |
|
extension
|
Required
|
string | Must be one of: json or html |
Planning Data OpenAPI
You can generate a client library from our OpenAPI file using Swagger Editor.
This may be an easier way for you to integrate your service with the planning data platform than writing a client library from scratch.
| Request type | URL |
|---|---|
| GET | https://www.planning.data.gov.uk/openapi.json |