# Nominatim OSM Geocoder (`brunofin/nominatim-osm-geocoder`) Actor

Forward geocode (address → coordinates) and reverse geocode (coordinates → address) using the official Nominatim OpenStreetMap API. Keyless, no auth required — just a proper User-Agent header.

- **URL**: https://apify.com/brunofin/nominatim-osm-geocoder.md
- **Developed by:** [Bruno Finger](https://apify.com/brunofin) (community)
- **Categories:** Travel
- **Stats:** 2 total users, 1 monthly users, 100.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/platform/actors/running/actors-in-store#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

## Nominatim OSM Geocoder

Forward geocode (address → coordinates) and reverse geocode (coordinates → address) using the official Nominatim OpenStreetMap API. Keyless, no auth required — just a proper User-Agent header.

### Features

- **Forward geocoding**: Convert addresses like "Berlin" or "1600 Pennsylvania Ave NW, Washington DC" to latitude/longitude coordinates
- **Reverse geocoding**: Convert coordinate pairs like "52.52,13.405" to human-readable addresses
- **Structured address breakdown**: Optional detailed address components (street, city, country, postcode, etc.)
- **Multiple results per query**: Configure how many results to return per forward geocode query
- **PAY\_PER\_EVENT pricing**: Charged per geocoded address or reverse-geocoded coordinate pair

### Input

| Field | Type | Description |
|-------|------|-------------|
| `queries` | string\[] | List of addresses to forward geocode (e.g., `["Berlin", "Tokyo, Japan"]`) |
| `reverseQueries` | string\[] | List of coordinate pairs to reverse geocode (e.g., `["52.52,13.405", "40.7128,-74.0060"]`) |
| `limit` | integer | Max results per forward query (default: 1, max: 50) |
| `addressDetails` | boolean | Include structured address components (default: true) |

### Output

Each result includes:

- `query` — the input query string
- `resultIndex` — index of this result (for forward queries with multiple results)
- `place_id` — Nominatim place ID
- `osm_type` — OSM object type (node, way, relation)
- `osm_id` — OSM object ID
- `lat` / `lon` — coordinates
- `display_name` — full human-readable address
- `class` / `type` — OSM classification (e.g., `boundary/administrative`, `highway/secondary`)
- `importance` — result relevance score
- `address` — structured address breakdown (when `addressDetails=true`)

### Usage Example

```json
{
  "queries": ["Berlin", "New York, USA", "Eiffel Tower"],
  "reverseQueries": ["52.52,13.405", "40.7128,-74.0060"],
  "limit": 2,
  "addressDetails": true
}
```

### Rate Limits

Nominatim enforces a **1 request per second** courtesy limit. This actor automatically respects that by adding a 1.1 second delay between requests.

### Data Source

[OpenStreetMap Nominatim API](https://nominatim.org/) — the official OSM geocoding service.

### Related Actors

- [Crossref Scholarly Works Fetcher](https://apify.com/brunofin/crossref-scholarly-works-fetcher) — academic paper metadata
- [GDELT News Event Graph Fetcher](https://apify.com/brunofin/gdelt-news-event-graph-fetcher) — real-time news monitoring
- [Apple iTunes Media Fetcher](https://apify.com/brunofin/apple-itunes-media-fetcher) — media/movie/podcast metadata

# Actor input Schema

## `queries` (type: `array`):

List of address strings to forward geocode (text → coordinates). e.g., \["Berlin", "New York, USA", "1600 Pennsylvania Ave NW, Washington DC"].

## `reverseQueries` (type: `array`):

List of coordinate pairs to reverse geocode (coordinates → address). Each item: "lat,lon". e.g., \["52.52,13.405", "40.7128,-74.0060"].

## `limit` (type: `integer`):

Maximum number of results per forward geocode query (Nominatim returns up to this many).

## `addressDetails` (type: `boolean`):

Include structured address components (street, city, country, etc.) in results.

## Actor input object example

```json
{
  "queries": [
    "Berlin",
    "Tokyo, Japan"
  ],
  "reverseQueries": [
    "52.52,13.405",
    "40.7128,-74.0060"
  ],
  "limit": 1,
  "addressDetails": 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 = {
    "queries": [
        "Berlin",
        "Tokyo, Japan"
    ],
    "reverseQueries": [
        "52.52,13.405",
        "40.7128,-74.0060"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("brunofin/nominatim-osm-geocoder").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 = {
    "queries": [
        "Berlin",
        "Tokyo, Japan",
    ],
    "reverseQueries": [
        "52.52,13.405",
        "40.7128,-74.0060",
    ],
}

# Run the Actor and wait for it to finish
run = client.actor("brunofin/nominatim-osm-geocoder").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 '{
  "queries": [
    "Berlin",
    "Tokyo, Japan"
  ],
  "reverseQueries": [
    "52.52,13.405",
    "40.7128,-74.0060"
  ]
}' |
apify call brunofin/nominatim-osm-geocoder --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,brunofin/nominatim-osm-geocoder"
        }
    }
}

```

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/TfEUWjmMp6pzQorGM/builds/cOplYIOHAM3yKb7Ou/openapi.json