{
  "openapi": "3.0.1",
  "info": {
    "title": "Patreon Scraper",
    "description": "Scrape Patreon creators, membership tiers and posts without login. Get patron counts, paid members, tier prices, post likes and comments. Search creators by keyword, browse Explore topics, or fetch posts by URL.",
    "version": "1.0",
    "x-build-id": "DP0bRQasJ2yap7ADg"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/parsebird~patreon-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-parsebird-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/parsebird~patreon-scraper/runs": {
      "post": {
        "operationId": "runs-sync-parsebird-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/parsebird~patreon-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-parsebird-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": "Choose what to scrape. <b>Creators</b>: creator page + tiers (and posts if enabled). <b>Posts</b>: posts only. <b>Search</b>: creators matching a keyword. <b>Explore</b>: creators from a Patreon Explore topic. <b>Posts by URL</b>: single posts.",
            "default": "creator"
          },
          "creators": {
            "title": "Creators",
            "type": "array",
            "description": "Add Patreon creator names or page URLs, e.g. <code>PhilosophyTube</code>, <code>https://www.patreon.com/thedollop</code>, <code>https://www.patreon.com/c/PhilosophyTube</code> or <code>https://www.patreon.com/user?u=315829</code>. Used in <b>Creators</b> and <b>Posts</b> modes.",
            "items": {
              "type": "string"
            }
          },
          "searchQuery": {
            "title": "Search query",
            "type": "string",
            "description": "Enter a keyword to find creators, e.g. <code>philosophy</code>, <code>true crime podcast</code>, <code>miniatures</code>. Used in <b>Search</b> mode."
          },
          "category": {
            "title": "Explore topic",
            "enum": [
              "podcasts_and_shows",
              "entertainment",
              "comedy",
              "pop_culture",
              "true_crime",
              "asmr",
              "sports",
              "educational",
              "science",
              "technology",
              "music",
              "musical_education",
              "visual_arts",
              "illustration",
              "painting",
              "comics",
              "photography",
              "art_tutorials",
              "writing",
              "video_games",
              "indie_games",
              "tabletop_games",
              "role_playing_games",
              "lifestyle",
              "travel",
              "spirituality",
              "religion",
              "beauty",
              "wellness",
              "fitness_and_health",
              "handicrafts",
              "social_impact",
              "apps_and_software"
            ],
            "type": "string",
            "description": "Pick a Patreon Explore topic. Leave empty to list Patreon's most popular creators overall. Patreon shows up to 120 creators per topic and sort order. Used in <b>Explore</b> mode."
          },
          "exploreSort": {
            "title": "Explore sort",
            "enum": [
              "popular",
              "trending"
            ],
            "type": "string",
            "description": "Choose Patreon's <b>Popular</b> or <b>Trending</b> list for the topic. Used in <b>Explore</b> mode.",
            "default": "popular"
          },
          "postUrls": {
            "title": "Post URLs",
            "type": "array",
            "description": "Add Patreon post URLs or IDs, e.g. <code>https://www.patreon.com/posts/september-diary-168975308</code> or <code>168975308</code>. Used in <b>Posts by URL</b> mode.",
            "items": {
              "type": "string"
            }
          },
          "includePosts": {
            "title": "Include posts",
            "type": "boolean",
            "description": "Also scrape each creator's latest posts in <b>Creators</b> mode. Posts are saved in a separate <code>posts</code> dataset of the run (see the Storage tab).",
            "default": true
          },
          "maxPostsPerCreator": {
            "title": "Max posts per creator",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Set how many of the newest posts to save per creator.",
            "default": 20
          },
          "minPatronCount": {
            "title": "Minimum patrons",
            "minimum": 0,
            "type": "integer",
            "description": "Only save creators with at least this many patrons (free + paid). Creators who hide their patron count are skipped when this is set."
          },
          "excludeNsfw": {
            "title": "Exclude NSFW creators",
            "type": "boolean",
            "description": "Skip creators that Patreon marks as adult (18+) content.",
            "default": false
          },
          "maxItems": {
            "title": "Max records",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Set the maximum number of records (creators + posts) to save in this run.",
            "default": 50
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}