{ "openapi": "3.0.1", "info": { "title": "OpenStreetMap Business & POI Search (Overpass API)", "description": "Returns businesses and places from OpenStreetMap via the Overpass API: cafes, hotels, pharmacies, gyms, offices and 100+ categories in a bounding box, radius or named city, with name, coordinates, address, phone, website, hours and tags. Open ODbL data, no Google Maps.", "version": "0.1", "x-build-id": "uLegrHoJaAbS7dqgB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lathewright~osm-places-overpass/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lathewright-osm-places-overpass", "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/lathewright~osm-places-overpass/runs": { "post": { "operationId": "runs-sync-lathewright-osm-places-overpass", "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/lathewright~osm-places-overpass/run-sync": { "post": { "operationId": "run-sync-lathewright-osm-places-overpass", "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": { "categories": { "title": "Categories", "type": "array", "description": "Preset place types, e.g. cafe, restaurant, bar, hotel, supermarket, pharmacy, dentist, hospital, gym, bank, atm, fuel, charging_station, parking, school, university, coworking, company, lawyer, accountant, estate_agent, it_company, car_repair, hairdresser, museum, park. Unknown names are treated as raw tag filters (key=value).", "items": { "type": "string" } }, "tagFilters": { "title": "Raw OSM tag filters", "type": "array", "description": "Advanced: one Overpass filter per entry, e.g. `shop=bicycle`, `amenity=restaurant cuisine~pizza`, `office=*`, `craft=brewery`. Space-separated conditions in one entry are ANDed; entries are ORed with the categories.", "items": { "type": "string" } }, "bbox": { "title": "Bounding box (south,west,north,east)", "type": "string", "description": "Decimal degrees, e.g. `52.48,13.35,52.55,13.45`. At most about 2x2 degrees per run on public instances." }, "center": { "title": "Center point (lat,lon)", "type": "string", "description": "Search around this point, e.g. `52.5200,13.4050`. Used with `radiusMeters`." }, "radiusMeters": { "title": "Radius in meters", "minimum": 50, "maximum": 50000, "type": "integer", "description": "Radius around `center` (50 to 50,000).", "default": 2000 }, "areaName": { "title": "Area name", "type": "string", "description": "Name of an administrative boundary in OSM, e.g. `Berlin`, `Lyon`, `Travis County`. Add `areaAdminLevel` (2 country, 4 state, 6 county, 8 city) when the name is ambiguous. Used only when `bbox` and `center` are empty. Needs an endpoint with area support (see `overpassEndpoint`)." }, "areaAdminLevel": { "title": "Area admin level", "minimum": 1, "maximum": 11, "type": "integer", "description": "OSM admin_level of the area name (2 country, 4 state/region, 6 county, 8 city/municipality)." }, "areaCountryCode": { "title": "Country code (ISO 3166-1)", "type": "string", "description": "Optional two-letter code to restrict `areaName` matching, e.g. `DE`." }, "namedOnly": { "title": "Named places only", "type": "boolean", "description": "Return only elements that have a `name` tag (skips unnamed benches, parking lots, etc.).", "default": true }, "maxPlaces": { "title": "Max places", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Cap on rows per run (also the Overpass output limit). Each place is one billable event.", "default": 50 }, "overpassEndpoint": { "title": "Overpass API endpoint", "type": "string", "description": "Interpreter URL. Default: the free public instance run by Private.coffee (commercial use allowed, fair sharing expected; its data snapshot can lag and it currently rejects area-name queries with HTTP 500). overpass-api.de supports every query type but asks automated users to self-host, so use it only for occasional runs. For scheduled or heavy use, run your own Overpass server and paste its URL." }, "queryTimeoutSeconds": { "title": "Query timeout (seconds)", "minimum": 10, "maximum": 180, "type": "integer", "description": "Overpass server-side timeout for the query.", "default": 60 }, "compactOutput": { "title": "Compact output", "type": "boolean", "description": "Return only the key fields (smaller, cheaper for AI agents to read).", "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 }, "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 } } } } } } } } } }