{ "openapi": "3.0.1", "info": { "title": "Yelp Business Profile, Hours & Menu Extractor", "description": "Search Yelp or fetch specific business URLs for profile data, hours, services, photo galleries, owner replies, coordinates, and reviews with reaction counts.", "version": "2.0", "x-build-id": "7mYG1lPFI7rSncbGE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataspryva~yelp-business-profile-hours-and-menu-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataspryva-yelp-business-profile-hours-and-menu-extractor", "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/dataspryva~yelp-business-profile-hours-and-menu-extractor/runs": { "post": { "operationId": "runs-sync-dataspryva-yelp-business-profile-hours-and-menu-extractor", "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/dataspryva~yelp-business-profile-hours-and-menu-extractor/run-sync": { "post": { "operationId": "run-sync-dataspryva-yelp-business-profile-hours-and-menu-extractor", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "direct" ], "type": "string", "description": "Search Yelp by keyword and location, or look up specific business URLs, aliases, or 22-character business IDs.", "default": "search" }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Keywords to search for in mode=search, for example 'pizza', 'plumber', or 'coffee shop'. Each query is combined with each location.", "default": [], "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Cities, neighborhoods, or ZIP codes to search in mode=search, for example 'New York, NY' or '10012'.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "In mode=search, paste Yelp search URLs. In mode=direct, paste business URLs, aliases, or 22-character business IDs.", "default": [], "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Optional Yelp category aliases or names used to narrow search results, for example 'pizza', 'coffee', or 'home_services'.", "default": [], "items": { "type": "string" } }, "sortBy": { "title": "Search result order", "enum": [ "recommended", "rating", "reviewCount" ], "type": "string", "description": "Ordering for mode=search result pages.", "default": "recommended" }, "price": { "title": "Price levels", "type": "array", "description": "Optional price levels for mode=search. Leave empty for every price level.", "items": { "type": "string", "enum": [ "$", "$$", "$$$", "$$$$" ] }, "default": [] }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Drop businesses rated below this value. Set to 0 to keep every rating.", "default": 0 }, "maxItems": { "title": "Maximum businesses", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on business records in the dataset. Search is limited to Yelp's 240-result ceiling per query.", "default": 50 }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Turn off to collect only business profiles, hours, and menus and skip the review feed.", "default": true }, "maxReviewsPerBusiness": { "title": "Reviews per business", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum reviews collected for each business. Reviews are paged 49 at a time from Yelp's public review feed.", "default": 20 }, "reviewSort": { "title": "Review order", "enum": [ "DATE_DESC", "DATE_ASC", "RATING_DESC", "RATING_ASC", "RELEVANCE_DESC", "ELITES_DESC" ], "type": "string", "description": "Ordering applied to each business's review feed.", "default": "DATE_DESC" }, "reviewRatings": { "title": "Review star ratings", "type": "array", "description": "Only collect reviews with these star ratings. Choose one or more values.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ] }, "default": [ "5", "4", "3", "2", "1" ] }, "reviewLanguage": { "title": "Review language", "enum": [ "all", "en", "es", "fr", "de", "it", "pt", "nl", "sv", "da", "no", "fi", "pl", "cs", "el", "tr", "ru", "uk", "he", "ar", "hi", "bn", "ta", "th", "vi", "id", "ms", "tl", "zh", "ja", "ko" ], "type": "string", "description": "Language for the review feed. Choose 'all' to page through every language Yelp reports for the business.", "default": "en" }, "includeMenu": { "title": "Extract menus", "type": "boolean", "description": "Fetch the public menu page for restaurants and extract sections, dishes, descriptions, and prices.", "default": true }, "includeHours": { "title": "Extract hours", "type": "boolean", "description": "Include weekly opening hours in each business record.", "default": true }, "maxPhotos": { "title": "Photos per business", "minimum": 0, "maximum": 100, "type": "integer", "description": "Maximum gallery photos per business (0-100). Set to 0 to skip photos.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. The actor automatically uses Apify Proxy when Yelp blocks a request; add a country or custom proxy here only when you need a specific route." } } }, "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 } } } } } } } } } }