/stackexchange/questions/search

POST /api/stackexchange/questions/search

Price: 5 credits

Full-text search across Stack Exchange questions

How to use it

Full-text search across Stack Exchange questions by query. Filter by tags, accepted-answer presence, minimum answer count, and minimum view count. Sort by relevance, votes, activity, or creation, in ascending or descending order. Returns title, body, score, view/answer counts, tags, accepted answer id, owner, and timestamps. Specify the network site via the 'site' parameter (default stackoverflow).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• site string — Stack Exchange network site to query (e.g. stackoverflow, superuser, serverfault, math) (default: "stackoverflow"; examples: "stackoverflow"; minLength: 1)
• query string required — Free-text search query matched against question titles and bodies (minLength: 1)
• count integer required — Max result count (examples: 20; min: 1)
• tagged string nullable — Restrict to questions with these tags (semicolon-separated) (examples: "python;pandas")
• sort string — Result sorting (default: "relevance"; one of: "relevance", "votes", "activity", "creation")
• order string — Sort direction (default: "desc"; one of: "desc", "asc")
• accepted boolean nullable — Only questions with (true) or without (false) an accepted answer
• min_answers integer nullable — Only questions with at least this many answers (examples: 1; min: 0)
• min_views integer nullable — Only questions with at least this many views (examples: 1000; min: 0)

Response

• @type string (default: "StackexchangeQuestion")
• id integer required
• body string nullable
• score integer nullable
• view_count integer nullable
• answer_count integer nullable
• is_answered boolean (default: false)
• is_closed boolean (default: false)
• accepted_answer_id integer nullable
• tags array (default: [])
• owner object nullable
  • @type string (default: "StackexchangeOwner")
  • user_id integer nullable
  • account_id integer nullable
  • display_name string (default: "")
  • reputation integer nullable
  • image string nullable
  • user_type string nullable
  • profile_url string nullable
• created_at integer nullable
• last_activity_at integer nullable
• last_edit_at integer nullable
• content_license string nullable
• link string (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 — 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.