{ "openapi": "3.0.1", "info": { "title": "Yelp Business Scraper - Reviews, Ratings, Hours & Contact Info", "description": "Scrape Yelp business details: name, rating, reviews, price range, categories, address, phone, website, hours, coordinates.", "version": "1.0", "x-build-id": "IgPQVoUHahDUxccvn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thirdwatch~yelp-business-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thirdwatch-yelp-business-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/thirdwatch~yelp-business-scraper/runs": { "post": { "operationId": "runs-sync-thirdwatch-yelp-business-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/thirdwatch~yelp-business-scraper/run-sync": { "post": { "operationId": "run-sync-thirdwatch-yelp-business-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": "Mode", "enum": [ "business", "reviews" ], "type": "string", "description": "`business` (default) scrapes one business-details row per business. `reviews` scrapes individual reviews for each business instead (one row per review). Both modes accept Business URLs and/or Search Queries.", "default": "business" }, "businessUrls": { "title": "Business URLs or Slugs", "type": "array", "description": "List of Yelp business URLs (e.g. 'https://www.yelp.com/biz/gary-danko-san-francisco') or just aliases (e.g. 'gary-danko-san-francisco'). Used by both modes.", "items": { "type": "string", "minLength": 1 }, "default": [ "gary-danko-san-francisco" ] }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "Find businesses by searching Yelp instead of providing URLs. Write the search term followed by the US city, e.g. 'best pizza new york', 'plumber in Austin, TX', 'thai restaurant chicago'. Results follow Yelp's own ranking; sponsored listings are skipped.", "items": { "type": "string", "minLength": 1 }, "default": [] }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of businesses to scrape. In reviews mode this caps how many businesses are visited (reviews per business are capped separately).", "default": 5 }, "maxReviewsPerBusiness": { "title": "Max reviews per business (reviews mode)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Reviews mode only. Maximum reviews to return per business. Yelp serves reviews in pages of 20, so higher values take proportionally longer.", "default": 20 }, "reviewSort": { "title": "Review sort (reviews mode)", "enum": [ "relevance", "newest", "oldest", "highest_rated", "lowest_rated", "elites" ], "type": "string", "description": "Reviews mode only. Order Yelp uses for the review feed.", "default": "relevance" }, "ratings": { "title": "Star ratings filter (reviews mode)", "maxItems": 5, "uniqueItems": true, "type": "array", "description": "Reviews mode only. Keep only reviews with these star ratings, e.g. [1, 2, 3] for complaints or [5] for praise. Leave empty for all ratings. The filter is applied by Yelp, so no extra pages are scanned.", "items": { "type": "integer", "minimum": 1, "maximum": 5 }, "default": [] }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional connection settings. Leave the default for best results.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }