/github/issues/search

POST /api/github/issues/search

Price: 10 credits

Search GitHub issues and pull requests by query with qualifiers

How to use it

Search GitHub issues and pull requests by keyword or advanced query (e.g. 'repo:owner/name state:open label:bug author:user' or 'memory leak in:title'). Results include both issues and pull requests (is_pull_request flag distinguishes them). Returns number, title, text, state, author, labels, assignees, milestone, comment count, reactions, repository, timestamps, and relevance score.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Search query for issues and pull requests with optional qualifiers (e.g. 'repo:owner/name state:open label:bug author:user') (examples: "repo:microsoft/vscode state:open label:bug", "memory leak in:title"; minLength: 1)
• count integer required — Number of results to return (min: 1; max: 1000)

Response

• @type string (default: "GithubIssueSearchResult")
• id integer required
• number integer required
• text string nullable
• state string (default: "")
• state_reason string nullable
• author object nullable
  • @type string (default: "GithubIssueAuthor")
  • id integer required
  • login string required
  • image string nullable
• author_association string (default: "")
• labels array (default: [])
• assignees array (default: [])
• milestone string nullable
• comment_count integer (default: 0)
• reactions object nullable
  • @type string (default: "GithubIssueReactions")
  • total_count integer (default: 0)
  • plus_one integer (default: 0)
  • minus_one integer (default: 0)
  • laugh integer (default: 0)
  • hooray integer (default: 0)
  • confused integer (default: 0)
  • heart integer (default: 0)
  • rocket integer (default: 0)
  • eyes integer (default: 0)
• is_locked boolean (default: false)
• is_pull_request boolean (default: false)
• repository_url string (default: "")
• created_at string (default: "")
• updated_at string (default: "")
• closed_at string nullable
• web_url string (default: "")
• score number 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 — 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.