{ "openapi": "3.0.1", "info": { "title": "OpenStreetMap POI Extractor (Overpass API: shops, amenities)", "description": "OpenStreetMap POI Extractor returns shops, cafes, restaurants and any tagged place within a radius, a bounding box, or a named area — one row per point of interest, powered by the free Overpass API.", "version": "0.1", "x-build-id": "lKdvnogxuhE1BnR8y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/webdatatools~overpass-poi-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-webdatatools-overpass-poi-extractor", "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/webdatatools~overpass-poi-extractor/runs": { "post": { "operationId": "runs-sync-webdatatools-overpass-poi-extractor", "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/webdatatools~overpass-poi-extractor/run-sync": { "post": { "operationId": "run-sync-webdatatools-overpass-poi-extractor", "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": { "mode": { "title": "Search mode", "enum": [ "radius", "bbox", "area" ], "type": "string", "description": "How to define the search area: \"radius\" around a point, \"bbox\" (a bounding box), or \"area\" (a place name resolved via Nominatim, e.g. a city or district).", "default": "radius" }, "latitude": { "title": "Latitude (radius mode)", "type": "number", "description": "Center point latitude for radius mode, e.g. 50.0755 for Prague's city centre. Ignored in bbox and area mode.", "default": 50.0755 }, "longitude": { "title": "Longitude (radius mode)", "type": "number", "description": "Center point longitude for radius mode, e.g. 14.4378 for Prague's city centre. Ignored in bbox and area mode.", "default": 14.4378 }, "radiusMeters": { "title": "Radius in meters (radius mode)", "minimum": 1, "maximum": 20000, "type": "integer", "description": "How far from the center point to search, in meters, e.g. 1000 for a 1 km radius. Larger radii return more results and take longer to query.", "default": 1000 }, "bbox": { "title": "Bounding box (bbox mode)", "type": "string", "description": "Bounding box as \"south,west,north,east\" decimal degrees, e.g. \"50.05,14.35,50.13,14.55\" for central Prague. Required when Search mode is \"bbox\".", "default": "50.05,14.35,50.13,14.55" }, "areaName": { "title": "Area name (area mode)", "type": "string", "description": "A place name to search inside, e.g. \"Prague, Czechia\" or \"Brooklyn, New York\". Resolved to an OpenStreetMap area via Nominatim. Required when Search mode is \"area\".", "default": "Prague, Czechia" }, "categories": { "title": "OSM categories (key=value tags)", "type": "array", "description": "OpenStreetMap tags to search for, each as \"key=value\", e.g. \"amenity=cafe\" or \"shop=supermarket\". Every category is searched and merged into one result list.", "default": [ "amenity=cafe", "amenity=restaurant" ], "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum number of POIs to return, e.g. 500. Overpass results beyond this count are dropped before they are pushed to the dataset.", "default": 100 }, "overpassEndpoint": { "title": "Overpass endpoint", "type": "string", "description": "The Overpass API endpoint to query first, e.g. https://overpass-api.de/api/interpreter. On a 429 or 504 response the Actor automatically falls back to https://overpass.kumi.systems/api/interpreter.", "default": "https://overpass-api.de/api/interpreter" } } }, "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 } } } } } } } } } }