{ "openapi": "3.0.1", "info": { "title": "Skool Community Scraper - Catalogue & Owner Insights", "description": "Find Skool communities for niche research and creator partnerships. Export member counts, visible pricing, public owner links, review ratings, and optional feedback samples. Search the indexed catalogue or target exact communities, with structured JSON results.", "version": "1.0", "x-build-id": "zvlHRpSTCjhUmQCgt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axlymxp~skool-community-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axlymxp-skool-community-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/axlymxp~skool-community-scraper/runs": { "post": { "operationId": "runs-sync-axlymxp-skool-community-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/axlymxp~skool-community-scraper/run-sync": { "post": { "operationId": "run-sync-axlymxp-skool-community-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": { "mode": { "title": "Source", "enum": [ "catalogue", "discovery", "urls" ], "type": "string", "description": "Catalogue uses cursor pagination; Discovery is curated and capped; URLs fetches exact communities.", "default": "catalogue" }, "keywords": { "title": "Keywords", "maxItems": 10, "type": "array", "description": "Up to ten searches. Leave empty to browse the selected source. Not used in URL mode.", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "default": [] }, "communityUrls": { "title": "Community URLs or slugs", "maxItems": 1000, "type": "array", "description": "Required in URL mode (Source = Specific communities). Accepts Skool group URLs, /about URLs, or slugs, e.g. https://www.skool.com/aivideobootcamp. Ignored in other modes.", "items": { "type": "string", "minLength": 1, "maxLength": 500 }, "default": [] }, "maxItems": { "title": "Maximum communities", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Total emitted communities across all input searches and URLs.", "default": 100 }, "maxCandidates": { "title": "Maximum candidates to examine", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Bounds work when member filters exclude many communities. Must be at least Maximum communities.", "default": 10000 }, "price": { "title": "Membership pricing", "enum": [ "all", "free", "paid", "free-trial" ], "type": "string", "description": "Unknown prices remain unknown. A paid community can hide its visible price.", "default": "all" }, "visibility": { "title": "Community visibility", "enum": [ "all", "public", "private" ], "type": "string", "description": "Private community results contain public metadata only, never member-only content.", "default": "all" }, "language": { "title": "Language", "maxLength": 100, "type": "string", "description": "Optional source language name such as english, spanish, or german. Validated against current Skool options.", "default": "" }, "category": { "title": "Discovery category", "enum": [ "", "hobbies", "music", "money", "spirituality", "tech", "health", "sports", "self_improvement", "relationships" ], "type": "string", "description": "Only for Discovery mode. Catalogue records do not have a verified category mapping.", "default": "" }, "sort": { "title": "Discovery ordering", "enum": [ "trending", "top-v2" ], "type": "string", "description": "Only affects Discovery. Catalogue results are unordered.", "default": "trending" }, "minMembers": { "title": "Minimum members", "minimum": 0, "type": "integer", "description": "Apply after fetching current community detail. Zero disables the lower bound.", "default": 0 }, "maxMembers": { "title": "Maximum members", "minimum": 0, "type": "integer", "description": "Optional upper bound, at least Minimum members." }, "includeOwnerDetails": { "title": "Include public owner profile", "type": "boolean", "description": "Adds public owner names, bio, location, and observed social links.", "default": true }, "maxReviewsPerCommunity": { "title": "Review samples per community", "minimum": 0, "maximum": 5, "type": "integer", "description": "Zero disables sampling. Up to five public reviews inside each community row. Review aggregates are included independently.", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Direct by default. Optional Apify or custom proxy; no automatic paid proxy escalation.", "default": { "useApifyProxy": 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 } } }, "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 } } } } } } } } } }