{ "openapi": "3.0.1", "info": { "title": "Website Contact Scraper", "description": "Turn company websites into contact records. Finds emails split into personal and role, phone numbers, social profiles across 17 platforms, postal address and named people. Renders JavaScript sites at no extra cost. One charge per domain, and domains with nothing found are free.", "version": "0.1", "x-build-id": "3M2PB1lFd4rdPwfV9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spookyweb~website-contact-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spookyweb-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/spookyweb~website-contact-scraper/runs": { "post": { "operationId": "runs-sync-spookyweb-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/spookyweb~website-contact-scraper/run-sync": { "post": { "operationId": "run-sync-spookyweb-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": { "url": { "title": "Website", "type": "string", "description": "A single company website to scan. The protocol is optional, so acme.com and https://acme.com are the same request." }, "urls": { "title": "Websites", "type": "array", "description": "Scan up to 500 company websites in one run. Takes priority over the single website field when both are given. Each domain is charged once, whatever the size of the site.", "items": { "type": "string" } }, "maxPagesPerDomain": { "title": "Pages per website", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many pages to read on each site. The homepage is always read, then the pages most likely to carry contact details, ranked ahead of the rest: contact, imprint, about, team, then support and legal.", "default": 5 }, "deepScan": { "title": "Probe standard contact paths", "type": "boolean", "description": "Also try the usual contact URLs directly even when the site does not link to them, including the imprint and legal notice pages that European sites are required to publish. Slower, and worth it on sites with a sparse or JavaScript driven menu.", "default": false }, "jsFallback": { "title": "Render JavaScript when a page looks empty", "type": "boolean", "description": "If a site's HTML carries no contact details at all, load it in a browser and read the page after its scripts have run. This is what recovers contacts from client rendered sites, and it is included rather than charged as an extra. Only used where the plain fetch found nothing, so it costs nothing on ordinary sites.", "default": true }, "includeFreeProviders": { "title": "Include Gmail and similar addresses", "type": "boolean", "description": "Keep addresses on free consumer providers such as gmail.com and outlook.com. Useful for sole traders and small businesses that publish a personal address, and noise if you only want corporate domains.", "default": true }, "onlyWithContacts": { "title": "Return only sites with contact details", "type": "boolean", "description": "Drop domains where nothing was found instead of returning an empty record for them. Those domains are never charged either way, so this only affects whether they appear in the output.", "default": false }, "timeoutSecs": { "title": "Request timeout, seconds", "minimum": 5, "maximum": 60, "type": "integer", "description": "How long to wait for a single page before moving on. Raise it for slow sites, lower it to get through a large list faster.", "default": 20 } } }, "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 } } } } } } } } } }