{
  "openapi": "3.0.1",
  "info": {
    "title": "Facebook Groups Search Scraper",
    "description": "Discover public Facebook groups by keyword and return clean group URLs, names, descriptions, visibility hints and member-count hints. Filter by minimum members or public groups only. No login needed.",
    "version": "1.2",
    "x-build-id": "6OKZ0BIipUC32P9vn"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/khadinakbar~facebook-groups-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-khadinakbar-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/khadinakbar~facebook-groups-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-khadinakbar-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/khadinakbar~facebook-groups-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-khadinakbar-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",
        "required": [
          "searchQueries"
        ],
        "properties": {
          "searchQueries": {
            "title": "Facebook group search queries",
            "type": "array",
            "description": "Use this when you want to discover Google-indexed Facebook groups for one or more topics. Provide short natural-language phrases such as 'real estate investors' or 'small business owners London' (up to 10). Each query is searched across several result pages, so one query can return up to 100 unique groups. The same group found by two queries is saved once. This is not a Facebook group URL input and does not access private content.",
            "items": {
              "type": "string"
            }
          },
          "maxResultsPerQuery": {
            "title": "Maximum groups per query",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Use this when you need to cap the unique Facebook groups returned for each search query. Enter 1 to 100; the default is 20. The Actor reads as many result pages as needed to reach your number, so a larger value means more groups (and more events). It is a ceiling, not a guarantee: a niche query may have fewer indexed groups.",
            "default": 20
          },
          "countryCode": {
            "title": "Search country code",
            "type": "string",
            "description": "Use this when the group search should be localized to a country. Enter a two-letter uppercase country code such as 'US', 'GB', or 'CA'; the default is 'US'. This affects the regional search results, not Facebook group membership or visibility. This is not a city or language field.",
            "default": "US"
          },
          "location": {
            "title": "Location filter",
            "type": "string",
            "description": "Keep only groups whose name or description mentions this place, for example 'Austin' or 'London UK'. The place is also added to the search to find more local groups. This matches the words in the public listing; it does not read where members live. Leave empty for no location filter."
          },
          "minMembers": {
            "title": "Minimum members",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only groups with at least this many members, for example 1000. Without exact details the member count comes from the search snippet, so groups with no visible count are skipped; with 'Add exact group details' on, the exact count is used. Filtered-out groups are not charged. Leave empty to keep every group."
          },
          "maxMembers": {
            "title": "Maximum members",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only groups with at most this many members, for example 50000. Handy for finding small, active niche groups. Same counting rules as the minimum. Filtered-out groups are not charged. Leave empty for no upper limit."
          },
          "publicOnly": {
            "title": "Public groups only",
            "type": "boolean",
            "description": "Keep only groups that are public. Without exact details this uses the public/private word in the search snippet, so groups with no visibility hint are skipped; with 'Add exact group details' on, Facebook's own label is used. Filtered-out groups are not charged. Default off.",
            "default": false
          },
          "enrichGroups": {
            "title": "Add exact group details (extra charge)",
            "type": "boolean",
            "description": "Look up each group and add the exact member count, public/private label, created date, posts per day and month, categories, admin and moderator counts and rule count. Each group with details is billed one extra 'group-enriched' event on top of the normal group event. Starts after the new price takes effect; until then the run returns normal rows and charges nothing extra. Default off.",
            "default": false
          },
          "includeRawData": {
            "title": "Include raw search result",
            "type": "boolean",
            "description": "Add the unprocessed search result to each row as rawSearchResult, for debugging or custom parsing. Does not change the price. Default off.",
            "default": 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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}