Documentation

Property API

Give it an Australian address and get back, in one JSON answer, six hazards at that location (bushfire, flood, landslide, coastal, earthquake and cyclone). Each comes with the register we hold for it, its date and how confident the answer is. In New South Wales it also gives the Valuer General’s land value for the lot on each 1 July since 2012 that the Valuer General valued it. Hazards are tested at one point: the address point, or the coordinates you send. Where we hold no register for a hazard, the answer saysunmapped. Today that includes earthquake and cyclone everywhere. It runs on the same API key as the address API. It is a paid add-on. A sample answer is free with any secret key.

Pricing

Add it in the console under Billing. It works with any plan, including Free, on a workspace billed by invoice. Workspaces billed through Shopify can’t add it. One property is one lookup, however many times you ask for it within an hour of being billed for it.

Tier	Per month	Property lookups included	Each lookup after that
Property Starter	$53.90 incl. GST ($49 ex-GST)	500	$0.165 incl. GST ($0.15 ex-GST)
Property Growth	$218.90 incl. GST ($199 ex-GST)	3,000	$0.088 incl. GST ($0.08 ex-GST)

Adding it starts a monthly add-on period that day. We invoice the month in full that day, due that day, then every month after that. It has its own monthly period, separate from your plan’s.
Lookups beyond the included number are invoiced when the month ends. Once a month reaches five times the included number, property requests pause until the next month starts.
Changing tier, or removing it, takes effect when the current month ends. Nothing is charged or refunded mid-month, except the refund our Terms give if a publisher withdraws data.
If an add-on invoice is still unpaid 14 days after its due date, we email a reminder first, then remove the add-on. Your plan and address API are not affected.
Not billed: an address we cannot match, a street or suburb instead of a property, a request we fail to answer, a repeat for the same property within an hour, and anything on a test key.
Need more than 15,000 a month? Ask us about Enterprise.

Quickstart

Use a secret key from your server (create one in the console under API keys). Start with the free sample, which works with any secret key (a live key, or a test key during your account’s first 15 days):

curl -H "Authorization: Bearer YOUR_SECRET_KEY" \
https://api.wattleaddr.com.au/v1/property/sample

Then ask about a real address, with a live key on a workspace that has the add-on:

curl -G -H "Authorization: Bearer YOUR_SECRET_KEY" \
--data-urlencode "address=25 Echidna Close, Bellbird NSW 2325" \
https://api.wattleaddr.com.au/v1/property

Test keys (waddr_sk_test_…) always get the sample back from /v1/property, whatever you ask for, marked "test": true, and are never billed. That lets you build against the real response shape before you buy.

Request

Parameter	What it is
`address`	A full street address, with the number (and the unit, for a unit). A street or a suburb on its own is refused, unbilled, with `not_a_property`.
`lat`, `lon`	Instead of `address`: a point in decimal degrees, latitude first and negative in Australia. The answer is for that point.

Response

Field	What it holds
`address`	The address we matched, its G-NAF id and how well it matched. Check it is the property you meant.
`jurisdiction`	The state or territory of the point.
`hazards[]`	One entry per hazard: `status` is `present`, `absent` or `unmapped`; `confidence` is `confirmed`, `derived`, `estimated` or `unresolved`; `findings` name the register, its category and date. `absent` is a finding only where a register covers the point, and it is never `confirmed`: it is tested at the address point, and part of the lot may still be inside a mapped area. `unmapped` means no register we hold covers it, which is not the same as safe. In New South Wales, flood is mapped only where a council has put its flood planning map into the statewide layer, so many NSW addresses get `unmapped` flood. The `basis` says where to ask.
`hazards[].wattleaddr_rating`	Our normalisation of the register’s categories so hazards can be compared across states, not the publisher’s own category (which is in `findings`). See `rating_note` in the answer.
`unmapped`	The hazards with no register here, listed again so you cannot miss them.
`land_value`	NSW only. `state: "present"` with `latest` and `history` (each 1 July the Valuer General valued the lot, in dollars), the lot, the Valuer General property id and the source; or `state: "unavailable"` with the reason. A land value is given only where the lot is exactly one Valuer General property, valued in the newest year we hold. So none is given for another state, a strata or community scheme, a property made of several lots or of part of a lot, a lot shared by several properties, or a lot whose property no longer exists.
`attribution`, `licences`, `licences_note`	The notices and licences for exactly the data in this answer. Keep them with the data wherever you show it.
`billing.property_key`, `billed`	The property this answer was billed for, and whether this call was billed (`false` for a repeat within the hour).
`test`, `sample`	Present and `true` on a test key’s answer and on the sample.

