{ "openapi": "3.0.1", "info": { "title": "Business Change Monitor: closures, hours, contacts", "description": "Monitor PUBLIC business listings and get an event the moment one closes, moves, or changes hours, phone, website, or category. Pay only per detected change.", "version": "0.1", "x-build-id": "vLkVt8ehvekzEmRLc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/satelink~business-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-satelink-business-change-monitor", "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/satelink~business-change-monitor/runs": { "post": { "operationId": "runs-sync-satelink-business-change-monitor", "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/satelink~business-change-monitor/run-sync": { "post": { "operationId": "run-sync-satelink-business-change-monitor", "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", "required": [ "change_types" ], "properties": { "urls_or_businesses": { "title": "Businesses to monitor", "type": "array", "description": "Business identifiers to monitor. For the OpenStreetMap source these are OSM element ids like \"node/123456\", \"way/987654\". Leave empty and set region_bbox to auto-discover all matching businesses in an area (500–10,000).", "items": { "type": "string" } }, "source": { "title": "Data source", "enum": [ "osm-overpass" ], "type": "string", "description": "PUBLIC listing source. OpenStreetMap (Overpass) is free and datacenter-proxy-friendly — no residential proxy needed, which is what keeps margin intact.", "default": "osm-overpass" }, "region_bbox": { "title": "Region bounding box (optional)", "type": "string", "description": "\"south,west,north,east\" lat/lon. If set, auto-discovers matching businesses in this area instead of (or in addition to) an explicit id list. Example: \"30.20,-97.80,30.35,-97.68\" (Austin, TX core)." }, "osm_category_filter": { "title": "Business category filter (OSM tag)", "type": "string", "description": "Narrow the niche. e.g. \"amenity=restaurant\", \"amenity=cafe\", \"shop=hairdresser\". Pick ONE vertical × region — general-purpose is a crowded, low-margin category.", "default": "amenity=restaurant" }, "monitoring_interval": { "title": "Monitoring interval", "enum": [ "daily", "weekly" ], "type": "string", "description": "How often you intend to schedule this Actor. Used to estimate the expected change rate for the pre-flight margin guard.", "default": "weekly" }, "change_types": { "title": "Change types to detect", "type": "array", "description": "Which field changes should produce (and bill) an event. rating/review_count are unavailable on sources without reviews (e.g. OSM) and are silently skipped there.", "items": { "type": "string", "enum": [ "rating", "review_count", "hours", "phone", "address", "website", "category", "disappeared" ], "enumTitles": [ "Rating", "Review count", "Opening hours", "Phone", "Address", "Website", "Category", "Disappeared / closed" ] }, "default": [ "hours", "phone", "address", "website", "category", "disappeared" ] }, "price_per_event_usd": { "title": "Price charged per detected change (USD)", "type": "string", "description": "Your 'change_detected' pay-per-event price. Used by the pre-flight margin guard. Must exceed per-business cost by the margin floor.", "default": "0.02" }, "price_per_business_checked_usd": { "title": "Price charged per business checked (USD)", "type": "string", "description": "Your 'business_checked' pay-per-event price. Every business actually checked earns this, even when nothing changed, so a no-change run still earns. Fed into the pre-flight margin guard's revenue estimate.", "default": "0.0005" }, "margin_floor": { "title": "Minimum acceptable margin (0–1)", "type": "string", "description": "The run is REJECTED before doing any work if projected margin falls below this. Default 0.50 = reject anything under 50% margin.", "default": "0.50" } } }, "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 } } } } } } } } } }