{ "openapi": "3.0.1", "info": { "title": "Website Contact & Email Scraper: Emails, Phones & Socials", "description": "Turn company websites into contacts. Per site, extract public emails, phones, WhatsApp, 15 social profiles (LinkedIn, X, Facebook, Instagram, YouTube, TikTok and more), contact people, company name and address, plus the page each contact came from. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "xnrjRGSZ446n6F1qz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~website-contacts-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-website-contacts-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/scrapers_lat~website-contacts-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-website-contacts-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/scrapers_lat~website-contacts-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-website-contacts-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": { "websites": { "title": "Websites", "type": "array", "description": "One or more company websites to enrich. Enter a domain (example.com) or a full URL. Each website returns one contact record.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (alternative to Websites)", "type": "array", "description": "Same as Websites, in Apify start-URL format. Accepts a list of {\"url\": \"https://example.com\"} objects. Merged with the Websites list.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "domain": { "title": "Single domain (optional)", "type": "string", "description": "Optional. A single domain to enrich, in addition to (or instead of) the list above." }, "paths": { "title": "Paths (optional)", "type": "array", "description": "Optional. Extra paths to visit on every website, e.g. /contact, /about-us. Applied to each domain in addition to the pages discovered automatically.", "items": { "type": "string" } }, "maxWebsites": { "title": "Max Websites To Scrape", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of websites to enrich in this run." }, "maxPagesPerSite": { "title": "Max pages per website", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many pages to read per website (homepage plus likely contact / about / team pages). Higher finds more contacts but is slower." }, "maxDepth": { "title": "Max crawl depth", "minimum": 0, "maximum": 4, "type": "integer", "description": "How many link-hops deep to follow within the same website. 0 = homepage only, 1 = homepage plus its linked contact/about pages, 2+ = follow deeper. Contact and about pages are always prioritized." }, "sameDomainOnly": { "title": "Stay on the same domain", "type": "boolean", "description": "Only crawl pages on the same domain as each seed website. Default true.", "default": true }, "includeSubdomains": { "title": "Include subdomains", "type": "boolean", "description": "Also crawl subdomains of the seed website (for example blog.example.com). Default false.", "default": false }, "includeUrlGlobs": { "title": "Include URL globs", "type": "array", "description": "Optional. Only crawl page URLs matching one of these glob patterns (supports * and ?), e.g. https://example.com/team/*. Leave empty to crawl all discovered pages.", "items": { "type": "string" } }, "excludeUrlGlobs": { "title": "Exclude URL globs", "type": "array", "description": "Optional. Skip page URLs matching one of these glob patterns, e.g. */blog/*, */careers/*.", "items": { "type": "string" } }, "stopWhenContactsFound": { "title": "Stop early when contacts are found", "type": "boolean", "description": "Stop crawling a website as soon as enough contacts (emails plus a social profile) are found. Faster; turn off to always crawl up to the page limit. Default true.", "default": true }, "renderJs": { "title": "Render JavaScript / bypass bot protection (paid plans)", "type": "boolean", "description": "For pages protected by Cloudflare or AWS WAF, route the request through our browser solver so JavaScript-rendered contacts are captured. Available on paid Apify plans. Default false.", "default": false }, "withEmailVerify": { "title": "Verify email deliverability (paid add-on)", "type": "boolean", "description": "Optional add-on (paid plans). For every email found, check the domain MX records and return a deliverability status. Charged per record only when at least one email is checked. Default false.", "default": false }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many websites to enrich in parallel. Higher is faster. Default 8." }, "dryRun": { "title": "Dry run (no charge)", "type": "boolean", "description": "Parse and return records without charging the result event. Useful for testing input coverage. Default false.", "default": false } } }, "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 } } } } } } } } } }