Searchland Logo
API docs by Redocly

Searchland API (1.0.0)

Download OpenAPI specification:Download

Settlement Boundaries

Check availability

Returns the status of settlement boundaries within the LPA of a specific point. The cost of this is 0 credits.

Authorizations:
Authorization
query Parameters
required
object

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "status": "council_has_settlements",
  • "lpa_name": "string"
}

List settlement boundaries

Returns settlement boundaries that intersect with the given geometry. The cost of this is 1 credit per 20 results.

Authorizations:
Authorization
query Parameters
page
number
Default: 0
required
object or object or object or object or object or object

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "data": [
    ]
}

Get a settlement boundary

Returns a settlement boundary. The cost of this is 1 credit.

Authorizations:
Authorization
query Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "data": {
    }
}

Planning

Get application

Returns an individual planning application. This costs 1 credit.

Authorizations:
Authorization
query Parameters
_id
required
string

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "count": 0,
  • "data": {
    }
}

Get documents

Returns all documents for a given planning application. This costs 1 credit per 20 documents returned.

Authorizations:
Authorization
query Parameters
page
number
Default: 0
planning_id
required
string

The ID from a planning application retrieved using search.

search_planning_documents
string

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "count": 0,
  • "data": [
    ]
}

Search applications

Returns all planning applications within a given area. This costs 1 credit per 20 applications returned. If using reutrn_full_meta_data, it will cost 1 credit per application returned.

Authorizations:
Authorization
query Parameters
perPage
number
Default: 20
page
number
Default: 0
object or object or object or object or object or object
title_number
string
whereQuery
string
return_full_meta_data
boolean
search_planning_documents
string
search_proposals
string
uprn
number

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "count": 0,
  • "data": [
    ]
}

Search applications

Returns all planning applications within a given area. This costs 1 credit per 20 applications returned. If using reutrn_full_meta_data, it will cost 1 credit per application returned.

Authorizations:
Authorization
Request Body schema: application/json
required
perPage
number
Default: 20
page
number
Default: 0
object or object or object or object or object or object
title_number
string
whereQuery
string
return_full_meta_data
boolean
search_planning_documents
string
search_proposals
string
uprn
number

Responses

Request samples

Content type
application/json
{
  • "perPage": 20,
  • "page": 0,
  • "geometry": {
    },
  • "title_number": "string",
  • "whereQuery": "string",
  • "return_full_meta_data": true,
  • "search_planning_documents": "string",
  • "search_proposals": "string",
  • "uprn": 0
}

Response samples

Content type
application/json
{
  • "cost": 0,
  • "count": 0,
  • "data": [
    ]
}

Planning report

Bespoke for generating per property planning reports. This costs 1 credit per land parcel returned, it requires a different credit called PLANNING_REPORT_API. return_full_meta_data does not cost extra with this query.

Authorizations:
Authorization
Request Body schema: application/json
required
perPage
number [ 500 .. 500 ]
Default: 500
page
number
Default: 0
object or object or object or object or object or object
title_number
string
whereQuery
string
return_full_meta_data
boolean
Default: true
search_planning_documents
string
search_proposals
string
uprn
number

Responses

Request samples

Content type
application/json
{
  • "perPage": 500,
  • "page": 0,
  • "geometry": {
    },
  • "title_number": "string",
  • "whereQuery": "string",
  • "return_full_meta_data": true,
  • "search_planning_documents": "string",
  • "search_proposals": "string",
  • "uprn": 0
}

Response samples

Content type
application/json
{
  • "cost": 0,
  • "count": 0,
  • "data": [
    ]
}

Constraints

Check title constraints

Returns a list constraints on a title. This costs 1 credit.

Authorizations:
Authorization
query Parameters
title_number
required
string
buffer
number <= 2

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "count": 0,
  • "constraints": [
    ],
  • "buffered_constraints": [
    ]
}

Check constraints for geometry

Returns constraints overlapping the provided geometry including their geometries. Costs 1 credit per constraint.

