Check out our High Performance Batch Processing API: Match and Enrich Data Using CSV/TSV Files as Input Data to our APIs Learn More

Address Match Similarity Key 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 'ai-medium-narrow' or 'ai-medium-wide' to suit your specific use case. A 'narrow' algorithm considers the unit designator (suite, apt, etc.) when generating similarity keys to match with, whereas a 'wide' algorithm does not.

Advanced Techniques

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

How It Works

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

Addresses generating the same similarity key are considered "similar". 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.

API Details

Endpoint

https://api.interzoid.com/getaddressmatchadvanced

Request Format

https://api.interzoid.com/getaddressmatchadvanced?license=[apikey]&address=[street address]&algorithm=[ai-medium-wide or ai-medium-narrow]

Sample Request

https://api.interzoid.com/getaddressmatchadvanced?license=fh5hs7*****&address=400 East Broadway St&algorithm=ai-medium-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=ai-medium-narrow"

Algorithm & AI Model Options

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.

ai-plus-narrow

AI-enhanced matching considering unit designators. Second-best in performance and accuracy.

ai-plus-wide

AI-enhanced matching on street address only. Second-best in performance and accuracy.

ai-medium-narrow

Best accuracy, considering unit designators. Recommended algorithm, but API response can take a little bit longer.

Recommended
ai-medium-wide

Best accuracy, matching on street address only. API can take a little longer but provides high-quality results.

Code Examples

Examples in Nine Programming Languages

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

Additional Resources

Address Match Reports

Generate match reports for entire datasets using our Full Dataset API:

Learn More
Web Matching Wizard

No coding necessary - try our Cloud Data Connect Web matching wizard to see this API in action with entire datasets using an intuitive browser interface.

Launch Wizard
Optional 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.

It is a blueprint for developers and enables integration by defining request and response schemas, authentication methods, and available operations.

YAML JSON
Video Description

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

YouTube
Excel Integration

Try our Microsoft Excel integration for matching and cleansing data directly within a spreadsheet. It's as easy as calling a pre-integrated Excel function for street addresses in worksheet cells.

Explore Excel Integration
Service Bureau - Our Super-powered Data Matching Task Force

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

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

555A OH road
555-A Ohio Road

100 first street
100 1st street