/segmentfault/articles

POST /api/segmentfault/articles

Price: 5 credits

Get one SegmentFault article or news item by id or URL: title, body as text and HTML, tags, author, the blog column it belongs to, original, repost or translation type, and view, vote, bookmark and comment counts

How to use it

News items are articles and resolve here by their id. Comments come from segmentfault/articles/comments.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• article string required — SegmentFault article or news id, or its URL (examples: "1190000010791103", "https://segmentfault.com/a/1190000010791103")
• lang string nullable — Language code of a translation, taken from `languages`; omitted returns the original (examples: "en")

Response

• @type string (default: "SegmentfaultArticle")
• id string required
• url string nullable
• text string nullable
• text_html string nullable
• excerpt string nullable
• cover string nullable
• article_type string nullable
• origin_url string nullable
• license string nullable
• status string nullable
• vote_count integer nullable
• bookmark_count integer nullable
• comment_count integer nullable
• view_count integer nullable
• unique_view_count integer nullable
• read_time_minutes integer nullable
• created_at integer nullable
• updated_at integer nullable
• is_edited boolean nullable
• is_paid boolean nullable
• languages array (default: [])
• ip_location string nullable
• moderation_reason string nullable
• tags array (default: [])
  • @type string (default: "SegmentfaultTag")
  • id string nullable
  • name string required
  • url string nullable
  • description string nullable
  • image string nullable
  • icon string nullable
  • content_count integer nullable
  • popularity_score integer nullable
• author object nullable
  • @type string (default: "SegmentfaultUser")
  • id string nullable
  • name string nullable
  • alias string nullable
  • url string nullable
  • image string nullable
  • reputation integer nullable
  • reputation_level string nullable
  • gold_badge_count integer nullable
  • silver_badge_count integer nullable
  • bronze_badge_count integer nullable
  • follower_count integer nullable
  • article_count integer nullable
  • bio string nullable
  • verified_title string nullable
  • social_links array (default: [])
    • @type string (default: "SegmentfaultSocialLink")
    • platform string required
    • url string required
• blog object nullable
  • @type string (default: "SegmentfaultBlog")
  • id string nullable
  • name string nullable
  • url string nullable
  • image string nullable
  • description string nullable
  • follower_count integer nullable
  • article_count integer nullable
  • license string nullable
• site object nullable
  • @type string (default: "SegmentfaultSite")
  • id string nullable
  • name string nullable
  • alias string nullable
  • url string nullable
  • image string nullable
• previous_article object nullable
  • @type string (default: "SegmentfaultArticleLink")
  • id string required
  • url string nullable
• next_article object nullable
  • @type string (default: "SegmentfaultArticleLink")
  • id string required
  • url string 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 — No article with that id, or no translation of it in the requested language 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.