Land value is not what a property is worth. It is the Valuer General’s value of the land alone, as at 1 July, as if nothing were built on it; councils rate on it, and Revenue NSW uses it, averaged over up to three years, for land tax. It is not a sale price, a valuation or a forecast, and the answer says so in land_value.note. Show that note wherever you show the figure.

Headers on a live call: x-wattleaddr-property-quota-limit (included lookups this period) and x-wattleaddr-property-quota-remaining (included lookups left. At 0, lookups continue as overage until five times the included number).

Example answer

An example answer for the sample property:

{
  "sample": true,
  "schema": "wattleaddr.property/v1",
  "generated_at": "2026-10-02T11:54:32+10:00",
  "query": {
    "lat": -32.85865014,
    "lon": 151.30169184
  },
  "address": {
    "matched": "25 Echidna Cl, Bellbird NSW 2325",
    "locality": "Bellbird NSW 2325",
    "gnaf_pid": "GANSW715368073",
    "confidence": "high",
    "match_level": "premise",
    "gnaf_release": null,
    "source": "WattleAddr Address API"
  },
  "jurisdiction": "NSW",
  "hazards": [
    {
      "peril": "bushfire",
      "status": "present",
      "confidence": "confirmed",
      "wattleaddr_rating": "low",
      "findings": [
        {
          "peril": "bushfire",
          "jurisdiction": "NSW",
          "category": "Vegetation Buffer",
          "wattleaddr_rating": "low",
          "published_category": null,
          "value": null,
          "units": null,
          "attrs": {
            "rfs_category": "vegetation_buffer",
            "published_category": "Vegetation Buffer"
          },
          "geometry_repaired": false,
          "repair_method": null,
          "date": "2025-11-11",
          "source": {
            "id": "nsw_bfpl",
            "title": "New South Wales — Bush Fire Prone Land",
            "publisher": "NSW Rural Fire Service",
            "licence": "CC BY 4.0",
            "attribution": "© State of New South Wales (NSW Rural Fire Service)",
            "url": "https://portal.spatial.nsw.gov.au/server/rest/services/Hosted/NSW_BushFire_Prone_Land/FeatureServer/0",
            "date_label": "Record updated",
            "currency_date": "2026-08-10"
          },
          "confidence": "confirmed",
          "method": "Bush fire prone land map made under section 10.3 of the Environmental Planning and Assessment Act 1979 and certified by the Commissioner of the NSW Rural Fire Service. Inclusion is a legal designation that triggers Planning for Bush Fire Protection requirements, not a model output. The statewide layer does not carry each council certification date, so the date shown is when the record was last updated."
        }
      ],
      "basis": "New South Wales — Bush Fire Prone Land"
    },
    {
      "peril": "flood",
      "status": "unmapped",
      "confidence": "unresolved",
      "wattleaddr_rating": null,
      "findings": [],
      "basis": "No flood register covering this location has been loaded. This is not a finding that the location is unaffected — it means no authority's map has been consulted."
    },
    {
      "peril": "earthquake",
      "status": "unmapped",
      "confidence": "unresolved",
      "wattleaddr_rating": null,
      "findings": [],
      "basis": "No earthquake register covering this location has been loaded. This is not a finding that the location is unaffected — it means no authority's map has been consulted."
    },
    {
      "peril": "cyclone",
      "status": "unmapped",
      "confidence": "unresolved",
      "wattleaddr_rating": null,
      "findings": [],
      "basis": "No cyclone register covering this location has been loaded. This is not a finding that the location is unaffected — it means no authority's map has been consulted."
    },
    {
      "peril": "coastal",
      "status": "unmapped",
      "confidence": "unresolved",
      "wattleaddr_rating": null,
      "findings": [],
      "basis": "No coastal register covering this location has been loaded. This is not a finding that the location is unaffected — it means no authority's map has been consulted."
    },
    {
      "peril": "landslide",
      "status": "unmapped",
      "confidence": "unresolved",
      "wattleaddr_rating": null,
      "findings": [],
      "basis": "No landslide register covering this location has been loaded. This is not a finding that the location is unaffected — it means no authority's map has been consulted."
    }
  ],
  "unmapped": [
    "flood",
    "earthquake",
    "cyclone",
    "coastal",
    "landslide"
  ],
  "land_value": {
    "state": "present",
    "note": "Land value is not what the property is worth. It is the NSW Valuer General's value of the land alone, as at 1 July each year, as if nothing were built on it: councils rate on it and Revenue NSW assesses land tax on it. It is not a sale price, a valuation of the property or a forecast.",
    "lot": "35//DP1057053",
    "valuer_general_property_id": 3017030,
    "latest": {
      "as_at": "2025-07-01",
      "amount_aud": 704000
    },
    "history": [
      {
        "as_at": "2012-07-01",
        "amount_aud": 239000
      },
      {
        "as_at": "2013-07-01",
        "amount_aud": 251000
      },
      {
        "as_at": "2014-07-01",
        "amount_aud": 256000
      },
      {
        "as_at": "2015-07-01",
        "amount_aud": 262000
      },
      {
        "as_at": "2016-07-01",
        "amount_aud": 271000
      },
      {
        "as_at": "2017-07-01",
        "amount_aud": 277000
      },
      {
        "as_at": "2018-07-01",
        "amount_aud": 322000
      },
      {
        "as_at": "2019-07-01",
        "amount_aud": 322000
      },
      {
        "as_at": "2020-07-01",
        "amount_aud": 322000
      },
      {
        "as_at": "2021-07-01",
        "amount_aud": 440000
      },
      {
        "as_at": "2022-07-01",
        "amount_aud": 716000
      },
      {
        "as_at": "2023-07-01",
        "amount_aud": 642000
      },
      {
        "as_at": "2024-07-01",
        "amount_aud": 665000
      },
      {
        "as_at": "2025-07-01",
        "amount_aud": 704000
      }
    ],
    "source": {
      "title": "NSW bulk land value information",
      "extract": "LV_20260901",
      "licence": "CC BY 4.0",
      "licence_url": "https://creativecommons.org/licenses/by/4.0/",
      "attribution": "© Valuer General New South Wales, NSW bulk land value information, licensed under CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Changes are WattleAddr Property's calculations from those figures."
    }
  },
  "attribution": [
    "© State of New South Wales (NSW Rural Fire Service)",
    "Australian Bureau of Statistics, Australian Statistical Geography Standard (ASGS) Edition 3, 2021 — State and Territory boundaries. Licensed under CC BY 4.0.",
    "© Valuer General New South Wales, NSW bulk land value information, licensed under CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Changes are WattleAddr Property's calculations from those figures."
  ],
  "licences": [
    {
      "source": "New South Wales — Bush Fire Prone Land",
      "publisher": "NSW Rural Fire Service",
      "licence": "CC BY 4.0",
      "url": null
    },
    {
      "source": "nsw_lv_history",
      "publisher": "Valuer General NSW",
      "licence": "CC BY 4.0",
      "url": "https://data.nsw.gov.au/data/dataset/327f9982-e610-4ffe-a51c-4047e97c7e7d"
    }
  ],
  "rating_note": "wattleaddr_rating is our normalisation across jurisdictions, not the publisher's.",
  "billing": {
    "unit": "property",
    "property_key": "GANSW715368073"
  },
  "query_ms": 81.31,
  "billed": false
}

What it covers

Hazards: every state and territory whose registers we hold, as the answer’s licences list shows. Where we hold none for a hazard, it is unmapped.
Land values: New South Wales, for a property that is one whole lot. Other states, strata schemes and lots shared by several Valuer General properties return unavailable with the reason.
The answer is for the address’s point and the lot it falls in. It is research from public registers, not advice, a certificate, a title search or a valuation.

Attribution

Each register is published under its own licence, named in the answer with its exact notice (for example, NSW land values: © Valuer General New South Wales, CC BY 4.0). If you display or pass on the data, keep that notice with it, say if you changed it, and do not imply the publisher endorses you. Our Terms of Service set this out.

Errors

Errors use the same shape as the address API. The property-specific codes are property_not_enabled, property_quota_exceeded, address_not_matched, not_a_property, outside_coverage, property_unavailable, forbidden_key_type and rate_limited. None of them is billed. All of them are on the error codes page.