# CEP Lookup - Brazil Address Finder (`cloway/cep-lookup`) Actor Busca enderecos brasileiros por CEP. Logradouro, bairro, cidade, estado, coordenadas GPS. Fallback ViaCEP + BrasilAPI. Lote ate 100 CEPs. Gratuito. - **URL**: https://apify.com/cloway/cep-lookup.md - **Developed by:** [Cloway](https://apify.com/cloway) (community) - **Categories:** SEO tools, E-commerce - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN 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 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 ## CEP Lookup - Brazil Address Finder Look up Brazilian postal codes (CEP) and get complete address data instantly. **FREE**, real-time, no API key needed. ### What it does This Actor receives one or more Brazilian CEPs (postal codes) and returns full address details including street, neighborhood, city, state, IBGE code, DDD (area code), and coordinates when available. - Queries **ViaCEP** (primary) and **BrasilAPI** (fallback) - Supports batch lookups: up to **100 CEPs per run** - Returns coordinates (latitude/longitude) via BrasilAPI - Automatic CEP validation and formatting - Rate-limited to respect API fair use ### Input | Field | Type | Description | |-------|------|-------------| | `ceps` | string[] | Array of CEP numbers (up to 100) | | `cep` | string | Single CEP number | | `useFallback` | boolean | Try BrasilAPI if ViaCEP fails (default: true) | CEPs can be provided with or without formatting: - `01001000` or `01001-000` both work - Non-digit characters are automatically stripped ### Output Each result includes: | Field | Description | |-------|-------------| | `cep` | CEP (8 digits) | | `cep_formatado` | Formatted CEP (XXXXX-XXX) | | `logradouro` | Street name | | `complemento` | Address complement | | `bairro` | Neighborhood | | `cidade` | City | | `estado` | State (UF, 2 letters) | | `ibge` | IBGE municipality code | | `ddd` | Area code | | `siafi` | SIAFI code | | `latitude` | Latitude (BrasilAPI only) | | `longitude` | Longitude (BrasilAPI only) | | `source` | Data source: `viacep` or `brasilapi` | | `status` | `success` or `error` | ### Example input ```json { "ceps": ["01001000", "20040020", "70040010"], "useFallback": true } ```` ### Example output ```json { "cep": "01001000", "cep_formatado": "01001-000", "logradouro": "Praca da Se", "complemento": "lado impar", "bairro": "Se", "cidade": "Sao Paulo", "estado": "SP", "ibge": "3550308", "ddd": "11", "siafi": "7107", "latitude": null, "longitude": null, "source": "viacep", "status": "success" } ``` ### Use cases - **E-commerce checkout**: Auto-fill address fields when the customer types a CEP - **Address validation**: Verify that a CEP exists and matches the expected city/state - **Logistics and shipping**: Enrich delivery data with IBGE codes and coordinates - **CRM enrichment**: Complete partial address records with full postal data - **Market research**: Map CEPs to regions, states, and area codes ### Data sources 1. **ViaCEP** (https://viacep.com.br) - Primary source. Free, public, no API key. Returns street, neighborhood, city, state, IBGE, DDD, SIAFI. 2. **BrasilAPI** (https://brasilapi.com.br) - Fallback source. Free, public, no API key. Also returns latitude/longitude coordinates when available. ### Cost This Actor uses only free, public APIs. There is no cost beyond Apify platform compute usage. ### Limits - Maximum 100 CEPs per run - 100ms delay between requests to respect API rate limits - 15-second timeout per API request *** Built by [NomePronto](https://nomepronto.com.br) - Registre sua marca com seguranca. # Actor input Schema ## `ceps` (type: `array`): Array of CEP numbers to look up (up to 100). Each CEP must be 8 digits. Can include formatting (e.g., 01001-000) which will be stripped automatically. ## `cep` (type: `string`): A single CEP number to look up. Use this field if you only need one CEP. If both 'cep' and 'ceps' are provided, they will be merged. ## `useFallback` (type: `boolean`): If ViaCEP fails, try BrasilAPI as a fallback. BrasilAPI also provides coordinates (latitude/longitude) when available. ## Actor input object example ```json { "ceps": [ "01001000", "20040020", "70040010" ], "cep": "01001000", "useFallback": true } ``` # Actor output Schema ## `resultados` (type: `string`): Resultados da busca de enderecos por CEP # 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 = { "ceps": [ "01001000" ] }; // Run the Actor and wait for it to finish const run = await client.actor("cloway/cep-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 = { "ceps": ["01001000"] } # Run the Actor and wait for it to finish run = client.actor("cloway/cep-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 '{ "ceps": [ "01001000" ] }' | apify call cloway/cep-lookup --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=cloway/cep-lookup", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "CEP Lookup - Brazil Address Finder", "description": "Busca enderecos brasileiros por CEP. Logradouro, bairro, cidade, estado, coordenadas GPS. Fallback ViaCEP + BrasilAPI. Lote ate 100 CEPs. Gratuito.", "version": "1.0", "x-build-id": "ZygMJjZGf37Kshx25" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cloway~cep-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cloway-cep-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/cloway~cep-lookup/runs": { "post": { "operationId": "runs-sync-cloway-cep-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/cloway~cep-lookup/run-sync": { "post": { "operationId": "run-sync-cloway-cep-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", "properties": { "ceps": { "title": "CEP List", "type": "array", "description": "Array of CEP numbers to look up (up to 100). Each CEP must be 8 digits. Can include formatting (e.g., 01001-000) which will be stripped automatically.", "items": { "type": "string" } }, "cep": { "title": "Single CEP", "type": "string", "description": "A single CEP number to look up. Use this field if you only need one CEP. If both 'cep' and 'ceps' are provided, they will be merged." }, "useFallback": { "title": "Use Fallback API", "type": "boolean", "description": "If ViaCEP fails, try BrasilAPI as a fallback. BrasilAPI also provides coordinates (latitude/longitude) when available.", "default": true } } }, "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 } } } } } } } } } } ```