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

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.

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.

Authorizations:
Authorization
query Parameters
page
number
Default: 0
object or object or object or object
title_number
string
whereQuery
string
return_full_meta_data
boolean

Responses

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

Responses

Response samples

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

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

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

Responses

Response samples

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

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

Responses

Response samples

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

Titles

Get title data

Returns an individual title. This costs 1 credit.

Authorizations:
Authorization
query Parameters
titleNumber
required
string

Responses

Response samples

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

Get Titles Overlapping Lat/Lng

Returns all titles that match the searching inputs, this costs 1 credit per title if return_full_meta_data=true, or 1/20th of a credit per title for return_full_meta_data=false (defaulted).

Authorizations:
Authorization
query Parameters
page
number
Default: 0
lat
required
number
lng
required
number
string or string
return_full_meta_data
boolean

Responses

Response samples

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

Search for titles

Returns all.

Authorizations:
Authorization
query Parameters
page
number
Default: 0
uprn
number
string or 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" "ownership_api" "local_plan_details_api" "settlement_boundaries_api" "price_paid_api" "allocations_api" "dno_api" "local_plan_policy" "tpo_api" "article_4_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
object or object or object or object

Responses

Response samples

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

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
object or object or object or object

Responses

Response samples

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

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
lpaCode
string

Responses

Response samples

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

MVT Endpoints

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.0005 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.0001 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.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

SHLAA

Returns features for a specific tile based on geospatial query. Each item returned costs 0.02 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.0005 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.0001 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.0001 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.0001 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.