{ "openapi": "3.0.1", "info": { "title": "Yelp Reviews Scraper", "description": "Export Yelp reviews with star rating, full text, date, language, photos, reactions and reviewer name, location and review count. Paste Yelp links or aliases, scrape many businesses in one run, sort by newest or lowest and filter by star rating.", "version": "1.0", "x-build-id": "58ajJNBduu1XJy7YD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thescrappa~yelp-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thescrappa-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/thescrappa~yelp-reviews-scraper/runs": { "post": { "operationId": "runs-sync-thescrappa-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/thescrappa~yelp-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-thescrappa-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": [ "businesses" ], "properties": { "businesses": { "title": "Businesses", "minItems": 1, "maxItems": 100, "type": "array", "description": "Yelp businesses to scrape, one per entry. Paste the Yelp link, the alias or the business ID. Each entry can set its own sort order and star rating filter.", "items": { "type": "object", "required": [ "business" ], "properties": { "business": { "title": "Business alias, ID or Yelp link", "type": "string", "minLength": 1, "maxLength": 500, "description": "Yelp business alias such as gary-danko-san-francisco, the 22-character business ID, or the yelp.com/biz link. The Actor reads the alias after /biz/ in the link.", "editor": "textfield" }, "sort": { "title": "Sort order", "type": "string", "enum": [ "relevance", "newest", "oldest", "highest", "lowest", "elite" ], "enumTitles": [ "Most relevant (Yelp default)", "Newest first", "Oldest first", "Highest rated first", "Lowest rated first", "Elite reviewers first" ], "description": "Order of the reviews. Leave empty for the Yelp default order (most relevant).", "editor": "select" }, "rating": { "title": "Star rating", "type": "integer", "minimum": 1, "maximum": 5, "description": "Only reviews with exactly this star rating, from 1 to 5. Leave empty for all ratings.", "editor": "number" } } } }, "sort": { "title": "Sort order", "enum": [ "relevance", "newest", "oldest", "highest", "lowest", "elite" ], "type": "string", "description": "Order of the reviews. Leave empty for the Yelp default order (most relevant)." }, "rating": { "title": "Star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only reviews with exactly this star rating, from 1 to 5. Leave empty for all ratings." }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum reviews to save for each business. Yelp returns 10 reviews per page.", "default": 100 }, "maxPages": { "title": "Maximum Pages", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum pages to request for each batch entry.", "default": 200 } } }, "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 } } } } } } } } } }