# Postal Code Scraper: Worldwide Place Lookup (`naimurhasanrwd/zippopotam-postal-scraper`) Actor

Resolve postal codes to place names, regions and coordinates across roughly 60 countries via the public Zippopotam.us API. No login, no proxy, no browser.

- **URL**: https://apify.com/naimurhasanrwd/zippopotam-postal-scraper.md
- **Developed by:** [Naimur Hasan](https://apify.com/naimurhasanrwd) (community)
- **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/actors/running/actors-in-store.md#pay-per-usage

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

## Postal Code Scraper

Resolves postal codes to place names, regions and coordinates across roughly
60 countries through the public Zippopotam.us API. No login, no proxy, no
browser.

### Input

| Field | Type | Notes |
|---|---|---|
| `country` | string | Required. Two-letter ISO country code, e.g. `us`, `de`, `br`. Default `us`. |
| `postalCodes` | array | Required. Codes to resolve within that country. Default `["90210", "10001"]`. |

### Output

One row per *place*: `postalCode`, `country`, `countryAbbreviation`,
`placeName`, `state`, `stateAbbreviation`, `latitude`, `longitude`.

### Notes

- One postal code can cover several places, so the row count can exceed the
  number of codes submitted — the dataset is keyed by place, not by code.
- An unrecognised code is logged and skipped rather than failing the batch;
  the run only fails if nothing at all resolved, since an empty dataset would
  otherwise read as a successful run.
- Coverage varies by country and comes from open data, not from each national
  postal operator — treat it as a good approximation rather than an
  authoritative address database. For the UK specifically,
  `postcodes-uk-scraper` returns far richer administrative detail.
- Upstream keys contain spaces (`"post code"`, `"place name"`), which are
  awkward downstream; they are renamed to camelCase here.

# Actor input Schema

## `country` (type: `string`):

Two-letter ISO country code, e.g. us, de, fr, br

## `postalCodes` (type: `array`):

Postal codes to resolve within that country

## Actor input object example

```json
{
  "country": "us",
  "postalCodes": [
    "90210",
    "10001"
  ]
}
```

# Actor output Schema

## `items` (type: `string`):

Every place the run resolved.

# 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 = {
    "country": "us",
    "postalCodes": [
        "90210",
        "10001"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("naimurhasanrwd/zippopotam-postal-scraper").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 = {
    "country": "us",
    "postalCodes": [
        "90210",
        "10001",
    ],
}

# Run the Actor and wait for it to finish
run = client.actor("naimurhasanrwd/zippopotam-postal-scraper").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 '{
  "country": "us",
  "postalCodes": [
    "90210",
    "10001"
  ]
}' |
apify call naimurhasanrwd/zippopotam-postal-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,naimurhasanrwd/zippopotam-postal-scraper"
        }
    }
}
```

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/KVAKhxk7m6nyrshCV/builds/wnZoZ4d3FgjEHqMCd/openapi.json