{ "openapi": "3.0.1", "info": { "title": "Yelp Business Scraper - Most Comprehensive", "description": "🔥 ~$0.5/1K places 🔥 Look up any Yelp business by URL or alias. Returns comprehensive business data including categories, hours, location, photos, attributes, and more. Optionally fetches all reviews inline.", "version": "0.1", "x-build-id": "TWqQ4eoT9Zb0PUZTc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kaix~yelp-business-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kaix-yelp-business-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/kaix~yelp-business-scraper/runs": { "post": { "operationId": "runs-sync-kaix-yelp-business-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/kaix~yelp-business-scraper/run-sync": { "post": { "operationId": "run-sync-kaix-yelp-business-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": { "businesses": { "title": "Business URLs or Aliases", "type": "array", "description": "Yelp business page URLs (e.g. https://www.yelp.com/biz/gary-danko-san-francisco) or aliases (e.g. gary-danko-san-francisco). Leave empty when using Search mode.", "items": { "type": "string" } }, "searchTerm": { "title": "Search Term", "type": "string", "description": "Search keyword (e.g. 'pizza', 'dentist', 'plumber'). Use this instead of Business URLs to discover businesses." }, "location": { "title": "Location", "type": "string", "description": "Location to search in. Accepts city names, zip codes, addresses, neighborhoods (e.g. 'San Francisco, CA', '10001', 'Mission District')." }, "latitude": { "title": "Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "Search by GPS coordinates instead of location text. Must be used with Longitude." }, "longitude": { "title": "Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "Search by GPS coordinates instead of location text. Must be used with Latitude." }, "category": { "title": "Category Filter", "type": "string", "description": "Category alias to filter search results (e.g. 'restaurants', 'dentists', 'plumbers')." }, "maxSearchResults": { "title": "Max Search Results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of businesses to discover from search.", "default": 20 }, "searchSort": { "title": "Search Sort", "enum": [ "default", "distance", "rating", "review_count" ], "type": "string", "description": "How to sort search results.", "default": "default" }, "searchRadius": { "title": "Search Radius (meters)", "minimum": 0, "type": "number", "description": "Limit search to businesses within this radius in meters (e.g. 5000 = 5km)." }, "includeReviews": { "title": "Include Reviews", "type": "boolean", "description": "Fetch and embed reviews inline in each business record. Each review is charged separately.", "default": false }, "maxReviewsPerBusiness": { "title": "Max Reviews Per Business", "minimum": 0, "type": "integer", "description": "Maximum number of reviews per business. Set to 0 for no limit.", "default": 20 }, "sortBy": { "title": "Sort Reviews By", "enum": [ "DATE_DESC", "DATE_ASC", "RATING_DESC", "RATING_ASC", "ELITES_DESC" ], "type": "string", "description": "How to sort reviews.", "default": "DATE_DESC" }, "ratings": { "title": "Filter by Rating", "uniqueItems": true, "type": "array", "description": "Only include reviews with these star ratings.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] }, "default": [ "1", "2", "3", "4", "5" ] }, "query": { "title": "Review Search Query", "type": "string", "description": "Search within reviews for specific keywords.", "default": "" }, "languageCode": { "title": "Review Language", "type": "string", "description": "Language code for reviews (e.g. en, zh, de).", "default": "en" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Select proxies to be used. Residential proxies provide more complete data." } } }, "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 } } } } } } } } } }