Returns matched addresses within a geoJSON polygon or multi-polygon object.
post
Authorizations
Query parameters
referencepointintegeroptional
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 · min: 1 · max: 100optional
The maximum number of results to return. Default: 100.
Default: 100
offsetintegeroptional
Offset the list of returned results by this amount.
Default: 0
datasetstring · enumoptional
The dataset to return. Multiple values can be sent, separated by a comma. Default: DPA.
Default: DPAAvailable options:
lrstring · enumoptional
Which language of addresses to return. Default: EN, CY.
Available options:
output_srsstring · enumoptional
The intended output spatial reference system. Default: EPSG:27700
Default: EPSG:27700Available options:
srsstring · enumoptional
The spatial reference system for the input coordinate set.
Available options:
fqstring[]optional
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