{ "openapi": "3.0.1", "info": { "title": "Yelp Business Details API", "description": "Scrape full Yelp business profiles from business URLs or place IDs - name, rating, reviews, price, categories, phone, address, website, hours, amenities, popular dishes, photos, and review highlights. Optional full menu extraction. Batch many businesses per run.", "version": "0.0", "x-build-id": "pfLTOeL7pAftnTdIp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/johnvc~Yelp-Place-API/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-johnvc-Yelp-Place-API", "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/johnvc~Yelp-Place-API/runs": { "post": { "operationId": "runs-sync-johnvc-Yelp-Place-API", "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/johnvc~Yelp-Place-API/run-sync": { "post": { "operationId": "run-sync-johnvc-Yelp-Place-API", "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": [ "place_ids" ], "properties": { "place_ids": { "title": "Businesses (URL, Place ID, or Alias)", "minItems": 1, "type": "array", "description": "List the Yelp businesses to look up. Each entry can be a full Yelp business URL copied from your browser (e.g. 'https://www.yelp.com/biz/maman-new-york-22'), the encoded place ID (e.g. 'DE0ROwygh-86i4s-WLp8wQ'), or the human-readable alias (e.g. 'maman-new-york-22'). You can mix all three in one list. IDs and aliases appear in the place_ids array of every Yelp Search API result. One business profile is returned per entry.", "items": { "type": "string" } }, "full_menu": { "title": "Fetch Full Menu", "type": "boolean", "description": "Set true to scrape the business full menu (sections, dishes, descriptions, prices) instead of the standard profile. If a business has no menu page, the standard profile is returned instead and flagged in the output. Defaults to false.", "default": false }, "menu_name": { "title": "Menu Name", "type": "string", "description": "Choose which menu to scrape when a business offers more than one (e.g. 'Dinner Menu'). Only used together with Fetch Full Menu. Optional." }, "business_alert": { "title": "Include Business Alert", "type": "boolean", "description": "Set true to include the business alert message when present (e.g. 'Yelpers report this location has closed.'). Defaults to false.", "default": false }, "yelp_domain": { "title": "Yelp Domain", "type": "string", "description": "Choose which regional Yelp domain to look the businesses up on. 41 domains are supported, e.g. 'www.yelp.com' (US), 'www.yelp.ca' (Canada), 'www.yelp.co.uk' (UK), 'www.yelp.fr' (France), 'www.yelp.de' (Germany), 'www.yelp.com.au' (Australia), 'www.yelp.co.jp' (Japan). Multilingual countries use a language prefix instead of 'www', e.g. 'fr.yelp.ca' for French Canada or 'zh.yelp.com.hk' for Hong Kong. A short form like 'yelp.co.uk' is accepted and expanded for you. Any entry you paste as a regional Yelp URL sets its own domain automatically and overrides this field, because a business alias only exists on its own regional domain. Optional - defaults to www.yelp.com. The full list is in the README." } } }, "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 } } } } } } } } } }