{ "openapi": "3.0.1", "info": { "title": "Local Business Leads: email finder, website audit, map", "description": "Local lead generation by business type and city: an email finder that reads each company's own website (mail server checked), a website audit of what each business lacks online, a fit score and pitch line for your offer, branded audit pages and a lead map. No Google API key.", "version": "0.1", "x-build-id": "GbfzJW9aAfP3sNtey" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/translucent_wire~local-business-email-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-translucent_wire-local-business-email-finder", "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/translucent_wire~local-business-email-finder/runs": { "post": { "operationId": "runs-sync-translucent_wire-local-business-email-finder", "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/translucent_wire~local-business-email-finder/run-sync": { "post": { "operationId": "run-sync-translucent_wire-local-business-email-finder", "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": { "location": { "title": "City or area", "type": "string", "description": "City, area or full address, e.g. 'Austin', 'Manchester', '350 5th Ave, New York'. Leave empty if you give a list of websites." }, "countryCode": { "title": "Country code", "type": "string", "description": "Two letters, e.g. US, GB, AE. Helps find the right city." }, "radiusKm": { "title": "Radius around the location (km, optional)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Search a circle around an address or point instead of a whole city. Good for field sales territories." }, "businessTypes": { "title": "Business types", "type": "array", "description": "Choose one or more types of business.", "items": { "type": "string", "enum": [ "company_offices", "manufacturers_factories", "warehouses_logistics_wholesale", "builders_trades", "solar_energy", "clinics_dentists_doctors", "restaurants_cafes", "hotels_guest_houses", "shops_retail", "accountants_lawyers_consultants", "real_estate_agents", "schools_training", "food_coffee_producers", "marketing_it_agencies", "gyms_beauty_wellness", "car_services" ], "enumTitles": [ "Company offices", "Manufacturers & factories", "Warehouses, logistics & wholesale", "Builders, roofers, electricians, plumbers, HVAC", "Solar & energy companies", "Clinics, dentists & doctors", "Restaurants & cafes", "Hotels, guest houses & hostels", "Shops & retail (all)", "Accountants, lawyers, tax advisors & consultants", "Real estate agents", "Schools, colleges & training", "Coffee roasters, chocolate, breweries & wineries", "Marketing, IT & web agencies", "Gyms, beauty & hair salons", "Car repair, dealers & car wash" ] } }, "customTags": { "title": "Custom OpenStreetMap tags (advanced)", "type": "array", "description": "Optional, e.g. office=insurance or craft=photovoltaic. Combined with the types above.", "items": { "type": "string" } }, "yourOffer": { "title": "What do you sell? (for the fit score and pitch line)", "enum": [ "website_design", "seo", "online_booking", "ai_chatbot", "social_media", "paid_ads", "ecommerce", "website_care", "general" ], "type": "string", "description": "Each business gets a 0-100 fit score for your offer, the reasons, and a ready pitch line.", "default": "general" }, "analyzeOpportunities": { "title": "Opportunity analysis (what each business lacks)", "type": "boolean", "description": "Checks each website for gaps: no online booking, not mobile friendly, outdated, not secure, no chat, no tracking, weak SEO, no social links... Each gap comes with its evidence. Charged per business (see Pricing).", "default": true }, "makeMapReport": { "title": "Interactive map + market report", "type": "boolean", "description": "One page with every business on a map (coloured by fit), the share of businesses with each gap, and your best-fit list. Charged once per run.", "default": true }, "prospectReports": { "title": "Branded audit page for each business", "type": "boolean", "description": "A one-page website check per business, with your name, logo, colour and contact button, ready to send to that business as a free audit. Link in each row (prospectReportUrl). Charged per business (see Pricing).", "default": false }, "brandName": { "title": "Your company name", "type": "string", "description": "Shown on the map, report and audit pages." }, "brandLogoUrl": { "title": "Your logo URL (https)", "type": "string", "description": "A public https link to your logo image (PNG or SVG). Shown at the top of the map and audit pages." }, "brandColor": { "title": "Your brand colour", "type": "string", "description": "Hex colour like #2b6cb0." }, "brandContact": { "title": "Your contact line", "type": "string", "description": "e.g. 'Jane Smith, Bright Web Studio, jane@brightweb.com'." }, "brandCtaUrl": { "title": "Button link (booking page or website)", "type": "string", "description": "Where the button sends people, e.g. your booking page or website." }, "brandCtaText": { "title": "Button text", "type": "string", "description": "Text on the button.", "default": "Book a free 15-minute call" }, "minFitScore": { "title": "Only businesses with fit score at least", "minimum": 0, "maximum": 100, "type": "integer", "description": "0 keeps everyone. 60 keeps only high-fit businesses. Filtered businesses are not charged.", "default": 0 }, "requiredGaps": { "title": "Only businesses lacking any of these", "type": "array", "description": "Optional. e.g. only businesses with no online booking. Filtered businesses are not charged.", "items": { "type": "string", "enum": [ "no_website", "website_down", "outdated_website", "not_mobile_friendly", "not_secure", "no_online_booking", "no_chat", "no_contact_form", "no_analytics", "weak_seo", "no_social_links", "no_online_shop" ], "enumTitles": [ "No website", "Website not loading", "Outdated website (old copyright year)", "Not mobile friendly", "Not secure (no HTTPS)", "No online booking", "No chat / WhatsApp button", "No contact form", "No visitor tracking", "No Google description (weak SEO)", "No social media links", "No online shop" ] } }, "highlightGap": { "title": "Highlight on the map", "enum": [ "none", "no_website", "website_down", "outdated_website", "not_mobile_friendly", "not_secure", "no_online_booking", "no_chat", "no_contact_form", "no_analytics", "weak_seo", "no_social_links", "no_online_shop" ], "type": "string", "description": "Draws a red ring around businesses lacking this.", "default": "none" }, "pitchTemplate": { "title": "Your own pitch line (optional)", "type": "string", "description": "Use {name}, {city}, {gap}, {offer}, {website}. Example: 'Hi {name} team, {gap} We help {city} businesses fix that.'" }, "websites": { "title": "Or: list of websites", "type": "array", "description": "Optional. Give company websites instead of a location, and get the best contact email for each.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResults": { "title": "Maximum businesses with email", "minimum": 1, "maximum": 5000, "type": "integer", "description": "The run stops when this many businesses with an email are found.", "default": 10 }, "onlyWithEmail": { "title": "Only return businesses with an email", "type": "boolean", "description": "Turn off to also get businesses where no email was found (those rows are free).", "default": true }, "genericEmailsOnly": { "title": "Generic addresses only (info@, sales@...)", "type": "boolean", "description": "Skip addresses that look like a person's name. Useful for GDPR-careful outreach in Europe.", "default": false }, "verifyEmailDomain": { "title": "Check the email domain accepts mail", "type": "boolean", "description": "Looks up the domain's mail server (MX record) so you avoid bounces.", "default": true } } }, "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 } } } } } } } } } }