Search repositories
GET {{baseUrl}}/search/repositories?q=<string>&sort=<string>&order=desc&per_page=30&page=1
Find repositories via various criteria. This method returns up to 100 results per page.
When searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
q=tetris+language:assembly&sort=stars&order=desc
This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
When you include the mercy preview header, you can also search for multiple topics by adding more topic: instances. For example, your query might look like this:
q=topic:ruby+topic:rails
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
q | string | (Required) The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching for repositories" for a detailed list of qualifiers. | |
sort | string | Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match | |
order | string | Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. | |
per_page | number | Results per page (max 100) | |
page | number | Page number of the results to fetch. |
RESPONSES
status: OK
{"total_count":40,"incomplete_results":false,"items":[{"id":3081286,"node_id":"MDEwOlJlcG9zaXRvcnkzMDgxMjg2","name":"Tetris","full_name":"dtrupenn/Tetris","owner":{"login":"dtrupenn","id":872147,"node_id":"MDQ6VXNlcjg3MjE0Nw==","avatar_url":"https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png","gravatar_id":"","url":"https://api.github.com/users/dtrupenn","received_events_url":"https://api.github.com/users/dtrupenn/received_events","type":"User","html_url":"https://github.com/octocat","followers_url":"https://api.github.com/users/octocat/followers","following_url":"https://api.github.com/users/octocat/following{/other_user}","gists_url":"https://api.github.com/users/octocat/gists{/gist_id}","starred_url":"https://api.github.com/users/octocat/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/octocat/subscriptions","organizations_url":"https://api.github.com/users/octocat/orgs","repos_url":"https://api.github.com/users/octocat/repos","events_url":"https://api.github.com/users/octocat/events{/privacy}","site_admin":true},"private":false,"html_url":"https://github.com/dtrupenn/Tetris","description":"A C implementation of Tetris using Pennsim through LC4","fork":false,"url":"https://api.github.com/repos/dtrupenn/Tetris","created_at":"2012-01-01T00:31:50Z","updated_at":"2013-01-05T17:58:47Z","pushed_at":"2012-01-01T00:37:02Z","homepage":"https://github.com","size":524,"stargazers_count":1,"watchers_count":1,"language":"Assembly","forks_count":0,"open_issues_count":0,"master_branch":"master","default_branch":"master","score":1,"archive_url":"https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}","assignees_url":"https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}","blobs_url":"https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}","branches_url":"https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}","collaborators_url":"https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}","comments_url":"https://api.github.com/repos/dtrupenn/Tetris/comments{/number}","commits_url":"https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}","compare_url":"https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}","contents_url":"https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}","contributors_url":"https://api.github.com/repos/dtrupenn/Tetris/contributors","deployments_url":"https://api.github.com/repos/dtrupenn/Tetris/deployments","downloads_url":"https://api.github.com/repos/dtrupenn/Tetris/downloads","events_url":"https://api.github.com/repos/dtrupenn/Tetris/events","forks_url":"https://api.github.com/repos/dtrupenn/Tetris/forks","git_commits_url":"https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}","git_refs_url":"https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}","git_tags_url":"https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}","git_url":"git:github.com/dtrupenn/Tetris.git","issue_comment_url":"https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}","issue_events_url":"https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}","issues_url":"https://api.github.com/repos/dtrupenn/Tetris/issues{/number}","keys_url":"https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}","labels_url":"https://api.github.com/repos/dtrupenn/Tetris/labels{/name}","languages_url":"https://api.github.com/repos/dtrupenn/Tetris/languages","merges_url":"https://api.github.com/repos/dtrupenn/Tetris/merges","milestones_url":"https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}","notifications_url":"https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}","pulls_url":"https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}","releases_url":"https://api.github.com/repos/dtrupenn/Tetris/releases{/id}","ssh_url":"git@github.com:dtrupenn/Tetris.git","stargazers_url":"https://api.github.com/repos/dtrupenn/Tetris/stargazers","statuses_url":"https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}","subscribers_url":"https://api.github.com/repos/dtrupenn/Tetris/subscribers","subscription_url":"https://api.github.com/repos/dtrupenn/Tetris/subscription","tags_url":"https://api.github.com/repos/dtrupenn/Tetris/tags","teams_url":"https://api.github.com/repos/dtrupenn/Tetris/teams","trees_url":"https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}","clone_url":"https://github.com/dtrupenn/Tetris.git","mirror_url":"git:git.example.com/dtrupenn/Tetris","hooks_url":"https://api.github.com/repos/dtrupenn/Tetris/hooks","svn_url":"https://svn.github.com/dtrupenn/Tetris","forks":1,"open_issues":1,"watchers":1,"has_issues":true,"has_projects":true,"has_pages":true,"has_wiki":true,"has_downloads":true,"archived":true,"disabled":true,"license":{"key":"mit","name":"MIT License","url":"https://api.github.com/licenses/mit","spdx_id":"MIT","node_id":"MDc6TGljZW5zZW1pdA==","html_url":"https://api.github.com/licenses/mit"}}]}