/github/repos/search

POST /api/github/repos/search

Price: 1 credit

Search GitHub repositories by query with optional sort and order

How to use it

Search GitHub repositories by keyword or advanced query (e.g. 'language:python stars:>1000'). Returns id, name, description, language, star/fork/issue/watcher counts, topics, license, visibility, fork/archived/template flags, timestamps, owner info, and relevance score. Sort by stars, forks, help-wanted-issues, updated, or best-match (default).

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 repositories (examples: "machine learning", "language:python stars:>1000"; minLength: 1)
• count integer required — Number of repositories to return (min: 1)
• sort string — Sort repositories by this field (default: "best-match"; one of: "best-match", "stars", "forks", "help-wanted-issues", "updated")
• order string — Sort order (default: "desc"; one of: "desc", "asc")

Response

• @type string (default: "GithubSearchRepo")
• id integer required
• alias string required
• name string required
• description string nullable
• language string nullable
• star_count integer (default: 0)
• fork_count integer (default: 0)
• open_issue_count integer (default: 0)
• watcher_count integer (default: 0)
• topics array (default: [])
• license string nullable
• visibility string (default: "")
• is_fork boolean (default: false)
• is_archived boolean (default: false)
• is_template boolean (default: false)
• allow_forking boolean (default: false)
• has_issues boolean (default: false)
• has_discussions boolean (default: false)
• default_branch string (default: "")
• size integer (default: 0)
• created_at string (default: "")
• updated_at string (default: "")
• pushed_at string (default: "")
• owner_alias string (default: "")
• owner_type string (default: "")
• owner_image 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.