{ "openapi": "3.0.1", "info": { "title": "Yelp Scraper - Local Business Data, Hours & Contacts", "description": "Scrape Yelp local businesses by city and category: name, address, phone, website, opening hours, categories, price tier, rating and review count. No login. Export CSV/JSON.", "version": "1.0", "x-build-id": "KlTBQeujLGbzTZgLL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/webdatalabs~yelp-business-scraper-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-webdatalabs-yelp-business-scraper-pro", "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/webdatalabs~yelp-business-scraper-pro/runs": { "post": { "operationId": "runs-sync-webdatalabs-yelp-business-scraper-pro", "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/webdatalabs~yelp-business-scraper-pro/run-sync": { "post": { "operationId": "run-sync-webdatalabs-yelp-business-scraper-pro", "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": { "location": { "title": "Location", "type": "string", "description": "City, state or ZIP code to search in. Example: \"Austin, TX\" or \"78702\"." }, "searchTerms": { "title": "Search terms", "type": "array", "description": "What to search for. Each term runs as its own query. Yelp stops paginating a single query at roughly 60 results, so use several specific terms (\"Pizza\", \"Sushi\", \"Coffee\") rather than one broad one to cover a city.", "default": [ "Restaurants" ], "items": { "type": "string" } }, "maxResults": { "title": "Maximum businesses", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many businesses across all search terms. Note that Yelp serves only ~60 per search term, so raising this alone will not return more - add more search terms.", "default": 100 }, "enrichDetails": { "title": "Fetch full business details", "type": "boolean", "description": "Visit each business page to add address, phone, website and opening hours. Turn off for a faster, cheaper run that returns only what the search page shows (name, rating, review count, price tier, categories).", "default": true }, "startUrls": { "title": "Yelp business URLs", "type": "array", "description": "Optional. Paste specific Yelp business URLs to scrape them directly instead of searching.", "default": [], "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "US residential proxy is required. Yelp limits by IP reputation and will refuse datacenter traffic.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "cacheMaxAgeDays": { "title": "Reuse cached details", "minimum": 0, "maximum": 90, "type": "integer", "description": "Reuse a business's address, phone, website and hours from a previous run of yours if they were fetched within this many days, instead of downloading the page again. Makes repeat sweeps of the same area much cheaper. Set to 0 to always fetch fresh. Every row reports its own 'detailFetchedAt' so you can see how fresh it is.", "default": 7 }, "detailConcurrency": { "title": "Business pages fetched at once", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many business detail pages to fetch in parallel. Each one uses its own IP, so the request rate per IP stays the same however high this is. Lower it only if you see a lot of refused requests.", "default": 5 }, "minDelayMs": { "title": "Delay between requests", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Minimum pause between requests. Lower values are faster but get refused more often, which costs more proxy traffic than it saves in time.", "default": 2500 }, "maxRetries": { "title": "Maximum retries", "minimum": 1, "maximum": 12, "type": "integer", "description": "How many times to retry a refused request on a fresh IP.", "default": 6 }, "debug": { "title": "Verbose logging", "type": "boolean", "description": "Log every request outcome. Use when reporting a problem.", "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 } } }, "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 } } } } } } } } } }