Authorizations:
Authorization
Request Body schema: application/json
required
required
object or object or object or object or object or object
types
Array of strings
Items Enum: "Flood Zone 2" "Flood Zone 3" "Listed Building(s) 50m Buffer" "Mine Entry Potential Zone of Influence" "Ancient Woodland" "SSSI Impact Zone" "Coal Outcrop" "Abandoned Mine" "Coal & Mining Development High Risk Area" "Past Shallow Coal Mine Workings" "CROW" "Scheduled Monuments" "Conservation Area" "SSSI" "Probable Shallow Coal Mine Workings" "Green Belt High Contribution" "Built Up Areas" "Fissure and Breaklines" "Designated Open Space" "SAC" "Surface Mining" "RAMSAR" "SPA 400m Buffer" "SPA" "Green Belt Review Other" "Parks and Gardens" "National Nature Reserves" "Local Nature Reserves" "LSIS" "Country Parks" "Surface Coal Resource Area" "Green Belt" "Mining Reporting Area" "Town Center Boundaries" "North East Mining Groundwater Constraints" "SIL" "Battlefields" "National Landscapes (AONB)" "World Heritage Sites" "Nutrient Neutrality" "Housing Zones" "Opportunity Areas" "National Parks" "Central Activities Zone" "Areas Of Intensification"

Filter results to only these constraint types

perPage
required
number
Default: 20
page
required
number
Default: 0

Responses

Request samples

Content type
application/json
{
  • "geometry": {
    },
  • "types": [
    ],
  • "perPage": 20,
  • "page": 0
}

Response samples

Content type
application/json
{
  • "cost": 0,
  • "count": 0,
  • "constraints": [
    ]
}

Count constraints within a given area

Returns count of constraints in a given area. This costs 1 credit if any found, 0 if none.

Authorizations:
Authorization
query Parameters
required
object or object or object or object or object or object
types
Array of strings
Items Enum: "Flood Zone 2" "Flood Zone 3" "Listed Building(s) 50m Buffer" "Mine Entry Potential Zone of Influence" "Ancient Woodland" "SSSI Impact Zone" "Coal Outcrop" "Abandoned Mine" "Coal & Mining Development High Risk Area" "Past Shallow Coal Mine Workings" "CROW" "Scheduled Monuments" "Conservation Area" "SSSI" "Probable Shallow Coal Mine Workings" "Green Belt High Contribution" "Built Up Areas" "Fissure and Breaklines" "Designated Open Space" "SAC" "Surface Mining" "RAMSAR" "SPA 400m Buffer" "SPA" "Green Belt Review Other" "Parks and Gardens" "National Nature Reserves" "Local Nature Reserves" "LSIS" "Country Parks" "Surface Coal Resource Area" "Green Belt" "Mining Reporting Area" "Town Center Boundaries" "North East Mining Groundwater Constraints" "SIL" "Battlefields" "National Landscapes (AONB)" "World Heritage Sites" "Nutrient Neutrality" "Housing Zones" "Opportunity Areas" "National Parks" "Central Activities Zone" "Areas Of Intensification"

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "count": 0,
  • "counts": [
    ]
}

Allocations

Get site allocation

Returns an individual site allocation. This costs 1 credit.

Authorizations:
Authorization
query Parameters
_id
required
string

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "data": {
    }
}

Search site allocation

Returns a list of upto 20 site allocation within a given area. This costs 1 credit.

Authorizations:
Authorization
query Parameters
page
number
Default: 0
object or object or object or object or object or object

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "data": [
    ]
}

Price Paid

Get price paid

Returns an individual price paid. This costs 1 credit.

Authorizations:
Authorization
query Parameters
_id
required
string

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "data": {
    }
}

Search price paid

Returns a list of upto 20 price paid records with reduced meta data. This costs 1 credit.

Authorizations:
Authorization
query Parameters
page
number
Default: 0
object or object or object or object or object or object

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "data": [
    ],
  • "count": 0
}

SHLAA

Get shlaa

Returns an individual shlaa. This costs 1 credit.

Authorizations:
Authorization
query Parameters
_id
required
string

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "data": {
    }
}

List shlaa

Returns shlaa within a given area. This costs 1 credit.

Authorizations:
Authorization
query Parameters
page
number
Default: 0
object or object or object or object or object or object

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "data": [
    ]
}

Titles

Get a title by title ID

Returns a title by its ID. This costs 1 credit.

Authorizations:
Authorization
query Parameters
titleNumber
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "cost": 0
}

Search for titles by coordinates

Returns all titles that intersect with the specified coordinates. Costs 1 credit per title with full metadata, or 1 credit per 20 titles otherwise.

