{
"openapi": "3.0.1",
"info": {
"title": "Yelp Scraper",
"description": "Effortlessly extract business names, addresses, phone numbers, ratings, and reviews from Yelp. No Yelp API is required! Analyze customer sentiment, track competitors, or gather market research data. Scrape by location or keywords. Export data (CSV, JSON, HTML) and automate scraping.",
"version": "1.0",
"x-build-id": "nod0AAZLwzjEWwFhG"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/eunit~yelp-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-eunit-yelp-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/eunit~yelp-scraper/runs": {
"post": {
"operationId": "runs-sync-eunit-yelp-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/eunit~yelp-scraper/run-sync": {
"post": {
"operationId": "run-sync-eunit-yelp-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": [
"proxy"
],
"properties": {
"searchTerms": {
"title": "Search terms",
"type": "array",
"description": "Here you can provide a search queries for Yelp bussinesses to scrape.
Choose either of 'Search Terms' or 'Direct URLs'.",
"items": {
"type": "string"
}
},
"locations": {
"title": "Locations",
"type": "array",
"description": "Locations that will be searched for each search term.",
"items": {
"type": "string"
}
},
"searchLimit": {
"title": "Search results limit",
"minimum": 1,
"maximum": 999999,
"type": "integer",
"description": "How many search results (eq. Yelp bussinesses) should be processed per search query"
},
"directUrls": {
"title": "Direct Yelp page URLs instead of search",
"uniqueItems": true,
"type": "array",
"description": "If you already have URL(s) of page(s) you wish to scrape, you can set them here.
Either of 'Search' or 'Direct URLs' or both fields.",
"default": [],
"items": {
"type": "string"
}
},
"maxImages": {
"title": "Max images",
"minimum": 0,
"type": "integer",
"description": "Maximum number of images per business"
},
"reviewLimit": {
"title": "Maximum reviews",
"minimum": 0,
"maximum": 999999,
"type": "integer",
"description": "How many reviews should be scraped per business"
},
"scrapeReviewerName": {
"title": "Reviewer name",
"type": "boolean",
"description": "Extract Reviewer name",
"default": false
},
"scrapeReviewerUrl": {
"title": "Reviewer URL",
"type": "boolean",
"description": "Extract Reviewer URL",
"default": false
},
"proxy": {
"title": "Proxy configuration",
"type": "object",
"description": "Proxy is required to run this actor! Either use Apify proxy, or provide your own proxy servers.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
},
"maxRequestRetries": {
"title": "Max page retries",
"minimum": 0,
"maximum": 100,
"type": "integer",
"description": "How many times a failed request is retried before thrown away. Requests usually failed when blocked by the target site.",
"default": 10
}
}
},
"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
}
}
}
}
}
}
}
}
}
}