{ "openapi": "3.0.1", "info": { "title": "Yelp Business Leads Scraper API (Email, Phone…)", "description": "Yelp email scraper and business leads extractor. Get emails, phone numbers, addresses, ratings, hours and social profiles from any Yelp search, plus reviews. Export to Excel, CSV or JSON.", "version": "0.0", "x-build-id": "VofcecUSBVEgdTH5J" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lurkapi~yelp-business-leads-scraper-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lurkapi-yelp-business-leads-scraper-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/lurkapi~yelp-business-leads-scraper-api/runs": { "post": { "operationId": "runs-sync-lurkapi-yelp-business-leads-scraper-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/lurkapi~yelp-business-leads-scraper-api/run-sync": { "post": { "operationId": "run-sync-lurkapi-yelp-business-leads-scraper-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", "properties": { "searchTerms": { "title": "Search terms", "uniqueItems": true, "type": "array", "description": "Enter business types or keywords, one per line. Every term is searched in every location below.", "items": { "type": "string" } }, "locations": { "title": "Locations", "uniqueItems": true, "type": "array", "description": "Enter cities, regions, postal codes, or countries, one per line.", "items": { "type": "string" } }, "maxBusinessesPerSearch": { "title": "Maximum businesses per search", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Cap the unique businesses returned for each search term and location pair.", "default": 10 }, "targets": { "title": "Yelp URLs, aliases, or business IDs", "uniqueItems": true, "type": "array", "description": "Paste filtered Yelp search URLs, direct business URLs, business aliases, or stable 22-character IDs. Mix formats freely; duplicates are returned and billed once.", "items": { "type": "string" }, "default": [] }, "sortBy": { "title": "Result order", "enum": [ "recommended", "rating", "review_count" ], "type": "string", "description": "Choose Yelp's recommended order, highest-rated ranking, or strict descending review count. A pasted search URL keeps its own sort.", "default": "recommended" }, "minRating": { "title": "Minimum rating", "minimum": 1, "maximum": 5, "type": "number", "description": "Skip businesses below this Yelp rating." }, "minReviewCount": { "title": "Minimum review count", "minimum": 0, "type": "integer", "description": "Skip businesses with fewer Yelp reviews." }, "priceTiers": { "title": "Price tiers", "uniqueItems": true, "type": "array", "description": "Return businesses in any selected Yelp price tier.", "items": { "type": "string", "enum": [ "$", "$$", "$$$", "$$$$" ], "enumTitles": [ "$", "$$", "$$$", "$$$$" ] } }, "categories": { "title": "Categories", "uniqueItems": true, "type": "array", "description": "Keep businesses in any listed Yelp category alias, such as plumbers, dentists, or coffee.", "items": { "type": "string" } }, "neighborhoods": { "title": "Neighborhoods", "uniqueItems": true, "type": "array", "description": "Keep businesses in any listed neighborhood. Matching is case-insensitive.", "items": { "type": "string" } }, "openNow": { "title": "Open now only", "type": "boolean", "description": "Return only businesses Yelp currently marks open.", "default": false }, "hasWebsite": { "title": "Only businesses with a website", "type": "boolean", "description": "Skip businesses without a website listed on Yelp.", "default": false }, "hasPhone": { "title": "Only businesses with a phone", "type": "boolean", "description": "Skip businesses without a phone listed on Yelp.", "default": false }, "includeWebsiteContacts": { "title": "Scrape emails from business websites ($)", "type": "boolean", "description": "Visit each business website to discover public emails, phone numbers, contact pages, and social profiles.", "default": false }, "includeEmailIntelligence": { "title": "Validate discovered emails ($)", "type": "boolean", "description": "Validate discovered email addresses and identify their providers. This automatically enables website contact discovery.", "default": false }, "includeReviews": { "title": "Collect reviews ($)", "type": "boolean", "description": "Save reviews as separate rows for every business matched by the search or direct targets above. Each saved review is billed separately.", "default": false }, "maxReviewsPerBusiness": { "title": "Maximum reviews per business", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Cap the review rows saved for each business.", "default": 10 }, "reviewSort": { "title": "Review order", "enum": [ "newest", "relevant", "highestRated", "lowestRated" ], "type": "string", "description": "Choose how Yelp orders collected reviews.", "default": "newest" }, "reviewRatings": { "title": "Review ratings", "uniqueItems": true, "type": "array", "description": "Return only selected star ratings. Leave empty for every rating.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "reviewDateFrom": { "title": "Reviews from date", "type": "string", "description": "Only save reviews on or after this date." }, "includePersonalData": { "title": "Include public reviewer profile fields", "type": "boolean", "description": "Include the public reviewer name, profile URL, location, and photo. Turn off to return those fields as null.", "default": true }, "includeWebsiteTechnology": { "title": "Detect website technology ($)", "type": "boolean", "description": "Identify the website platform, hosting, CDN, and related technologies.", "default": false }, "websiteTechnologyFilter": { "title": "Keep only selected website technologies", "uniqueItems": true, "type": "array", "description": "Return only businesses using any selected technology. Selecting a value automatically enables website technology detection; non-matches are not charged.", "items": { "type": "string" } }, "includeDomainIntelligence": { "title": "Domain registration details ($)", "type": "boolean", "description": "Add domain age, registration, expiration, and registrar details when available.", "default": false }, "includeLinkedInCompany": { "title": "LinkedIn company data ($)", "type": "boolean", "description": "Resolve the business's LinkedIn company profile and public company details.", "default": false }, "includeCompanyRegistry": { "title": "Verified company registry record ($)", "type": "boolean", "description": "Match the business to an official company registry record when supported.", "default": false }, "includeLegalEntity": { "title": "Legal business entity ($)", "type": "boolean", "description": "Resolve the likely legal business name and published identifiers from first-party evidence.", "default": false }, "includeYelpAdvertiser": { "title": "Yelp advertiser flag ($)", "type": "boolean", "description": "Identify businesses Yelp exposes as advertisers.", "default": false }, "includeFullPhotoGallery": { "title": "Full Yelp photo gallery ($)", "type": "boolean", "description": "Collect the expanded Yelp photo gallery and media totals.", "default": false }, "includeCommunityQuestions": { "title": "Community questions and answers ($)", "type": "boolean", "description": "Collect public Yelp community questions and their top answers.", "default": false }, "includeMenu": { "title": "Yelp menu ($)", "type": "boolean", "description": "Collect Yelp menu data when the business publishes it.", "default": false }, "enableLeadScoring": { "title": "Lead score (free)", "type": "boolean", "description": "Calculate a lead score from the fields collected for each business.", "default": false }, "language": { "title": "Language", "pattern": "^[A-Za-z]{2}(?:-[A-Za-z]{2})?$", "type": "string", "description": "Language code requested from Yelp, such as en, fr, de, es, it, ja, or pt.", "default": "en" }, "searchCircle": { "title": "Search circle", "required": [ "lat", "lng", "radiusMiles" ], "type": "object", "description": "Restrict keyword searches to a circle. Ignored when a pasted search URL already contains its own map area.", "properties": { "lat": { "title": "Latitude", "type": "number", "description": "Center latitude from -90 to 90.", "minimum": -90, "maximum": 90 }, "lng": { "title": "Longitude", "type": "number", "description": "Center longitude from -180 to 180.", "minimum": -180, "maximum": 180 }, "radiusMiles": { "title": "Radius", "type": "number", "description": "Search radius in miles.", "minimum": 0.01, "maximum": 250, "unit": "miles" } }, "additionalProperties": false }, "outputPhone": { "title": "Phone", "type": "boolean", "description": "Include Yelp's business phone and phone-availability flag.", "default": true }, "outputWebsite": { "title": "Website", "type": "boolean", "description": "Include the business website and website-availability flag.", "default": true }, "outputAddress": { "title": "Full address", "type": "boolean", "description": "Include the formatted and street address.", "default": true }, "outputCity": { "title": "City", "type": "boolean", "description": "Include the city.", "default": true }, "outputState": { "title": "State or region", "type": "boolean", "description": "Include the state or region.", "default": true }, "outputPostalCode": { "title": "Postal code", "type": "boolean", "description": "Include the postal code.", "default": true }, "outputCountry": { "title": "Country code", "type": "boolean", "description": "Include the country code.", "default": true }, "outputNeighborhoods": { "title": "Neighborhoods", "type": "boolean", "description": "Include Yelp neighborhoods.", "default": true }, "outputCoordinates": { "title": "Latitude and longitude", "type": "boolean", "description": "Include geographic coordinates.", "default": true }, "outputTimezone": { "title": "Timezone", "type": "boolean", "description": "Include the business timezone.", "default": true }, "outputCategories": { "title": "Categories", "type": "boolean", "description": "Include Yelp categories and aliases.", "default": true }, "outputPriceRange": { "title": "Price range", "type": "boolean", "description": "Include Yelp's price range.", "default": true }, "outputServiceArea": { "title": "Service area", "type": "boolean", "description": "Include the service area when Yelp publishes one.", "default": true }, "outputRating": { "title": "Rating", "type": "boolean", "description": "Include the Yelp rating.", "default": true }, "outputReviewCount": { "title": "Review count", "type": "boolean", "description": "Include the Yelp review count.", "default": true }, "outputOpeningHours": { "title": "Opening hours", "type": "boolean", "description": "Include weekly opening hours and closed status.", "default": true }, "outputAttributes": { "title": "Attributes", "type": "boolean", "description": "Include structured Yelp business attributes.", "default": true }, "outputAmenities": { "title": "Amenities", "type": "boolean", "description": "Include Yelp amenities.", "default": true }, "outputClaimed": { "title": "Claimed status", "type": "boolean", "description": "Include whether the Yelp page is claimed.", "default": true }, "outputMainImage": { "title": "Main image", "type": "boolean", "description": "Include the main Yelp image URL.", "default": true }, "outputImages": { "title": "Additional images", "type": "boolean", "description": "Include additional native Yelp image URLs.", "default": true }, "outputDescription": { "title": "Description", "type": "boolean", "description": "Include the business description.", "default": true }, "outputSpecialties": { "title": "Specialties", "type": "boolean", "description": "Include the business specialties text.", "default": true }, "outputHistory": { "title": "History", "type": "boolean", "description": "Include the business history text.", "default": true }, "outputHighlights": { "title": "Review highlights", "type": "boolean", "description": "Include Yelp review highlights.", "default": true }, "outputHealthScore": { "title": "Health inspection score", "type": "boolean", "description": "Include health inspection information only when Yelp exposes it.", "default": true }, "autoTileSearches": { "title": "Expand large searches automatically", "type": "boolean", "description": "Legacy API control for splitting capped searches into additional Yelp searches.", "default": true }, "maxEmailsToValidate": { "title": "Maximum emails to check per business", "minimum": 1, "maximum": 100, "type": "integer", "description": "Legacy API limit for email intelligence.", "default": 20 }, "maxPhotosPerBusiness": { "title": "Maximum photos per business", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Legacy API limit for full photo galleries.", "default": 100 }, "maxQuestionsPerBusiness": { "title": "Maximum questions per business", "minimum": 1, "maximum": 500, "type": "integer", "description": "Legacy API limit for community questions.", "default": 50 }, "leadScoreWeights": { "title": "Custom lead-score weights", "type": "object", "description": "Legacy API overrides for documented lead-score signals.", "default": {} }, "searchUrls": { "title": "Filtered Yelp search URLs", "type": "array", "description": "Legacy API input. Use targets in the visual form.", "items": { "type": "string" } }, "businessUrls": { "title": "Yelp business URLs", "type": "array", "description": "Legacy API input. Use targets in the visual form.", "items": { "type": "string" } }, "businessIds": { "title": "Business IDs or aliases", "type": "array", "description": "Legacy API input. Use targets in the visual form.", "items": { "type": "string" } }, "reviewUrls": { "title": "Review-only business URLs", "type": "array", "description": "Legacy API input. Use targets with includeReviews instead.", "items": { "type": "string" }, "default": [] }, "yelpAttributes": { "title": "Raw Yelp feature aliases", "type": "array", "description": "Legacy API filter. Filtered Yelp target URLs preserve their own attributes.", "items": { "type": "string" } }, "addOns": { "title": "Enrichments", "uniqueItems": true, "type": "array", "description": "Legacy API selector. Use the individual enrichment toggles in the visual form.", "items": { "type": "string" }, "default": [] }, "outputColumns": { "title": "Output columns", "uniqueItems": true, "type": "array", "description": "Legacy API selector. Use the individual output toggles in the visual form.", "items": { "type": "string" }, "default": [] } } }, "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 } } } } } } } } } }