Authorizations:
Authorization
query Parameters
page
number
Default: 0
perPage
number
Default: 20
lng
number
lat
number
"leasehold" (string) or "freehold" (string)
return_full_meta_data
boolean
Default: false
whereQuery
string

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "count": 0,
  • "data": [
    ]
}

Search for titles with advanced criteria

Returns all titles matching the specified criteria. POST version for complex queries. Costs 1 credit per title with full metadata, or 1 credit per 20 titles otherwise.

Authorizations:
Authorization
Request Body schema: application/json
required
perPage
number
Default: 20
page
number
Default: 0
lng
required
number
lat
required
number
uprn
required
number
"leasehold" (string) or "freehold" (string)
object or object or object or object or object or object
return_full_meta_data
required
boolean
Default: false
whereQuery
string

Responses

Request samples

Content type
application/json
{
  • "perPage": 20,
  • "page": 0,
  • "lng": 0,
  • "lat": 0,
  • "uprn": 0,
  • "tenure": "leasehold",
  • "geometry": {
    },
  • "return_full_meta_data": false,
  • "whereQuery": "string"
}

Response samples

Content type
application/json
{
  • "cost": 0,
  • "count": 0,
  • "data": [
    ]
}

Search for titles by UPRN and other criteria

Returns all titles matching the specified criteria. Costs 1 credit per title with full metadata, or 1 credit per 20 titles otherwise.

Authorizations:
Authorization
query Parameters
perPage
number
Default: 20
page
number
Default: 0
uprn
number
"leasehold" (string) or "freehold" (string)
object or object or object or object or object or object
return_full_meta_data
boolean
Default: false
whereQuery
string

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "count": 0,
  • "data": [
    ]
}

Product Api Usage

Get api usage for product

Returns api usage for product. This costs 0 credits.

Authorizations:
Authorization
query Parameters
product
required
string
Enum: "constraints_api" "shlaa_api" "energy_api" "planning_api" "planning_report_api" "unlimited_planning_report_api" "ownership_api" "local_plan_details_api" "settlement_boundaries_api" "price_paid_api" "allocations_api" "dno_api" "local_plan_policy" "tpo_api" "article_4_api" "hmo_api" "address_density_api"

Responses

Response samples

Content type
application/json
{
  • "apiCreditsUsed": 0,
  • "limit": 0
}

Get api usage for all products

Returns api usage for all products. This costs 0 credits.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

TPO

Get TPOs within a given area

Returns TPO within a given area. This costs 0.2 credits per tpo returned

Authorizations:
Authorization
query Parameters
page
number
Default: 0
required
object or object or object or object or object or object

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "count": 0,
  • "data": [
    ]
}

Count TPOs within a given area

Returns count of TPOs in a given area. This Costs 1 credit if any found, 0 if none.

Authorizations:
Authorization
query Parameters
required
object or object or object or object or object or object

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "count": 0
}

Article4

List Article4

Returns Article 4 within a given area. This costs 1 credit per Article 4 returned.

Authorizations:
Authorization
query Parameters
page
number
Default: 0
required
object or object or object or object or object or object

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "data": [
    ]
}

Count Article4 within a given area

Returns count of Article 4 in a given area. This costs 1 credit if any found, 0 if none.

Authorizations:
Authorization
query Parameters
required
object or object or object or object or object or object

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "count": 0
}

LocalPlanPolicy

Get Local Plan policys within a given area

Returns Local Plan policy within a given area. This costs 0.2 credits per LocalPlanPolicy returned

Authorizations:
Authorization
query Parameters
page
number
Default: 0
object or object or object or object or object or object
lpaCode
string

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "data": [
    ]
}

HMO

List HMO

Returns HMOs within a given area. This costs 1 credit per HMO returned.

Authorizations:
Authorization
query Parameters
page
number
Default: 0
object or object or object or object or object or object

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "data": [
    ]
}

Address Density

Return title boundary geometries within the search circle

Returns the geom of every title whose curtilage intersects the lat/lng/radius circle. 1 credit on first page.

Authorizations:
Authorization
query Parameters
lat
required
number
lng
required
number
radius
required
number <= 200
page
number
Default: 0
pageSize
number <= 100
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0,
  • "cost": 0
}

MVT Endpoints

HMO

