/ptt/articles

POST /api/ptt/articles

Price: 10 credits

Get a PTT article by id or URL, a board article or a digest (精華區) article: title, author and nickname, creation time, full text, signature, text added below the posting footer, origin IP and country, edit history, embedded images, outbound links and push/boo/neutral comment counts

How to use it

Pass a full article URL, or the article id together with its board — ids come from ptt/boards/articles and ptt/articles/search; a digest article is passed by its URL from ptt/boards/digest. score is pushes minus boos counted on the page; the comments themselves are served by ptt/articles/comments. is_truncated is true when PTT shows the article only in part.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• article string required — PTT article id or article URL (examples: "M.1790823248.A.C89", "https://www.ptt.cc/bbs/Stock/M.1790823248.A.C89.html", "https://www.ptt.cc/man/Stock/DA50/M.1637026507.A.609.html"; minLength: 1)
• board string nullable — Board the article was posted on; required with a bare article id (examples: "Stock")

Response

• @type string (default: "PttArticle")
• id string required
• board string required
• url string required
• category string nullable
• is_reply boolean (default: false)
• is_forward boolean (default: false)
• author string nullable
• author_nickname string nullable
• created_at integer nullable
• content string nullable
• signature string nullable
• appended_content string nullable
• is_truncated boolean (default: false)
• origin_ip string nullable
• origin_country string nullable
• edits array (default: [])
  • @type string (default: "PttArticleEdit")
  • editor string nullable
  • ip string nullable
  • country string nullable
  • edited_at integer nullable
• images array (default: [])
• links array (default: [])
• comment_count integer (default: 0)
• push_count integer (default: 0)
• boo_count integer (default: 0)
• arrow_count integer (default: 0)
• score integer (default: 0)

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 — The entity was not found, or a precondition failed 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.