{ "openapi": "3.0.1", "info": { "title": "WhatsApp Group Links Scraper & Category Directories", "description": "Find and extract public WhatsApp group invite links from websites, search results, and online directories. Collect group names, invite URLs, categories, and related details for research, community discovery, market analysis, and lead generation workflows.", "version": "0.1", "x-build-id": "bbwvAVbbiUPFF5ubQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapier~whatsapp-group-links-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapier-whatsapp-group-links-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/scrapier~whatsapp-group-links-scraper/runs": { "post": { "operationId": "runs-sync-scrapier-whatsapp-group-links-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/scrapier~whatsapp-group-links-scraper/run-sync": { "post": { "operationId": "run-sync-scrapier-whatsapp-group-links-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": { "searchTerms": { "title": "πŸ”‘ Search Terms", "type": "array", "description": "Topics to look up on the chosen social network, e.g. \"marketing\", \"crypto jobs\", \"real estate\". One row per public post that advertises a WhatsApp group. Legacy name: `keywords`.", "items": { "type": "string" } }, "socialNetwork": { "title": "πŸ“² Social Network To Scan", "enum": [ "facebook.com", "linkedin.com", "instagram.com", "twitter.com", "youtube.com", "reddit.com", "pinterest.com", "tiktok.com" ], "type": "string", "description": "Which social network the keyword lane looks through for public join-link mentions. Legacy name: `platform`." }, "geoTarget": { "title": "πŸ—ΊοΈ Geo Target", "enum": [ "us", "uk", "ca", "au", "in", "it", "gm", "fr", "sp", "al", "ag", "ar", "am", "as", "aj", "bg", "bo", "be", "bh", "bk", "br", "bu", "ci", "ch", "co", "cs", "hr", "cu", "ez", "dk", "ec", "eg", "en", "fi", "gg", "gr", "hk", "hu", "ic", "id", "ir", "iz", "ei", "is", "jm", "ja", "ke", "kn", "ks", "ku", "lg", "ly", "ls", "lh", "lu", "mc", "mk", "my", "mt", "mx", "md", "mn", "mj", "mo", "np", "nl", "nz", "ni", "no", "pk", "we", "pm", "pa", "pe", "rp", "pl", "po", "rq", "qa", "ro", "rs", "sm", "sa", "sg", "ri", "sn", "lo", "si", "sf", "sw", "sz", "sy", "tw", "th", "ts", "tu", "ua", "ae", "uy", "uz", "ve" ], "type": "string", "description": "Country bias for the keyword lane (FIPS 10-4 code). Has no effect on the directory lane, which is worldwide. Legacy name: `country`." }, "linkSource": { "title": "🧭 Collection Lane", "enum": [ "directory", "search_engine", "both" ], "type": "string", "description": "πŸ“‚ Category directories β€” browse curated directory listings by category (worldwide, no keyword needed). πŸ”Ž Keyword search β€” the classic social-network lookup. πŸ”€ Both lanes β€” run the directory pass first, then the keyword pass. Every row is tagged with `discoverySource` so you always know where it came from." }, "groupCategory": { "title": "🏷️ Directory Category", "enum": [ "all", "friendship", "indian", "pakistan", "usa", "students", "education", "earn_money", "jobs", "business", "crypto", "trading_forex", "shopping", "movies", "gaming", "cricket", "sports", "news", "girls", "social" ], "type": "string", "description": "Which directory category to walk. Pick 🌐 All categories to sweep every category that is available. The chosen category is written to the `groupCategory` column on every directory row." }, "maxGroupsPerCategory": { "title": "πŸ“¦ Max Groups Per Category", "minimum": 1, "type": "integer", "description": "Caps how many groups are taken from each directory category before moving to the next one, so one huge category cannot swallow the whole run. Example: 20 categories Γ— 15 = up to 300 groups. Leave empty for no per-category cap." }, "minClaimedMembers": { "title": "πŸ‘₯ Minimum Claimed Members", "minimum": 0, "type": "integer", "description": "Keep only directory groups whose listing claims at least this many members (e.g. 300 keeps \"300+ members\" and \"1000+ members\", drops \"150+ members\"). Groups whose listing states no member figure are dropped while this is set β€” leave it empty or 0 to keep them all. Never applies to keyword-lane rows, which carry no member figure." }, "maxGroupRecords": { "title": "πŸ”’ Max Rows In Total", "minimum": 1, "type": "integer", "description": "Hard ceiling on rows written across both lanes together. Leave empty for no ceiling. Legacy name: `limit`." }, "keywords": { "title": "πŸ”‘ keywords (legacy alias of Search Terms)", "type": "array", "description": "Backward-compatible alias of πŸ”‘ Search Terms.", "items": { "type": "string" } }, "platform": { "title": "πŸ“² platform (legacy alias of Social Network)", "enum": [ "facebook.com", "linkedin.com", "instagram.com", "twitter.com", "youtube.com", "reddit.com", "pinterest.com", "tiktok.com" ], "type": "string", "description": "Backward-compatible alias of πŸ“² Social Network To Scan." }, "country": { "title": "πŸ—ΊοΈ country (legacy alias of Geo Target)", "enum": [ "us", "uk", "ca", "au", "in", "it", "gm", "fr", "sp", "al", "ag", "ar", "am", "as", "aj", "bg", "bo", "be", "bh", "bk", "br", "bu", "ci", "ch", "co", "cs", "hr", "cu", "ez", "dk", "ec", "eg", "en", "fi", "gg", "gr", "hk", "hu", "ic", "id", "ir", "iz", "ei", "is", "jm", "ja", "ke", "kn", "ks", "ku", "lg", "ly", "ls", "lh", "lu", "mc", "mk", "my", "mt", "mx", "md", "mn", "mj", "mo", "np", "nl", "nz", "ni", "no", "pk", "we", "pm", "pa", "pe", "rp", "pl", "po", "rq", "qa", "ro", "rs", "sm", "sa", "sg", "ri", "sn", "lo", "si", "sf", "sw", "sz", "sy", "tw", "th", "ts", "tu", "ua", "ae", "uy", "uz", "ve" ], "type": "string", "description": "Backward-compatible alias of πŸ—ΊοΈ Geo Target." }, "limit": { "title": "πŸ”’ limit (legacy alias of Max Rows In Total)", "minimum": 1, "type": "integer", "description": "Backward-compatible alias of πŸ”’ Max Rows In Total." }, "proxyConfiguration": { "title": "πŸ›‘οΈ Proxy Configuration", "type": "object", "description": "Network route used while collecting. The Actor starts on the configured route and automatically adjusts if a source stops responding.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "GOOGLE_SERP" ] } } } }, "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 } } } } } } } } } }