API reference

Addresses

Every Australian address from G-NAF, matched exactly from one line, with what is known about its point in the same answer. Base URL https://dataquoll.io/api/v1.

POST/address

Look up an Australian address and what is known about it

One Australian address in, one call: the address matched EXACTLY against G-NAF (every Australian address, Geoscape Australia under the Open G-NAF EULA), and what DataQuoll knows about its point: the local government area, declared-area status (with the declarations scope), active incidents within radiusKm, the nearest river gauge, the nearest emergency facilities and the mobile network sites around it. Matching is exact, never fuzzy: a misspelt street or suburb returns status no_match with the part that failed (reason and part), never a guess and never a list of addresses. Units (3/12, Unit 3, U3), levels, lots (Lot 101 Port Wakefield Rd), ranges (87-89) and suffixes (12A) are read exactly. Give the state or the postcode. precision says how far G-NAF's point can be trusted: address (on the property), street, locality or interpolated. The LGA and declared-area status are given only for an address-level point, because a street or suburb point can sit in another LGA. The address is sent in the body and is never logged, stored or echoed; responses are not cached. Hazard history for the point is a separate call to /hazard-history/point with the returned coordinates.

Responses

StatusDescription
200A match with its answers, or status no_match with the part that failed
400The body is not a JSON object with an address string, or radiusKm is out of range
401Missing or invalid API key
429Rate limit exceeded
Request
curl "https://dataquoll.io/api/v1/address" \
  -H "Authorization: Bearer YOUR_API_KEY"