Address Matching API

Generate similarity keys for address matching and data quality management

API Overview

This API generates hashed similarity keys from input address data, enabling efficient matching and sorting of address information across datasets.

Similarity Keys

Generates similarity keys for matching of street addresses, avoiding issues with data inconsistency and human-entered address format standards and variations.

Flexible Algorithms

Choose matching algorithms such as 'model-v3-narrow' or 'model-v3-wide' to suit your specific use case. A 'narrow' algorithm considers the unit designator (suite, apt, etc.) when generating similarity keys.

Advanced Techniques

Utilizes artificial intelligence, machine learning, heuristics, phonetics, knowledge bases, and specialized algorithms for accurate matching.

How It Works

Addresses generating the same similarity key are considered "similar".

Address Input Similarity Key
500 E Main St. Vy77jRfV0SR11wdJwDO0Cvzh4xCg
500 east main VY77RfV0SR11wdJwDO0Cvzh4xCg
745 broadway avenue nw, #201 pdsjjImDHMQUX6EMlBHD9H17SAoTamH6zCBjFm1
745 BROADWAY AVE NORTH WEST APT 201 pdsjjImDHMQUX6EMlBHD9H17SAoTamH6zCBjFm1
745 Broad Way N.W. Unit 201 pdsjjImDHMQUX6EMlBHD9H17SAoTamH6zCBjFm1

These keys can be used for sorting and identifying redundant addresses in a single table or file, matching based on address across datasets, or as a fuzzy search mechanism.

Best practice: This API is designed to match on street address data, not city/state/zip information. We recommend generating a similarity key from the street address, and then appending the address's zip code to create a "combination similarity key" for best results. Contact us at support@interzoid.com for more details.

API Details

Endpoint
https://api.interzoid.com/getaddressmatchadvanced
Request Format
https://api.interzoid.com/getaddressmatchadvanced?license=[apikey]&address=[street address]&algorithm=[model-v3-wide or model-v3-narrow]
Sample Request
https://api.interzoid.com/getaddressmatchadvanced?license=fh5hs7*****&address=400 East Broadway St&algorithm=model-v3-narrow
Sample Response
{"SimKey":"d477E1d7sG6dja3hDNsk9P","Code":"Success","Credits":5794029}
cURL Example (with API key in header)
curl --header "x-api-key: fh5hs7*****" "https://api.interzoid.com/getaddressmatchadvanced?address=400%20East%20Broadway&algorithm=model-v3-narrow"

Algorithm & AI Model Options

Choose the algorithm that best fits your address matching requirements.

narrow

Matches considering unit designators (suite, apt, etc.). Very fast but less accurate than AI options.

wide

Matches on street address only, ignoring unit designators. Very fast but less accurate than AI options.

model-v3-narrow

Our latest model - best accuracy and considers unit designators (APT, Suite, etc.)

Recommended
model-v3-wide

Our latest model, matching on street address only.

Only one algorithm can be used as a parameter to the API at a time. Different algorithms will yield different matching results and similarity keys. Matching can occur with values whose similarity keys have been generated with the same algorithm.

Additional Resources

Code Examples

See quick and easy code examples in nine different popular languages, including Python, Node.js, Java, Typescript, Go, Rust, C#, R, and Scala.

See All Code Examples
Try This API Interactively

Our API interactive usage tool enables you to try this API interactively with a user interface and without writing code. The tool is available for all of our APIs.

Try it Now
Cloud Batch Processing

Our No-Code batch tool enables you to quickly use this API within our parallel-processing Cloud platform, processing text files (CSV/TSV) with a few clicks and without writing code.

Start Now
OpenAPI Specification

An OpenAPI Specification (OAS) is a standardized format for describing the structure, endpoints, and functionality of a RESTful API in a machine-readable format.

YAML JSON
Video Description

Watch a short video describing similarity keys and how they work.

YouTube
Service Bureau

Want us to do it for you? We can take your data and use our products on your behalf with a quick turnaround.

Contact Support

Sample Address Matches

Examples showing how different address variations are matched using similarity keys.

1000 Fourth Street E
1000 4th St. East

99 Los Angeles Street
99 L.A. Street

455 E Main St
455 East Main
455 Main Street

7000 Cleveland Road
7000 Cleaveland Rd

9000 e calif road
9000 east calif road

1777 st louis rd
1777 saint louis road
1777 saint louis raod

500 Browne lane suite #100
500 Browne ln suite 100
500 brown lane ste 100

9 Johnson Road
Nine Johnston rd

100 first street
100 1st street

Each group represents address variations that generate identical similarity keys, meaning they are considered matches despite spelling differences, abbreviations, or formatting variations.