{
  "openapi": "3.0.1",
  "info": {
    "title": "Facebook Groups Search Scraper - Members, Activity & Rules",
    "description": "Find Facebook groups by keyword and city: group ID, name, URL, cover, exact member count, public or private, posts per day and month, created date, rules and admins. No login, no cookies. $0.80 per 1,000 groups, $2.60 with the About data.",
    "version": "0.1",
    "x-build-id": "BdbWvuYOikI5hJ1rI"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/topapi~facebook-groups-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-topapi-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/topapi~facebook-groups-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-topapi-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/topapi~facebook-groups-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-topapi-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": "Search terms",
            "type": "array",
            "description": "Topics to find groups for, one per line, e.g. \"yoga\", \"real estate investors\", \"tesla owners\". Each term is searched on its own in a web index of facebook.com/groups.",
            "items": {
              "type": "string"
            }
          },
          "locations": {
            "title": "Location (added to each term)",
            "type": "array",
            "description": "Optional city, region or country, one per line, e.g. \"Austin\" or \"London\". Each term is searched once per location (\"yoga Austin\"). Empty = no location.",
            "items": {
              "type": "string"
            }
          },
          "groupUrls": {
            "title": "Group links, IDs or names",
            "type": "array",
            "description": "Groups you already know, one per line: a link (facebook.com/groups/cheapmealideas, /groups/126966114029232/posts/...), a numeric ID or a vanity name. Each becomes one row.",
            "items": {
              "type": "string"
            }
          },
          "privacy": {
            "title": "Privacy",
            "enum": [
              "any",
              "public",
              "private"
            ],
            "type": "string",
            "description": "Keep public groups, private groups or both. Facebook shows the About data of private groups to anyone, only their posts are hidden.",
            "default": "any"
          },
          "minMembers": {
            "title": "Minimum members",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Keep only groups with at least this many members (the exact count from the group's About data). Empty = no minimum."
          },
          "maxMembers": {
            "title": "Maximum members",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Keep only groups with at most this many members, e.g. 5000 for small local groups. Empty = no maximum."
          },
          "minPostsPerDay": {
            "title": "Minimum posts per day",
            "minimum": 0,
            "maximum": 100000,
            "type": "number",
            "description": "Keep only active groups: posts in the last month / 30 at least this, e.g. 1. Empty = any activity."
          },
          "minPostsPerMonth": {
            "title": "Minimum posts per month",
            "minimum": 0,
            "maximum": 10000000,
            "type": "integer",
            "description": "Keep only groups with at least this many posts in the last month. Empty = any."
          },
          "locationContains": {
            "title": "Group location contains",
            "type": "array",
            "description": "Keep only groups whose own locations, name or description mention one of these words, e.g. \"Texas\". Not case sensitive. Empty = anywhere.",
            "items": {
              "type": "string"
            }
          },
          "requireKeywordMatch": {
            "title": "Only groups that mention the keyword",
            "type": "boolean",
            "description": "On: keep only groups whose name or search result (title, snippet) contains every word of the term, in any form (\"photography\" finds \"photographers\"); others are skipped before their About data is read. Off: every group listed.",
            "default": true
          },
          "createdAfter": {
            "title": "Created on or after",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$",
            "type": "string",
            "description": "Keep only groups created on or after this day (YYYY-MM-DD), e.g. new groups of this year."
          },
          "createdBefore": {
            "title": "Created on or before",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$",
            "type": "string",
            "description": "Keep only groups created on or before this day (YYYY-MM-DD)."
          },
          "excludeGroupIds": {
            "title": "Skip these groups",
            "type": "array",
            "description": "Group IDs, vanity names or links never to return (groups you already have).",
            "items": {
              "type": "string"
            }
          },
          "includeDetails": {
            "title": "Group About data",
            "type": "boolean",
            "description": "On: each group's About data is read: exact members, privacy, visibility, posts in the last day and month, created date, history, description, tags, locations, admins and moderators shown publicly, rules. Charged as group-details. Off: the search row only.",
            "default": true
          },
          "includeRules": {
            "title": "Group rules",
            "type": "boolean",
            "description": "With the About data: include each rule's title and text. Included in the group-details price.",
            "default": true
          },
          "includeMembershipQuestions": {
            "title": "Membership questions flag",
            "type": "boolean",
            "description": "With the About data: also read whether the group asks joining members questions (hasMembershipQuestions) and the visitor join state. One more read per group; included in the group-details price.",
            "default": false
          },
          "requireDetails": {
            "title": "Only rows with the About data",
            "type": "boolean",
            "description": "On: a group whose About data Facebook does not serve is skipped, and the run stops once Facebook refuses the About data to the run's IPs. Off: such groups are delivered as search rows (group event only).",
            "default": false
          },
          "monitorMode": {
            "title": "Monitor: only new groups",
            "type": "boolean",
            "description": "Deliver (and charge) only groups no earlier monitor run delivered. Pairs with a daily or weekly schedule.",
            "default": false
          },
          "monitorChanges": {
            "title": "Monitor: also changed groups",
            "type": "boolean",
            "description": "In monitor mode, also deliver known groups that changed. Free check first: a known group's About data is read again only if its name, privacy or cover changed, or its last read is older than the re-read interval; each re-read is delivered and charged.",
            "default": false
          },
          "monitorRefreshDays": {
            "title": "Monitor: re-read interval (days)",
            "minimum": 0,
            "maximum": 365,
            "type": "integer",
            "description": "With changed groups on: re-read a known group's member count and activity when its last read is this many days old (charged as a row, changed true or false). 0 = only on a name, privacy or cover change.",
            "default": 7
          },
          "monitorStoreName": {
            "title": "Monitor memory name",
            "type": "string",
            "description": "Named key-value store that remembers delivered groups. Use one name per watch list.",
            "default": "facebook-groups-search-monitor"
          },
          "maxItems": {
            "title": "Maximum groups in total",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Stop after this many groups across every search. You pay only for groups delivered. 0 = no limit (a topic + city term lists ~275 groups).",
            "default": 100
          },
          "maxGroupsPerQuery": {
            "title": "Maximum groups per search",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Stop each search term (x location) after this many groups. Empty = only the total limit applies."
          },
          "searchEngines": {
            "title": "Search engines",
            "type": "array",
            "description": "Web indexes that list the groups. Yahoo is the default; DuckDuckGo lite is used on its own when Yahoo refuses the run, or for every search when listed here.",
            "items": {
              "type": "string",
              "enum": [
                "yahoo",
                "duckduckgo"
              ],
              "enumTitles": [
                "Yahoo",
                "DuckDuckGo"
              ]
            },
            "default": [
              "yahoo"
            ]
          },
          "maxConcurrency": {
            "title": "Groups read at once",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many groups' About data are read in parallel.",
            "default": 4
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Leave as is: the run starts on Apify's own connection and climbs to one Apify datacenter and one residential session only when a step is refused. Your own proxy URLs or groups replace that ladder.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}