# Address Quality & Matching API (`tryva/address-quality-matching-api`) Actor

Normalize, assess and match international addresses. Turn messy address text into structured fields and SAME\_ADDRESS / POSSIBLE\_MATCH / DIFFERENT duplicate decisions.

- **URL**: https://apify.com/tryva/address-quality-matching-api.md
- **Developed by:** [smile flow](https://apify.com/tryva) (community)
- **Categories:**
- **Stats:** 2 total users, 1 monthly users, 50.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-usage

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Address Quality & Matching API

Normalize messy international addresses, assess structural quality, and detect duplicates.

One messy address in. One structured quality report out.

For two addresses, the Actor returns a deterministic `SAME_ADDRESS`, `POSSIBLE_MATCH`, or `DIFFERENT` decision with component-level evidence.

### What it returns

#### Analyze & normalize

- normalized address and stable component fields
- house number, road, unit, city, state, postcode, country
- completeness score and missing components
- warnings and `CLEAN`, `REVIEW`, or `INCOMPLETE` quality status

#### Match & deduplicate

- `SAME_ADDRESS`, `POSSIBLE_MATCH`, or `DIFFERENT`
- confidence score
- component-level similarity scores
- matching evidence
- detected differences
- both normalized address forms

The result describes structure and similarity only. It does not prove deliverability, that an address exists, or identity ownership.

### Example: analyze

#### Input

```json
{
  "operation": "analyze",
  "addresses": ["92 avenue des Champs-Élysées Paris 75008 France"]
}
```

#### Output

```json
{
  "operation": "analyze",
  "input": "92 avenue des Champs-Élysées Paris 75008 France",
  "normalized_address": "92, avenue des Champs-Élysées, 75008, Paris, France",
  "components": {
    "house_number": "92",
    "road": "avenue des Champs-Élysées",
    "city": "Paris",
    "postcode": "75008",
    "country": "France"
  },
  "quality": {
    "status": "CLEAN",
    "completeness": 1.0,
    "missing_components": [],
    "warnings": []
  },
  "warnings": []
}
```

### Example: match & deduplicate

#### Input

```json
{
  "operation": "match",
  "pairs": [
    {
      "addressA": "92 avenue des Champs-Élysées Paris",
      "addressB": "92 Av. des Champs Elysees, 75008 Paris, France"
    }
  ]
}
```

#### Output

```json
{
  "decision": "SAME_ADDRESS",
  "confidence": 0.93,
  "evidence": [
    "house_number_match",
    "road_match",
    "city_match"
  ],
  "differences": [
    "postcode_missing_on_one_or_both"
  ]
}
```

### Use cases

- CRM address cleanup
- customer database deduplication
- e-commerce and checkout data cleaning
- marketplace record matching
- logistics data preparation
- ETL and data-quality pipelines
- master data management
- lead database cleanup
- duplicate customer detection

### How it works

This Actor uses local libpostal parsing plus deterministic normalization and matching logic.

It does not call an external postal-verification or geocoding service.

### API usage

Run the Actor from the Apify Console or Apify API. Results are written to the default dataset and can be consumed through the dataset API.

### Pricing model

Usage is billed with Apify Pay Per Event.

- `address-analyzed` — charged for each successfully analyzed address
- `address-matched` — charged for each successfully matched address pair

Current prices are displayed in the Actor's Apify pricing section.

No LLM token billing and no external geocoding API is required.

# Actor input Schema

## `operation` (type: `string`):

Analyze addresses or match address pairs.

## `addresses` (type: `array`):

Addresses to normalize and assess.

## `pairs` (type: `array`):

Pairs to compare when operation is 'match'.

## `countryHint` (type: `string`):

Optional country hint. Does not validate deliverability.

## `languageHint` (type: `string`):

Optional language hint for metadata.

## Actor input object example

```json
{
  "operation": "analyze",
  "addresses": [
    "92 avenue des Champs-Élysées Paris 75008 France"
  ],
  "pairs": [
    {
      "addressA": "92 avenue des Champs-Élysées Paris",
      "addressB": "92 Av. des Champs Elysees, 75008 Paris, France"
    }
  ]
}
```

# Actor output Schema

## `operation` (type: `string`):

No description

## `input` (type: `string`):

No description

## `normalized_address` (type: `string`):

No description

## `components` (type: `string`):

No description

## `quality` (type: `string`):

No description

## `decision` (type: `string`):

No description

## `confidence` (type: `string`):

No description

## `component_scores` (type: `string`):

No description

## `evidence` (type: `string`):

No description

## `differences` (type: `string`):

No description

## `warnings` (type: `string`):

No description

## `error` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("tryva/address-quality-matching-api").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("tryva/address-quality-matching-api").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call tryva/address-quality-matching-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,tryva/address-quality-matching-api"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/AzdjjkmM7eTxpD1Dg/builds/iYv67l5KNCAaS3NKb/openapi.json