# Whatsapp Group Scraper (`romy/whatsapp-group-scraper`) Actor Fetch metadata from WhatsApp groups using invite links or invite codes. Returns group name, description, participant count, creation date, and more — in real time from WhatsApp. - **URL**: https://apify.com/romy/whatsapp-group-scraper.md - **Developed by:** [Romy](https://apify.com/romy) (community) - **Categories:** Social media, Developer tools, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $8.00 / 1,000 group scrapeds This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## WhatsApp Group Scraper Fetch metadata from **WhatsApp groups** using invite links or invite codes. Returns group name, description, participant count, creation date, and more — in real time from WhatsApp. ### What does WhatsApp Group Scraper do? This Actor takes WhatsApp group invite links (or bare invite codes) and retrieves the group's public metadata: name, topic/description, participant count, creation date, country of origin, privacy settings, and the full raw WhatsApp API response. Perfect for **community research**, **competitor analysis**, **lead generation**, and **market intelligence**. ### Why use WhatsApp Group Scraper? - **Real-time data** — Live check against WhatsApp's servers, not a cached database - **Bulk-ready** — Pass hundreds of group links in a single run - **Flexible input** — Accepts full invite URLs, short URLs, or bare invite codes - **Rich metadata** — Group name, topic, participant count, creation date, country, privacy flags - **Raw output** — Complete WhatsApp API response, no data lost ### How to use 1. Open the Actor in the Apify Console or via the API 2. Paste your list of WhatsApp group invite links into `groupLinks` 3. Click **Start** — results appear in the dataset as each group is fetched 4. Download as JSON, CSV, or Excel #### Example input ```json { "groupLinks": [ "https://chat.whatsapp.com/invite/IJhrKyIsd3aCo3JypCW3KA", "https://chat.whatsapp.com/ABC123XYZ", "DEF456uvw" ] } ```` ### Input | Field | Type | Required | Description | |---|---|---|---| | `groupLinks` | string\[] | ✓ | Invite links or codes. Accepted: full URL, short URL, or bare invite code. | ### Output One record per group — raw response from WhatsApp's API with `invite_code` and `found` fields added: ```json { "invite_code": "IJhrKyIsd3aCo3JypCW3KA", "found": true, "JID": "918376064235-1587060182@g.us", "Name": "𝚈𝚘𝚞 𝚝𝚞𝚋𝚎 𝚌𝚛𝚎𝚊𝚝𝚒𝚘𝚗", "Topic": "I don't give girl flower 🌸 not to about love 😍,", "ParticipantCount": 78, "GroupCreated": "2020-04-17T01:03:02+07:00", "CreatorCountryCode": "IN", "IsLocked": false, "IsAnnounce": false, "IsJoinApprovalRequired": false } ``` Invalid or expired invite codes return: ```json { "invite_code": "EXPIREDCODE", "found": false } ``` ### Data fields | Field | Type | Description | |---|---|---| | `invite_code` | string | Extracted invite code (added by Actor) | | `found` | boolean | Whether the group was found | | `JID` | string | WhatsApp group JID | | `Name` | string | Group display name | | `Topic` | string | Group description/topic | | `ParticipantCount` | integer | Number of members | | `GroupCreated` | string | ISO 8601 creation timestamp | | `CreatorCountryCode` | string | 2-letter country code of group creator | | `IsLocked` | boolean | Only admins can edit group info | | `IsAnnounce` | boolean | Only admins can send messages | | `IsJoinApprovalRequired` | boolean | Admin approval required to join | ### Pricing **Pay-per-event:** - $0.05 per Actor start - **$0.008 per group scraped** ($8 per 1,000 groups) | Groups | Cost | |---|---| | 100 | $0.85 | | 1,000 | $8.05 | | 10,000 | $80.05 | ### FAQ **What if the invite link is expired?** The record will return `found: false`. No charge for groups not found. **Can I scrape private groups I'm not a member of?** This Actor fetches metadata via the invite link — no membership required for public groups. **Is this legal?** WhatsApp group invite links are intentionally shareable. Always comply with applicable data privacy laws in your jurisdiction. **Found a bug or need a custom feature?** Open an issue in the [Issues tab](https://apify.com/RomySaputraSihananda/whatsapp-group-scraper/issues). # Actor input Schema ## `groupLinks` (type: `array`): WhatsApp group invite links or codes. Accepted formats: full URL (https://chat.whatsapp.com/invite/CODE), short URL (https://chat.whatsapp.com/CODE), or bare invite code. ## Actor input object example ```json { "groupLinks": [ "https://chat.whatsapp.com/invite/IJhrKyIsd3aCo3JypCW3KA" ] } ``` # Actor output Schema ## `dataset` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "groupLinks": [ "https://chat.whatsapp.com/invite/IJhrKyIsd3aCo3JypCW3KA" ] }; // Run the Actor and wait for it to finish const run = await client.actor("romy/whatsapp-group-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "groupLinks": ["https://chat.whatsapp.com/invite/IJhrKyIsd3aCo3JypCW3KA"] } # Run the Actor and wait for it to finish run = client.actor("romy/whatsapp-group-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "groupLinks": [ "https://chat.whatsapp.com/invite/IJhrKyIsd3aCo3JypCW3KA" ] }' | apify call romy/whatsapp-group-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=romy/whatsapp-group-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Whatsapp Group Scraper", "description": "Fetch metadata from WhatsApp groups using invite links or invite codes. Returns group name, description, participant count, creation date, and more — in real time from WhatsApp.", "version": "0.0", "x-build-id": "LMSz6EPnu2H4Dx4wx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/romy~whatsapp-group-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-romy-whatsapp-group-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/romy~whatsapp-group-scraper/runs": { "post": { "operationId": "runs-sync-romy-whatsapp-group-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/romy~whatsapp-group-scraper/run-sync": { "post": { "operationId": "run-sync-romy-whatsapp-group-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", "required": [ "groupLinks" ], "properties": { "groupLinks": { "title": "Group Links or Invite Codes", "type": "array", "description": "WhatsApp group invite links or codes. Accepted formats: full URL (https://chat.whatsapp.com/invite/CODE), short URL (https://chat.whatsapp.com/CODE), or bare invite code.", "items": { "type": "string" } } } }, "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 } } } } } } } } } } ```