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

Get Location

The Get Location API resolves a Location suggestion 'Id' to the place and its centre.

Request

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

Resolving the suggestion for 'DARWIN CITY NT 0800'.

Request

GET https://api.getaddress.io/get-location/darwin-city-nt-0800?api-key={your-api-key}

Response

{
    "id": "darwin-city-nt-0800",
    "location": "DARWIN CITY NT 0800",
    "locality_name": "DARWIN CITY",
    "state": "NT",
    "postcode": "0800",
    "coordinates": {
        "latitude": -12.460733,
        "longitude": 130.841415
    }
}

Response Fields

Field Description
id The place's location id. Built from its suburb, state and postcode, so it is the same in every G-NAF release.
location The label, the same text the suggestion showed.
locality_name The suburb, as G-NAF names it.
state The state or territory abbreviation: NSW, VIC, QLD, SA, WA, TAS, NT, ACT, or OT for the other territories.
postcode The 4-digit Australian postcode.
coordinates The centre of the place (GDA2020): the mean position of its addresses. For a crescent-shaped suburb it can fall just outside the suburb's boundary.

Usage

  • Each successful Get Location request counts as 1 look-up against your plan's daily allowance.
  • An unknown id returns 404 and costs nothing.

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