{
  "openapi": "3.0.1",
  "info": {
    "title": "WhatsApp Group Link Search Scraper",
    "description": "Find public WhatsApp group invite links by topic or in the GroupWhat directory. Turn on Include WhatsApp Channels to add publicly indexed Channel invite links. Get a structured dataset with normalized links, source context, discovery details, and public preview metadata when available.",
    "version": "3.0",
    "x-build-id": "SOaZ9MOglwTjshqBe"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/maximedupre~whatsapp-group-links/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-maximedupre-whatsapp-group-links",
        "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/maximedupre~whatsapp-group-links/runs": {
      "post": {
        "operationId": "runs-sync-maximedupre-whatsapp-group-links",
        "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/maximedupre~whatsapp-group-links/run-sync": {
      "post": {
        "operationId": "run-sync-maximedupre-whatsapp-group-links",
        "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": [
          "discoveryMethod"
        ],
        "properties": {
          "discoveryMethod": {
            "title": "Find links by",
            "enum": [
              "topic",
              "directory",
              "groupwhat",
              "listing"
            ],
            "type": "string",
            "description": "Choose one way to find public WhatsApp invite links."
          },
          "socialNetwork": {
            "title": "Public social network",
            "type": "string",
            "description": "Choose one public social network to search for topic matches."
          },
          "region": {
            "title": "Country or region",
            "type": "string",
            "description": "Bias Search by topic toward this country or region. This does not prove where a group is based."
          },
          "topicMatching": {
            "title": "Topic matching",
            "enum": [
              "focused",
              "related"
            ],
            "type": "string",
            "description": "Choose focused topic matching or broader discovery through related phrases."
          },
          "searchCoverage": {
            "title": "Search coverage",
            "enum": [
              "single",
              "broad"
            ],
            "type": "string",
            "description": "Choose one public search index or broader coverage across independent public search indexes."
          },
          "directoryCategory": {
            "title": "Directory category",
            "minLength": 1,
            "type": "string",
            "description": "For Browse directories, enter a category to filter public directory listings. GroupWhat country and language filters apply together with this category."
          },
          "directoryCountry": {
            "title": "Directory country",
            "minLength": 1,
            "type": "string",
            "description": "For Browse directories, keep GroupWhat listings in this country. Use the country name or its directory URL slug. Leave it empty for all countries."
          },
          "directoryLanguage": {
            "title": "Directory language",
            "minLength": 1,
            "type": "string",
            "description": "For Browse directories, keep GroupWhat listings in this language. Use the language name or its directory URL slug. Leave it empty for all languages."
          },
          "minimumClaimedMembers": {
            "title": "Minimum claimed members",
            "minimum": 0,
            "type": "integer",
            "description": "For Browse directories, keep only listings that claim at least this many members. GroupWhat does not publish member counts, so this currently removes every GroupWhat listing, whatever number you enter."
          },
          "listingUrls": {
            "title": "GroupWhat listing URLs",
            "minItems": 1,
            "type": "array",
            "description": "For Look up GroupWhat listings, add one or more full URLs of public GroupWhat group pages. Each page is checked for its group link and public details.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "topics": {
            "title": "Topics to search",
            "minItems": 1,
            "type": "array",
            "description": "Enter one or more topics for Search by topic or Search GroupWhat. Each topic is searched in this run. Other choices ignore this list.",
            "items": {
              "type": "string",
              "minLength": 1
            }
          },
          "includeChannels": {
            "title": "Include WhatsApp Channels",
            "type": "boolean",
            "description": "For Search by topic and Browse directories, also return publicly indexed WhatsApp Channel invite links. Leave this off to return group links only. Search GroupWhat and Look up GroupWhat listings return group links only.",
            "default": false
          },
          "maxResults": {
            "title": "Result limit",
            "minimum": 1,
            "type": "integer",
            "description": "Stop after this many matching links. Leave it empty to collect all available results until public sources are exhausted. This is a limit, not a promise that the source will return this many links."
          }
        }
      },
      "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}