Skip to main content
GET
Scores

Authorizations

Authorization
string
header
required

Your secret key, ctf_sk_live_…

Query Parameters

postcode
string | null

A postcode, e.g. SG8 9NT.

Maximum string length: 20
Pattern: ^[^\x00-\x1f]*$
q
string | null

A town or village, or an address (its postcode is used).

Maximum string length: 200
Pattern: ^[^\x00-\x1f]*$
lat
number | null
Required range: 49 <= x <= 61
lng
number | null
Required range: -10 <= x <= 3
radius_m
integer
default:500
Required range: 50 <= x <= 1000
limit
integer
default:20
Required range: 1 <= x <= 60
geometry
boolean
default:false

Include each field's outline.

applications
boolean
default:true

Include housing applications.

Response

Successful Response

centre
Centre · object
required

Where the fields were looked for around.

radius_m
integer
required

How far from it, in metres.

model_version
string
required

The scoring model the scores come from.

fields
FieldScore · object[]
required

Open fields nearest first.

attribution
string[]
required

Must be shown wherever the data is shown.

applications
Application · object[] | null

Housing applications within the radius, newest first.