Pricing
from $8.00 / 1,000 results
Collect Yelp business listings, reviews, menus, and IDs by search, category, or URL. Clean JSON output for lead gen, CRM, and local SEO.
Pricing
from $8.00 / 1,000 results
Rating
0.0
(0)
Developer
Sachin Kumar Yadav
Actor stats
0
Bookmarked
4
Total users
2
Monthly active users
8 days ago
Last modified
Categories
Share
You can access the Yelp.com Scraper Pro programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "0.0", "x-build-id": "xsqGIv2V9hNmnC9Sx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/igview-owner~yelp-business-data-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-igview-owner-yelp-business-data-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/igview-owner~yelp-business-data-scraper/runs": { "post": { "operationId": "runs-sync-igview-owner-yelp-business-data-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/igview-owner~yelp-business-data-scraper/run-sync": { "post": { "operationId": "run-sync-igview-owner-yelp-business-data-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": { "search_enabled": { "title": "🔍 Search Businesses", "type": "boolean", "description": "Enable Yelp business search.", "default": false }, "search_location": { "title": "📍 Search · Location", "type": "string", "description": "Enter exact locations. For example, use Roosevelt, NY not Roosevelt only.", "default": "" }, "search_term": { "title": "🔎 Search · Term", "type": "string", "description": "Keyword or phrase to search for (e.g., restaurants, Coffee shop, Pizza shop, electrician, etc).", "default": "" }, "search_limit": { "title": "📊 Search · Limit", "type": "integer", "description": "Maximum number of results to return.", "default": 50 }, "search_offset": { "title": "➡️ Search · Offset", "type": "integer", "description": "Pagination offset for result list.", "default": 0 }, "search_business_details_type": { "title": "📋 Search · Details type", "type": "string", "description": "Level of business details to include (e.g., basic).", "default": "basic" }, "category_search_enabled": { "title": "🏷️ Search by Category", "type": "boolean", "description": "Enable Yelp category-based search.", "default": false }, "category_location": { "title": "📍 Category · Location", "type": "string", "description": "Enter exact locations. For example, use Roosevelt, NY not Roosevelt only.", "default": "" }, "category_search_category": { "title": "🏷️ Category · Name", "type": "string", "description": "Yelp category to search (e.g., Vacation Rental Agents).", "default": "" }, "category_limit": { "title": "📊 Category · Limit", "type": "integer", "description": "Maximum number of results to return.", "default": 50 }, "category_offset": { "title": "➡️ Category · Offset", "type": "integer", "description": "Pagination offset for result list.", "default": 0 }, "category_business_details_type": { "title": "📋 Category · Details type", "type": "string", "description": "Level of business details to include (e.g., basic).", "default": "basic" }, "each_enabled": { "title": "📋 Business Details (each)", "type": "boolean", "description": "Enable detailed business fetch by Yelp business URL.", "default": false }, "each_business_urls": { "title": "🔗 Business URLs", "type": "array", "description": "Yelp business page URLs to fetch.", "items": { "type": "string" }, "default": [ "https://www.yelp.com/biz/pizza-paradise-new-york" ] }, "reviews_enabled": { "title": "⭐ Reviews", "type": "boolean", "description": "Enable fetching business reviews.", "default": false }, "reviews_business_url": { "title": "🔗 Reviews · Business URL", "type": "string", "description": "Full Yelp business page URL (optional if business_id provided).", "default": "" }, "reviews_business_id": { "title": "🆔 Reviews · Business ID", "type": "string", "description": "Yelp business ID (optional if business_url provided).", "default": "" }, "reviews_per_page": { "title": "📄 Reviews · Per page", "type": "integer", "description": "Number of reviews to return per page.", "default": 20 }, "reviews_sort_by": { "title": "🔀 Reviews · Sort by", "enum": [ "Yelp_sort", "Newest_first", "Oldest_first", "Highest_rated", "Lowest_rated", "Elites" ], "type": "string", "description": "Sorting strategy for reviews.", "default": "Yelp_sort" }, "reviews_rating_filter": { "title": "⭐ Reviews · Rating filter", "enum": [ "All_ratings", "5_stars", "4_stars", "3_stars", "2_stars", "1_stars" ], "type": "string", "description": "Filter for review ratings.", "default": "All_ratings" }, "menus_enabled": { "title": "🍽️ Menus", "type": "boolean", "description": "Enable fetching menus by business ID.", "default": false }, "menus_business_ids": { "title": "🆔 Menu · Business IDs", "type": "array", "description": "Business IDs to fetch menus for.", "items": { "type": "string" }, "default": [] }, "popular_dish_enabled": { "title": "🔥 Popular Dishes", "type": "boolean", "description": "Enable fetching popular dishes by business ID.", "default": false }, "popular_dish_business_ids": { "title": "🆔 Popular Dish · Business IDs", "type": "array", "description": "Business IDs to fetch popular dishes for.", "items": { "type": "string" }, "default": [] }, "biz_url2id_enabled": { "title": "🔗 Business URL to ID", "type": "boolean", "description": "Enable converting Yelp business URL to business ID.", "default": false }, "biz_url2id_urls": { "title": "🔗 Biz URL · URLs", "type": "array", "description": "Yelp business URLs to convert to ID.", "items": { "type": "string" }, "default": [ "https://www.yelp.com/biz/joes-coffee-san-francisco" ] } } }, "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 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Yelp.com Scraper Pro from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: