View Source GitHub.Search (GitHub REST API Client v0.3.3)
Provides API endpoints related to search
Link to this section Summary
Functions
Search code
Search commits
Search issues and pull requests
Search labels
Search repositories
Search topics
Search users
Link to this section Types
@type code_200_json_resp() :: %{ __info__: map(), incomplete_results: boolean(), items: [GitHub.CodeSearchResultItem.t()], total_count: integer() }
@type commits_200_json_resp() :: %{ __info__: map(), incomplete_results: boolean(), items: [GitHub.Commit.SearchResultItem.t()], total_count: integer() }
@type issues_and_pull_requests_200_json_resp() :: %{ __info__: map(), incomplete_results: boolean(), items: [GitHub.Issue.SearchResultItem.t()], total_count: integer() }
@type labels_200_json_resp() :: %{ __info__: map(), incomplete_results: boolean(), items: [GitHub.LabelSearchResultItem.t()], total_count: integer() }
@type repos_200_json_resp() :: %{ __info__: map(), incomplete_results: boolean(), items: [GitHub.RepoSearchResultItem.t()], total_count: integer() }
@type topics_200_json_resp() :: %{ __info__: map(), incomplete_results: boolean(), items: [GitHub.TopicSearchResultItem.t()], total_count: integer() }
@type users_200_json_resp() :: %{ __info__: map(), incomplete_results: boolean(), items: [GitHub.User.SearchResultItem.t()], total_count: integer() }
Link to this section Functions
@spec code(keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Search code
Searches for query terms inside of a file. This method returns up to 100 results per page.
When searching for code, you can get text match metadata for the file content and file path 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 find the definition of the addClass function inside jQuery repository, your query would look something like this:
q=addClass+in:file+language:js+repo:jquery/jquery
This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.
Considerations for code search:
Due to the complexity of searching code, there are a few restrictions on how searches are performed:
- Only the default branch is considered. In most cases, this will be the
masterbranch. - Only files smaller than 384 KB are searchable.
- You must always include at least one search term when searching source code. For example, searching for
language:gois not valid, whileamazing language:gois.
This endpoint requires you to authenticate and limits you to 10 requests per minute.
options
Options
q: 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 the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching code" for a detailed list of qualifiers.sort: This field is deprecated. Sorts the results of your query. Can only beindexed, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: best matchorder: This field is deprecated. 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 providesort.per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."
resources
Resources
@spec commits(keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Search commits
Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide 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 find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
q=repo:octocat/Spoon-Knife+css
options
Options
q: 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 the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching commits" for a detailed list of qualifiers.sort: Sorts the results of your query byauthor-dateorcommitter-date. Default: best matchorder: 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 providesort.per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."
resources
Resources
@spec issues_and_pull_requests(keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Search issues and pull requests
Find issues by state and keyword. This method returns up to 100 results per page.
When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body 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 find the oldest unresolved Python bugs on Windows. Your query might look something like this.
q=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note: For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see "Searching only issues or pull requests."
options
Options
q: 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 the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching issues and pull requests" for a detailed list of qualifiers.sort: Sorts the results of your query by the number ofcomments,reactions,reactions-+1,reactions--1,reactions-smile,reactions-thinking_face,reactions-heart,reactions-tada, orinteractions. You can also sort results by how recently the items werecreatedorupdated, Default: best matchorder: 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 providesort.per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."
resources
Resources
@spec labels(keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Search labels
Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.
When searching for labels, you can get text match metadata for the label 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 find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
q=bug+defect+enhancement&repository_id=64778136
The labels that best match the query appear first in the search results.
options
Options
repository_id: The id of the repository.q: The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.sort: Sorts the results of your query by when the label wascreatedorupdated. Default: best matchorder: 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 providesort.per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."
resources
Resources
@spec repos(keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Search repositories
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.
options
Options
q: 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 the web interface for GitHub. 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: Sorts the results of your query by number ofstars,forks, orhelp-wanted-issuesor how recently the items wereupdated. Default: best matchorder: 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 providesort.per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."
resources
Resources
@spec topics(keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Search topics
Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See "Searching topics" for a detailed list of qualifiers.
When searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field 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 topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
q=ruby+is:featured
This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
options
Options
q: 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 the web interface for GitHub. To learn more about the format of the query, see Constructing a search query.per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."
resources
Resources
@spec users(keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Search users
Find users via various criteria. This method returns up to 100 results per page.
When searching for users, you can get text match metadata for the issue login, public email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you're looking for a list of popular users, you might try this query:
q=tom+repos:%3E42+followers:%3E1000
This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "GraphQL Queries."
options
Options
q: 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 the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching users" for a detailed list of qualifiers.sort: Sorts the results of your query by number offollowersorrepositories, or when the personjoinedGitHub. Default: best matchorder: 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 providesort.per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."