{
"openapi": "3.0.1",
"info": {
"title": "Website Contacts API",
"description": "Extract e-mails, phone numbers, WhatsApp, Telegram, social profiles, contact page and address from any list of websites. One clean row per website, priced per website, not per page. No API key, no proxy, no browser.",
"version": "0.1",
"x-build-id": "xCrb9z273Hhd2Ty2S"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/lergassy~website-contacts-api/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-lergassy-website-contacts-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/lergassy~website-contacts-api/runs": {
"post": {
"operationId": "runs-sync-lergassy-website-contacts-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/lergassy~website-contacts-api/run-sync": {
"post": {
"operationId": "run-sync-lergassy-website-contacts-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": {
"startUrls": {
"title": "🌐 Websites",
"type": "array",
"description": "Websites to scan, one per line: a domain (acme.com), a home page or any page of the site. Paste a list, upload a file, or link a Google Sheet. One dataset row comes back per website.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"domains": {
"title": "🌐 Domains (one per line)",
"type": "array",
"description": "Bare domains without https://, e.g. acme.com — handy for lists exported from Google Maps, a CRM or a spreadsheet. Merged with the websites above.",
"items": {
"type": "string"
}
},
"maxPagesPerSite": {
"title": "📄 Max pages per website",
"minimum": 1,
"maximum": 30,
"type": "integer",
"description": "Home page plus the most contact-like pages (contact, about, team, imprint, legal). 6 finds nearly everything on a normal business site; raise it for large sites. The price does not depend on this number.",
"default": 6
},
"defaultCountry": {
"title": "📞 Default phone country",
"pattern": "^[A-Za-z]{2}$",
"type": "string",
"description": "Two-letter country code used to read phone numbers written without a country code. A site's own country domain (.de, .co.uk, .id) always wins over this value.",
"default": "US"
},
"checkEmails": {
"title": "✅ Add-on: check e-mails ($)",
"type": "boolean",
"description": "Adds deliverability signals for every e-mail found: whether the domain accepts mail (DNS MX), the mail provider, disposable and role flags and a typo suggestion. Charged per checked address. This is a domain-level check, not a mailbox probe.",
"default": false
},
"onlyOwnDomainEmails": {
"title": "Keep only the website's own e-mails",
"type": "boolean",
"description": "Drop addresses on other domains (a partner, a web agency, a gmail.com mailbox). Off by default because a sole trader's only address is often on gmail.com.",
"default": false
},
"stopEarly": {
"title": "Stop when a page already gave an own-domain e-mail and a phone",
"type": "boolean",
"description": "Faster runs: once a page has yielded both an e-mail on the site's own domain and a valid phone, the remaining pages of that website are skipped. Turn off to collect every address on every page.",
"default": true
},
"maxWebsites": {
"title": "Max websites",
"minimum": 1,
"type": "integer",
"description": "Safety cap on how many websites from the list are processed in one run.",
"default": 1000
},
"concurrency": {
"title": "Websites in parallel",
"minimum": 1,
"maximum": 50,
"type": "integer",
"description": "How many websites are scanned at the same time.",
"default": 10
},
"pageTimeoutSecs": {
"title": "Page timeout (seconds)",
"minimum": 3,
"maximum": 60,
"type": "integer",
"description": "Give up on a page after this many seconds.",
"default": 15
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Not needed for normal business websites and off by default. Turn on Apify Proxy only if your list is full of sites that block datacenter traffic."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}