{
  "openapi": "3.0.1",
  "info": {
    "title": "Patreon Extractor 🎯 ⭐5.0",
    "description": "💫 All-in-One Patreon.com Scraper [v5.0]",
    "version": "0.1",
    "x-build-id": "VIrM7c3ixZQw5xc9J"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/jupri~patreon/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-jupri-patreon",
        "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/jupri~patreon/runs": {
      "post": {
        "operationId": "runs-sync-jupri-patreon",
        "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/jupri~patreon/run-sync": {
      "post": {
        "operationId": "run-sync-jupri-patreon",
        "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": {
          "query": {
            "title": "❓ Query",
            "type": "array",
            "description": "💡 Query, Search Terms or Start URL<br>See README for more info.",
            "items": {
              "type": "string"
            }
          },
          "example": {
            "title": "💡 Example",
            "enum": [
              "Animation",
              "creators:Comic Book",
              "https://www.patreon.com/TheBestShow",
              "@TheBestShow",
              "@TheBestShow/socials",
              "@TheBestShow/posts",
              "@TheBestShow/images",
              "@TheBestShow/audios",
              "@TheBestShow/videos",
              "@TheBestShow/episodes",
              "@TheBestShow/links",
              "@TheBestShow/polls",
              "@TheBestShow/collections",
              "@TheBestShow/podcasts",
              "@TheBestShow/shop"
            ],
            "type": "string",
            "description": "💡 <b>Query Examples:</b> Select one or more examples, then hit <code>START!</code> <p>OR, enter your own queries in the <code>QUERY</code> input.</p>"
          },
          "search_mode": {
            "title": "🔎 Search Mode",
            "enum": [
              "posts",
              "creators"
            ],
            "type": "string",
            "description": ""
          },
          "limit": {
            "title": "♾️ Limit",
            "type": "integer",
            "description": "💡 Number of results (per query)"
          },
          "types": {
            "title": "Types",
            "type": "array",
            "description": "",
            "items": {
              "type": "string",
              "enum": [
                "text",
                "image",
                "video",
                "audio",
                "podcast",
                "link",
                "poll",
                "livestrean"
              ],
              "enumTitles": [
                "Text",
                "Image",
                "Video",
                "Audio",
                "Podcast",
                "Link",
                "Poll",
                "Livestream"
              ]
            }
          },
          "sort": {
            "title": "Sort",
            "enum": [
              "new",
              "old"
            ],
            "type": "string",
            "description": ""
          },
          "search": {
            "title": "Search",
            "type": "string",
            "description": "💡 Search posts"
          },
          "access": {
            "title": "Post Access",
            "type": "array",
            "description": "",
            "items": {
              "type": "string",
              "enum": [
                "public",
                "free_membership",
                "one_time_purchasable",
                "paid_membership"
              ],
              "enumTitles": [
                "Public",
                "Free membership",
                "One-time purchasable",
                "Paid membership"
              ]
            }
          },
          "year": {
            "title": "Year",
            "type": "integer",
            "description": ""
          },
          "month": {
            "title": "Month",
            "enum": [
              "1",
              "2",
              "3",
              "4",
              "5",
              "6",
              "7",
              "8",
              "9",
              "10",
              "11",
              "12"
            ],
            "type": "string",
            "description": "💡 Require YEAR parameter"
          },
          "tier": {
            "title": "Tier",
            "type": "integer",
            "description": ""
          },
          "public": {
            "title": "Yes",
            "type": "boolean",
            "description": "💡 Public posts only"
          },
          "attributes:user": {
            "title": "📁 TYPE = user",
            "type": "array",
            "description": "",
            "items": {
              "type": "string",
              "enum": [
                "about",
                "created",
                "current_user_block_status",
                "facebook",
                "first_name",
                "full_name",
                "gender",
                "image_url",
                "last_name",
                "social_connections",
                "thumb_url",
                "twitch",
                "twitter",
                "url",
                "vanity",
                "youtube"
              ]
            }
          },
          "attributes:campaign": {
            "title": "📁 TYPE = campaign",
            "type": "array",
            "description": "",
            "items": {
              "type": "string",
              "enum": [
                "avatar_photo_image_urls",
                "avatar_photo_url",
                "can_migrate_ab",
                "cover_photo_url",
                "cover_photo_url_sizes",
                "created_at",
                "creation_name",
                "currency",
                "current_user_has_entitlement",
                "earnings_visibility",
                "has_community",
                "has_rss",
                "has_spotify_rss",
                "has_visible_shop",
                "image_small_url",
                "image_url",
                "is_monthly",
                "is_nsfw",
                "is_paused",
                "is_plural",
                "main_video_embed",
                "main_video_url",
                "name",
                "one_liner",
                "patron_count",
                "patron_count_visibility",
                "pause_ended_at",
                "pay_per_name",
                "pledge_sum_currency",
                "pledge_url",
                "post_count",
                "primary_theme_color",
                "published_at",
                "show_earnings",
                "show_patron_count",
                "spotify_uri",
                "summary",
                "url",
                "use_tier_welcome_message",
                "vanity"
              ]
            }
          },
          "attributes:post": {
            "title": "📁 TYPE = post",
            "type": "array",
            "description": "",
            "items": {
              "type": "string",
              "enum": [
                "attachments_preview_metadata",
                "change_visibility_at",
                "cleaned_teaser_text",
                "comment_count",
                "commenter_count",
                "content_teaser_text",
                "created_at",
                "current_user_can_comment",
                "current_user_can_delete",
                "current_user_can_report",
                "current_user_can_view",
                "current_user_comment_disallowed_reason",
                "deleted_at",
                "edit_url",
                "edited_at",
                "has_custom_thumbnail",
                "has_ti_violation",
                "image",
                "is_automated_monthly_charge",
                "is_new_to_current_user",
                "is_paid",
                "is_preview_blurred",
                "like_count",
                "meta_image_url",
                "min_cents_pledged_to_view",
                "moderation_status",
                "patreon_url",
                "pledge_url",
                "pls_one_liners_by_category",
                "post_level_suspension_removal_date",
                "post_metadata",
                "post_type",
                "preview_asset_type",
                "published_at",
                "scheduled_for",
                "share_images",
                "teaser_text",
                "teaser_text_json_string",
                "thumbnail",
                "title",
                "upgrade_url",
                "url",
                "video_preview",
                "was_posted_by_campaign_owner"
              ]
            }
          },
          "attributes:media": {
            "title": "📁 TYPE = media",
            "type": "array",
            "description": "",
            "items": {
              "type": "string",
              "enum": [
                "created_at",
                "display",
                "file_name",
                "image_urls",
                "media_type",
                "metadata",
                "mimetype",
                "owner_id",
                "owner_relationship",
                "owner_type",
                "size_bytes",
                "state"
              ]
            }
          },
          "dev_proxy_config": {
            "title": "🌐 PROXY NETWORKING",
            "type": "object",
            "description": "💡 <b>Supported protocol:</b><br><br><b>HTTP(S), SOCKS5</b><br><code>{http|socks5}://{user:pass}@{hostname|ip-address}:port</code><br><br><b>Example</b>: <code>socks5://example.com:9000</code>"
          },
          "dev_custom_headers": {
            "title": "📜 HTTP HEADERS",
            "type": "array",
            "description": "💡 Additional HTTP Headers",
            "items": {
              "type": "object",
              "required": [
                "key",
                "value"
              ],
              "properties": {
                "key": {
                  "type": "string",
                  "title": "Key"
                },
                "value": {
                  "type": "string",
                  "title": "Value"
                }
              }
            }
          },
          "dev_custom_cookies": {
            "title": "🍰 HTTP COOKIES",
            "type": "array",
            "description": "💡 Additional HTTP Cookies",
            "items": {
              "type": "object",
              "required": [
                "key",
                "value"
              ],
              "properties": {
                "key": {
                  "type": "string",
                  "title": "Key"
                },
                "value": {
                  "type": "string",
                  "title": "Value"
                }
              }
            }
          },
          "dev_transform_fields": {
            "title": "♻️ CUSTOM FIELD",
            "type": "array",
            "description": "💡 <b>Transform the resulting output. Select only needed fields.</b><br><br>For nested object use <b>DOT</b>. For example: <pre>address.streetAddress</pre><br>For nested array use <b>NUMBER</b> <i>(index of array element starting from index=0)</i>. For example: <pre>images.0.url</pre>",
            "items": {
              "type": "object",
              "required": [
                "key",
                "value"
              ],
              "properties": {
                "key": {
                  "type": "string",
                  "title": "Key"
                },
                "value": {
                  "type": "string",
                  "title": "Value"
                }
              }
            }
          },
          "dev_dataset_name": {
            "title": "📁 CUSTOM STORAGE",
            "type": "string",
            "description": "💡 <b>Save results into custom named Dataset, use mask to customize dataset name</b><br><br><code>{ACTOR} = actor name<br>{DATE} = date (YYYYMMDD)<br>{TIME} = time (HHMMSS)</code><br><br>This masks can be used to autogenerate Dataset Name.<br><br>example: <i><code>data-{DATE}</code></i><br>Depending on today date the dataset name will be: <code>data-20230603</code><i><br><br>default: <code>data-{ACTOR}-{DATE}-{TIME}</code></i>"
          },
          "dev_dataset_clear": {
            "title": "Clear Storage",
            "type": "boolean",
            "description": "Clear Dataset before insert/update."
          },
          "dev_no_strip": {
            "title": "Disable data cleansing",
            "type": "boolean",
            "description": "💡 Keep/Save empty values <i><code>(NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)</code></i>"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}