Skip to main content

Esta versión de GitHub Enterprise Server se discontinuó el 2024-03-26. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener rendimiento mejorado, seguridad mejorada y nuevas características, actualice a la versión más reciente de GitHub Enterprise Server. Para obtener ayuda con la actualización, póngase en contacto con el soporte técnico de GitHub Enterprise.

Después de que un administrador del sitio actualice la instancia de Enterprise Server a Enterprise Server 3.9 o posterior, la API de REST tendrá control de versiones. Para informarte sobre cómo encontrar la versión de tu instancia, consulta "Acerca de las versiones de GitHub Docs". Para obtener más información, consulta "Acerca del control de versiones de la API".

Puntos de conexión de la API de REST para búsquedas

Usa la API REST para buscar elementos específicos en GitHub Enterprise Server.

Puedes usar la API REST para buscar el elemento específico que quieras encontrar. Por ejemplo, puedes buscar un usuario o un archivo específico en el repositorio. Tómalo como el simil de realizar una búsqueda en Google. Se diseñó para ayudarte a encontrar el resultado exacto que estás buscando (o tal vez algunos de los resultados que buscas). Tal como la búsqueda en Google, a veces quieres ver algunas páginas de los resultados de búsqueda para que puedas encontrar el elemento que mejor satisfaga tus necesidades. Para satisfacer esta necesidad, la API REST de GitHub Enterprise Server proporciona hasta 1000 resultados por búsqueda.

Puedes delimitar tu búsqueda utilizando consultas. Para más información sobre la sintaxis de las consultas de búsqueda, consulta "Puntos de conexión de la API de REST para búsquedas".

Clasificar los resultados de la búsqueda

A menos de que se proporcione algún otro tipo de opción como parámetro de consulta, los resultados se clasificarán de acuerdo a la exactitud de la coincidencia en orden descendente. Varios factores se combinan para impulsar el elemento más relevante hasta arriba de la lista de resultados.

Límite de frecuencia

Los límites de frecuencia están deshabilitados de forma predeterminada para GitHub Enterprise Server. Contacta a tu administrador de sitio para confirmar los límites de frecuencia de tu instancia.

La API REST tiene un límite de frecuencia personalizado para la búsqueda. En el caso de las solicitudes autenticadas, puede realizar hasta 30 solicitudes por minuto. En el caso de las solicitudes sin autenticación, el límite de frecuencia le permite hacer hasta 10 solicitudes por minuto.

Para obtener información sobre cómo determinar el estado actual del límite de velocidad, consulta "Límite de velocidad".

Construir una consulta de búsqueda

Cada punto de conexión de la búsqueda usa parámetros de consulta para realizar búsquedas en GitHub Enterprise Server. Consulta los puntos de conexión individuales para obtener ejemplos que incluyen el punto de conexión y los parámetros de consulta.

Una consulta puede contener cualquier combinación de calificadores de búsqueda que sea compatible con GitHub Enterprise Server. El formato de esta consulta de búsqueda es:

SEARCH_KEYWORD_1 SEARCH_KEYWORD_N QUALIFIER_1 QUALIFIER_N

Por ejemplo, si quiere buscar todos los repositorios que pertenecen a defunkt y contienen las palabras GitHub y Octocat en el archivo Léame, puede usar la consulta siguiente con el punto de conexión de búsqueda en repositorios:

GitHub Octocat in:readme user:defunkt

Nota: Asegúrese de usar el codificador HTML preferido de su lenguaje de programación para construir las cadenas de consulta. Por ejemplo:

// JavaScript
const queryString = 'q=' + encodeURIComponent('GitHub Octocat in:readme user:defunkt');

Consulta "Buscar en GitHub" para obtener una lista completa de los calificadores disponibles, su formato y un ejemplo de cómo usarlos. Para obtener información sobre cómo usar los operadores para comparar cantidades y fechas específicas, o para que excluyan resultados, consulta "Entender la sintaxis de búsqueda".

Limitaciones sobre la longitud de la consulta

No puedes usar consultas que:

  • sean mayores a 256 caracteres (sin incluir los operadores o calificativos).
  • Tienen más de cinco operadores AND, OR o NOT.

Estas consultas de búsqueda devolverán un mensaje de error de "Validation failed".

Límites del ámbito de búsqueda

