/qiita/articles/search

POST /api/qiita/articles/search

Price: 20 credits

Search Qiita Articles

How to use it

Search Qiita articles by free text, title, body, code blocks, tags, author, organization, stock threshold, and publish or update date ranges. Returns title, snippet, tags, author, organization, and engagement counts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Free text matched against title and body (examples: "Python")
• article_title string nullable — Match only the article title (examples: "Git")
• body string nullable — Match only the article body (examples: "Ruby")
• code string nullable — Match only code blocks (examples: "function")
• tags array nullable — Match any of these tags (examples: ["Python","AWS"])
• exclude_tags array nullable — Exclude these tags (examples: ["PHP"])
• user string nullable — Author alias (examples: "minorun365")
• organization string nullable — Organization alias of the author (examples: "kddiagile")
• min_stocks integer nullable — Only articles stocked more times than this (min: 0)
• created_from string nullable — Published on or after (examples: "2024-01-01")
• created_to string nullable — Published on or before (examples: "2025-12-31")
• updated_from string nullable — Updated on or after (examples: "2024-01")
• updated_to string nullable — Updated on or before (examples: "2025-12")
• sort string — Result ordering (default: "relevance"; one of: "relevance", "created", "like", "stock")
• count integer required — Max result count (examples: 20; min: 1; max: 2000)

Response

• @type string (default: "QiitaArticleRef")
• id string required
• article_title string nullable
• url string nullable
• snippet string nullable
• created_at integer nullable
• like_count integer nullable
• stock_count integer nullable
• comment_count integer nullable
• author object nullable
  • @type string (default: "QiitaUserRef")
  • alias string required
  • name string nullable
  • image string nullable
  • url string nullable
• organization object nullable
  • @type string (default: "QiitaOrganizationRef")
  • 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

Errors

• 422 — At least one search filter must be provided. 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.