/segmentfault/questions

POST /api/segmentfault/questions

Price: 5 credits

Get one SegmentFault question by id or URL: title, body as text and HTML, tags, author, counters, and every answer with its body, votes, author and accepted or ignored status

How to use it

One call returns the question with all of its answers, the accepted one first and answers hidden by moderators last with `status=ignored` and a `moderation_reason`. Comments are not included — use segmentfault/questions/comments for the question's and segmentfault/answers/comments for an answer's.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• question string required — SegmentFault question id or question URL (examples: "1010000010885952", "https://segmentfault.com/q/1010000010885952", "https://segmentfault.com/q/1010000010885952/a-1020000011118788")
• answers_sort string — Order of the answers: by rank, or by creation time from oldest to newest (default: "rank"; one of: "rank", "newest")

Response

• @type string (default: "SegmentfaultQuestion")
• id string required
• url string nullable
• short_url string nullable
• text string nullable
• text_html string nullable
• excerpt string nullable
• image string nullable
• status string nullable
• vote_count integer nullable
• answer_count integer nullable
• comment_count integer nullable
• follower_count integer nullable
• bookmark_count integer nullable
• view_count integer nullable
• created_at integer nullable
• updated_at integer nullable
• is_edited boolean nullable
• is_wiki boolean nullable
• ip_location string nullable
• moderation_reason string nullable
• accepted_answer_id string nullable
• answers_sort 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
• editor 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
• site object nullable
  • @type string (default: "SegmentfaultSite")
  • id string nullable
  • name string nullable
  • alias string nullable
  • url string nullable
  • image string nullable
• answers array (default: [])
  • @type string (default: "SegmentfaultAnswer")
  • id string required
  • url string nullable
  • short_url string nullable
  • question_id string nullable
  • status string nullable
  • is_accepted boolean (default: false)
  • text string nullable
  • text_html string nullable
  • vote_count integer nullable
  • comment_count integer nullable
  • created_at integer nullable
  • updated_at integer nullable
  • is_edited boolean nullable
  • is_wiki boolean nullable
  • ip_location string nullable
  • moderation_reason string 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: [])
  • editor 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: [])
  • moderator 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: [])

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 question with that id 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.