/patreon/creators

POST /api/patreon/creators

Price: 1 credit

Get a Patreon creator (campaign) by vanity handle, profile URL, or numeric campaign id. Returns the public profile: name, alias, description, tagline, avatar and cover image, patron and paid-member counts, post count, native currency, social links, starting pledge amount, and the list of membership tiers.

How to use it

Fetch a single Patreon creator profile. creator is a vanity handle (e.g. rossdraws), a profile URL (patreon.com/rossdraws or /cw/rossdraws), or a numeric campaign id. Returns one item with id (campaign id), name, alias (vanity), url, creation_name, tagline, description, image, cover, patron_count, paid_member_count, post_count, currency, min_pledge_amount, social_links (platform/url), and tiers (embedded membership plans). Prices are in the creator's native currency.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• creator string required — Creator vanity handle, profile URL, or numeric campaign id (examples: "rossdraws", "https://www.patreon.com/rossdraws", "189274"; minLength: 1)

Response

• @type string (default: "PatreonCreator")
• id integer required
• name string nullable
• alias string nullable
• url string nullable
• creation_name string nullable
• tagline string nullable
• description string nullable
• image string nullable
• cover string nullable
• patron_count integer nullable
• paid_member_count integer nullable
• post_count integer nullable
• currency string nullable
• pay_per_name string nullable
• is_monthly boolean nullable
• is_nsfw boolean nullable
• min_pledge_amount number nullable
• pledge_url string nullable
• video_url string nullable
• created_at integer nullable
• published_at integer nullable
• social_links array (default: [])
  • @type string (default: "PatreonSocialLink")
  • platform string required
  • url string nullable
  • user_id string nullable
• tiers array (default: [])
  • @type string (default: "PatreonTier")
  • id integer required
  • name string nullable
  • amount number nullable
  • currency string nullable
  • description string nullable
  • benefits array (default: [])
  • image string nullable
  • post_count integer nullable
  • remaining integer nullable
  • requires_shipping boolean nullable
  • is_free boolean nullable
  • is_published boolean nullable
  • created_at integer nullable
  • published_at integer nullable
  • edited_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Creator not found, or the input is not a valid Patreon creator Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.