{ "openapi": "3.0.1", "info": { "title": "Yelp Reviews Scraper — UK & Czech Pages", "description": "Export full public Yelp reviews with stars, dates, public authors, photos and owner replies. Supports accessible UK/Czech business pages, pagination and language/date filters, with explicit regional limits and source diagnostics. Independent tool.", "version": "0.6", "x-build-id": "ZyG48jCpkzbeyXQtk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/peerless_columbine~yelp-public-reviews-independent/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-peerless_columbine-yelp-public-reviews-independent", "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/peerless_columbine~yelp-public-reviews-independent/runs": { "post": { "operationId": "runs-sync-peerless_columbine-yelp-public-reviews-independent", "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/peerless_columbine~yelp-public-reviews-independent/run-sync": { "post": { "operationId": "run-sync-peerless_columbine-yelp-public-reviews-independent", "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": [ "startUrls" ], "properties": { "startUrls": { "title": "Start URLs", "minItems": 1, "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Provide Yelp business URLs, e.g., https://www.yelp.com/biz/bar-54-new-york-2.", "items": { "type": "object", "properties": { "url": { "type": "string", "title": "Business URL", "description": "Direct public HTTPS Yelp business URL." }, "userData": { "type": "object", "title": "Request user data", "description": "Optional request metadata; ignored by the collector." }, "method": { "type": "string", "title": "Request method", "description": "Only GET is accepted; omitted values default to GET.", "pattern": "^GET$" } }, "required": [ "url" ], "additionalProperties": false } }, "maxReviewsPerUrl": { "title": "Max reviews per business.", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Set the maximum number of reviews to extract for each business." }, "language": { "title": "Language", "enum": [ "", "en", "es", "fr", "de", "it", "nl", "pt", "ru", "ja", "zh", "zh_TW", "ko", "tr", "ar", "da", "fi", "no", "sv", "he", "th", "pl", "cs", "hu", "el" ], "type": "string", "description": "Select the language of the reviews.", "default": "" }, "dateFrom": { "title": "Start Date", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Select the starting date in format YYYY-MM-DD. Only reviews created on or after this date will be included." }, "dateTo": { "title": "End Date", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Select the end date in format YYYY-MM-DD. Only reviews created on or before this date will be included." }, "sort": { "title": "Review sort", "enum": [ "newest", "oldest", "recommended", "highest_rating", "lowest_rating" ], "type": "string", "description": "Applied at the public source, verified per language; merges all-language chronological/rating streams. Recommended across languages has no global ranking guarantee.", "default": "newest" }, "ratings": { "title": "Star filter", "type": "array", "description": "Only these star ratings; enforced on source and returned rows.", "items": { "type": "integer", "minimum": 1, "maximum": 5 }, "default": [] }, "keyword": { "title": "Literal text filter", "maxLength": 200, "type": "string", "description": "Case-insensitive literal substring filter on complete review text; pagination continues through nonmatching pages.", "default": "" }, "includePersonalData": { "title": "Public reviewer fields", "type": "boolean", "description": "Matches primary contract default. False nulls reviewer name, profile URL, location and count. Never infers sensitive attributes.", "default": true }, "maxPagesPerBusiness": { "title": "Page safety limit", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Finite resource bound. Hitting page/time bounds is reported as incomplete.", "default": 100 }, "maxConcurrency": { "title": "Concurrent businesses", "minimum": 1, "maximum": 4, "type": "integer", "description": "Finite resource bound. Hitting page/time bounds is reported as incomplete.", "default": 2 }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 3, "maximum": 20, "type": "integer", "description": "Finite resource bound. Hitting page/time bounds is reported as incomplete.", "default": 15 }, "maxRetries": { "title": "Transient retries", "minimum": 0, "maximum": 2, "type": "integer", "description": "Finite resource bound. Hitting page/time bounds is reported as incomplete.", "default": 1 }, "runTimeoutSecs": { "title": "Internal time limit", "minimum": 10, "maximum": 105, "type": "integer", "description": "Finite resource bound. Hitting page/time bounds is reported as incomplete.", "default": 100 }, "dnsResolver": { "title": "DNS resolver", "enum": [ "system", "google-doh" ], "type": "string", "description": "Explicit google-doh local mode uses fixed public DNS with TLS and public IP validation. System DNS is the cloud default.", "default": "system" }, "useProxy": { "title": "Use your own proxy configuration", "type": "boolean", "description": "Disabled by default. Configuration errors fail explicitly. Proxy traffic can cost money; no paid proxy was used in this validation.", "default": false }, "proxyConfiguration": { "title": "User proxy configuration", "type": "object", "description": "Requires useProxy=true. Supports your Apify proxy groups/country or custom proxyUrls. Do not paste secrets into logs." }, "includePreviousReviews": { "title": "Include source-attached previous reviews", "type": "boolean", "description": "Adds nested versions returned with each accepted parent review. Default off. Parent filters/order/cap and row billing are unchanged. Missing/null/empty source history are distinguished; complete history is not guaranteed.", "default": false }, "reviews_translate": { "title": "Translate reviews", "enum": [ "", "en", "es", "fr", "de", "it", "nl", "pt", "ru", "ja", "zh", "zh_TW", "ko", "tr", "ar", "da", "fi", "no", "sv", "he", "th", "pl", "cs", "hu", "el" ], "type": "string", "description": "Optional target language for Yelp source-provided translations. Empty preserves default output and original text. English translations from French source reviews are verified; unavailable translations are null.", "default": "" }, "reviewSource": { "title": "Review source", "enum": [ "recommended", "not-recommended" ], "type": "string", "description": "Recommended keeps the existing feed. Not-recommended uses explicit UK archive SSR: language must be empty, sort lowest_rating, no translation or previous versions; reviewer fields always suppressed.", "default": "recommended" } } }, "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 } } } } } } } } } }