/ptt/boards/articles

POST /api/ptt/boards/articles

Price: 5 credits

List a PTT board's articles, newest first: article id, title, title category, author, creation time, push score and board mark

How to use it

Board names are case-insensitive, e.g. 'Stock', 'Gossiping'. score is the board's net push count as PTT labels it (score_label): '爆' is 100, 'X1'..'X9' are -10..-90, 'XX' is -100, and an empty label, score 0, covers -9 to 0. Pass id and board to ptt/articles for the full text.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• board string required — PTT board name or board URL (examples: "Stock", "https://www.ptt.cc/bbs/Gossiping/index.html"; minLength: 1)
• count integer required — Max number of articles to return (min: 1; max: 4000)
• include_pinned boolean — Also return the board's pinned articles, ahead of the newest ones (default: false)

Response

• @type string (default: "PttArticleSummary")
• 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
• created_at integer nullable
• score integer (default: 0)
• score_label string nullable
• mark string nullable
• is_pinned boolean (default: false)

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.