A fin de mantener la velocidad de la API REST para todos los usuarios, se limita el número de repositorios en los que se buscará una consulta. La API REST encontrará hasta 4000 repositorios que coincidan con los filtros y devolverá resultados de esos repositorios.

Tiempos excedidos y resultados incompletos

Para que la API REST sea rápida para todos, se limita el tiempo que se puede ejecutar una consulta individual. Para las consultas que superan el límite de tiempo, la API devuelve las coincidencias que se han encontrado antes de que se cumpla el tiempo de espera y la respuesta tiene la propiedad incomplete_results establecida en true.

Llegar a una interrupción no necesariamente significa que los resultados de búsqueda estén incompletos. Puede que se hayan encontrado más resultados, pero también puede que no.

Errores de acceso o resultados de búsqueda faltantes

Necesita autenticarse correctamente y tener acceso a los repositorios en sus consultas de búsqueda, de otro modo, verá un error 422 Unprocessable Entry con el mensaje "Validation Failed". Por ejemplo, se producirá un error en la búsqueda si su consulta incluye calificadores repo:, user: o org: que solicitan recursos a los cuales no tiene acceso cuando inicia sesión en GitHub.

Cuando su consulta de búsqueda solicita recursos múltiples, la respuesta solo contendrá aquellos a los que tenga acceso y no proporcionará un mensaje de error que liste los recursos que no se han devuelto.

Por ejemplo, si la consulta de búsqueda busca en los repositorios octocat/test y codertocat/test, pero solo tiene acceso a octocat/test, la respuesta mostrará los resultados de la búsqueda para octocat/test y no mostrará nada para codertocat/test. Este comportamiento simula cómo funciona la búsqueda en GitHub.

Metadatos en el texto coincidente

En GitHub, puedes usar el contexto que proporcionan los fragmentos de código y los puntos destacados en los resultados de búsqueda. Los puntos de conexión de búsqueda devuelven metadatos adicionales que te permiten resaltar los términos de búsqueda coincidentes cuando se muestran los resultados de la búsqueda.

Las solicitudes pueden decidir recibir esos fragmentos de texto en la respuesta, y cada fragmento se acompaña de intervalos numéricos que identifican la ubicación exacta de cada término de búsqueda coincidente.

Para obtener estos metadatos en los resultados de búsqueda, especifique el tipo de medio text-match en el encabezado Accept.

application/vnd.github.text-match+json

Al proporcionar el tipo de medio text-match, recibirá una clave extra en la carga de JSON llamada text_matches, la cual proporciona información sobre la posición de sus términos de búsqueda dentro del texto y la propiedad (property) que incluye dicho término de búsqueda. Dentro de la matriz text_matches, cada objeto incluye los siguientes atributos:

NombreDescripción
object_urlLa URL del recurso que contiene una propiedad de secuencia que empata con uno de los términos de búsqueda.
object_typeEl nombre del tipo de recurso que existe en el atributo object_url especificado.
propertyEl nombre de la propiedad del recurso que existe en object_url. Esa propiedad es una secuencia que empata con uno de los términos de la búsqueda. (En el código JSON que se devuelve de object_url, el contenido completo del objeto fragment se encontrará en la propiedad con este nombre).
fragmentUn subconjunto del valor de property. Este es el fragmento de texto que empata con uno o más de los términos de búsqueda.
matchesUna matriz de uno o más términos de búsqueda presentes en el objeto fragment. Los índices (es decir, "intervalos") son relativos al fragmento. (No son relativos al contenido completo del objeto property).

Ejemplo

Con un comando curl y el ejemplo de búsqueda de incidencias anterior, nuestra solicitud de API tendría este aspecto:

curl -H 'Accept: application/vnd.github.text-match+json' \
'http(s)://<em>HOSTNAME</em>/api/v3/search/issues?q=windows+label:bug \
+language:python+state:open&sort=created&order=asc'

La respuesta incluirá una matriz text_matches para cada resultado de búsqueda. En el código JSON siguiente, tenemos dos objetos en la matriz text_matches.

La primera coincidencia de texto se produjo en la propiedad body de la incidencia. Aquí vemos un fragmento de texto del cuerpo del informe de problemas. El término de búsqueda (windows) aparece dos veces en ese fragmento, y tenemos los índices de cada aparición.

La segunda coincidencia de texto se produjo en la propiedad body de uno de los comentarios de la incidencia. Tenemos la URL para el comentario del informe de problemas. Y, por supuesto, vemos un fragmento de texto del cuerpo del comentario. El término de búsqueda (windows) aparece una vez en ese fragmento.

