Loading...
Sign in to see the examples with your own API key.

Get

The Get API resolves an Autocomplete suggestion 'Id' to the full address.

Request

GET https://api.getaddress.io/get/{id}?api-key={your-api-key}

The API key goes in the api-key query parameter; a header is not accepted.

Example

Resolving the suggestion for 'SYDNEY OPERA HOUSE 2 CIRCULAR QUAY EAST, SYDNEY NSW 2000'.

Request

GET https://api.getaddress.io/get/GANSW718642855?api-key={your-api-key}

Response

The response is the G-NAF record itself: the field names are G-NAF's, and nothing is derived, aliased or composed on the way out. Every string field is present on every address, and is empty when that address has no value for it. The one addition is address_status, which tells you whether G-NAF still publishes the address. 

{
    "address_label": "SYDNEY OPERA HOUSE 2 CIRCULAR QUAY EAST, SYDNEY NSW 2000",
    "address_detail_pid": "GANSW718642855",
    "address_site_name": "SYDNEY OPERA HOUSE",
    "address_status": "current",
    "alias_principal": "PRINCIPAL",
    "building_name": "SYDNEY OPERA HOUSE",
    "cleaning_provenance": {},
    "date_created": "2015-10-23",
    "flat_number": "",
    "flat_type": "",
    "geocode_type": "PROPERTY CENTROID",
    "legal_parcel_id": "4/787933",
    "level_number": "",
    "level_type": "",
    "locality_name": "SYDNEY",
    "lot_number": "",
    "mb_code": "10741860000",
    "number_first": "2",
    "number_last": "",
    "postcode": "2000",
    "primary_pid": "",
    "primary_secondary": "PRIMARY",
    "principal_pid": "",
    "state": "NSW",
    "street_name": "CIRCULAR QUAY EAST",
    "street_suffix": "",
    "street_type": "",
    "coordinates": {
        "latitude": -33.8587646484375,
        "longitude": 151.21322631835938
    }
}

Response Fields

Field Description
address_label The one-line display label, the same text the suggestion showed.
address_detail_pid G-NAF's own identifier for this address detail record.
address_site_name The name of the site the address sits on, when it has one.
address_status "current" when G-NAF still publishes this address, "retired" when it has been withdrawn since. A retired address still resolves — an id you stored months ago keeps working — but it will never be suggested again.
alias_principal Whether the record is G-NAF's principal address ("PRINCIPAL") or an alias of one ("ALIAS").
building_name The name of the building, when it has one.
cleaning_provenance An object noting the values cleaned when G-NAF was loaded, keyed by field. {} when nothing was, which is almost every record. A record the widget builds from the Google Places fallback has {"Source": "GOOGLE"} here instead.
date_created The date G-NAF created the address, as an ISO 8601 date with no time (yyyy-MM-dd), e.g. "2015-10-23".
flat_type / flat_number The flat or unit, e.g. "UNIT" and "2". Empty when the address has none.
geocode_type What the geocode points at, e.g. "PROPERTY CENTROID".
legal_parcel_id The land title / legal parcel identifier.
level_type / level_number The level within the building. Usually empty.
locality_name The G-NAF locality, e.g. "SYDNEY".
lot_number The lot number, for addresses identified by lot rather than street number.
mb_code The ABS mesh block code the address falls in.
number_first / number_last The street number, and the last of a range. number_last is empty for a single number.
postcode The 4-digit Australian postcode.
primary_secondary / primary_pid Whether the address is a primary ("PRIMARY") or a secondary ("SECONDARY") one, and the primary it belongs to.
principal_pid The principal address this one aliases, when it is an alias.
state The state or territory abbreviation: NSW, VIC, QLD, SA, WA, TAS, NT or ACT.
street_name / street_type / street_suffix The street name ("PITT"), its type ("STREET") and its suffix ("EAST", usually empty).
coordinates The geocode of the address (GDA2020), as latitude and longitude. Null when the address carries no coordinates.

Usage

  • Each successful Get request counts as 1 look-up against your plan's daily allowance.

Rate Limiting

Your subscription's plan will limit the number of requests per 5 minute span. Exceeding your plan's rate limit will return a HTTP 429 response.
The Retry-After HTTP header contains the number of seconds until a successful retry can be made.

Top