Address Lookup — Australia

Returns full GNAF address details for a single Australian address. Pass the address detail PID returned from Address Suggest or Address By Geo Location as the path parameter id.

On the API this is implemented as AddressController.GetById(string id) — GET /address-api-v1/au/address/{id}.

Authentication

Send your API key in the x-auth-key header. Requires an active Address Select subscription (same as other Address API routes).

Request

GET http://localhost:8383/address-api-v1/au/address/GANSW717116102

Path template: /address-api-v1/au/address/{id}. URL-encode id if it contains reserved characters.

Path parameters

Parameter	Type	Description
`id`	string	Address detail PID (e.g. `GANSW717116102` from suggest results).

Response (200 OK)

JSON object with snake_case properties. Empty strings are used when a field does not apply.

{
  "id": "GANSW717116102",
  "date_created": "2018-05-16T14:22:11Z",
  "address_label": "55 KAY ST PYRMONT NSW 2009",
  "address_site_name": "55 KAY ST",
  "building_name": "",
  "flat_type": "",
  "flat_number": "",
  "level_type": "",
  "level_number": "",
  "number_first": "55",
  "number_last": "",
  "lot_number": "",
  "street_name": "KAY",
  "street_type": "ST",
  "street_suffix": "",
  "locality_name": "PYRMONT",
  "state": "NSW",
  "postcode": "2009",
  "legal_parcel_id": "",
  "mb_code": "",
  "alias_principal": "",
  "principal_pid": "",
  "primary_secondary": "",
  "primary_pid": "",
  "geocode_type": "PROPERTY CENTROID",
  "longitude": 151.1952063,
  "latitude": -33.8694127
}

Response properties

Property	Type	Description
`id`	string	Address detail PID.
`date_created`	string (ISO 8601)	Record timestamp (UTC).
`address_label`	string	Full formatted address line.
`address_site_name`	string	Site-level address line.
`building_name`	string	Building name, if any.
`flat_type`, `flat_number`	string	Flat / unit type and number.
`level_type`, `level_number`	string	Level / floor type and number.
`number_first`, `number_last`	string	Street number (range).
`lot_number`	string	Lot number.
`street_name`, `street_type`, `street_suffix`	string	Street components.
`locality_name`	string	Suburb / locality.
`state`	string	State or territory code.
`postcode`	string	Postcode.
`legal_parcel_id`	string	Legal parcel identifier (GNAF).
`mb_code`	string	Mesh block code.
`alias_principal`, `principal_pid`	string	Principal / alias linkage (GNAF).
`primary_secondary`, `primary_pid`	string	Primary address relationship (GNAF).
`geocode_type`	string	Geocode reliability / type label.
`longitude`, `latitude`	number	Coordinates (WGS84).

Errors

401 Unauthorized — Missing or invalid API key.
403 Forbidden — API key is not entitled to Address Select.
404 Not Found — No address exists for the given id.

Example

curl -sS -X GET "http://localhost:8383/address-api-v1/au/address/GANSW717116102" \
  -H "x-auth-key: YOUR_API_KEY"