# French Geo Lookup (Communes, Departements, Regions — INSEE) (`vigilant_jasmine/french-communes-geo-lookup`) Actor Look up French communes, departements and regions by name/postal/INSEE, or reverse by GPS. Population, surface, centroid, filters. Parallel, dedup, proxy. Free. - **URL**: https://apify.com/vigilant\_jasmine/french-communes-geo-lookup.md - **Developed by:** [DEV DEV](https://apify.com/vigilant_jasmine) (community) - **Categories:** Business, Developer tools - **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 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 ## French Geo Lookup — Communes, Departements & Regions (INSEE) — Pro **Free Apify actor.** Look up French **communes, departements and regions** by name, postal code, INSEE code — or **reverse** by GPS coordinates. Recherche geographique francaise (INSEE): communes, departements, regions. Source: official `geo.api.gouv.fr` (Etalab / DINUM), INSEE Code Officiel Geographique. No API key. Open Licence 2.0. ### Levels & modes - **commune** — search (name / postal / INSEE) or **reverse** (GPS). Returns INSEE code, postal codes, department, region, population, surface, EPCI, SIREN and the commune centroid. Filter by `department`, `region`, `minPopulation`. - **departement** — by name or code -> name, code, region code. - **region** — by name or code -> name, code. ### Runtime (developer-grade) Bounded **parallelism** (`maxConcurrency`), global **`maxItems`** cap, **de-duplication** by level+code, resilient HTTP client (timeout, backoff+jitter, 429/5xx), optional **Apify proxy**, structured logs, and a **run summary** in the key-value store (`OUTPUT`). ### Output (commune, trimmed) ```json { "status": "found", "level": "commune", "nom": "Bordeaux", "code_insee": "33063", "codes_postaux": ["33000", "33100", "33200", "33300", "33800"], "code_departement": "33", "population": 267991, "surface_ha": 4936, "centre_longitude": -0.58, "centre_latitude": 44.84 } ```` Every entry yields an item with `status`: `found`, `not_found`, `error`. ### Use cases - Convert postal codes to INSEE codes (or the reverse) in bulk. - Reverse-geocode GPS points to their commune. - Enrich data with department, region, population and surface. - Build reference tables for French geographic pipelines. ### Limitations & fair use - A postal code can map to several communes; all matches are returned. - Use `maxConcurrency` responsibly on this shared public API. ### More actors by this developer See the full range of French open-data actors: https://apify.com/vigilant\_jasmine # Actor input Schema ## `level` (type: `string`): Which level to look up. ## `communeMode` (type: `string`): search = by name/postal/INSEE; reverse = by GPS coordinates. ## `queries` (type: `array`): Commune names / postal codes / INSEE codes, or departement/region names or codes. ## `coordinates` (type: `array`): One 'lat,lon' pair per entry. ## `department` (type: `string`): Restrict commune search to a department. ## `region` (type: `string`): Restrict commune search to a region. ## `minPopulation` (type: `integer`): Only communes with at least this population. ## `resultsPerQuery` (type: `integer`): Max communes per query (1-25). ## `maxItems` (type: `integer`): Hard cap on total dataset items across all queries. 0 = unlimited. ## `maxConcurrency` (type: `integer`): How many queries to process in parallel (1-20). ## `proxyConfiguration` (type: `object`): Optional Apify proxy for outbound requests. Off by default; these are public government APIs. ## `debug` (type: `boolean`): Enable verbose debug logs (retries, URLs). ## Actor input object example ```json { "level": "commune", "communeMode": "search", "queries": [ "Lyon", "Bordeaux", "75001", "33000" ], "coordinates": [ "48.8534,2.3488" ], "minPopulation": 0, "resultsPerQuery": 5, "maxItems": 0, "maxConcurrency": 5, "proxyConfiguration": { "useApifyProxy": false }, "debug": false } ``` # 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 = { "queries": [ "Lyon", "Bordeaux", "75001", "33000" ], "coordinates": [ "48.8534,2.3488" ] }; // Run the Actor and wait for it to finish const run = await client.actor("vigilant_jasmine/french-communes-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 = { "queries": [ "Lyon", "Bordeaux", "75001", "33000", ], "coordinates": ["48.8534,2.3488"], } # Run the Actor and wait for it to finish run = client.actor("vigilant_jasmine/french-communes-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 '{ "queries": [ "Lyon", "Bordeaux", "75001", "33000" ], "coordinates": [ "48.8534,2.3488" ] }' | apify call vigilant_jasmine/french-communes-geo-lookup --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=vigilant_jasmine/french-communes-geo-lookup", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "French Geo Lookup (Communes, Departements, Regions — INSEE)", "description": "Look up French communes, departements and regions by name/postal/INSEE, or reverse by GPS. Population, surface, centroid, filters. Parallel, dedup, proxy. Free.", "version": "0.0", "x-build-id": "pP68weYSMKtDBK75d" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vigilant_jasmine~french-communes-geo-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vigilant_jasmine-french-communes-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/vigilant_jasmine~french-communes-geo-lookup/runs": { "post": { "operationId": "runs-sync-vigilant_jasmine-french-communes-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/vigilant_jasmine~french-communes-geo-lookup/run-sync": { "post": { "operationId": "run-sync-vigilant_jasmine-french-communes-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", "properties": { "level": { "title": "Administrative level", "enum": [ "commune", "departement", "region" ], "type": "string", "description": "Which level to look up.", "default": "commune" }, "communeMode": { "title": "Commune mode", "enum": [ "search", "reverse" ], "type": "string", "description": "search = by name/postal/INSEE; reverse = by GPS coordinates.", "default": "search" }, "queries": { "title": "Queries", "type": "array", "description": "Commune names / postal codes / INSEE codes, or departement/region names or codes.", "items": { "type": "string" } }, "coordinates": { "title": "Coordinates (commune reverse)", "type": "array", "description": "One 'lat,lon' pair per entry.", "items": { "type": "string" } }, "department": { "title": "Filter: department code (commune)", "type": "string", "description": "Restrict commune search to a department." }, "region": { "title": "Filter: region code (commune)", "type": "string", "description": "Restrict commune search to a region." }, "minPopulation": { "title": "Filter: minimum population (commune)", "minimum": 0, "type": "integer", "description": "Only communes with at least this population.", "default": 0 }, "resultsPerQuery": { "title": "Results per query (commune)", "minimum": 1, "maximum": 25, "type": "integer", "description": "Max communes per query (1-25).", "default": 5 }, "maxItems": { "title": "Max items (global cap)", "minimum": 0, "type": "integer", "description": "Hard cap on total dataset items across all queries. 0 = unlimited.", "default": 0 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many queries to process in parallel (1-20).", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify proxy for outbound requests. Off by default; these are public government APIs.", "default": { "useApifyProxy": false } }, "debug": { "title": "Debug logging", "type": "boolean", "description": "Enable verbose debug logs (retries, URLs).", "default": false } } }, "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 } } } } } } } } } } ```