Match addresses

Address Similarity compares two addresses and returns a match score between 0 and 1 reflecting the similarity of the addresses. Addresses are defined as a set of address fields. The endpoint compares the fields in address1 to the fields in address2, matching each specified field and uses these values to calculate the match score. Addresses being matched do not have to contain all the same fields.

The matching algorithm is optimized based on the field type. Named entity fields, such as street address, city, and state are matched using a linguistic, statistically-based system that handles address variations. Numeric and alphanumeric fields, such as house number, postal code, and unit, are matched using numeric-based methods.

Advanced field matching support includes cross-field matching, for example, matching the value in the city field to the value in the state field, and field overrides, for example, matching England and UK.

Headers

X-RosetteAPI-KeystringRequired

Request

This endpoint expects an object.
address1map from strings to any or stringOptional
address2map from strings to any or stringOptional
parameterslist of objectsOptional
Parameter name and value to change score calculation.

Response

OK
scoredouble or null
Similarity score of two addresses