{ "openapi": "3.0.1", "info": { "title": "Yelp Business Scraper & Monitor (ratings, hours, change alerts)", "description": "Yelp business scraper: search by term and location or paste business URLs and get flat rows with rating, review count, price range, categories, address, phone, hours, claimed and closed flags. Monitor mode alerts when a rating, review count or open status changes. No login, no Yelp API key.", "version": "0.1", "x-build-id": "MdjnAYQvmfxLG5MEg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datahamster~yelp-business-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datahamster-yelp-business-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/datahamster~yelp-business-monitor/runs": { "post": { "operationId": "runs-sync-datahamster-yelp-business-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/datahamster~yelp-business-monitor/run-sync": { "post": { "operationId": "run-sync-datahamster-yelp-business-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", "properties": { "searches": { "title": "Searches", "type": "array", "description": "List of Yelp searches as JSON objects: {\"term\": \"coffee\", \"location\": \"San Francisco, CA\"}. `term` is what you would type in Yelp's \"Find\" box (a category or business name); `location` is the \"Near\" box - a city with state, a neighbourhood or a ZIP code. Example: [{\"term\": \"coffee\", \"location\": \"San Francisco, CA\"}].", "default": [ { "term": "coffee", "location": "San Francisco, CA" } ] }, "businessUrls": { "title": "Business URLs or aliases", "type": "array", "description": "Individual Yelp business pages to read, as a full URL or just the alias from it. Business pages carry the full detail (phone, hours, claimed flag, neighbourhoods). Accepted forms: \"https://www.yelp.com/biz/uncle-bennys-donut-and-bagel-san-francisco\", \"uncle-bennys-donut-and-bagel-san-francisco\".", "items": { "type": "string" } }, "searchPages": { "title": "Pages per search", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many search result pages to request per search, 1 to 50. One page is 10 businesses, so searchPages 3 covers the first 30 hits. Example: 1.", "default": 1 }, "fetchDetails": { "title": "Open business pages", "type": "boolean", "description": "true opens the business page of every search hit to add phone, opening hours, claimed flag and neighbourhoods, at the cost of one extra request (and unblocker traffic) per business. false keeps only what the search page shows. Example: false.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many businesses in total. Integer, example: 20. You are charged only for businesses actually pushed to the dataset.", "default": 20 }, "mode": { "title": "Mode", "enum": [ "scrape", "monitor" ], "type": "string", "description": "\"scrape\" returns every business found. \"monitor\" returns only businesses whose rating, review count or open status changed since the previous run of the same task, and adds changeType, changedFields and previous. Example: \"scrape\".", "default": "scrape" }, "monitorKey": { "title": "Monitor key", "type": "string", "description": "Optional name for the monitor-mode state when the actor is not started from a saved task; runs sharing this key compare against each other. Example: \"sf-coffee\"." }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional HTTPS endpoint that receives a POST with a JSON summary of the changed businesses at the end of a monitor-mode run. Example: \"https://hooks.example.com/yelp\"." }, "telegramBotToken": { "title": "Telegram bot token", "type": "string", "description": "Optional Telegram bot token (from @BotFather) used to send the monitor-mode change summary. Format: \"123456789:AA...\"." }, "telegramChatId": { "title": "Telegram chat id", "type": "string", "description": "Optional Telegram chat id that receives the monitor-mode summary; use a negative id for a group. Example: \"-1001234567890\"." } } }, "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 } } } } } } } } } }