{
  "text_matches": [
    {
      "object_url": "https://api.github.com/repositories/215335/issues/132",
      "object_type": "Issue",
      "property": "body",
      "fragment": "comprehensive windows font I know of).\n\nIf we can find a commonly
      distributed windows font that supports them then no problem (we can use html
      font tags) but otherwise the '(21)' style is probably better.\n",
      "matches": [
        {
          "text": "windows",
          "indices": [
            14,
            21
          ]
        },
        {
          "text": "windows",
          "indices": [
            78,
            85
          ]
        }
      ]
    },
    {
      "object_url": "https://api.github.com/repositories/215335/issues/comments/25688",
      "object_type": "IssueComment",
      "property": "body",
      "fragment": " right after that are a bit broken IMHO :). I suppose we could
      have some hack that maxes out at whatever the font does...\n\nI'll check
      what the state of play is on Windows.\n",
      "matches": [
        {
          "text": "Windows",
          "indices": [
            163,
            170
          ]
        }
      ]
    }
  ]
}

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 master branch.
  • 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:go is not valid, while amazing language:go is.

Parámetros para "Search code"

Encabezados
Nombre, Tipo, Descripción
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de consulta
Nombre, Tipo, Descripción
q string Requerido

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See "Searching code" for a detailed list of qualifiers.

sort string

Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: best match

Valor: indexed

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.

Valor predeterminado: desc

Puede ser uno de los siguientes: desc, asc

per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

Códigos de estado de respuesta HTTP para "Search code"

status codeDescripción
200

OK

304

Not modified

403

Forbidden

422

Validation failed, or the endpoint has been spammed.

503

Service unavailable

Ejemplos de código para "Search code"

Ejemplo de solicitud

get/search/code
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ "http(s)://HOSTNAME/api/v3/search/code?q=Q"

Response

Status: 200
{ "total_count": 7, "incomplete_results": false, "items": [ { "name": "classes.js", "path": "src/attributes/classes.js", "sha": "d7212f9dee2dcc18f084d7df8f417b80846ded5a", "url": "https://HOSTNAME/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4", "git_url": "https://HOSTNAME/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a", "html_url": "https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js", "repository": { "id": 167174, "node_id": "MDEwOlJlcG9zaXRvcnkxNjcxNzQ=", "name": "jquery", "full_name": "jquery/jquery", "owner": { "login": "jquery", "id": 70142, "node_id": "MDQ6VXNlcjcwMTQy", "avatar_url": "https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png", "gravatar_id": "", "url": "https://HOSTNAME/users/jquery", "html_url": "https://github.com/jquery", "followers_url": "https://HOSTNAME/users/jquery/followers", "following_url": "https://HOSTNAME/users/jquery/following{/other_user}", "gists_url": "https://HOSTNAME/users/jquery/gists{/gist_id}", "starred_url": "https://HOSTNAME/users/jquery/starred{/owner}{/repo}", "subscriptions_url": "https://HOSTNAME/users/jquery/subscriptions", "organizations_url": "https://HOSTNAME/users/jquery/orgs", "repos_url": "https://HOSTNAME/users/jquery/repos", "events_url": "https://HOSTNAME/users/jquery/events{/privacy}", "received_events_url": "https://HOSTNAME/users/jquery/received_events", "type": "Organization", "site_admin": false }, "private": false, "html_url": "https://github.com/jquery/jquery", "description": "jQuery JavaScript Library", "fork": false, "url": "https://HOSTNAME/repos/jquery/jquery", "forks_url": "https://HOSTNAME/repos/jquery/jquery/forks", "keys_url": "https://HOSTNAME/repos/jquery/jquery/keys{/key_id}", "collaborators_url": "https://HOSTNAME/repos/jquery/jquery/collaborators{/collaborator}", "teams_url": "https://HOSTNAME/repos/jquery/jquery/teams", "hooks_url": "https://HOSTNAME/repos/jquery/jquery/hooks", "issue_events_url": "https://HOSTNAME/repos/jquery/jquery/issues/events{/number}", "events_url": "https://HOSTNAME/repos/jquery/jquery/events", "assignees_url": "https://HOSTNAME/repos/jquery/jquery/assignees{/user}", "branches_url": "https://HOSTNAME/repos/jquery/jquery/branches{/branch}", "tags_url": "https://HOSTNAME/repos/jquery/jquery/tags", "blobs_url": "https://HOSTNAME/repos/jquery/jquery/git/blobs{/sha}", "git_tags_url": "https://HOSTNAME/repos/jquery/jquery/git/tags{/sha}", "git_refs_url": "https://HOSTNAME/repos/jquery/jquery/git/refs{/sha}", "trees_url": "https://HOSTNAME/repos/jquery/jquery/git/trees{/sha}", "statuses_url": "https://HOSTNAME/repos/jquery/jquery/statuses/{sha}", "languages_url": "https://HOSTNAME/repos/jquery/jquery/languages", "stargazers_url": "https://HOSTNAME/repos/jquery/jquery/stargazers", "contributors_url": "https://HOSTNAME/repos/jquery/jquery/contributors", "subscribers_url": "https://HOSTNAME/repos/jquery/jquery/subscribers", "subscription_url": "https://HOSTNAME/repos/jquery/jquery/subscription", "commits_url": "https://HOSTNAME/repos/jquery/jquery/commits{/sha}", "git_commits_url": "https://HOSTNAME/repos/jquery/jquery/git/commits{/sha}", "comments_url": "https://HOSTNAME/repos/jquery/jquery/comments{/number}", "issue_comment_url": "https://HOSTNAME/repos/jquery/jquery/issues/comments/{number}", "contents_url": "https://HOSTNAME/repos/jquery/jquery/contents/{+path}", "compare_url": "https://HOSTNAME/repos/jquery/jquery/compare/{base}...{head}", "merges_url": "https://HOSTNAME/repos/jquery/jquery/merges", "archive_url": "https://HOSTNAME/repos/jquery/jquery/{archive_format}{/ref}", "downloads_url": "https://HOSTNAME/repos/jquery/jquery/downloads", "issues_url": "https://HOSTNAME/repos/jquery/jquery/issues{/number}", "pulls_url": "https://HOSTNAME/repos/jquery/jquery/pulls{/number}", "milestones_url": "https://HOSTNAME/repos/jquery/jquery/milestones{/number}", "notifications_url": "https://HOSTNAME/repos/jquery/jquery/notifications{?since,all,participating}", "labels_url": "https://HOSTNAME/repos/jquery/jquery/labels{/name}", "deployments_url": "http://HOSTNAME/repos/octocat/Hello-World/deployments", "releases_url": "http://HOSTNAME/repos/octocat/Hello-World/releases{/id}" }, "score": 1 } ] }

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

Parámetros para "Search commits"

Encabezados
Nombre, Tipo, Descripción
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de consulta
Nombre, Tipo, Descripción
q string Requerido

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See "Searching commits" for a detailed list of qualifiers.

sort string

Sorts the results of your query by author-date or committer-date. Default: best match

Puede ser uno de los siguientes: author-date, committer-date

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.

Valor predeterminado: desc

Puede ser uno de los siguientes: desc, asc

per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

Códigos de estado de respuesta HTTP para "Search commits"

status codeDescripción
200

OK

304

Not modified

Ejemplos de código para "Search commits"

Ejemplo de solicitud

get/search/commits
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ "http(s)://HOSTNAME/api/v3/search/commits?q=Q"

Response

Status: 200
{ "total_count": 1, "incomplete_results": false, "items": [ { "url": "https://HOSTNAME/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", "sha": "bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", "html_url": "https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", "comments_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments", "commit": { "url": "https://HOSTNAME/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", "author": { "date": "2014-02-04T14:38:36-08:00", "name": "The Octocat", "email": "octocat@nowhere.com" }, "committer": { "date": "2014-02-12T15:18:55-08:00", "name": "The Octocat", "email": "octocat@nowhere.com" }, "message": "Create styles.css and updated README", "tree": { "url": "https://HOSTNAME/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68", "sha": "a639e96f9038797fba6e0469f94a4b0cc459fa68" }, "comment_count": 8 }, "author": { "login": "octocat", "id": 583231, "node_id": "MDQ6VXNlcjU4MzIzMQ==", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=3", "gravatar_id": "", "url": "https://HOSTNAME/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://HOSTNAME/users/octocat/followers", "following_url": "https://HOSTNAME/users/octocat/following{/other_user}", "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}", "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions", "organizations_url": "https://HOSTNAME/users/octocat/orgs", "repos_url": "https://HOSTNAME/users/octocat/repos", "events_url": "https://HOSTNAME/users/octocat/events{/privacy}", "received_events_url": "https://HOSTNAME/users/octocat/received_events", "type": "User", "site_admin": false }, "committer": {}, "parents": [ { "url": "https://HOSTNAME/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4", "html_url": "https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4", "sha": "a30c19e3f13765a3b48829788bc1cb8b4e95cee4" } ], "repository": { "id": 1300192, "node_id": "MDEwOlJlcG9zaXRvcnkxMzAwMTky", "name": "Spoon-Knife", "full_name": "octocat/Spoon-Knife", "owner": { "login": "octocat", "id": 583231, "node_id": "MDQ6VXNlcjU4MzIzMQ==", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=3", "gravatar_id": "", "url": "https://HOSTNAME/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://HOSTNAME/users/octocat/followers", "following_url": "https://HOSTNAME/users/octocat/following{/other_user}", "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}", "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions", "organizations_url": "https://HOSTNAME/users/octocat/orgs", "repos_url": "https://HOSTNAME/users/octocat/repos", "events_url": "https://HOSTNAME/users/octocat/events{/privacy}", "received_events_url": "https://HOSTNAME/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Spoon-Knife", "description": "This repo is for demonstration purposes only.", "fork": false, "url": "https://HOSTNAME/repos/octocat/Spoon-Knife", "forks_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/forks", "keys_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/keys{/key_id}", "collaborators_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/collaborators{/collaborator}", "teams_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/teams", "hooks_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/hooks", "issue_events_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/issues/events{/number}", "events_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/events", "assignees_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/assignees{/user}", "branches_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/branches{/branch}", "tags_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/tags", "blobs_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/git/blobs{/sha}", "git_tags_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/git/tags{/sha}", "git_refs_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/git/refs{/sha}", "trees_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/git/trees{/sha}", "statuses_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/statuses/{sha}", "languages_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/languages", "stargazers_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/stargazers", "contributors_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/contributors", "subscribers_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/subscribers", "subscription_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/subscription", "commits_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/commits{/sha}", "git_commits_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/git/commits{/sha}", "comments_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/comments{/number}", "issue_comment_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/issues/comments{/number}", "contents_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/contents/{+path}", "compare_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/compare/{base}...{head}", "merges_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/merges", "archive_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/{archive_format}{/ref}", "downloads_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/downloads", "issues_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/issues{/number}", "pulls_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/pulls{/number}", "milestones_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/milestones{/number}", "notifications_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/notifications{?since,all,participating}", "labels_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/labels{/name}", "releases_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/releases{/id}", "deployments_url": "https://HOSTNAME/repos/octocat/Spoon-Knife/deployments" }, "score": 1, "node_id": "MDQ6VXNlcjU4MzIzMQ==" } ] }

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."

Parámetros para "Search issues and pull requests"

Encabezados
Nombre, Tipo, Descripción
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de consulta
Nombre, Tipo, Descripción
q string Requerido

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. 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 string

Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match

Puede ser uno de los siguientes: comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, interactions, created, updated

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.

Valor predeterminado: desc

Puede ser uno de los siguientes: desc, asc

per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

Códigos de estado de respuesta HTTP para "Search issues and pull requests"

status codeDescripción
200

OK

304

Not modified

403

Forbidden

422

Validation failed, or the endpoint has been spammed.

503

Service unavailable

Ejemplos de código para "Search issues and pull requests"

Ejemplo de solicitud

get/search/issues
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ "http(s)://HOSTNAME/api/v3/search/issues?q=Q"

Response

Status: 200
{ "total_count": 280, "incomplete_results": false, "items": [ { "url": "https://HOSTNAME/repos/batterseapower/pinyin-toolkit/issues/132", "repository_url": "https://HOSTNAME/repos/batterseapower/pinyin-toolkit", "labels_url": "https://HOSTNAME/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}", "comments_url": "https://HOSTNAME/repos/batterseapower/pinyin-toolkit/issues/132/comments", "events_url": "https://HOSTNAME/repos/batterseapower/pinyin-toolkit/issues/132/events", "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132", "id": 35802, "node_id": "MDU6SXNzdWUzNTgwMg==", "number": 132, "title": "Line Number Indexes Beyond 20 Not Displayed", "user": { "login": "Nick3C", "id": 90254, "node_id": "MDQ6VXNlcjkwMjU0", "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", "gravatar_id": "", "url": "https://HOSTNAME/users/Nick3C", "html_url": "https://github.com/Nick3C", "followers_url": "https://HOSTNAME/users/Nick3C/followers", "following_url": "https://HOSTNAME/users/Nick3C/following{/other_user}", "gists_url": "https://HOSTNAME/users/Nick3C/gists{/gist_id}", "starred_url": "https://HOSTNAME/users/Nick3C/starred{/owner}{/repo}", "subscriptions_url": "https://HOSTNAME/users/Nick3C/subscriptions", "organizations_url": "https://HOSTNAME/users/Nick3C/orgs", "repos_url": "https://HOSTNAME/users/Nick3C/repos", "events_url": "https://HOSTNAME/users/Nick3C/events{/privacy}", "received_events_url": "https://HOSTNAME/users/Nick3C/received_events", "type": "User", "site_admin": true }, "labels": [ { "id": 4, "node_id": "MDU6TGFiZWw0", "url": "https://HOSTNAME/repos/batterseapower/pinyin-toolkit/labels/bug", "name": "bug", "color": "ff0000" } ], "state": "open", "assignee": null, "milestone": { "url": "https://HOSTNAME/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://HOSTNAME/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://HOSTNAME/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://HOSTNAME/users/octocat/followers", "following_url": "https://HOSTNAME/users/octocat/following{/other_user}", "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}", "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions", "organizations_url": "https://HOSTNAME/users/octocat/orgs", "repos_url": "https://HOSTNAME/users/octocat/repos", "events_url": "https://HOSTNAME/users/octocat/events{/privacy}", "received_events_url": "https://HOSTNAME/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "comments": 15, "created_at": "2009-07-12T20:10:41Z", "updated_at": "2009-07-19T09:23:43Z", "closed_at": null, "pull_request": { "url": "https://api/github.com/repos/octocat/Hello-World/pull/1347", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://HOSTNAME/repos/octocat/Hello-World/pulls/1347" }, "body": "...", "score": 1, "locked": true, "author_association": "COLLABORATOR", "state_reason": "completed" } ] }

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.

Parámetros para "Search labels"

Encabezados
Nombre, Tipo, Descripción
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de consulta
Nombre, Tipo, Descripción
repository_id integer Requerido

The id of the repository.

q string Requerido

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 string

Sorts the results of your query by when the label was created or updated. Default: best match

Puede ser uno de los siguientes: created, updated

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.

Valor predeterminado: desc

Puede ser uno de los siguientes: desc, asc

per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

Códigos de estado de respuesta HTTP para "Search labels"

status codeDescripción
200

OK

304

Not modified

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Ejemplos de código para "Search labels"

Ejemplo de solicitud

get/search/labels
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ "http(s)://HOSTNAME/api/v3/search/labels?repository_id=REPOSITORY_ID&q=Q"

Response

Status: 200
{ "total_count": 2, "incomplete_results": false, "items": [ { "id": 418327088, "node_id": "MDU6TGFiZWw0MTgzMjcwODg=", "url": "https://HOSTNAME/repos/octocat/linguist/labels/enhancement", "name": "enhancement", "color": "84b6eb", "default": true, "description": "New feature or request.", "score": 1 }, { "id": 418327086, "node_id": "MDU6TGFiZWw0MTgzMjcwODY=", "url": "https://HOSTNAME/repos/octocat/linguist/labels/bug", "name": "bug", "color": "ee0701", "default": true, "description": "Something isn't working.", "score": 1 } ] }

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.

Parámetros para "Search repositories"

Encabezados
Nombre, Tipo, Descripción
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de consulta
Nombre, Tipo, Descripción
q string Requerido

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. 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

Puede ser uno de los siguientes: stars, forks, help-wanted-issues, updated

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.

Valor predeterminado: desc

Puede ser uno de los siguientes: desc, asc

per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

Códigos de estado de respuesta HTTP para "Search repositories"

status codeDescripción
200

OK

304

Not modified

422

Validation failed, or the endpoint has been spammed.

503

Service unavailable

Ejemplos de código para "Search repositories"

Ejemplo de solicitud

get/search/repositories
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ "http(s)://HOSTNAME/api/v3/search/repositories?q=Q"

Response

Status: 200
{ "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://HOSTNAME/users/dtrupenn", "received_events_url": "https://HOSTNAME/users/dtrupenn/received_events", "type": "User", "html_url": "https://github.com/octocat", "followers_url": "https://HOSTNAME/users/octocat/followers", "following_url": "https://HOSTNAME/users/octocat/following{/other_user}", "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}", "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions", "organizations_url": "https://HOSTNAME/users/octocat/orgs", "repos_url": "https://HOSTNAME/users/octocat/repos", "events_url": "https://HOSTNAME/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://HOSTNAME/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://HOSTNAME/repos/dtrupenn/Tetris/{archive_format}{/ref}", "assignees_url": "https://HOSTNAME/repos/dtrupenn/Tetris/assignees{/user}", "blobs_url": "https://HOSTNAME/repos/dtrupenn/Tetris/git/blobs{/sha}", "branches_url": "https://HOSTNAME/repos/dtrupenn/Tetris/branches{/branch}", "collaborators_url": "https://HOSTNAME/repos/dtrupenn/Tetris/collaborators{/collaborator}", "comments_url": "https://HOSTNAME/repos/dtrupenn/Tetris/comments{/number}", "commits_url": "https://HOSTNAME/repos/dtrupenn/Tetris/commits{/sha}", "compare_url": "https://HOSTNAME/repos/dtrupenn/Tetris/compare/{base}...{head}", "contents_url": "https://HOSTNAME/repos/dtrupenn/Tetris/contents/{+path}", "contributors_url": "https://HOSTNAME/repos/dtrupenn/Tetris/contributors", "deployments_url": "https://HOSTNAME/repos/dtrupenn/Tetris/deployments", "downloads_url": "https://HOSTNAME/repos/dtrupenn/Tetris/downloads", "events_url": "https://HOSTNAME/repos/dtrupenn/Tetris/events", "forks_url": "https://HOSTNAME/repos/dtrupenn/Tetris/forks", "git_commits_url": "https://HOSTNAME/repos/dtrupenn/Tetris/git/commits{/sha}", "git_refs_url": "https://HOSTNAME/repos/dtrupenn/Tetris/git/refs{/sha}", "git_tags_url": "https://HOSTNAME/repos/dtrupenn/Tetris/git/tags{/sha}", "git_url": "git:github.com/dtrupenn/Tetris.git", "issue_comment_url": "https://HOSTNAME/repos/dtrupenn/Tetris/issues/comments{/number}", "issue_events_url": "https://HOSTNAME/repos/dtrupenn/Tetris/issues/events{/number}", "issues_url": "https://HOSTNAME/repos/dtrupenn/Tetris/issues{/number}", "keys_url": "https://HOSTNAME/repos/dtrupenn/Tetris/keys{/key_id}", "labels_url": "https://HOSTNAME/repos/dtrupenn/Tetris/labels{/name}", "languages_url": "https://HOSTNAME/repos/dtrupenn/Tetris/languages", "merges_url": "https://HOSTNAME/repos/dtrupenn/Tetris/merges", "milestones_url": "https://HOSTNAME/repos/dtrupenn/Tetris/milestones{/number}", "notifications_url": "https://HOSTNAME/repos/dtrupenn/Tetris/notifications{?since,all,participating}", "pulls_url": "https://HOSTNAME/repos/dtrupenn/Tetris/pulls{/number}", "releases_url": "https://HOSTNAME/repos/dtrupenn/Tetris/releases{/id}", "ssh_url": "git@github.com:dtrupenn/Tetris.git", "stargazers_url": "https://HOSTNAME/repos/dtrupenn/Tetris/stargazers", "statuses_url": "https://HOSTNAME/repos/dtrupenn/Tetris/statuses/{sha}", "subscribers_url": "https://HOSTNAME/repos/dtrupenn/Tetris/subscribers", "subscription_url": "https://HOSTNAME/repos/dtrupenn/Tetris/subscription", "tags_url": "https://HOSTNAME/repos/dtrupenn/Tetris/tags", "teams_url": "https://HOSTNAME/repos/dtrupenn/Tetris/teams", "trees_url": "https://HOSTNAME/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://HOSTNAME/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, "visibility": "private", "license": { "key": "mit", "name": "MIT License", "url": "https://HOSTNAME/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://HOSTNAME/licenses/mit" } } ] }

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.

Parámetros para "Search topics"

Encabezados
Nombre, Tipo, Descripción
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de consulta
Nombre, Tipo, Descripción
q string Requerido

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query.

per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

Códigos de estado de respuesta HTTP para "Search topics"

status codeDescripción
200

OK

304

Not modified

Ejemplos de código para "Search topics"

Ejemplo de solicitud

get/search/topics
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ "http(s)://HOSTNAME/api/v3/search/topics?q=Q"

Response

Status: 200
{ "total_count": 6, "incomplete_results": false, "items": [ { "name": "ruby", "display_name": "Ruby", "short_description": "Ruby is a scripting language designed for simplified object-oriented programming.", "description": "Ruby was developed by Yukihiro \"Matz\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.", "created_by": "Yukihiro Matsumoto", "released": "December 21, 1995", "created_at": "2016-11-28T22:03:59Z", "updated_at": "2017-10-30T18:16:32Z", "featured": true, "curated": true, "score": 1 }, { "name": "rails", "display_name": "Rails", "short_description": "Ruby on Rails (Rails) is a web application framework written in Ruby.", "description": "Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.", "created_by": "David Heinemeier Hansson", "released": "December 13 2005", "created_at": "2016-12-09T17:03:50Z", "updated_at": "2017-10-30T16:20:19Z", "featured": true, "curated": true, "score": 1 }, { "name": "python", "display_name": "Python", "short_description": "Python is a dynamically typed programming language.", "description": "Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.", "created_by": "Guido van Rossum", "released": "February 20, 1991", "created_at": "2016-12-07T00:07:02Z", "updated_at": "2017-10-27T22:45:43Z", "featured": true, "curated": true, "score": 1 }, { "name": "jekyll", "display_name": "Jekyll", "short_description": "Jekyll is a simple, blog-aware static site generator.", "description": "Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.", "created_by": "Tom Preston-Werner", "released": "2008", "created_at": "2016-12-16T21:53:08Z", "updated_at": "2017-10-27T19:00:24Z", "featured": true, "curated": true, "score": 1 }, { "name": "sass", "display_name": "Sass", "short_description": "Sass is a stable extension to classic CSS.", "description": "Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.", "created_by": "Hampton Catlin, Natalie Weizenbaum, Chris Eppstein", "released": "November 28, 2006", "created_at": "2016-12-16T21:53:45Z", "updated_at": "2018-01-16T16:30:40Z", "featured": true, "curated": true, "score": 1 }, { "name": "homebrew", "display_name": "Homebrew", "short_description": "Homebrew is a package manager for macOS.", "description": "Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.", "created_by": "Max Howell", "released": "2009", "created_at": "2016-12-17T20:30:44Z", "updated_at": "2018-02-06T16:14:56Z", "featured": true, "curated": true, "score": 1 } ] }

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."

Parámetros para "Search users"

Encabezados
Nombre, Tipo, Descripción
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de consulta
Nombre, Tipo, Descripción
q string Requerido

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See "Searching users" for a detailed list of qualifiers.

sort string

Sorts the results of your query by number of followers or repositories, or when the person joined GitHub Enterprise Server. Default: best match

Puede ser uno de los siguientes: followers, repositories, joined

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.

Valor predeterminado: desc

Puede ser uno de los siguientes: desc, asc

per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

Códigos de estado de respuesta HTTP para "Search users"

status codeDescripción
200

OK

304

Not modified

422

Validation failed, or the endpoint has been spammed.

503

Service unavailable

Ejemplos de código para "Search users"

Ejemplo de solicitud

get/search/users
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ "http(s)://HOSTNAME/api/v3/search/users?q=Q"

Response

Status: 200
{ "total_count": 12, "incomplete_results": false, "items": [ { "login": "mojombo", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", "gravatar_id": "", "url": "https://HOSTNAME/users/mojombo", "html_url": "https://github.com/mojombo", "followers_url": "https://HOSTNAME/users/mojombo/followers", "subscriptions_url": "https://HOSTNAME/users/mojombo/subscriptions", "organizations_url": "https://HOSTNAME/users/mojombo/orgs", "repos_url": "https://HOSTNAME/users/mojombo/repos", "received_events_url": "https://HOSTNAME/users/mojombo/received_events", "type": "User", "score": 1, "following_url": "https://HOSTNAME/users/mojombo/following{/other_user}", "gists_url": "https://HOSTNAME/users/mojombo/gists{/gist_id}", "starred_url": "https://HOSTNAME/users/mojombo/starred{/owner}{/repo}", "events_url": "https://HOSTNAME/users/mojombo/events{/privacy}", "site_admin": true } ] }