{ "openapi": "3.0.1", "info": { "title": "Yelp Reviews Scraper: Reviews, Ratings and Owner Replies", "description": "Scrape Yelp reviews by business link, alias or name and city: text, stars, date, reviewer, photos and the owner reply, newest first, with star and date filters. Plus one row per business with rating, review count, stars breakdown, categories and address. No login, no browser.", "version": "0.1", "x-build-id": "JUTCfLUg2CQIlmuG7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/themineworks~yelp-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-themineworks-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/themineworks~yelp-reviews-scraper/runs": { "post": { "operationId": "runs-sync-themineworks-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/themineworks~yelp-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-themineworks-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", "properties": { "businessUrls": { "title": "Yelp business links, aliases or ids", "type": "array", "description": "One per line. A link such as https://www.yelp.com/biz/prince-street-pizza-new-york-2 (any Yelp country site, the mobile site and links to a review or the menu work too), the alias prince-street-pizza-new-york-2, or the 22 character business id zj8Lq1T8KIC5zwFief15jg. Up to 2,000 businesses per run.", "items": { "type": "string" } }, "businessNames": { "title": "Business names with city (optional)", "type": "array", "description": "One per line: the business name, a comma, then the city, for example Katz's Delicatessen, New York, NY or Franklin Barbecue, Austin, TX. Yelp's own business suggestions are used and the closest name is taken; name_match_score on the row says how close it was. A name with no close match gets an error row with the candidates Yelp offered.", "items": { "type": "string" } }, "maxReviewsPerBusiness": { "title": "Max reviews per business", "minimum": 0, "maximum": 10000, "type": "integer", "description": "The most reviews to return for each business, 0 to 10,000. 0 returns the profile row only (rating, review count, count per star, categories, address). Example: 100.", "default": 20 }, "sortBy": { "title": "Review order", "enum": [ "newest", "oldest", "relevance", "highest", "lowest" ], "type": "string", "description": "The order Yelp returns reviews in. Newest first is the default and the one to use for monitoring.", "default": "newest" }, "reviewsNewerThan": { "title": "Only reviews on or after (optional)", "type": "string", "description": "A date such as 2026-09-01. Reviews are read newest first and the business stops at the first older review, so a weekly run fetches only the new ones. When set, Review order is newest first." }, "starRatings": { "title": "Star ratings to include (optional)", "type": "array", "description": "Leave empty for all reviews. Pick 1 and 2 to collect only negative reviews, for example. The filter runs on Yelp's side, so you only pay for matching reviews.", "items": { "type": "string", "enum": [ "5", "4", "3", "2", "1" ], "enumTitles": [ "5 stars", "4 stars", "3 stars", "2 stars", "1 star" ] } }, "reviewLanguage": { "title": "Review language", "type": "string", "description": "all (default) reads English reviews first, then each other language the business has, from most to fewest reviews. A two letter code such as en, es, fr or de reads that language only.", "default": "all" } } }, "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 } } } } } } } } } }