---
title: "Match addresses from input"
method: POST
path: "/address-similarity"
tags: ["address-similarity"]
---

# Match addresses from input

`POST /address-similarity`

## Request

- Base URL: `https://api.rosette.com/rest/v1`
- URL: `https://api.rosette.com/rest/v1/address-similarity`
- Auth: API key in header `X-RosetteAPI-Key`

Returns the confidence score of matching 2 addresses. You can specify the fields of the addresses to be matched or provide the address as a string.

## Request body

- AddressSimilarityRequest
  - `address1` union
    - AddressFielded
      - `city` string: the city, town, village, etc.
      - `cityDistrict` string: a borough or district within a city,
      - `country` string: a sovereign nation or its dependent territory,
      - `countryRegion` string: informal subdivision of a country,
      - `entrance` string: numbered/lettered entrance,
      - `house` string: venue or building name,
      - `houseNumber` string: external building number,
      - `island` string: a named island,
      - `level` string: expression indicating a floor number,
      - `poBox` string: post office box,
      - `postCode` string: postal code,
      - `road` string: street name,
      - `staircase` string: numbered/lettered staircase,
      - `state` string: a first-level administrative division,
      - `stateDistrict` string: a second-level administrative division or county,
      - `suburb` string: unofficial neighborhood name,
      - `unit` string: a secondary unit designator,
      - `worldRegion` string: West Indies, if appropriate,
    - AddressString
      - `address` string: an address string
  - `address2` union
    - AddressFielded
      - `city` string: the city, town, village, etc.
      - `cityDistrict` string: a borough or district within a city,
      - `country` string: a sovereign nation or its dependent territory,
      - `countryRegion` string: informal subdivision of a country,
      - `entrance` string: numbered/lettered entrance,
      - `house` string: venue or building name,
      - `houseNumber` string: external building number,
      - `island` string: a named island,
      - `level` string: expression indicating a floor number,
      - `poBox` string: post office box,
      - `postCode` string: postal code,
      - `road` string: street name,
      - `staircase` string: numbered/lettered staircase,
      - `state` string: a first-level administrative division,
      - `stateDistrict` string: a second-level administrative division or county,
      - `suburb` string: unofficial neighborhood name,
      - `unit` string: a secondary unit designator,
      - `worldRegion` string: West Indies, if appropriate,
    - AddressString
      - `address` string: an address string

## Response `200`

OK

- AddressSimilarityResponse
  - `score` number: Similarity score of two addresses

---

[API](https://skmtc.dev/babelstreet/apis/rosette-text-analytics.md) · [All operations](https://skmtc.dev/babelstreet/apis/rosette-text-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/babelstreet/apis/rosette-text-analytics/revisions/7c1d1497a5dd?raw)