# ZIP / Postal Code to Geo (City, State, Lat/Lon) (`thoob/zip-geo-lookup`) Actor Turns postal codes into clean geographic records, city, state, latitude, and longitude, for the US and many other countries, via the open Zippopotam.us service. Built for CRM and address enrichment. Billed only per postal code resolved. - **URL**: https://apify.com/thoob/zip-geo-lookup.md - **Developed by:** [Pono Data](https://apify.com/thoob) (community) - **Categories:** Developer tools - **Stats:** 2 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing $0.50 / 1,000 resolved postal codes 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/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. 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. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use 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 ## ZIP / Postal Code to Geo Turn postal codes into clean geographic records: city/place, state, latitude, and longitude. Built for CRM and address enrichment, where this lookup is needed constantly but the clean version is hard to find on the Store. Powered by the open Zippopotam.us service (no key), covering the US and many other countries. ### Input - **Postal codes**: one per line, in the country's own format (`90210`, `EC1A`, `10115`). Prefix a code with a country to override the default (`gb:EC1A`). - **Default country code**: ISO alpha-2 applied to un-prefixed codes (`us`, `gb`, ...). - **Max delivered codes**: cap on billed rows (0 = no cap). ### Output One row per resolved code: `postalCode`, `country`, `countryAbbreviation`, `placeName` (primary), `state`, `stateAbbreviation`, `latitude`, `longitude`, `placeCount`, `allPlaceNames`, plus provenance (`sourceUrl`, `retrievedAt`, `confidence`, `dataSource`). ### How it works Every field is copied from the Zippopotam.us response; nothing is inferred. A code that does not resolve (unknown code, or a country the service does not cover) is written to the free `rejected` dataset and is not billed. When a code maps to several places, the first is the primary and `allPlaceNames` lists them all. ### Note on GeoNames GeoNames offers a deeper postal dataset but its API needs a free username. Zippopotam covers the common enrichment case with no key; GeoNames enrichment is a documented future option, not required to run this actor. ### Billing Pay per postal code resolved. Unresolvable codes cost nothing. ### Sample output A real run turning US ZIP codes into geographic records: | ZIP | place | state | lat | lon | | --- | --- | --- | --- | --- | | 90210 | Beverly Hills | CA | 34.0901 | -118.4065 | | 10001 | New York City | NY | 40.7484 | -73.9967 | | 60601 | Chicago | IL | 41.8858 | -87.6181 | | 94103 | San Francisco | CA | 37.7725 | -122.4147 | Each row carries a `sourceUrl`, for example `https://api.zippopotam.us/us/90210`. ### See also More clean, pay-only-for-results data tools from Pono Data: - [Barcode to Nutrition](https://apify.com/thoob/barcode-nutrition-lookup) - UPC/EAN barcode to nutrition facts - [URL Metadata & OpenGraph Extractor](https://apify.com/thoob/url-metadata-extractor) - title, OpenGraph, and meta tags per page Full catalog: https://apify.com/thoob # Actor input Schema ## `postalCodes` (type: `array`): Postal / ZIP codes to look up, one per line. Use the format of the country (US 90210, UK EC1A, DE 10115). You can prefix a code with a country to override the default, for example gb:EC1A or de:10115. ## `defaultCountry` (type: `string`): ISO 3166-1 alpha-2 country code applied to codes that have no country prefix (us, gb, de, ca, fr, ...). ## `maxCodes` (type: `integer`): Cap on resolved, billed rows. 0 means no cap. The platform spend cap is honored regardless. ## Actor input object example ```json { "postalCodes": [ "90210", "10001", "gb:EC1A", "de:10115" ], "defaultCountry": "us", "maxCodes": 0 } ```` # Actor output Schema ## `locations` (type: `string`): One row per resolved postal code. # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "postalCodes": [ "90210", "10001", "gb:EC1A", "de:10115" ] }; // Run the Actor and wait for it to finish const run = await client.actor("thoob/zip-geo-lookup").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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "postalCodes": [ "90210", "10001", "gb:EC1A", "de:10115", ] } # Run the Actor and wait for it to finish run = client.actor("thoob/zip-geo-lookup").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "postalCodes": [ "90210", "10001", "gb:EC1A", "de:10115" ] }' | apify call thoob/zip-geo-lookup --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=thoob/zip-geo-lookup", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "ZIP / Postal Code to Geo (City, State, Lat/Lon)", "description": "Turns postal codes into clean geographic records, city, state, latitude, and longitude, for the US and many other countries, via the open Zippopotam.us service. Built for CRM and address enrichment. Billed only per postal code resolved.", "version": "0.0", "x-build-id": "j8OX6S1F2UwLO4eYs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thoob~zip-geo-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thoob-zip-geo-lookup", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/thoob~zip-geo-lookup/runs": { "post": { "operationId": "runs-sync-thoob-zip-geo-lookup", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/thoob~zip-geo-lookup/run-sync": { "post": { "operationId": "run-sync-thoob-zip-geo-lookup", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "postalCodes" ], "properties": { "postalCodes": { "title": "Postal codes", "minItems": 1, "type": "array", "description": "Postal / ZIP codes to look up, one per line. Use the format of the country (US 90210, UK EC1A, DE 10115). You can prefix a code with a country to override the default, for example gb:EC1A or de:10115.", "items": { "type": "string" } }, "defaultCountry": { "title": "Default country code", "type": "string", "description": "ISO 3166-1 alpha-2 country code applied to codes that have no country prefix (us, gb, de, ca, fr, ...).", "default": "us" }, "maxCodes": { "title": "Max delivered codes", "minimum": 0, "maximum": 200000, "type": "integer", "description": "Cap on resolved, billed rows. 0 means no cap. The platform spend cap is honored regardless.", "default": 0 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```