{ "openapi": "3.0.1", "info": { "title": "Whitepages Leads Scraper", "description": "Find and collect qualified leads from public records by name, phone number, or address. Extract phone numbers, addresses, relatives, contact details, and match confidence into clean, structured data for lead generation and research.", "version": "0.0", "x-build-id": "dGSupabn1aBLDbWi5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/searchshark~whitepages-leads-scraper-v2/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-searchshark-whitepages-leads-scraper-v2", "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/searchshark~whitepages-leads-scraper-v2/runs": { "post": { "operationId": "runs-sync-searchshark-whitepages-leads-scraper-v2", "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/searchshark~whitepages-leads-scraper-v2/run-sync": { "post": { "operationId": "run-sync-searchshark-whitepages-leads-scraper-v2", "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": [ "records" ], "properties": { "records": { "title": "Lead records", "type": "array", "description": "Bulk lead records to look up. Provide a phone, an address, or a name plus location. lookupMode is optional.", "items": { "type": "object", "properties": { "inputRowId": { "title": "Input row ID", "type": "string", "description": "Optional stable row identifier used for traceability.", "editor": "textfield" }, "externalLeadId": { "title": "External lead ID", "type": "string", "description": "Optional ID from your CRM or source system.", "editor": "textfield" }, "fullName": { "title": "Full name", "type": "string", "description": "Person full name.", "editor": "textfield" }, "firstName": { "title": "First name", "type": "string", "description": "Person first name.", "editor": "textfield" }, "lastName": { "title": "Last name", "type": "string", "description": "Person last name.", "editor": "textfield" }, "city": { "title": "City", "type": "string", "description": "City used for people lookup and matching.", "editor": "textfield" }, "state": { "title": "State", "type": "string", "description": "State, province, or region used for lookup and matching where applicable.", "editor": "textfield" }, "zip": { "title": "ZIP code", "type": "string", "description": "ZIP or postal code used for lookup and matching where applicable.", "editor": "textfield" }, "address": { "title": "Address", "type": "string", "description": "Street address for reverse-address lookup.", "editor": "textfield" }, "phone": { "title": "Phone", "type": "string", "description": "Phone number for reverse-phone lookup where supported.", "editor": "textfield" }, "lookupMode": { "title": "Lookup mode", "type": "string", "description": "Optional explicit lookup mode. Leave unset for automatic selection.", "editor": "select", "enum": [ "people", "reverse_phone", "reverse_address" ], "enumTitles": [ "People", "Reverse phone", "Reverse address" ] }, "country": { "title": "Country", "type": "string", "description": "Lookup country. US uses the existing U.S. provider; CA uses Canada411; GB uses 192.com; AU and NZ use Person Lookup.", "default": "US", "enum": [ "US", "CA", "GB", "AU", "NZ" ], "enumTitles": [ "US - United States", "CA - Canada", "GB - United Kingdom", "AU - Australia", "NZ - New Zealand" ], "editor": "select" }, "province": { "title": "Province", "type": "string", "description": "Canadian province code such as ON, BC, AB, or QC. Used when country is CA.", "editor": "textfield" }, "postalCode": { "title": "Postal code", "type": "string", "description": "Canadian postal code such as M6P 1M6. Used when country is CA.", "editor": "textfield" } } } }, "maxCandidatesPerRecord": { "title": "Max candidates per record", "type": "integer", "description": "Maximum candidate rows retained for each input record.", "default": 10 }, "minimumMatchConfidence": { "title": "Minimum match confidence", "minimum": 0, "maximum": 1, "type": "number", "description": "Minimum candidate confidence required for a match.", "default": 0.6 }, "includeAmbiguous": { "title": "Include ambiguous matches", "type": "boolean", "description": "Include strong near-tie candidates classified as AMBIGUOUS.", "default": true }, "deduplicatePeople": { "title": "Deduplicate people", "type": "boolean", "description": "Deduplicate person candidates using stable phone or person/address keys.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "type": "integer", "description": "Maximum number of concurrent crawler requests.", "default": 5 }, "maxRetries": { "title": "Max retries", "type": "integer", "description": "Maximum retries for retryable request failures.", "default": 3 } } }, "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 } } } } } } } } } }