{
"openapi": "3.0.1",
"info": {
"title": "Yelp Reviews Scraper - All Languages & Owner Replies",
"description": "Extract every Yelp review in every language: star rating, full text, date, reviewer profile, owner reply and photos. Yelp shows one language at a time; this returns all of them. Free business summary with the 1-5 star breakdown, categories and location. Export to JSON, CSV or Excel.",
"version": "0.0",
"x-build-id": "88zGh5anPTYlDHddY"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/clearpath~yelp-reviews-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-clearpath-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/clearpath~yelp-reviews-scraper/runs": {
"post": {
"operationId": "runs-sync-clearpath-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/clearpath~yelp-reviews-scraper/run-sync": {
"post": {
"operationId": "run-sync-clearpath-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",
"maxItems": 200,
"type": "array",
"description": "Yelp business links, or just business names. One per line.
Link — https://www.yelp.com/biz/hotel-zetta-san-francisco-san-francisco-3. Any Yelp country domain works.
Name — Hotel Zetta San Francisco, matched to the closest business (add a Search location below to keep it in the right city).",
"items": {
"type": "string"
}
},
"searchLocation": {
"title": "Search location",
"type": "string",
"description": "City or area used when you enter business names instead of links. Ignored for links."
},
"maxReviewsPerBusiness": {
"title": "Max reviews per business",
"minimum": 1,
"maximum": 50000,
"type": "integer",
"description": "Stop after this many reviews per business. Clear the field to collect every review, which on a busy restaurant can be thousands."
},
"sortBy": {
"title": "Sort reviews by",
"enum": [
"newest",
"oldest",
"highest_rating",
"lowest_rating",
"most_prolific"
],
"type": "string",
"description": "Which reviews come first. Only matters when you set a maximum.",
"default": "newest"
},
"reviewLanguages": {
"title": "Review languages",
"type": "array",
"description": "Leave empty to collect every language, which is almost always what you want. Yelp shows one language at a time, so a business outside the US usually has most of its reviews in the local language. Pick languages only when the analysis targets one market.",
"items": {
"type": "string",
"enum": [
"en",
"de",
"fr",
"es",
"it",
"nl",
"pt",
"pl",
"tr",
"da",
"sv",
"nb",
"fi",
"cs",
"ja",
"zh",
"ko",
"ru",
"tl",
"ms"
],
"enumTitles": [
"English",
"German",
"French",
"Spanish",
"Italian",
"Dutch",
"Portuguese",
"Polish",
"Turkish",
"Danish",
"Swedish",
"Norwegian",
"Finnish",
"Czech",
"Japanese",
"Chinese",
"Korean",
"Russian",
"Filipino",
"Malay"
]
}
},
"includeFilteredReviews": {
"title": "Also collect hidden reviews (not in the star rating)",
"type": "boolean",
"description": "Yelp keeps some reviews off the main listing, either because its ranking no longer shows them or because it removed them. They do not count towards the star rating, and every row is labelled so you can separate them.",
"default": false
},
"includeSummary": {
"title": "Include business summary",
"type": "boolean",
"description": "Add one summary row per business (rating, review count, language breakdown, categories, address) to a separate summary dataset. It never counts as a review result.",
"default": true
}
}
},
"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
}
}
}
}
}
}
}
}
}
}