{ "openapi": "3.0.1", "info": { "title": "Website Email Extractor - Find Emails on Any Website List", "description": "Extract email addresses from any list of websites or domains: contact, about, imprint and team pages are read, emails are deduplicated and the main company email is picked for you. Phones and social profiles included. Pay only for websites where an email was found.", "version": "1.0", "x-build-id": "DkjyLtNwSG5tYK3cS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pipiagent~website-email-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pipiagent-website-email-extractor", "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/pipiagent~website-email-extractor/runs": { "post": { "operationId": "runs-sync-pipiagent-website-email-extractor", "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/pipiagent~website-email-extractor/run-sync": { "post": { "operationId": "run-sync-pipiagent-website-email-extractor", "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": { "websites": { "title": "Websites", "type": "array", "description": "Websites to find emails on. Full URLs (https://example.com) or bare domains (example.com) both work. Paste a whole list at once, one website per line or separated by commas. You get one result per website.", "items": { "type": "string" } }, "maxPagesPerWebsite": { "title": "Max pages per website", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many pages to open on each website, the homepage included. The Actor opens contact, about, imprint, team and similar pages first, so 5 to 10 is enough for most websites. The price per website does not change with this number.", "default": 10 }, "maxDepth": { "title": "Max link depth", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many clicks away from the homepage the Actor may go. 0 = homepage only, 1 = pages linked from the homepage, 2 = one more step (for example Company > Team).", "default": 2 }, "defaultCountry": { "title": "Country for phone numbers", "type": "string", "description": "Optional two-letter country code, for example US, GB or DE. Used to read local phone numbers written without a country prefix. Leave empty to detect the country from the website's domain ending and language." }, "includeEmptyResults": { "title": "Save websites without contacts (free)", "type": "boolean", "description": "Also save a row for websites that could not be opened or showed no email, phone number or social profile, with a status that says why. These rows are free. Turn off to keep only websites with contacts.", "default": true }, "maxConcurrency": { "title": "Websites in parallel", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many websites to scan at the same time. Pages of one website are always opened one after another.", "default": 10 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. The Actor works without a proxy. Turn one on only if many websites come back as blocked.", "default": { "useApifyProxy": 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 } } } } } } } } } }