This provides access to the Royal Mail's Postcode Address File (PAF) as well as Postzon
geographic data.
| Method |
Description |
SOAP,
.NET |
XML, CSV,
DS, RST |
| Browse |
Lists the postcode area names and the regions they cover. |
Yes |
Yes |
| ByArea |
Lists the individual localities covered by a postcode area. |
Yes |
Yes |
| ByBuilding |
Lists the properties in the given town matching the given building name or number. |
Yes |
Yes |
| ByFreeText |
Lists the properties matching the given free text string. Performs a compound search based on the free text string. |
Yes |
Yes |
| ByLocalityKey |
Lists the streets in a given locality. |
Yes |
Yes |
| ByOrganisation |
Lists the organisations matching the given name and town. |
Yes |
Yes |
| ByOutcode |
Lists the localities served by a given postcode outcode (first part of the postcode). |
Yes |
Yes |
| ByCoordinates |
Lists the properties within the area defined by a pair of easting and northing coordinates. |
Yes |
Yes |
| ByPostcode |
Lists the properties in a given postcode. |
Yes |
Yes |
| ByPostcodeFiltered |
Lists the properties in a given postcode that match the given building name or number. |
Yes |
Yes |
| ByStreet |
Lists the streets matching the given street and town name. |
Yes |
Yes |
| ByStreetFiltered |
Lists the properties in the given street and town that match the given building name or number. |
Yes |
Yes |
| ByStreetKey |
Lists the properties in the given street. |
Yes |
Yes |
| ByPoBox |
Lists the addresses with the corresponding PO Box. |
Yes |
Yes |
| Cleanse |
Performs a compound search given an address of likely candidate addresses. Find addresses, postcodes and corrects errors in addresses. |
Yes |
Yes |
| BatchCleanse |
Cleans the batch of addresses against the database. Finds missing postcodes, corrects errors and typing mistakes. |
Yes |
Yes |
| FastAddress |
Queries the database, returning an address matching the Postcode and Building. |
Yes |
Yes |
| FetchAddress |
Queries the database, returning an address matching the Id. |
Yes |
Yes |
| BatchFetch |
Queries the database, returning a list of addresses matching the list of IDs. |
Yes |
Yes |
| Changes |
Examines all addresses returned for the account between the given dates which have changed. |
Yes |
Yes |
| ByLocation |
Lists localities covered by the input string. Used to get coordinates for a location. |
Yes |
Yes |
| Location |
Gets the coordinates for the given location. |
Yes |
Yes |
| Nearest |
Given a list of destination postcodes and an origin postcode, returns a list of destinations in ascending order of distance from origin. |
Yes |
Yes |
| NearestRadial |
Given a list of destination postcodes and an origin postcode, returns a list of destinations in ascending order of distance from origin. |
Yes |
Yes |
| StoredNearest |
Given an origin postcode, returns a list of previously uploaded destinations in ascending order of distance from origin. |
Yes |
Yes |
| StoredNearestRadial |
Given an origin postcode, returns a list of previously uploaded destinations in ascending order of distance from origin. |
Yes |
Yes |
| NearestPostcode |
Calculates the nearest postcode to a set of coordinates. |
Yes |
Yes |
| StatisticsByPostcode |
Calculates the number of delivery points within a postcode. |
Yes |
Yes |
| StatisticsBySector |
Calculates the number of delivery points within a postcode. |
Yes |
Yes |
| StatisticsByOutcode |
Calculates the number of delivery points within an outcode. |
Yes |
Yes |
| StatisticsByStreetKey |
Calculates the number of delivery points within a street. |
Yes |
Yes |
| NearestOutcodes |
Calculates the nearest outcodes (first part of the postcode) to a set of coordinates. |
Yes |
Yes |
| NearestSectors |
Calculates the nearest sectors (first part of the postcode and first character of the second part of the postcode e.g. WR2 6) to a set of coordinates. |
Yes |
Yes |
| NearestSectors |
Calculates the nearest sectors (first part of the postcode and first character of the second part of the postcode e.g. WR2 6) to a set of coordinates. |
Yes |
Yes |
| GeocodePostcode |
Get the coordinates of a postcode. |
Yes |
Yes |
| GeocodeAddressId |
Get the coordinates of a property found using one of the lookup services (e.g. ByPostcode). |
Yes |
Yes |
| GeocodeAddress |
Get the coordinates of an address. |
Yes |
Yes |
| Distance |
Calculates the distance between 2 places. |
Yes |
Yes |
| BatchDistance |
Calculates a batch of distances between places. |
Yes |
Yes |
| SOA |
Queries the database, returning super output area information for a postcode. |
No |
Yes |
| BatchPostcodeChanges |
Takes a list of postcodes and returns those which have changed, the new postcode and the date the change occurred. |
Yes |
Yes |
| ConvertCoordinates |
Converts coordinates between different systems (easting + northing, lat + long, OS reference). |
No |
Yes |