Return near postcodes from a postcode or lat/lng combination.
Note: This is the documentation for the v2 API which is still in beta.
Given a postcode or lat/lng combination and your own list of postcodes returns the postcodes ordered from near to far.
targetPostalCodes(array): An array of 4PPs(e.g: [1000, 1011, 1012])
postalCode(string): The 4PP(e.g: 1000), if both postalCode and lat/lng combination is given the lat/lng from the postalCode will be used.
latitude(number): The latitude
longitude(number): The longitude
searchRange(integer): The range to search, in meters. Maximum 100000.
orderBy(string): The order in which to return the results: distance (default) **input (keeps the input ordering) **postalcode (order by the postalcode) ** not yet supported
maxResults(integer): The amount of results returned, a number between 0 and 999.
authKey: This is the Authorization key. You have to add it as a GET parameter.
Your auth key can be found on the CMS.
Available API calls