Returns matched addresses based on a free text search.
get
/find
Authorizations
Query parameters
querystringrequired
Free text search parameter.
formatenum
The format the response will be returned in. Default: JSON.
Options: JSON, XML
maxresultsinteger
The maximum number of results to return. Default: 100.
offsetinteger
Offset the list of returned results by this amount.
datasetenum
The dataset to return. Multiple values can be sent, separated by a comma. Default: DPA.
Options: DPA, LPI
bboxstring
Limits results to only those contained within the supplied British National Grid bounding box. The bounding box must be specified with four comma-separated numbers, indicating the lower-left and upper-right coordinates in the format bbox=left,bottom,right,top. The bounding box must be entirely within the British National Grid.
lrenum
Which language of addresses to return. Default: EN, CY.
Options: EN, CY
minmatchnumber
The minimum match score a result has to have to be returned.
matchprecisionnumber
The decimal point position at which the match score value is to be truncated.
output_srsenum
The intended output spatial reference system. Default: EPSG:27700
Filter for classification code, logical status code, LPI logical status code and/or country code. Filtering for classification code will accept wildcard ( * ) searches. Multiple searches can be done by separating the codes with a space. Multiple filters can be used together by including the parameter multiple times
Filter for classification code, logical status code, LPI logical status code and/or country code. Filtering for classification code will accept wildcard ( * ) searches. Multiple searches can be done by separating the codes with a space. Multiple filters can be used together by including the parameter multiple times
Filter for classification code, logical status code, LPI logical status code and/or country code. Filtering for classification code will accept wildcard ( * ) searches. Multiple searches can be done by separating the codes with a space. Multiple filters can be used together by including the parameter multiple times
Returns closest addresses to a pair of coordinates (X and Y).
get
/nearest
Authorizations
Query parameters
pointstringrequired
One comma-separated coordinate set that specifies the coordinate to which the nearest record in a straight line should be found. The maximum distance the search will try is 1,000 metres. The precision of the coordinates is to two decimal places (that is, 1 cm accuracy).
radiusnumber
The radius in metres to search within. The precision of the distance is to two decimal places (that is, 1 cm accuracy). Minimum = 0.01, Maximum = 1,000 . Default = 100
formatenum
The format the response will be returned in. Default: JSON.
Options: JSON, XML
datasetenum
The dataset to return. Multiple values can be sent, separated by a comma. Default: DPA.
Options: DPA, LPI
lrenum
Which language of addresses to return. Default: EN, CY.
Options: EN, CY
output_srsenum
The intended output spatial reference system. Default: EPSG:27700
Filter for classification code, logical status code, LPI logical status code and/or country code. Filtering for classification code will accept wildcard ( * ) searches. Multiple searches can be done by separating the codes with a space. Multiple filters can be used together by including the parameter multiple times
A pair of comma-separated coordinates with an accuracy of two decimal places or less, that specify the lower left and upper right coordinates of the bounding box. The maximum size of the bounding box is 1 km2. If the bounding box exceeds this, an error message is returned. The precision of the coordinates is to an accuracy of 8 metres.
formatenum
The format the response will be returned in. Default: JSON.
Options: JSON, XML
maxresultsinteger
The maximum number of results to return. Default: 100.
offsetinteger
Offset the list of returned results by this amount.
datasetenum
The dataset to return. Multiple values can be sent, separated by a comma. Default: DPA.
Options: DPA, LPI
lrenum
Which language of addresses to return. Default: EN, CY.
Options: EN, CY
output_srsenum
The intended output spatial reference system. Default: EPSG:27700
Filter for classification code, logical status code, LPI logical status code and/or country code. Filtering for classification code will accept wildcard ( * ) searches. Multiple searches can be done by separating the codes with a space. Multiple filters can be used together by including the parameter multiple times
Takes a pair of coordinates as the centre for a circle and returns all addresses that are intersected by it.
get
/radius
Authorizations
Query parameters
pointstringrequired
One comma-separated coordinate set that specifies the coordinate to which the nearest record in a straight line should be found. The maximum distance the search will try is 1,000 metres. The precision of the coordinates is to two decimal places (that is, 1 cm accuracy).
radiusnumber
The radius in metres to search within. The precision of the distance is to two decimal places (that is, 1 cm accuracy). Minimum = 0.01, Maximum = 1,000 . Default = 100
formatenum
The format the response will be returned in. Default: JSON.
Options: JSON, XML
maxresultsinteger
The maximum number of results to return. Default: 100.
offsetinteger
Offset the list of returned results by this amount.
datasetenum
The dataset to return. Multiple values can be sent, separated by a comma. Default: DPA.
Options: DPA, LPI
lrenum
Which language of addresses to return. Default: EN, CY.
Options: EN, CY
output_srsenum
The intended output spatial reference system. Default: EPSG:27700
Filter for classification code, logical status code, LPI logical status code and/or country code. Filtering for classification code will accept wildcard ( * ) searches. Multiple searches can be done by separating the codes with a space. Multiple filters can be used together by including the parameter multiple times
Returns matched addresses within a geoJSON polygon or multi-polygon object.
post
/polygon
Authorizations
Query parameters
referencepointinteger
Reference point geometry is the basis from which the distance value is calculated. Output is ordered by ascending distance from given reference point only if parameter has been specified.
maxresultsinteger
The maximum number of results to return. Default: 100.
offsetinteger
Offset the list of returned results by this amount.
datasetenum
The dataset to return. Multiple values can be sent, separated by a comma. Default: DPA.
Options: DPA, LPI
lrenum
Which language of addresses to return. Default: EN, CY.
Options: EN, CY
output_srsenum
The intended output spatial reference system. Default: EPSG:27700
Filter for classification code, logical status code, LPI logical status code and/or country code. Filtering for classification code will accept wildcard ( * ) searches. Multiple searches can be done by separating the codes with a space. Multiple filters can be used together by including the parameter multiple times