{ "openapi": "3.0.1", "info": { "title": "WhatsApp Scraper — Numbers, Channels & Groups", "description": "Scrape public WhatsApp data from phone numbers, channel pages, group invite links, and business catalogs: name, photo, followers, bio, catalog flag, and latest updates. No login, no QR code.", "version": "1.1", "x-build-id": "k3j80dJk5WksMIkeU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawloop~whatsapp-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawloop-whatsapp-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/crawloop~whatsapp-scraper/runs": { "post": { "operationId": "runs-sync-crawloop-whatsapp-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/crawloop~whatsapp-scraper/run-sync": { "post": { "operationId": "run-sync-crawloop-whatsapp-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": { "phoneNumbers": { "title": "Phone numbers", "type": "array", "description": "International numbers to look up on public wa.me pages (E.164 preferred, e.g. +14155238886). Personal accounts with hidden profiles come back as unresolved — that is not a proof the number is unregistered.", "items": { "type": "string" } }, "numbersText": { "title": "Paste numbers", "type": "string", "description": "Optional. Paste many numbers at once (one per line, or comma/semicolon separated). Merged with Phone numbers and de-duplicated." }, "startUrls": { "title": "Channel / group / catalog / wa.me URLs", "type": "array", "description": "Public WhatsApp channel pages (whatsapp.com/channel/…), group invite links (chat.whatsapp.com/…), click-to-chat links (wa.me/…), or business catalog links (wa.me/c/… or whatsapp.com/catalog/…).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "queries": { "title": "Channel search queries", "type": "array", "description": "Discover public WhatsApp channels via search-engine indexing of whatsapp.com/channel pages (not the in-app directory). Coverage is broad but incomplete; extra result pages are fetched until the cap.", "items": { "type": "string" } }, "defaultCountry": { "title": "Default country", "type": "string", "description": "ISO 3166 alpha-2 (US, GB, BR, IN, …) used to parse numbers that do not start with +. Leave empty to require an international prefix." }, "includeChannelUpdates": { "title": "Include channel latest updates", "type": "boolean", "description": "When a channel page shows a Latest updates strip (time + reaction counts), attach it on the channel row. Off = metadata only.", "default": true }, "includeCatalog": { "title": "Check business catalog", "type": "boolean", "description": "For each number, request the public catalog landing (whatsapp.com/catalog/{number}). Returns hasCatalog true/false. Logged-out pages do not list product SKUs — only that a catalog exists, plus the business name on the landing.", "default": true }, "maxChannelsPerQuery": { "title": "Max channels per search query", "minimum": 1, "maximum": 100, "type": "integer", "description": "Cap on channel URLs collected from each search query before hydration.", "default": 20 }, "maxItems": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Hard cap on dataset rows for the whole run (numbers + channels + groups).", "default": 100 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel page fetches (1–20). Lower it if you see rate limits.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Public WhatsApp pages usually work without a proxy. Enable Apify proxy if you run large batches or channel search.", "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 } } }, "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 } } } } } } } } } }