{ "openapi": "3.0.1", "info": { "title": "Skool Community Scraper", "description": "Scrape Skool communities from discovery search and category filters. Extract listing data plus optional about-page details, owner, reviews, top members, classroom, and calendar.", "version": "1.0", "x-build-id": "Y6aB8fujOgmuciFBe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rigelbytes~skool-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rigelbytes-skool-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/rigelbytes~skool-scraper/runs": { "post": { "operationId": "runs-sync-rigelbytes-skool-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/rigelbytes~skool-scraper/run-sync": { "post": { "operationId": "run-sync-rigelbytes-skool-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 to search on Skool discovery (the `q` parameter), e.g. \"ai video\" or \"fitness\". Leave empty to browse by category and filters only.", "items": { "type": "string" } }, "categories": { "title": "Categories", "uniqueItems": true, "type": "array", "description": "Discovery categories. Leave empty to search across all categories. Trending is a sort option, not a category.", "items": { "type": "string", "enum": [ "hobbies", "music", "money", "spirituality", "tech", "health", "sports", "self_improvement", "relationships" ], "enumTitles": [ "Hobbies", "Music", "Money", "Spirituality", "Tech", "Health", "Sports", "Self-improvement", "Relationships" ] } }, "communityUrls": { "title": "Community URLs", "type": "array", "description": "Optional Skool community URLs or slugs to scrape directly, e.g. https://www.skool.com/aivideobootcamp/about.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "price": { "title": "Price", "enum": [ "", "free", "paid", "free-trial" ], "type": "string", "description": "Discovery price filter.", "default": "" }, "communityType": { "title": "Type", "enum": [ "", "public", "private" ], "type": "string", "description": "Discovery visibility filter.", "default": "" }, "sortBy": { "title": "Sort by", "enum": [ "trending", "top-v2" ], "type": "string", "description": "Discovery sort order. Use trending (default) or top.", "default": "trending" }, "language": { "title": "Language", "type": "string", "description": "Discovery language filter (Skool `lang` parameter).", "default": "english" }, "scrapeCommunityDetails": { "title": "Scrape community details", "type": "boolean", "description": "Visit each community about page for owner/admin, landing description, price, ratings, and stats. Charged as community-details.", "default": false }, "scrapeCommunityReviews": { "title": "Scrape community reviews", "type": "boolean", "description": "Extract community reviews (about-page preview plus remaining pages). Charged as community-reviews.", "default": false }, "scrapeMembers": { "title": "Scrape top members", "type": "boolean", "description": "Extract the public top members list (about 30) when the community has not hidden members.", "default": false }, "scrapeClassroom": { "title": "Scrape classroom", "type": "boolean", "description": "Extract public classroom courses and modules when the classroom tab is visible.", "default": false }, "scrapeCalendar": { "title": "Scrape calendar", "type": "boolean", "description": "Extract public calendar events when the calendar tab is visible.", "default": false }, "maxItems": { "title": "Max communities", "minimum": 0, "type": "integer", "description": "Maximum number of communities to scrape (0 = unlimited).", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Apify Residential proxies are recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } }, "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 } } } } } } } } } }