{
  "openapi": "3.0.1",
  "info": {
    "title": "Facebook Groups Search Scraper: Find Groups by Keyword",
    "description": "Find Facebook groups by keyword, location or language without login: one row per group with name, link, group id, public or private, exact members, posts per day and month, created date, location, description, rules and admin count.",
    "version": "0.1",
    "x-build-id": "mWs03kVHAaodANlEO"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/themineworks~facebook-groups-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-themineworks-facebook-groups-search-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/themineworks~facebook-groups-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-themineworks-facebook-groups-search-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/themineworks~facebook-groups-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-themineworks-facebook-groups-search-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": {
          "searchQueries": {
            "title": "Keywords",
            "type": "array",
            "description": "What the groups are about, one keyword or phrase per line. Example: real estate investors, dog lovers, crypto trading, nurses. Each keyword is searched on its own. Up to 100 keywords per run.",
            "items": {
              "type": "string"
            }
          },
          "location": {
            "title": "Location (optional)",
            "type": "string",
            "description": "A city, region or country added to every search, for example London, Texas or Mumbai. It steers the search toward local groups. Turn on \"Only groups that mention the location\" to drop groups that do not name it."
          },
          "language": {
            "title": "Language (optional)",
            "enum": [
              "",
              "en",
              "es",
              "pt",
              "fr",
              "de",
              "it",
              "nl",
              "pl",
              "tr",
              "id",
              "vi",
              "ar",
              "hi",
              "ro",
              "sv",
              "tl"
            ],
            "type": "string",
            "description": "Adds that language's words for group and community to the searches and asks DuckDuckGo for that region, so groups in that language come up first. It steers the search; Facebook does not publish a group's language, so it is not a strict filter.",
            "default": ""
          },
          "maxGroupsPerKeyword": {
            "title": "Max groups per keyword",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Stop a keyword once this many groups are delivered, 1 to 1,000. Popular keywords usually reach 100 to 300 groups, niche ones fewer. Example: 100.",
            "default": 50
          },
          "includeAbout": {
            "title": "Read each group's About page (members, privacy, activity)",
            "type": "boolean",
            "description": "On: each group's public About data is read logged out for the exact member count, public or private, posts today and in the last 30 days, created date, every location, the rules and the number of admins and moderators. Off: rows carry the group id, name, link, description and first location only, which is faster. Same price either way.",
            "default": true
          },
          "privacy": {
            "title": "Privacy",
            "enum": [
              "any",
              "public",
              "private"
            ],
            "type": "string",
            "description": "Keep only public or only private groups. Private groups still show their name, members, activity, location and rules to anyone; only their posts are hidden. Needs the About page (turned on automatically).",
            "default": "any"
          },
          "minMembers": {
            "title": "Minimum members",
            "minimum": 0,
            "type": "integer",
            "description": "Skip groups with fewer members than this. 0 keeps every size. Needs the About page (turned on automatically). Groups skipped by a filter are never charged.",
            "default": 0
          },
          "requireKeywordMatch": {
            "title": "Only groups whose name or description has the keyword",
            "type": "boolean",
            "description": "Keep a group only when every word of the keyword appears in its name, description or location. Off: groups whose members posted about the keyword are kept too. Each row says where the keyword matched in keyword_match.",
            "default": false
          },
          "locationMustMatch": {
            "title": "Only groups that mention the location",
            "type": "boolean",
            "description": "With a location set, keep a group only when its Facebook locations, name or description name every word of it.",
            "default": false
          },
          "startUrls": {
            "title": "Group links (optional)",
            "type": "array",
            "description": "Facebook group links to read directly, one per line: https://www.facebook.com/groups/<name or id>/, a post or About link inside a group, or a share link https://www.facebook.com/share/g/<code>/. A Facebook group search link (https://www.facebook.com/search/groups/?q=yoga) becomes a keyword. Filters do not apply to groups you list.",
            "items": {
              "type": "string"
            }
          },
          "searchEngines": {
            "title": "Search engines",
            "type": "array",
            "description": "Where groups are looked up, in this order. DuckDuckGo and Brave are included in the price. Google adds more groups for some keywords; it is used only when you add it here and does not change the price.",
            "items": {
              "type": "string",
              "enum": [
                "duckduckgo",
                "brave",
                "google"
              ],
              "enumTitles": [
                "DuckDuckGo",
                "Brave Search",
                "Google"
              ]
            },
            "default": [
              "duckduckgo",
              "brave"
            ]
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}