Technical specification
Last updated
Was this helpful?
Last updated
Was this helpful?
This technical specification explains the content of the OS Match & Cleanse API, and the methods that you can use to call it.
This specification does not cover core concepts that apply to all Ordnance Survey APIs.
Please read the following pages to learn more about OS API core concepts:
The OS Match & Cleanse API is only available on a Premium Plan.
OS Match & Cleanse API has one type of request:
Match for granular matching and cleansing of existing address records.
Free text search parameter.
The format the response will be returned in. Default: JSON.
The maximum number of results to return. Default: 100.
Offset the list of returned results by this amount.
The dataset to return. Multiple values can be sent, separated by a comma. Default: DPA.
Which language of addresses to return. Default: EN, CY.
The minimum match score a result has to have to be returned.
The decimal point position at which the match score value is to be truncated.
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
["CLASSIFICATION_CODE:CI CLASSIFICATION_CODE:RD","LOGICAL_STATUS_CODE:6","LPI_LOGICAL_STATUS_CODE:3","COUNTRY_CODE:EN"]