{ "openapi": "3.0.1", "info": { "title": "Patreon Scraper: Creators, Posts & Comments", "description": "Scrape public Patreon creators, membership tiers, posts, comments and replies, collections, and Shop products. Export structured profiles, engagement, media, paywall, pricing, and revenue-estimate data without login.", "version": "0.0", "x-build-id": "vP61k8xIMuh8G2fHi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapingmonkey~patreon-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapingmonkey-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/scrapingmonkey~patreon-scraper/runs": { "post": { "operationId": "runs-sync-scrapingmonkey-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/scrapingmonkey~patreon-scraper/run-sync": { "post": { "operationId": "run-sync-scrapingmonkey-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": [ "search", "creator", "posts", "postDetails", "comments", "collections", "collectionPosts", "shop", "productDetails" ], "type": "string", "description": "Choose the Patreon resource or workflow to scrape.", "default": "search" }, "searchTerms": { "title": "Search terms", "minItems": 1, "maxItems": 100, "type": "array", "description": "Keywords processed separately in search mode.", "items": { "type": "string" }, "default": [ "digital artist" ] }, "creatorUrls": { "title": "Creator URLs, vanity names, or campaign IDs", "minItems": 1, "maxItems": 100, "type": "array", "description": "Public creator URLs such as https://www.patreon.com/cw/creator, vanity names, or numeric campaign IDs for creator, posts, collections, and shop modes.", "items": { "type": "string" }, "default": [ "https://www.patreon.com/cw/jackdanreact" ] }, "postIds": { "title": "Post IDs or URLs", "minItems": 1, "maxItems": 100, "type": "array", "description": "Numeric Patreon post IDs or public post URLs for postDetails and comments modes.", "items": { "type": "string" }, "default": [ "131455912" ] }, "collectionIds": { "title": "Collection IDs or URLs", "minItems": 1, "maxItems": 100, "type": "array", "description": "Numeric collection IDs or https://www.patreon.com/collection/ID URLs for collectionPosts mode.", "items": { "type": "string" }, "default": [ "1986892" ] }, "productIds": { "title": "Product IDs or URLs", "minItems": 1, "maxItems": 100, "type": "array", "description": "Numeric Patreon Shop product IDs or public /shop/product-name-ID URLs for productDetails mode.", "items": { "type": "string" }, "default": [ "3957" ] }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum rows per search term, creator, post, collection, or shop input. In comments mode, replies count toward this limit.", "default": 50 }, "includeDetails": { "title": "Enrich search results", "type": "boolean", "description": "Fetch the full public creator page and metrics for every search result.", "default": false }, "includePosts": { "title": "Creator mode: include posts", "type": "boolean", "description": "Also emit up to maxResults post rows for every creator in creator mode.", "default": false }, "includeCollections": { "title": "Creator mode: include collections", "type": "boolean", "description": "Also emit up to maxResults collection rows for every creator in creator mode.", "default": false }, "includeShop": { "title": "Creator mode: include Shop products", "type": "boolean", "description": "Also emit up to maxResults Shop product rows for every creator in creator mode.", "default": false }, "includeComments": { "title": "Post details: include comments", "type": "boolean", "description": "Also emit comment rows after each postDetails row.", "default": false }, "maxComments": { "title": "Maximum included comments", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum comment and reply rows per post when includeComments is enabled in postDetails mode.", "default": 100 }, "commentSort": { "title": "Comment sort", "enum": [ "top", "newest" ], "type": "string", "description": "Sort top-level comments by helpful votes or creation time. Replies remain chronological.", "default": "top" }, "includeReplies": { "title": "Include comment replies", "type": "boolean", "description": "Fetch public replies for comments that expose a reply thread.", "default": true }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum creator, post, collection, product, or search inputs processed in parallel.", "default": 5 }, "dateFrom": { "title": "Published from", "type": "string", "description": "Optional ISO 8601 date or timestamp. Only posts and comments on or after it are emitted." }, "dateTo": { "title": "Published to", "type": "string", "description": "Optional ISO 8601 date or timestamp. Only posts and comments on or before it are emitted." }, "afterPostId": { "title": "Resume after post ID", "minimum": 0, "type": "integer", "description": "Optional global checkpoint. Emit only numeric post IDs greater than this value." }, "afterPostIds": { "title": "Per-input post checkpoints", "type": "object", "description": "Optional JSON object mapping a creator or collection input to its last saved numeric post ID. RUN_SUMMARY returns nextAfterPostIds for the next run.", "additionalProperties": true }, "postAccess": { "title": "Post access", "enum": [ "all", "public", "paid", "locked" ], "type": "string", "description": "Filter post rows by public visibility, paid status, or locked status.", "default": "all" }, "postTypes": { "title": "Post types", "type": "array", "description": "Optional exact Patreon post types, such as text_only, image_file, video_embed, audio_file, poll, or link. Empty means all types.", "items": { "type": "string" }, "default": [] }, "minLikes": { "title": "Minimum likes", "minimum": 0, "type": "integer", "description": "Only emit post rows with at least this many likes.", "default": 0 }, "minComments": { "title": "Minimum comments", "minimum": 0, "type": "integer", "description": "Only emit post rows with at least this many comments.", "default": 0 }, "includeNsfw": { "title": "Include NSFW search results", "type": "boolean", "description": "When false, creator rows explicitly marked NSFW are excluded from search results.", "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 } } }, "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 } } } } } } } } } }