[ Whereis® API Home ] [ JSON API Home ]

Service name

Service Type

Description

Autosuggest

Utilities

Returns suggested location names and IDs, based on a search term expressed as a fragment of text

Get details by postcode

Get Detail

Returns details about one or more locations, based on postcode

Get details by region

Get Detail

Returns details about one or more locations, based on region

Get details by state

Get Detail

Returns details about one or more locations, based on state

Get details by suburb

Get Detail

Returns details about one or more locations, based on suburb

Get details by ID

Get Detail

Returns details about a location, based on its ID

Structured geocode

Geocoding

Returns details, including ID, for each of one or more locations, based on submission of a structured address object

Unstructured geocode

Geocoding

Returns details, including ID, for each of one or more locations, based on submission of unstructured address string

Map

Map

Returns map as a binary stream, via a URL, or as base 64 data, based on the bounds implied by <mapData> submitted for inclusion

Map by bounds

Map

Returns map based on bounds

Map by zoom

Map

Returns map based on centre point and zoom

Map by radius

Map

Returns map based on centre point and radius

Rank

Route

Ranks points by distance from a centre point

Reverse geocode

Geocoding

Returns a list of addresses based on their proximity to a specified longitude and latitude

Route

Route

Returns a route based on startpoint, endpoint, optionally passing through waypoints and/or avoiding avoidpoints

Route handle

Route

Five additional services using HTTP GET to return information based on an id retrieved from a previous route request

WaypointsRouteOptimise the order of route stops to get the shortest or fastest route
Alternate routesRouteReturn a list of alternatives for a given route
Points of interestPOIsGet a list of points of interest for a given area

Service description

Utilities

Returns metadata in relation to our map offering, via HTTP GET

Viewport by boundsMap

Returns the viewport that corresponds to an equivalent Map by bounds request

Viewport by zoom

Map

Returns the viewport that corresponds to an equivalent Map by centre request

Viewport by geometry

Map

Returns the viewport that corresponds to an equivalent Map request

Viewport by radius

Map

Returns the viewport that corresponds to an equivalent Map by radius request