{ "openapi": "3.0.1", "info": { "title": "Yelp Scraper — Businesses, Reviews — $2.50/1K until 11-24", "description": "Yelp scraper at a launch price: $2.50 per 1,000 businesses until 2026-11-24, then $4.00. US businesses by query and city with rating, review count, categories, price tier, phone, address, coordinates and hours, or reviews by business URL; watch mode delivers only new reviews.", "version": "0.1", "x-build-id": "SmtOg14P8swiWFKSl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/architekture~yelp-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-architekture-yelp-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/architekture~yelp-scraper/runs": { "post": { "operationId": "runs-sync-architekture-yelp-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/architekture~yelp-scraper/run-sync": { "post": { "operationId": "run-sync-architekture-yelp-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": { "mode": { "title": "What to collect", "enum": [ "search", "reviews" ], "type": "string", "description": "search: every query is searched in every location and the organic Yelp results come back as business rows. reviews: each business URL's reviews come back as review rows, newest first.", "default": "search" }, "queries": { "title": "Search queries (search mode)", "maxItems": 50, "type": "array", "description": "What you would type into Yelp's search box, e.g. \"pizza\", \"plumbers\", \"dentist\". Each query is run in each location (at most 50 searches per run).", "items": { "type": "string" } }, "locations": { "title": "Locations (search mode)", "maxItems": 50, "type": "array", "description": "US city and state, ZIP code or neighbourhood, as Yelp accepts it, e.g. \"Austin, TX\" or \"Brooklyn, NY\". US only in this version.", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Businesses per search", "minimum": 1, "maximum": 100, "type": "integer", "description": "Organic results per query and location. Yelp shows 10 per page; more than 10 reads the next pages (one extra page request per 10). Sponsored results are never returned.", "default": 10 }, "businessUrls": { "title": "Business URLs (reviews mode)", "maxItems": 50, "type": "array", "description": "Yelp business pages, e.g. https://www.yelp.com/biz/home-slice-pizza-austin (1 to 50).", "items": { "type": "string" } }, "maxReviewsPerBusiness": { "title": "Reviews per business", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Most recent reviews to collect per business (10 per Yelp page).", "default": 20 }, "sortBy": { "title": "Review order", "enum": [ "newest", "relevance" ], "type": "string", "description": "Watch mode (incrementalMode) stops at the first page of known reviews only with newest first.", "default": "newest" }, "incrementalMode": { "title": "Only new rows (watch mode)", "type": "boolean", "description": "Deliver and charge only businesses or reviews this stateKey has not delivered before. Needs a stateKey.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Any name you choose, reused on every run of the same watch (incrementalMode) or to resume a stopped run without re-charging." }, "feedback": { "title": "Feedback for the maintainers", "type": "string", "description": "Optional note for the maintainers. It is logged and read by a human, and it never changes output." } } }, "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 } } } } } } } } } }