{ "openapi": "3.0.1", "info": { "title": "Yelp Scraper", "description": "Scrape Yelp search results and business pages: names, ratings, reviews, phone, website, address, hours and coordinates. Export to CSV, Excel, JSON or XML.", "version": "0.1", "x-build-id": "ufqfJAQAyZR3Zw4fd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~yelp-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-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/parseforge~yelp-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-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/parseforge~yelp-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-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", "properties": { "searchTerms": { "title": "Search terms", "type": "array", "description": "What to search for, exactly as you would type it on Yelp (for example plumbers, sushi, dentist). Each term is searched in every location below. Leave empty to list all businesses in a location.", "items": { "type": "string" } }, "locationQueries": { "title": "Locations", "type": "array", "description": "Where to search: a city and state, a ZIP code, a neighborhood or an address (for example Austin, TX or 94103). Works for every country Yelp covers.", "items": { "type": "string" } }, "startUrls": { "title": "Yelp URLs", "type": "array", "description": "Optional. Yelp search URLs (www.yelp.com/search?...) keep all their filters. Yelp business URLs (www.yelp.com/biz/...) always return the full business record, so each one is billed as a result plus business details.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" }, "sortBy": { "title": "Sort by", "enum": [ "recommended", "rating", "review_count" ], "type": "string", "description": "Order of search results, as on Yelp.", "default": "recommended" }, "priceLevels": { "title": "Price levels", "type": "array", "description": "Only return businesses in these price levels. Leave empty for all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4" ], "enumTitles": [ "$", "$$", "$$$", "$$$$" ] }, "default": [] }, "openNow": { "title": "Open now", "type": "boolean", "description": "Only return businesses that are open at the time of the run.", "default": false }, "includeSponsored": { "title": "Include sponsored results", "type": "boolean", "description": "Yelp mixes paid ads into search pages. Off by default so you only get organic results.", "default": false }, "includeDetails": { "title": "Add business details (phone, website, full address, coordinates)", "type": "boolean", "description": "Opens each business page to add phone, website, menu link, state, ZIP, country, latitude and longitude, service areas, claimed status, year established, amenities, photos and the business description. Billed as an extra business-details event per business.", "default": false }, "includeReviews": { "title": "Add reviews", "type": "boolean", "description": "Attach the business's English reviews (text, rating, date, author, reactions, photos) to each row. Billed per review returned.", "default": false }, "maxReviewsPerBusiness": { "title": "Max reviews per business", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many reviews to attach to each business when reviews are on. Yelp serves 10 per page.", "default": 10 }, "reviewsSort": { "title": "Review order", "enum": [ "RELEVANCE_DESC", "DATE_DESC", "DATE_ASC", "RATING_DESC", "RATING_ASC", "ELITES_DESC" ], "type": "string", "description": "Which reviews come first when reviews are on.", "default": "RELEVANCE_DESC" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed in normal use. Turn it on only if you see blocked requests in the log.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }