Search

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

Toda a documentação do GitHub é de código aberto. Encontrou informações erradas ou confusas? Envie uma solicitação de pull.

Ajude-nos a tornar esses documentos ótimos!

Ações

Digite um termo de pesquisa a encontrar na Documentação do GitHub.

Search - GitHub Docs

Use a API REST para pesquisar itens específicos no GitHub.

Início Rápido

Comparando APIs do GitHub

Recursos na API REST

Limites de taxa

Versões da API

Tipos de mídia

Autenticação

Manter credenciais de API seguras

Solução de problemas

Libraries

Descrição da OpenAPI

Tipos de eventos de problemas

Tipos de eventos do GitHub

Pontos de extremidade para tokens de instalação do aplicativo GitHub

Pontos de extremidade para tokens de usuário do aplicativo GitHub

Pontos de extremidade para PATs refinados

Permissões para aplicativos GitHub

Permissões para PATs refinados

Alterações de quebra

Visão geral

Usando a API

Script com JavaScript

Script com Ruby

Descobrir recursos para um usuário

Entregar implantações

Representar dados como gráficos

Trabalhar com comentários

Paginação

Criar um servidor de CI

Práticas recomendadas

Introdução – banco de dados Git

Introdução – Verificações

Criptografar segredos

Guides

Artifacts

Cache

OIDC

Permissões

Segredos

Executores auto-hospedados

Variáveis

Trabalhos de fluxo de trabalho

Execução de fluxo de trabalho

Fluxos de trabalho

Eventos

Feeds

Notificações

Marcar com uma estrela

Observando

Atividade

Aplicativos GitHub

Instalações

Marketplace

Autorizações do OAuth

Webhooks

Aplicativos

Cobrança

Branches

Branches protegidos

Execuções de verificação

conjuntos de verificações

Verificações

Sala de aula

Verificação de código

Códigos de conduta

Espaços de código

Organizações

Segredos da organização

Virtuais

Segredos do repositório

Segredos do usuário

Colaboradores

Convites

Confirmações

Comentários de commit

Status do commit

Copilot business

Copilot

Alertas

Dependabot

Análise de dependência

Envio de dependência

SBOM (lista de materiais de software)

Gráfico de Dependência

Chaves de implantação

Políticas de branch de implantação

Implantações

Ambientes

Regras de proteção

Status da implantação

Emojis

Gists

Comentários

Blobs

Referências

Marcações

Árvores

Banco de dados do Git

Gitignore

Organização

Repositório

Usuário

Interações

Problemas

Responsáveis

Rótulos

Marcos

Linha do tempo

Licenças

Markdown

Comunidade

Estatísticas

Tráfego

Métricas

Importações de código-fonte

Usuários

Migrações

Bloquear usuários

Custom properties

Membros

Funções da organização

Colaboradores externos

Tokens de acesso pessoal

Conjuntos de Regras

Regras

Gerentes de segurança

Pacotes

Páginas

Boards

Cartões

Colunas

Projects (classic)

Pulls

Comentários de opiniões

Solicitações de revisão

Análises

Limite de taxa

Reações

Versões

Ativos de versões

Links automáticos

Sumário

Garfos

Repositórios

Conjuntos de regras

Verificação de segredo

Avisos de segurança global

Avisos de segurança do repositório

Avisos de segurança

Teams

Comentários da discussão

Discussões

Emails

Seguidores

Chaves GPG

Chaves SSH do Git

Chaves de assinatura SSH

Contas sociais

API REST

classes.js

Searches for query terms inside of a file. This method returns up to 100 results <a href="https://docs.github.com/rest/guides/using-pagination-in-the-rest-api">per page</a>.
When searching for code, you can get text match metadata for the file content and file path fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href="https://docs.github.com/rest/search/search#text-match-metadata">Text match metadata</a>.
For example, if you want to find the definition of the <code>addClass</code> function inside <a href="https://github.com/jquery/jquery">jQuery</a> repository, your query would look something like this:
<code>q=addClass+in:file+language:js+repo:jquery/jquery</code>
This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.
Considerations for code search:
Due to the complexity of searching code, there are a few restrictions on how searches are performed:
<ul>
<li>Only the default branch is considered. In most cases, this will be the <code>master</code> branch.</li>
<li>Only files smaller than 384 KB are searchable.</li>
<li>You must always include at least one search term when searching source code. For example, searching for <a href="https://github.com/search?utf8=%E2%9C%93&#x26;q=language%3Ago&#x26;type=Code"><code>language:go</code></a> is not valid, while <a href="https://github.com/search?utf8=%E2%9C%93&#x26;q=amazing+language%3Ago&#x26;type=Code"><code>amazing language:go</code></a> is.</li>
</ul>
This endpoint requires you to authenticate and limits you to 10 requests per minute.

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 <a href="https://docs.github.com/rest/search/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/search-github/searching-on-github/searching-code">Searching code</a>" for a detailed list of qualifiers.

This field is deprecated. Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: <a href="https://docs.github.com/rest/search/search#ranking-search-results">best match</a>

sort

This field is deprecated. Determines whether the first search result returned is the highest number of matches (<code>desc</code>) or lowest number of matches (<code>asc</code>). This parameter is ignored unless you provide <code>sort</code>.

order

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

Validation failed, or the endpoint has been spammed.

Search code

Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href="https://docs.github.com/rest/guides/using-pagination-in-the-rest-api">per page</a>.
When searching for commits, you can get text match metadata for the message field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href="https://docs.github.com/rest/search/search#text-match-metadata">Text match
metadata</a>.
For example, if you want to find commits related to CSS in the <a href="https://github.com/octocat/Spoon-Knife">octocat/Spoon-Knife</a> repository. Your query would look something like this:
<code>q=repo:octocat/Spoon-Knife+css</code>

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 <a href="https://docs.github.com/rest/search/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/search-github/searching-on-github/searching-commits">Searching commits</a>" for a detailed list of qualifiers.

Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href="https://docs.github.com/rest/search/search#ranking-search-results">best match</a>

Determines whether the first search result returned is the highest number of matches (<code>desc</code>) or lowest number of matches (<code>asc</code>). This parameter is ignored unless you provide <code>sort</code>.

Search commits

Line Number Indexes Beyond 20 Not Displayed

Find issues by state and keyword. This method returns up to 100 results <a href="https://docs.github.com/rest/guides/using-pagination-in-the-rest-api">per page</a>.
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 <code>text-match</code> media type. For more details about how to receive highlighted
search results, see <a href="https://docs.github.com/rest/search/search#text-match-metadata">Text match metadata</a>.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
<code>q=windows+label:bug+language:python+state:open&#x26;sort=created&#x26;order=asc</code>
This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. 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 <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> 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 <code>is</code> qualifier, see "<a href="https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests">Searching only issues or pull requests</a>."

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 <a href="https://docs.github.com/rest/search/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests">Searching issues and pull requests</a>" for a detailed list of qualifiers.

Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href="https://docs.github.com/rest/search/search#ranking-search-results">best match</a>

Search issues and pull requests

enhancement

Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href="https://docs.github.com/rest/guides/using-pagination-in-the-rest-api">per page</a>.
When searching for labels, you can get text match metadata for the label name and description fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href="https://docs.github.com/rest/search/search#text-match-metadata">Text match metadata</a>.
For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:
<code>q=bug+defect+enhancement&#x26;repository_id=64778136</code>
The labels that best match the query appear first in the search results.

Search labels