# French Address Geocoder (BAN) (`mcmh_data/french-address-geocoder-ban`) Actor

Geocode French addresses in bulk with the official Base Adresse Nationale. Returns coordinates, INSEE code and a match score. Unmatched addresses are free.

- **URL**: https://apify.com/mcmh\_data/french-address-geocoder-ban.md
- **Developed by:** [Michael HOSPITAL](https://apify.com/mcmh_data) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$1.00 / 1,000 address geocodeds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

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

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## French Address Geocoder (BAN)

Bulk geocoding of French addresses with the official Base Adresse Nationale (data.geopf.fr). Paste a list of addresses, get latitude, longitude, normalised label, postal code, INSEE code, department and a match score.

### Input

- `addresses`: one address per line.
- `minScore`: minimum match score from 0 to 1 (default 0.5).
- `postcode`, `matchType`: optional restrictions.
- `includeUnmatched`: keep unmatched rows in the dataset (default true).

### Output

One row per address: input, matched, score, label, house number, street, postal code, city, INSEE code, department, context, match type, latitude, longitude, BAN id.

### Pricing

Pay per matched address (`address-geocoded`). Unmatched addresses are free.

### Source

Base Adresse Nationale via the Geoplateforme geocoder, Licence Ouverte 2.0. Only the addresses you provide are processed.

### Exemple en français

Géocoder deux adresses : `{"addresses":["8 bd du Port 80000 Amiens","20 avenue de Ségur 75007 Paris"]}`.

# Actor input Schema

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

One address per line, for example: 8 bd du Port 80000 Amiens.

## `minScore` (type: `number`):

From 0 to 1. Addresses below this score are reported as unmatched and are not charged. Default 0.5.

## `postcode` (type: `string`):

Optional. Applies to every address.

## `matchType` (type: `string`):

Optional filter: housenumber, street, locality or municipality.

## `includeUnmatched` (type: `boolean`):

Unmatched addresses are added to the dataset for free so you can review them.

## Actor input object example

```json
{
  "addresses": [
    "8 bd du Port 80000 Amiens",
    "20 avenue de Segur 75007 Paris"
  ],
  "minScore": 0.5,
  "includeUnmatched": true
}
```

# Actor output Schema

## `results` (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 = {
    "addresses": [
        "8 bd du Port 80000 Amiens",
        "20 avenue de Segur 75007 Paris"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("mcmh_data/french-address-geocoder-ban").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 = { "addresses": [
        "8 bd du Port 80000 Amiens",
        "20 avenue de Segur 75007 Paris",
    ] }

# Run the Actor and wait for it to finish
run = client.actor("mcmh_data/french-address-geocoder-ban").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 '{
  "addresses": [
    "8 bd du Port 80000 Amiens",
    "20 avenue de Segur 75007 Paris"
  ]
}' |
apify call mcmh_data/french-address-geocoder-ban --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,mcmh_data/french-address-geocoder-ban"
        }
    }
}
```

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/rXY5CEaHZcwgjaRba/builds/ZVubwXImAzCJD78gk/openapi.json