{ "openapi": "3.0.1", "info": { "title": "Patreon Scraper", "description": "Scrape Patreon creators (campaigns) with campaign metadata, tier pricing, public posts, and patron counts.", "version": "1.0", "x-build-id": "rlwMv3hbbXDdpW23d" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~patreon-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-patreon-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/crawlerbros~patreon-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-patreon-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/crawlerbros~patreon-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-patreon-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "creator", "posts", "search", "explore", "postByUrl" ], "type": "string", "description": "What to fetch.", "default": "creator" }, "creators": { "title": "Creator vanity slugs or URLs (mode=creator / posts)", "type": "array", "description": "Creator slugs (e.g. `PhilosophyTube`) or full URLs (`https://www.patreon.com/c/PhilosophyTube`).", "default": [ "PhilosophyTube" ], "items": { "type": "string" } }, "searchQuery": { "title": "Search query (mode=search)", "type": "string", "description": "Keyword to search across all Patreon creators." }, "category": { "title": "Explore category (mode=explore)", "enum": [ "", "podcasts", "video-film", "music", "visual-arts", "comedy", "games", "writing", "drawing-painting", "comics-graphic-novels", "tabletop-games", "science", "education", "crafts-diy", "lifestyle" ], "type": "string", "description": "Patreon's Explore directory category. Leave empty to browse the top-level `/explore/` page." }, "postUrls": { "title": "Post URLs (mode=postByUrl)", "type": "array", "description": "Patreon post URLs to fetch individually, e.g. `https://www.patreon.com/posts/12345` or `https://www.patreon.com/posts/title-slug-12345`.", "items": { "type": "string" } }, "includePosts": { "title": "Include posts (mode=creator)", "type": "boolean", "description": "When `mode=creator`, also fetch the creator's recent posts.", "default": true }, "maxPostsPerCreator": { "title": "Max posts per creator", "minimum": 1, "maximum": 200, "type": "integer", "description": "Hard cap on posts emitted per creator.", "default": 20 }, "minPatronCount": { "title": "Min patron count", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Drop creators with fewer than this many patrons." }, "excludeNsfw": { "title": "Exclude NSFW", "type": "boolean", "description": "Drop creators marked as NSFW.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on total emitted records (creators + posts combined).", "default": 50 }, "autoEscalateOnBlock": { "title": "Auto-escalate to Apify proxy on block", "type": "boolean", "description": "If true (default), the actor automatically engages Apify Proxy when it hits HTTP 403 / anti-bot blocks from a raw datacenter IP. Set false to disable (request fails fast).", "default": true }, "proxyGroups": { "title": "Apify proxy groups (used on auto-escalation)", "type": "array", "description": "Apify proxy groups to use when auto-escalating after a block. Empty = datacenter (default), then residential fallback.", "default": [], "items": { "type": "string" } } } }, "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 } } } } } } } } } }