{ "openapi": "3.0.1", "info": { "title": "Website Contacts Scraper: Emails, Phones, Socials", "description": "Built to beat Contact Details Scraper: on the same 40 sites it found an email on 85% vs 68% and a company mailbox on 75% vs 43%, plus addresses, for 1/6 the cost: a flat $1.50 per 1,000 sites, not $2 per 1,000 pages (~$9.20 per 1,000 sites). Dead sites free.", "version": "0.1", "x-build-id": "VYLcQ8Mh80pznn9t0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tidyharvest~website-contacts-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tidyharvest-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/tidyharvest~website-contacts-scraper/runs": { "post": { "operationId": "runs-sync-tidyharvest-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/tidyharvest~website-contacts-scraper/run-sync": { "post": { "operationId": "run-sync-tidyharvest-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": { "domains": { "title": "Websites or domains", "type": "array", "description": "One per line: a domain (acme.com), a URL or an email address (uses its domain). A URL with a path, like a chain's location page (rotorooter.com/columbus/), is read first, so you get that branch's phone and email; each location is its own row. Duplicates are removed.", "items": { "type": "string" } }, "datasetIds": { "title": "Read websites from Apify datasets", "type": "array", "description": "Dataset ids (or dataset URLs) from another run, for example a Google Maps scraper. Each item's website field (website, url, domain, homepage) is used, and the place's name, placeId, phone and address are copied into `source` so you can join the results back.", "items": { "type": "string" } }, "skipDatasetIds": { "title": "Skip domains already in these datasets", "type": "array", "description": "For scheduled refreshes: dataset ids from earlier runs of this actor. Domains already processed there are skipped and not charged.", "items": { "type": "string" } }, "maxPagesPerDomain": { "title": "Max pages per domain", "minimum": 1, "maximum": 20, "type": "integer", "description": "Homepage plus the best contact, imprint, about and team pages found in its links. The price is per domain either way; more pages finds more but takes longer.", "default": 5 }, "timeoutSecsPerDomain": { "title": "Time limit per domain (seconds)", "minimum": 10, "maximum": 120, "type": "integer", "description": "Slow sites are cut off after this and return what was found so far.", "default": 30 }, "country": { "title": "Default phone country", "type": "string", "description": "Two-letter country code used to read local phone numbers without a + prefix (US, GB, DE...). Empty = guess from the domain ending, else US." }, "includePersonalEmails": { "title": "Include people's emails", "type": "boolean", "description": "Also return addresses that belong to a named person (jane.doe@) or a single first name (jason@), typed `personal` / `other`. Turn off to keep only company mailboxes (info@, sales@); the rest are then counted in hiddenEmails. If you contact EU/UK people, you are responsible for a lawful basis under GDPR.", "default": true }, "checkEmails": { "title": "Check emails (paid add-on)", "type": "boolean", "description": "Run each email through syntax, mail-server (MX), disposable, role and free-mail checks. Charged per email checked. No SMTP probe is sent.", "default": false }, "retryBlockedWithProxy": { "title": "Retry blocked sites through Apify Proxy", "type": "boolean", "description": "Some small-business hosts refuse cloud servers. Sites that answer with bot protection are retried once through Apify Proxy (datacenter). Still free if they stay blocked.", "default": true }, "maxItems": { "title": "Max charged domains", "minimum": 0, "type": "integer", "description": "Stop after this many sites have been read (also caps your cost). Dead, parked and blocked domains don't count. 0 or empty = no limit." } } }, "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 } } } } } } } } } }