{ "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 } } } } } } } } } }