Returns features for a specific tile based on geospatial query. Each item returned costs 1 credits.

path Parameters
z
required
string
x
required
string
y
required
string
query Parameters
apiKey
required
string
whereQuery
string

An SQL style query for example. decision = 'Approved' AND calculatedDateReceived < '2023-01-01'

orderBy
string

An SQL style order e.g. calculatedDateReceived DESC

limit
number
additionalFields
string

To include additional fields in the ogcLayer, use this comma separated list of field names e.g 'noDwellings'

Responses

Settlement boundaries

Returns features for a specific tile based on geospatial query. Each item returned costs 0.1 credits.

path Parameters
z
required
string
x
required
string
y
required
string
query Parameters
apiKey
required
string
whereQuery
string

An SQL style query for example. decision = 'Approved' AND calculatedDateReceived < '2023-01-01'

orderBy
string

An SQL style order e.g. calculatedDateReceived DESC

limit
number
additionalFields
string

To include additional fields in the ogcLayer, use this comma separated list of field names e.g 'noDwellings'

Responses

Planning

Returns features for a specific tile based on geospatial query. Each item returned costs 0.005 credits.

path Parameters
z
required
string
x
required
string
y
required
string
query Parameters
apiKey
required
string
whereQuery
string

An SQL style query for example. decision = 'Approved' AND calculatedDateReceived < '2023-01-01'

orderBy
string

An SQL style order e.g. calculatedDateReceived DESC

limit
number
additionalFields
string

To include additional fields in the ogcLayer, use this comma separated list of field names e.g 'noDwellings'

Responses

Planning with outlines

Returns features for a specific tile based on geospatial query. Each item returned costs 0.001 credits.

path Parameters
z
required
string
x
required
string
y
required
string
query Parameters
apiKey
required
string
whereQuery
string

An SQL style query for example. decision = 'Approved' AND calculatedDateReceived < '2023-01-01'

orderBy
string

An SQL style order e.g. calculatedDateReceived DESC

limit
number
additionalFields
string

To include additional fields in the ogcLayer, use this comma separated list of field names e.g 'noDwellings'

Responses

Planning constraints

Returns features for a specific tile based on geospatial query. Each item returned costs 0.1 credits.

path Parameters
z
required
string
x
required
string
y
required
string
query Parameters
apiKey
required
string
whereQuery
string

An SQL style query for example. decision = 'Approved' AND calculatedDateReceived < '2023-01-01'

orderBy
string

An SQL style order e.g. calculatedDateReceived DESC

limit
number
additionalFields
string

To include additional fields in the ogcLayer, use this comma separated list of field names e.g 'noDwellings'

Responses

Allocations

Returns features for a specific tile based on geospatial query. Each item returned costs 0.1 credits.

path Parameters
z
required
string
x
required
string
y
required
string
query Parameters
apiKey
required
string
whereQuery
string

An SQL style query for example. decision = 'Approved' AND calculatedDateReceived < '2023-01-01'

orderBy
string

An SQL style order e.g. calculatedDateReceived DESC

limit
number
additionalFields
string

To include additional fields in the ogcLayer, use this comma separated list of field names e.g 'noDwellings'

Responses

SHLAA

Returns features for a specific tile based on geospatial query. Each item returned costs 0.05 credits.

path Parameters
z
required
string
x
required
string
y
required
string
query Parameters
apiKey
required
string
whereQuery
string

An SQL style query for example. decision = 'Approved' AND calculatedDateReceived < '2023-01-01'

orderBy
string

An SQL style order e.g. calculatedDateReceived DESC

limit
number
additionalFields
string

To include additional fields in the ogcLayer, use this comma separated list of field names e.g 'noDwellings'

Responses

Price paid

Returns features for a specific tile based on geospatial query. Each item returned costs 0.005 credits.

path Parameters
z
required
string
x
required
string
y
required
string
query Parameters
apiKey
required
string
whereQuery
string

An SQL style query for example. decision = 'Approved' AND calculatedDateReceived < '2023-01-01'

orderBy
string

An SQL style order e.g. calculatedDateReceived DESC

limit
number
additionalFields
string

To include additional fields in the ogcLayer, use this comma separated list of field names e.g 'noDwellings'

Responses

Title boundaries

Returns features for a specific tile based on geospatial query. Each item returned costs 0.001 credits.

