---
title: "Get a property's zones and overlays"
method: GET
path: "/v1/property"
tags: ["Property lookup"]
---

# Get a property's zones and overlays

`GET /v1/property`

## Request

- Base URL: `https://app.propcode.com.au/api`
- URL: `https://app.propcode.com.au/api/v1/property`
- Auth: HTTP bearer

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.

## Query parameters

- `title` string, required
- `jurisdiction` string

## Response `200`

The property and its maps.

- PropertyMaps: A property with its zones and overlays.
  - `title` string, required: The title reference.
  - `jurisdiction` string, required: The state: nsw, vic, act or tas.
  - `address` string, required: The property's street address.
  - `lga` string: The local government area.
  - `lotAreaM2` number: The lot's area, in m².
  - `object` 'property', required
  - `unlocked` boolean, 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.
  - `maps` Map[], required: The planning maps with a feature on the lot, as PropCode's property page lists them: its zone, its controls and its overlays.
    - `name` string, required: The map, e.g. Land Zoning Map.
    - `features` MapFeature[], required
      - `coverage` number, nullable, required: How much of the lot it covers, from 0 to 1, when known. Null until your team has unlocked the property as Pro.
      - `attributes` object[], required: What the map says here, as the map labels it, e.g. Zone: R2 - Low Density Residential.
        - `label` string, required
        - `value` string, required

## Other responses

- `400`: The request isn’t valid. Codes: `key_in_url`, `invalid_parameter`.
- `401`: No valid key. Codes: `missing_api_key`, `invalid_api_key`.
- `403`: This key can’t ask that. Codes: `sandbox_title_only`.
- `404`: Not found. Codes: `title_not_found`.
- `429`: Over a limit: retry after Retry-After. Codes: `rate_limited`, `sandbox_daily_limit`.
- `500`: Our error. Codes: `internal_error`.

---

[API](https://skmtc.dev/propcode/apis/propcode-api.md) - [All operations](https://skmtc.dev/propcode/apis/propcode-api/llms.txt) - [OpenAPI document](https://skmtc.dev/propcode/apis/propcode-api/revisions/f393cce32349?raw)