Sidebar

Mobile navigation sidebar

Developer console

Address By Geo Location — Australia

Returns addresses within a radius of a point, sorted by distance (nearest first). Use for reverse geocoding, nearby-address lookup, or map-based applications. Requires Meilisearch with geosearch enabled.

Request

GET http://localhost:8383/address-api-v1/au/address/by-geo-location?lat=-33.8688&lng=151.2093&radius=2000&limit=10

Query parameters

Parameter Type Description
lat number Latitude of the centre point (required).
lng number Longitude of the centre point (required).
radius integer Search radius in meters. Default 5000, min 1, max 100000.
limit integer Max results. Default 10, max 30.

Try it

Enter coordinates or use your current location to find nearby addresses. See the API response in real time.

Loading…

Response (200 OK)

{
  "count": 3,
  "items": [
    {
      "id": "GANSW717116102",
      "address_line_1": "55 KAY ST PYRMONT NSW 2009",
      "locality": "PYRMONT",
      "state": "NSW",
      "postcode": "2009"
    }
  ]
}

Response properties

Property Description
countNumber of items returned.
itemsArray of addresses, sorted by distance (nearest first).
items[].idAddress detail PID. Use with Address Lookup for full details.
items[].address_line_1Formatted address line.
items[].localitySuburb or locality name.
items[].stateState code (e.g. NSW, VIC).
items[].postcodePostcode.

Example

curl -X GET "http://localhost:8383/address-api-v1/au/address/by-geo-location?lat=-33.8688&lng=151.2093&radius=2000&limit=5" -H "x-auth-key: YOUR_API_KEY"