PRpropcode
Property lookup

Get a property's zones and overlays

One property's planning maps: its zone, controls and overlays, as PropCode's property page lists them. No analysis. Their measures, such as height and floor space ratio limits, come once your team has unlocked the property as Pro. Not billed.

get/v1/property

Request

  • Base URL
    https://app.propcode.com.au/api
  • Auth
    HTTP bearer

Query parameters

titlestring required

The title id, e.g. 5008/DP752015. Find one with GET /v1/properties.

jurisdictionstring

The state: nsw (the default), vic, act or tas. Complying development answers are NSW only.

Response

The property and its maps.

titlestring required

The title reference.

jurisdictionstring required

The state: nsw, vic, act or tas.

addressstring required

The property's street address.

lgastring

The local government area.

lotAreaM2number

The lot's area, in m².

object'property' required
unlockedboolean required

Whether your team has unlocked the property as Pro, or it is one of the sample properties, whose measures and Pro report are free with any key. Until then, the maps leave out their measures, such as height and floor space ratio limits and minimum lot sizes, and how much of the lot each feature covers. access says which.

access'unlocked' | 'free_sample' | 'locked' required

How your team reads the property's measures and Pro report: unlocked, where it holds the property as Pro; free_sample, for one of the sample properties, free with any key and never among your unlocked properties; locked until a Pro unlock.

Changes

No recorded changes to this operation across all 1 revision of this API.