/patreon/posts

POST /api/patreon/posts

Price: 1 credit

Get a Patreon post by id or URL. Returns the public projection of the post: name, alias, url, post_type, teaser and (for public posts) full text, published date, like and comment counts, image, video duration, required tiers, poll options, and tags.

How to use it

Fetch a single Patreon post by numeric id (e.g. 79973672) or post URL. Returns one item with id, name, alias (slug), url, post_type (image_file/video_external_file/poll/text_only/link/audio_file), teaser, text (full body only for public posts), published_at, like_count, comment_count, image, video_duration (seconds), is_public, tiers (tiers required to unlock), poll_options, and tags. Paid post bodies are behind the paywall and are not returned.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• post string required — Post id or post URL (examples: "79973672", "https://www.patreon.com/posts/steps-full-video-79973672"; minLength: 1)

Response

• @type string (default: "PatreonPost")
• id integer required
• name string nullable
• alias string nullable
• url string nullable
• post_type string nullable
• teaser string nullable
• text string nullable
• published_at integer nullable
• edited_at integer nullable
• created_at integer nullable
• like_count integer nullable
• comment_count integer nullable
• is_paid boolean nullable
• is_public boolean nullable
• image string nullable
• video_duration integer nullable
• min_pledge_amount number nullable
• campaign_id integer nullable
• tiers array (default: [])
• poll_options array (default: [])
• tags array (default: [])

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 — Post not found, or the input is not a valid Patreon post 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.