{ "openapi": "3.0.1", "info": { "title": "OpenStreetMap Places Scraper: Geocoding & POI Search", "description": "Geocode addresses, reverse-geocode coordinates and harvest points of interest from OpenStreetMap. Address components, bounding boxes and raw OSM tags. No key.", "version": "0.0", "x-build-id": "zfTTD1RUgKmeFRfrq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arman-bd~openstreetmap-places-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arman-bd-openstreetmap-places-scraper", "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/arman-bd~openstreetmap-places-scraper/runs": { "post": { "operationId": "runs-sync-arman-bd-openstreetmap-places-scraper", "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/arman-bd~openstreetmap-places-scraper/run-sync": { "post": { "operationId": "run-sync-arman-bd-openstreetmap-places-scraper", "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": { "queries": { "title": "Addresses or place names", "type": "array", "description": "Free-text addresses or place names to geocode. Anything the OpenStreetMap search box accepts works here. Leave empty to skip forward geocoding.", "items": { "type": "string" } }, "coordinates": { "title": "Coordinates to reverse-geocode", "type": "array", "description": "\"lat,lon\" pairs turned back into addresses, e.g. \"52.5163,13.3777\". Leave empty to skip reverse geocoding.", "items": { "type": "string" } }, "poiTags": { "title": "POI tags", "type": "array", "description": "OpenStreetMap tag filters such as amenity=cafe or shop=supermarket. Requires an area bounding box. Every node, way and relation carrying any of these tags inside the box is returned.", "items": { "type": "string" } }, "areaBoundingBox": { "title": "POI area", "type": "object", "description": "The area POI tags are searched in: { south, west, north, east } in WGS84 degrees. Only read when poiTags is set. Keep it tight, because Overpass times out on city-scale boxes with common tags." }, "countryCodes": { "title": "Restrict to countries", "type": "array", "description": "Two-letter ISO country codes that forward geocoding is confined to, e.g. de, gb. Leave empty to search worldwide. Ignored for reverse geocoding and POI searches.", "items": { "type": "string" } }, "includeAddressDetails": { "title": "Break out address components", "type": "boolean", "description": "Split the result into house number, road, city, state, postcode and country instead of only the single display name. Costs nothing extra.", "default": true }, "includeExtraTags": { "title": "Include raw OSM tags", "type": "boolean", "description": "Attach the object's raw OpenStreetMap tags: opening hours, website, phone, wheelchair access, brand and whatever else the mappers recorded. Always present for POI searches.", "default": false }, "resultsPerQuery": { "title": "Results per address", "minimum": 1, "maximum": 40, "type": "integer", "description": "How many candidate matches to keep for each forward-geocoding query. Nominatim never returns more than 40. Use 1 when you are standardising a known address list.", "default": 1 }, "maxResults": { "title": "Max places", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Cap on total places saved across every query in the run.", "default": 1000 }, "contactEmail": { "title": "Contact email", "type": "string", "description": "Added to the User-Agent sent to OpenStreetMap. Their usage policy asks for a way to reach whoever is running the queries, and giving one means they warn you before blocking rather than after." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }