{ "openapi": "3.0.1", "info": { "title": "Yelp Reviews Scraper | $3/1K | Real-Time (No Cache)", "description": "Scrape Yelp business reviews in real-time — reviewer, rating, text, date. Up to ~20-30 recent reviews per business.", "version": "1.0", "x-build-id": "yrQNkVBZXrGDd5gZs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apivault_labs~yelp-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apivault_labs-yelp-reviews-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/apivault_labs~yelp-reviews-scraper/runs": { "post": { "operationId": "runs-sync-apivault_labs-yelp-reviews-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/apivault_labs~yelp-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-apivault_labs-yelp-reviews-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", "required": [ "businessUrls" ], "properties": { "businessUrls": { "title": "Yelp Business URLs", "type": "array", "description": "List of Yelp business page URLs (e.g. https://www.yelp.com/biz/tartine-bakery-san-francisco)", "items": { "type": "string" } }, "maxPages": { "title": "Pages per business", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many review pages to attempt per business (each ~10 reviews). Recommended: 2-3. Yelp caps most businesses around 20-30 recent reviews.", "default": 3 }, "sortBy": { "title": "Sort reviews by", "enum": [ "date_desc", "date_asc", "rating_desc", "rating_asc", "elites_desc" ], "type": "string", "description": "Which review order to request", "default": "date_desc" }, "extractReviewer": { "title": "Reviewer Name", "type": "boolean", "description": "Extract reviewer display name", "default": true }, "extractReviewerLocation": { "title": "Reviewer Location", "type": "boolean", "description": "Extract reviewer city / location", "default": true }, "extractReviewerStats": { "title": "Reviewer Stats (friends, reviews count)", "type": "boolean", "description": "How many friends and reviews the author has on Yelp", "default": true }, "extractRating": { "title": "Rating", "type": "boolean", "description": "Extract star rating 1-5", "default": true }, "extractDate": { "title": "Review Date", "type": "boolean", "description": "Extract review date", "default": true }, "extractText": { "title": "Review Text", "type": "boolean", "description": "Extract review body text", "default": true }, "extractPhotosCount": { "title": "Review Photos Count", "type": "boolean", "description": "How many photos are attached to the review", "default": true }, "extractReactions": { "title": "Useful / Funny / Cool counts", "type": "boolean", "description": "Extract Useful / Funny / Cool reaction counts", "default": true }, "extractBusinessName": { "title": "Business Name", "type": "boolean", "description": "Include business slug on each review row", "default": true }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 4, "type": "integer", "description": "Parallel page scrapes (recommended: 2)", "default": 2 }, "timeout": { "title": "Timeout per page (seconds)", "minimum": 60, "maximum": 300, "type": "integer", "description": "Max wait time per Yelp page", "default": 180 } } }, "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 } } } } } } } } } }