Nothing Found
    Nothing Found
Locations API
Version 2.3.0

getPointsByGeoCoordinates

This endpoint returns a list of all Australia Post points within a given range of the coordinates provided. Results are ordered by the distance field, from closest to farthest away. You can filter your results using the various parameters shown below.

SecurityAUTH-KEY
Request
path Parameters
longitude
required
number

A coordinate representing the angular distance in degrees, minutes and seconds, of a point east or west of the Greenwich Meridian, expressed as a double.

latitude
required
number

A coordinate representing the angular distance in degrees, minutes and seconds, of a point north or south of the equator, expressed as a double.

query Parameters
pc
string

A partner code identifies an entity that owns location data. Currently we offer access only to Australia Post outlet and services data. In the future we may expand this to include location data from partner providers. Note: If this field is left empty, the default value is "AP". Submitting any other value will return an empty data set.

usage_types
string

The usage_types parameter is an optional comma-separated string used to filter locations by its usage type. The filter works as an OR condition, meaning locations matching any of the specified values will be returned. If omitted, all locations will be returned.

Example: usage_types=1,2
radius
integer [ 0 .. 1000 ]

The radius in kilometres, to search around the provided latitude/longitude coordinate point. The default value is 50, and the hard limit is 1000Km.

services
string

A comma-delimited string of service codes by which to filter the returned list of matching locations. **Note: ** A list of current services is available through the getServices endpoint.

limit
integer [ 0 .. 10000 ]

The maximum number of results to return. The default value is 5.

types
string

The types parameter is an optional string of comma-delimited values denoting which outlets and facilities you want to locate. There are six of these enumerated values, all of which are selected by default:

  • UPL: Parcel lockers.
  • R_SPB: A red street post box.
  • C_SPB: Combined street post boxes (Both red and yellow boxes together).
  • PO: An Australia Post outlet.
  • OS: Outstation (These are a part of a post office not in the same physical building. For example, a separate building dedicated to PO boxes.)
  • DC: A delivery centre.
Enum: "PO" "UPL" "R_SPB" "C_SPB" "OS" "DC"
Responses
200

OK

get/points/geo/{longitude}/{latitude}
Request samples 
Response samples 
application/json
{
  • "points": [
    ]
}