{ "openapi": "3.0.1", "info": { "title": "Géocoder/Géocodage d'Adresses en France en Masse: Bulk Geocoder", "description": "Fast and cost optimized Bulk French Address Geocoder using public API of BAN (Base Adresse Nationale), recently transferred to IGN (Institut National de l’Information Géographique et Forestière). The cost starts from 0.02$/1000 results. The actor allows you to query the two indexes: BAN and BD TOPO.", "version": "0.0", "x-build-id": "P5dW5fOuh0FBGp1sU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nlp_data_lni~fr-ign-geocodage/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nlp_data_lni-fr-ign-geocodage", "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/nlp_data_lni~fr-ign-geocodage/runs": { "post": { "operationId": "runs-sync-nlp_data_lni-fr-ign-geocodage", "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/nlp_data_lni~fr-ign-geocodage/run-sync": { "post": { "operationId": "run-sync-nlp_data_lni-fr-ign-geocodage", "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": { "addresses": { "title": "Addresses to geocode", "type": "array", "description": "Addresses located in France to geocode", "items": { "type": "string" } }, "address_file": { "title": "File with addresses to geocode", "type": "string", "description": "Upload a text file containg the address list (one address by line)" }, "bulk_mode": { "title": "Enable Bulk mode", "type": "boolean", "description": "In bulk mode, input addresses are processed in batches, which reduces the number of calls to the geocoder API. In this mode, only one candidate is collected for each address. If bulk mode is disabled, each address Each input address generates a call to the API.", "default": true }, "index": { "title": "Index", "enum": [ "address", "poi" ], "type": "string", "description": "Select Index to query", "default": "address" }, "max_candidates": { "title": "Maximum maching candidates for each address", "type": "integer", "description": "Maximum maching candidates for each input address. A matching score is assigned to each candidate", "default": 1 }, "create_map": { "title": "Create an OpenStreetMap map", "type": "boolean", "description": "Enable map creation. If set, an OpenStreetMap map will be produced in HTML format including markers at the addreses coordinates and tooltips for more details.", "default": false }, "max_map_markers": { "title": "Maximum markers number on the map", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of markers to render on the map. This number must not exceed 1000 in order to maintain the readability of the map.", "default": 250 }, "proxy_settings": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used for requests calls." } } }, "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 } } } } } } } } } }