path Parameters
z
required
string
x
required
string
y
required
string
query Parameters
apiKey
required
string
whereQuery
string

An SQL style query for example. decision = 'Approved' AND calculatedDateReceived < '2023-01-01'

orderBy
string

An SQL style order e.g. calculatedDateReceived DESC

limit
number
additionalFields
string

To include additional fields in the ogcLayer, use this comma separated list of field names e.g 'noDwellings'

Responses

Local plan details

Returns features for a specific tile based on geospatial query. Each item returned costs 1 credits.

path Parameters
z
required
string
x
required
string
y
required
string
query Parameters
apiKey
required
string
whereQuery
string

An SQL style query for example. decision = 'Approved' AND calculatedDateReceived < '2023-01-01'

orderBy
string

An SQL style order e.g. calculatedDateReceived DESC

limit
number
additionalFields
string

To include additional fields in the ogcLayer, use this comma separated list of field names e.g 'noDwellings'

Responses

Dno towers

Returns features for a specific tile based on geospatial query. Each item returned costs 0.001 credits.

path Parameters
z
required
string
x
required
string
y
required
string
query Parameters
apiKey
required
string
whereQuery
string

An SQL style query for example. decision = 'Approved' AND calculatedDateReceived < '2023-01-01'

orderBy
string

An SQL style order e.g. calculatedDateReceived DESC

limit
number
additionalFields
string

To include additional fields in the ogcLayer, use this comma separated list of field names e.g 'noDwellings'

Responses

Dno lines

Returns features for a specific tile based on geospatial query. Each item returned costs 0.001 credits.

path Parameters
z
required
string
x
required
string
y
required
string
query Parameters
apiKey
required
string
whereQuery
string

An SQL style query for example. decision = 'Approved' AND calculatedDateReceived < '2023-01-01'

orderBy
string

An SQL style order e.g. calculatedDateReceived DESC

limit
number
additionalFields
string

To include additional fields in the ogcLayer, use this comma separated list of field names e.g 'noDwellings'

Responses

Dno substation

Returns features for a specific tile based on geospatial query. Each item returned costs 0.01 credits.

path Parameters
z
required
string
x
required
string
y
required
string
query Parameters
apiKey
required
string
whereQuery
string

An SQL style query for example. decision = 'Approved' AND calculatedDateReceived < '2023-01-01'

orderBy
string

An SQL style order e.g. calculatedDateReceived DESC

limit
number
additionalFields
string

To include additional fields in the ogcLayer, use this comma separated list of field names e.g 'noDwellings'

Responses

Local plan policy

Returns features for a specific tile based on geospatial query. Each item returned costs 0.01 credits.

path Parameters
z
required
string
x
required
string
y
required
string
query Parameters
apiKey
required
string
whereQuery
string

An SQL style query for example. decision = 'Approved' AND calculatedDateReceived < '2023-01-01'

orderBy
string

An SQL style order e.g. calculatedDateReceived DESC

limit
number
additionalFields
string

To include additional fields in the ogcLayer, use this comma separated list of field names e.g 'noDwellings'

Responses

OGC Endpoints

All OGC Endpoints

OGC endpoints can be used across, Arcgis Online, ArcgisPro and QGIS.

query Parameters
apiKey
required
string
whereQuery
string

An SQL style query for example. decision = 'Approved' AND calculatedDateReceived < '2023-01-01'

orderBy
string

An SQL style order e.g. calculatedDateReceived DESC

limit
number
additionalFields
string

To include additional fields in the ogcLayer, use this comma separated list of field names e.g 'noDwellings'

lpaCodes
string

Comma separated list of LPA codes (LPA21CD) to filter by for Example 'E60000249,E60000257' find a list of LPA codes here: https://geoportal.statistics.gov.uk/datasets/9f0e8ceda260416daeed52fd10e68834/explore

regions
string

Comma separated list of regions to filter by from the list of, north-west scotland east-of-england wales ireland london yorkshire-and-the-humber east-midlands south-east north-east south-west west-midlands

enablePagination
boolean

Defaulted to false, Only se to true in arcgisPro to load in all data, this will cost alot of credits if not used along side other filters.

qgis
boolean

Defaulted to false, Only se to true in QGIS to load in all data, this will cost alot of credits if not used along side other filters.