{ "openapi": "3.0.1", "info": { "title": "OpenStreetMap Places Scraper", "description": "Points of interest from OpenStreetMap by city, bounding box or radius. Overpass reports a timed-out query as HTTP 200 with an empty result, and gives ways no coordinates unless asked - both are handled, so an empty answer here means an empty area.", "version": "0.1", "x-build-id": "h3zFUkYZT1zLuvCtj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapyx~osm-places-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapyx-osm-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/scrapyx~osm-places-scraper/runs": { "post": { "operationId": "runs-sync-scrapyx-osm-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/scrapyx~osm-places-scraper/run-sync": { "post": { "operationId": "run-sync-scrapyx-osm-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": { "place": { "title": "Place name", "type": "string", "description": "A city, district or country — geocoded to a bounding box via Nominatim. Give a fuller name for a better match ('Berlin, Germany'). Use exactly one of place / boundingBox / centerPoint." }, "boundingBox": { "title": "Bounding box", "type": "string", "description": "south,west,north,east — note the ORDER; it is not lat,lon pairs. Precise and free of any geocoding guess." }, "centerPoint": { "title": "Centre point", "type": "string", "description": "lat,lon — searches a radius around this point." }, "radiusMeters": { "title": "Radius (metres)", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Used with Centre point. 1–50000.", "default": 1000 }, "categories": { "title": "Categories", "type": "array", "description": "Each preset is a UNION of the OSM tags that actually carry the thing you mean — 'hotels' covers tourism=hotel, hostel, guest_house, motel and apartment, because OSM splits them. This is where naive OSM queries lose most of their results.", "items": { "type": "string", "enum": [ "attractions", "banks_atms", "bars_pubs", "cafes", "car_services", "education", "fast_food", "fuel_charging", "gyms_sports", "healthcare", "hotels", "offices", "parking", "pharmacies", "places_of_worship", "post_shipping", "restaurants", "shops", "supermarkets", "tourism_all" ] }, "default": [ "restaurants" ] }, "customTags": { "title": "Custom OSM tags", "type": "array", "description": "For anything the presets miss. 'key=value' for an exact match, or just 'key' to match any value — e.g. 'amenity=veterinary', or 'craft' for every craft business.", "items": { "type": "string" } }, "osmTypes": { "title": "OSM element types", "type": "array", "description": "Nodes are points. Ways and relations are outlines — supermarkets, hospitals, hotels and malls are mapped that way far more often than as points, so excluding them loses exactly the large POIs you probably want.", "items": { "type": "string", "enum": [ "node", "way", "relation" ] }, "default": [ "node", "way", "relation" ] }, "requireName": { "title": "Only places with a name", "type": "boolean", "description": "On by default. OSM contains vast numbers of unnamed features (benches, parking bays) that are real data but noise in a places dataset.", "default": true }, "maxResults": { "title": "Max places", "minimum": 0, "type": "integer", "description": "Set 0 for unlimited. The summary row reports the TRUE total from Overpass's own count query, so you can see what a cap left behind.", "default": 500 }, "queryTimeout": { "title": "Overpass query timeout (seconds)", "minimum": 10, "maximum": 300, "type": "integer", "description": "Sent to Overpass as its own server-side budget. Too low is the fastest way to get an empty result that LOOKS like an empty area — this actor detects that and reports it as a failure instead.", "default": 90 }, "minRequestInterval": { "title": "Min seconds between requests", "minimum": 0, "maximum": 60, "type": "integer", "description": "0 uses the built-in default. Overpass publishes a budget of 2 concurrent queries per IP and this actor reads that number from its status endpoint.", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Off by default. Overpass is volunteer-funded and its slot budget is per IP — rotating addresses to get more of it would be taking capacity from a donated service.", "default": { "useApifyProxy": 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 } } } } } } } } } }