Skip to main content
GET
Field

Authorizations

Authorization
string
header
required

Your secret key, ctf_sk_live_…

Path Parameters

field_id
integer
required

The field's field_id.

Required range: 1 <= x <= 9223372036854776000

Query Parameters

geometry
boolean
default:false

Include the field's outline.

Response

Successful Response

field_id
integer
required

Our id for the field; use it with /v1/fields/{field_id}.

inspire_id
integer | null
required

HM Land Registry INSPIRE id of the land parcel.

distance_m
integer
required

Metres from the place asked about to the field's edge.

area_ha
number
required

The field's area in hectares.

council
Council · object
required
point
number[]
required

A point inside the field, [longitude, latitude].

status
enum<string>
required

pending: not scored yet; it has been queued, so ask again in a few minutes. not_open_land: built on, or too small to be a field; never scored.

Available options:
scored,
pending,
not_open_land
score
integer | null
required

Likelihood of housing, 0–100. Null until scored.

band
enum<string> | null
required

The score's band: Low 0–19, Moderate 20–44, High 45–69, Very High 70–100.

Available options:
Low,
Moderate,
High,
Very High
horizons
Horizons · object | null
required
reasons
Reason · object[]
required

The strongest reasons behind the score, at most 3.

scored_at
string<date-time> | null
required

When the field was last scored.

report_url
string
required

The field on our map, with its report where it has one.

model_version
string
required

The scoring model the score comes from.

applications
Application · object[]
required

Housing applications within 1 km.

attribution
string[]
required

Must be shown wherever the data is shown.

geometry
Geometry · object | null

The field's outline as GeoJSON (WGS84), when asked for.