{
"openapi": "3.0.1",
"info": {
"title": "Contact Scraper - Website Emails, Phones & Socials",
"description": "Extract emails, phone numbers and social media profiles (LinkedIn, Facebook, Instagram, X, YouTube, TikTok...) from any list of company websites or domains. One clean row per website, contact-page aware, email provider (MX) detection. Pay only for websites with contacts.",
"version": "1.0",
"x-build-id": "lCPM0knd8hXAs2dZv"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/wrenfield-data~website-contact-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-wrenfield-data-website-contact-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/wrenfield-data~website-contact-scraper/runs": {
"post": {
"operationId": "runs-sync-wrenfield-data-website-contact-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/wrenfield-data~website-contact-scraper/run-sync": {
"post": {
"operationId": "run-sync-wrenfield-data-website-contact-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": {
"urls": {
"title": "Websites / domains",
"type": "array",
"description": "Company websites or bare domains, one per line: acme.com, https://www.acme.com or a specific page like acme.com/contact. The Actor always starts at the homepage and then visits the pages most likely to list contacts (Contact, About, Team, Impressum, Locations...). Duplicates are skipped.",
"items": {
"type": "string"
}
},
"datasetId": {
"title": "Enrich an existing dataset (optional)",
"type": "string",
"description": "ID of an Apify dataset to enrich, e.g. from Google Maps Scraper or Company Name to Domain Finder. The Actor reads each item's website from the field below and adds sourceName / sourceIndex so you can join the results back."
},
"datasetUrlField": {
"title": "Dataset website field",
"type": "string",
"description": "Field holding the website in that dataset. Leave empty to auto-detect (website, url, domain, companyWebsite...)."
},
"maxPagesPerDomain": {
"title": "Max pages per website",
"minimum": 1,
"maximum": 50,
"type": "integer",
"description": "Homepage plus the highest-ranked contact/about/team/legal pages. 4-8 finds most contacts; more pages = slower, never more expensive per website.",
"default": 6
},
"extractPhones": {
"title": "Extract phone numbers",
"type": "boolean",
"description": "Phone numbers from tel: links, structured data and text next to a phone label, validated and normalised to E.164 (+14155550132).",
"default": true
},
"extractSocials": {
"title": "Extract social profiles",
"type": "boolean",
"description": "LinkedIn, Facebook, Instagram, X/Twitter, YouTube, TikTok, Pinterest, GitHub, Threads, WhatsApp, Telegram, Discord, Yelp and Trustpilot profile links. Share buttons and post links are ignored.",
"default": true
},
"defaultCountry": {
"title": "Default phone country",
"type": "string",
"description": "2-letter country used to read local phone numbers (without +country code) on sites with a generic TLD like .com. Country TLDs (.de, .co.uk...) and the page language (en-GB) override it.",
"default": "US"
},
"onlyRoleEmails": {
"title": "Only role-based emails (info@, sales@, support@...)",
"type": "boolean",
"description": "Drop personal addresses (jane.doe@...) and free-mail addresses. Useful for GDPR-sensitive outreach.",
"default": false
},
"onlyOwnDomainEmails": {
"title": "Only emails on the website's own domain",
"type": "boolean",
"description": "Drop addresses on other domains (agencies, parent companies, gmail.com...).",
"default": false
},
"checkMx": {
"title": "Check email domains & detect email provider",
"type": "boolean",
"description": "DNS check: drops emails whose domain cannot receive mail, and adds the website's email provider (Google Workspace, Microsoft 365, Zoho...) and security gateway (Proofpoint, Mimecast...). No emails are sent.",
"default": true
},
"respectRobotsTxt": {
"title": "Respect robots.txt",
"type": "boolean",
"description": "Skip pages the website's robots.txt disallows for all crawlers. Websites that disallow everything return a free robots_disallowed row.",
"default": true
},
"maxConcurrency": {
"title": "Websites in parallel",
"minimum": 1,
"maximum": 100,
"type": "integer",
"description": "How many websites are crawled at the same time.",
"default": 30
},
"maxResults": {
"title": "Max websites with contacts",
"minimum": 1,
"type": "integer",
"description": "Stop after this many paid results (websites with at least one contact). Leave empty for no limit. You can also cap spending with the run's maximum cost."
},
"proxyMode": {
"title": "When to use the proxy",
"enum": [
"fallback",
"always"
],
"type": "string",
"description": "Most company websites don't block, so pages are fetched directly and only blocked requests are retried through the proxy.",
"default": "fallback"
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Proxy used for websites that block direct requests. Apify datacenter proxy is included in the price.",
"default": {
"useApifyProxy": true
}
},
"residentialFallback": {
"title": "Residential proxy as last resort",
"type": "boolean",
"description": "Retry still-blocked websites through residential IPs. Slightly higher success on heavily protected sites.",
"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
},
"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
}
}
}
}
}
}
}
}
}
}