{ "openapi": "3.0.1", "info": { "title": "Contact Phone Extractor", "description": "Fast and highly accurate phone number extractor. Automatically crawls into relevant contact and about pages to scrape valid international phone numbers while strictly filtering out faxes, dates, and VAT IDs.", "version": "1.0", "x-build-id": "fhzetJijlc2USxW60" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/codescraper~contact-phone-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-codescraper-contact-phone-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/codescraper~contact-phone-extractor/runs": { "post": { "operationId": "runs-sync-codescraper-contact-phone-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/codescraper~contact-phone-extractor/run-sync": { "post": { "operationId": "run-sync-codescraper-contact-phone-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "URLs to scrape for phone numbers.", "items": { "type": "string" } }, "defaultCountryCode": { "title": "Default Country Code", "type": "string", "description": "2-letter ISO country code (e.g., 'US', 'GB', 'DE') to use as a fallback if the country cannot be determined from the domain.", "default": "US" }, "searchSections": { "title": "Sections to Search", "type": "object", "description": "Choose which sections of the main page to search. (Contact pages are automatically searched entirely).", "default": { "header": true, "footer": true, "body": false } }, "deduplicationStrictness": { "title": "Deduplication Strictness", "enum": [ "aggressive", "balanced", "lenient" ], "type": "string", "description": "How aggressively to merge similar looking phone numbers.", "default": "balanced" }, "minPhoneLength": { "title": "Minimum Phone Length", "type": "integer", "description": "Minimum number of digits required.", "default": 8 }, "maxPhoneLength": { "title": "Maximum Phone Length", "type": "integer", "description": "Maximum number of digits allowed.", "default": 15 }, "excludePatterns": { "title": "Exclude Patterns (Regex)", "type": "array", "description": "Exclude numbers matching these regex patterns (e.g., ^800 for toll-free).", "default": [ "^800", "^888" ], "items": { "type": "string" } }, "includeOnlyCountryCodes": { "title": "Include Only Country Codes", "type": "array", "description": "Only keep numbers starting with these calling codes (e.g., '1' for US, '49' for Germany). Leave empty to allow all.", "default": [], "items": { "type": "string" } }, "confidenceThreshold": { "title": "Confidence Threshold", "type": "number", "description": "Minimum confidence score (0.0 to 1.0) required to keep a number.", "default": 0.5 }, "maxResultsPerUrl": { "title": "Max Results Per URL", "type": "integer", "description": "Maximum number of phone numbers to return per input URL.", "default": 5 }, "outputFormat": { "title": "Output Format", "enum": [ "raw", "formatted", "both" ], "type": "string", "description": "How the phone numbers should be formatted in the dataset.", "default": "both" } } }, "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 } } } } } } } } } }