/qiita/questions

POST /api/qiita/questions

Price: 10 credits

Get Qiita Question

How to use it

Get a Qiita question with every answer and the comments on each answer. Returns the question body, format, open or closed state, tags, the asker, each answerer, and a flag marking answers Qiita has removed for guideline violations, whose text it no longer serves.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• question string required — Question URL, or the question id combined with the user parameter (examples: "https://qiita.com/Kogia_sima/questions/18727a7b3f7592f3b81b", "18727a7b3f7592f3b81b")
• user string nullable — Alias of the user who asked the question, required when question is a bare id

Response

• @type string (default: "QiitaQuestion")
• id string required
• question_title string nullable
• url string nullable
• text_html string nullable
• question_format string nullable (one of: "question", "discussion")
• is_closed boolean (default: false)
• created_at integer nullable
• like_count integer nullable
• answer_count integer nullable
• questioner object nullable
  • @type string (default: "QiitaUserRef")
  • alias string required
  • name string nullable
  • image string nullable
  • url string nullable
• tags array (default: [])
  • @type string (default: "QiitaTagRef")
  • name string required
  • alias string required
  • url string nullable
• answers array (default: [])
  • @type string (default: "QiitaAnswer")
  • id string required
  • text string nullable
  • text_html string nullable
  • is_banned boolean (default: false)
  • created_at integer nullable
  • like_count integer nullable
  • comment_count integer nullable
  • answerer object nullable
    • @type string (default: "QiitaUserRef")
    • alias string required
    • name string nullable
    • image string nullable
    • url string nullable
  • comments array (default: [])
    • @type string (default: "QiitaAnswerComment")
    • id string required
    • text string nullable
    • text_html string nullable
    • commenter object nullable (see schema QiitaUserRef)

Errors

• 422 — Pass the full question URL, or the question id together with the author alias in user. 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 — Question not found. Verify the question URL. 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.