{ "openapi": "3.0.1", "info": { "title": "Website Contact & Leads Scraper", "description": "Read company websites for the contacts they publish today: emails, phones, address, socials. Charges only reachable leads. Export CSV, Excel, JSON, XML.", "version": "0.1", "x-build-id": "BodveUsMtJabt6cHF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~website-contact-leads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-website-contact-leads-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/parseforge~website-contact-leads-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-website-contact-leads-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/parseforge~website-contact-leads-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-website-contact-leads-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": { "websiteUrls": { "title": "๐ŸŒ Company websites", "type": "array", "description": "The company websites to read. Paste domains (acme.com) or full URLs, both work. This is the main input: point it at a list you already have and every row comes back with the contact details that site publishes today.", "items": { "type": "string" } }, "searchTerms": { "title": "๐Ÿ”Ž Or find websites by search", "type": "array", "description": "Describe the companies you want and the Actor finds candidate websites first, then reads them. Directories, review sites and news outlets are filtered out. Use this when you do not have a domain list yet; a domain list always gives cleaner results.", "items": { "type": "string" } }, "maxItems": { "title": "๐Ÿงพ Maximum leads", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many leads. Free users get up to 10 results per run; paid users get up to 1,000,000." }, "requireContact": { "title": "๐Ÿ“ฌ Only return companies with a contact", "type": "boolean", "description": "On by default. A company whose site publishes no email and no phone is skipped and never charged. Turn it off to get a row for every website, including the ones with nothing to show.", "default": true }, "resultsPerSearch": { "title": "๐Ÿ”ข Websites per search term", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many company websites to take from each search term. Directories and review sites do not count toward this number.", "default": 10 }, "maxPagesPerSite": { "title": "๐Ÿ“„ Pages to read per website", "minimum": 1, "maximum": 6, "type": "integer", "description": "The home page is read first. If it already carries an email, no further page is requested. Otherwise the Actor follows the site's own contact, about or imprint links, up to this many pages.", "default": 3 }, "concurrency": { "title": "โšก Websites in parallel", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many company sites to read at once. Each site only ever gets one request at a time from this run; the parallelism is spread across different companies. Lower it if your list holds many sites hosted together and you want to be gentle with that host.", "default": 40 }, "directSiteRequests": { "title": "Read company sites directly", "type": "boolean", "description": "On by default: company websites are read straight from the run, which is faster, and a site that fails is tried once more through the proxy. Search always uses the proxy. Turn it off to send every request through the proxy below.", "default": true }, "proxyConfiguration": { "title": "๐ŸŒ Proxy", "type": "object", "description": "Datacenter proxy by default: company websites serve it normally, and its transfer is not billed, which is what keeps the price per lead down. Switch to residential only if a specific target refuses datacenter.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "BUYPROXIES94952" ] } } } }, "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 } } } } } } } } } }