{ "openapi": "3.0.1", "info": { "title": "Skool Communities Scraper — Discovery, Pricing & Owner Links", "description": "Scrape Skool discovery by keyword, category, language, and price. Members, rating, price per month, courses, posts, plus owner website, Instagram, YouTube, X, and LinkedIn. Beats the 1,000-result cap.", "version": "0.1", "x-build-id": "3zk75uMoRXSXct9L8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spotless_studios~skool-communities-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spotless_studios-skool-communities-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/spotless_studios~skool-communities-scraper/runs": { "post": { "operationId": "runs-sync-spotless_studios-skool-communities-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/spotless_studios~skool-communities-scraper/run-sync": { "post": { "operationId": "run-sync-spotless_studios-skool-communities-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 queries", "type": "array", "description": "Keywords searched in Skool discovery, e.g. ai automation, trading, fitness coach. Empty = browse.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Skool categories by name or slug: hobbies, music, money, spirituality, tech, health, sports, self-improvement, relationships, and more.", "items": { "type": "string" } }, "splitByCategory": { "title": "Split by category (beat the 1,000 cap)", "type": "boolean", "description": "Skool shows at most ~1,000 communities per query. With no categories set, this also runs every category separately to collect far more.", "default": false }, "languages": { "title": "Languages", "type": "array", "description": "Skool language names, e.g. english, german, spanish, french, portuguese. Empty = Skool's default (English).", "items": { "type": "string" } }, "price": { "title": "Price", "enum": [ "any", "free", "paid" ], "type": "string", "description": "Server-side price filter.", "default": "any" }, "minMembers": { "title": "Min members", "minimum": 0, "type": "integer", "description": "Keep communities with at least this many members." }, "maxMembers": { "title": "Max members", "minimum": 0, "type": "integer", "description": "Keep smaller communities (e.g. up to 500 members)." }, "minPriceUsd": { "title": "Min price per month", "minimum": 0, "type": "integer", "description": "Monthly-equivalent price in the community's currency (yearly plans divided by 12)." }, "maxPriceUsd": { "title": "Max price per month", "minimum": 0, "type": "integer", "description": "Monthly-equivalent price ceiling." }, "minRating": { "title": "Min rating", "type": "string", "description": "Average review rating from 0 to 5, e.g. 4.5." }, "minReviews": { "title": "Min reviews", "minimum": 0, "type": "integer", "description": "Keep communities with at least this many reviews." }, "createdAfter": { "title": "Created after", "type": "string", "description": "YYYY-MM-DD or relative, e.g. 90 days. Find new, fast-growing communities." }, "createdBefore": { "title": "Created before", "type": "string", "description": "YYYY-MM-DD or relative." }, "communityUrls": { "title": "Direct community URLs or slugs", "type": "array", "description": "Scrape specific Skool communities directly (e.g. https://www.skool.com/hormozi or hormozi). When set without discovery filters, skips discovery crawl.", "items": { "type": "string" } }, "includeDetails": { "title": "Include about-page details", "type": "boolean", "description": "Adds owner name, bio, website, Instagram, YouTube, X, LinkedIn, Facebook, MRR tier, plus courses, posts, admins, online members, affiliate %, pricing tiers, and marketing tools used. Billed as an add-on per community.", "default": false }, "ownerHasWebsite": { "title": "Only owners with a website", "type": "boolean", "description": "Keep communities whose owner lists a website. Turns on details automatically.", "default": false }, "includeKeywords": { "title": "Include keywords", "type": "array", "description": "Keep communities whose name, description, landing page, or owner bio contain these words. /regex/ supported.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Drop communities containing any of these words or /regex/.", "items": { "type": "string" } }, "keywordMatch": { "title": "Include keyword logic", "enum": [ "any", "all" ], "type": "string", "description": "Require any or all include keywords.", "default": "any" }, "onlyNewItems": { "title": "Only new communities (monitoring mode)", "type": "boolean", "description": "Remember communities from previous runs and save only new ones.", "default": false }, "stateKey": { "title": "Monitor name", "type": "string", "description": "Separate memory per saved search.", "default": "default" }, "maxResults": { "title": "Max communities", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after saving this many communities.", "default": 50 }, "outputPreset": { "title": "Data preset", "enum": [ "full", "lean", "contacts" ], "type": "string", "description": "Quickly choose how much data to save per record: full record, lean summary, or contact & social links only.", "default": "full" }, "outputFields": { "title": "Output fields", "type": "array", "description": "Save only these fields, in this order (e.g. name, url, members, priceMonthly, ownerName, ownerWebsite, ownerInstagram). Supports nested dot-paths (e.g. makers.username). Empty keeps all fields from the selected preset.", "items": { "type": "string" } }, "excludeFields": { "title": "Exclude fields", "type": "array", "description": "Remove specific fields (or nested dot-paths) from each saved record to keep datasets compact.", "items": { "type": "string" } }, "includeEmptyFields": { "title": "Keep empty / null fields", "type": "boolean", "description": "When turned off, strips null, empty strings, empty arrays, and empty objects from every saved record.", "default": true }, "requiredFields": { "title": "Required non-empty fields", "type": "array", "description": "Only save (and only pay for) records where every listed field or dot-path has a non-empty value (e.g. website, inquiryEmail).", "items": { "type": "string" } }, "maxPagesPerQuery": { "title": "Max pages per query", "minimum": 1, "maximum": 34, "type": "integer", "description": "30 communities per page; Skool stops at 34 pages.", "default": 34 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 12, "type": "integer", "description": "About pages fetched in parallel when details are on.", "default": 4 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Use Apify Proxy (RESIDENTIAL) if Skool's bot check blocks runs.", "default": { "useApifyProxy": false } }, "proxyEscalation": { "title": "Auto-escalate proxies when blocked", "type": "boolean", "description": "If the site blocks the run, automatically step up from a direct connection to Apify datacenter proxy, then residential proxy, only for the blocked site. Turn off to use exactly the proxy above.", "default": 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 } } } } } } } } } }