このバージョンの GitHub Enterprise サーバーはこの日付をもって終了となりました: 2024-09-25. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise サーバーにアップグレードしてください。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください。

REST API はバージョン管理になりました。 詳細については、「API のバージョン管理について」を参照してください。

検索用 REST API エンドポイント

この REST API を使い、GitHub Enterprise Server で特定のアイテムを検索します。

この REST API を使って特定の項目を検索できます。 たとえば、リポジトリ内のユーザや特定のファイルを見つけることができます。 Google で検索を実行するのと同じように考えてください。 Search API は、探している 1 つの結果 (または探しているいくつかの結果) を見つけるために役立つよう設計されています。 Google で検索する場合と同じように、ニーズに最も合う項目を見つけるため、検索結果を数ページ表示したい場合もあるでしょう。 こうしたニーズを満たすため、GitHub Enterprise Server REST API は、検索ごとに最大 1,000 件の結果を提供します。

クエリを使って、検索を絞り込めます。 検索クエリの構文の詳細については、「検索用 REST API エンドポイント」を参照してください。

検索結果を順番づける

クエリパラメータとして別のソートオプションが指定されない限り、結果は最も一致するものから降順にソートされます。 最も関連性の高い項目を検索結果の最上位に押し上げるように、複数の要素が組み合わされます。

レート制限

Note

GitHub Enterprise Server では、レート制限は既定で無効になっています。 インスタンスのレート制限を確認するには、サイト管理者にお問い合わせください。

この REST API では、検索にカスタムのレート制限があります。 認証要求の場合、1 分間に最大 30 回の要求を行うことができます。。 認証されていない要求の場合、レート制限を使用すると、1 分あたり最大 10 件の要求を作成できます。

現在のレート制限の状態を確認する方法については、「レート制限」を参照してください。

検索クエリの構築

検索の各エンドポイントではクエリ パラメーターを使い、GitHub Enterprise Server で検索します。 エンドポイントとクエリ パラメーターを含む例については、個々のエンドポイントを参照してください。

クエリには、GitHub Enterprise Server でサポートされている検索修飾子を任意に組み合わせて使用できます。 検索クエリの形式は次のとおりです。

SEARCH_KEYWORD_1 SEARCH_KEYWORD_N QUALIFIER_1 QUALIFIER_N

たとえば、defunkt が所有する_リポジトリ_で、README ファイルに GitHub と Octocat という単語が含まれているものをすべて検索する場合は、検索リポジトリ エンドポイントで次のクエリを使用します。

GitHub Octocat in:readme user:defunkt

注: ご使用の言語の推奨 HTML エンコーダーを使用して、クエリ文字列を作成してください。 次に例を示します。

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

使用可能な修飾子の完全な一覧、その形式、使用例については、「GitHub 上で検索する」を参照してください。 演算子を使用して特定の数量や日付に一致させたり、結果を除外したりする方法については、「検索構文を理解する」を参照してください。

クエリの長さの制限

次のようなクエリは使えません。

  • 256 文字 (演算子や修飾子は除く) より長い。
  • 5 個を超える AND、OR、NOT 演算子がある。

こうした検索クエリを使用すると、「Validation failed」というエラーメッセージが返されます。

検索範囲の制限

すべてのユーザーのために高速な REST API を維持する目的で、クエリによって検索されるリポジトリの数を制限しています。 この REST API では、フィルターに一致するリポジトリが最大 4,000 個検索され、それらのリポジトリから結果が返されます。

タイムアウトと不完全な結果

すべてのユーザーのために高速な REST API を維持する目的で、個々のクエリの実行時間を制限しています。 制限時間を超えるクエリの場合、タイムアウト前に既に見つかった一致を API が返し、応答では incomplete_results プロパティが true に設定されます。

タイムアウトになったことは、必ずしも検索結果が未完了であるということではありません。 もっと多くの検索結果が出たかもしれませんし、出ていないかもしれません。

アクセスエラーまたは検索結果の欠落

検索クエリでリポジトリを正常に認証してアクセスできるようにする必要があります。それ以外の場合は、"検証に失敗しました" というメッセージが表示される 422 Unprocessable Entry エラーが表示されます。 たとえば、GitHub にサインインしたときにアクセスできないリソースを要求する repo:、user:、または org: 修飾子がクエリに含まれている場合、検索は失敗します。

検索クエリが複数のリソースを要求すると、応答にはアクセスできるリソースのみが含まれ、返されなかったリソースを一覧表示するエラー メッセージは表示されません。

たとえば、検索クエリが octocat/test および codertocat/test リポジトリを検索しても、octocat/test へのアクセス権しかない場合は、応答には octocat/test の検索結果が表示され、codertocat/test の検索結果は表示されません。 この振る舞いは、GitHub における検索の仕組みと同じです。

テキスト一致メタデータ

GitHub では、コードスニペットが提供するコンテキストと、検索結果のハイライトが使用できます。 検索のためのエンドポイントからは、検索結果を表示するときに、検索と一致した言葉をハイライトできる付加的なメタデータが返されます。

リクエストでは、レスポンスに含まれるテキストフラグメントを受け取ることを選べます。各フラグメントには、一致した各検索用語の正確な場所を特定する数値オフセットが付属しています。

検索結果でこのメタデータを取得するには、Accept ヘッダーで text-match メディアの種類を指定します。

application/vnd.github.text-match+json

text-match メディアの種類を指定すると、JSON ペイロード内にある text_matches と呼ばれる追加のキーを受け取ります。これは、テキスト内の検索用語の位置と、検索用語を含む property についての情報を提供します。 text_matches 配列内では、各オブジェクトに次の属性が含まれます。

名前説明
object_url検索用語のいずれかに一致する文字列プロパティを含むリソースの URL。
object_type指定された object_url に存在するリソースの種類の名前。
propertyobject_url に存在するリソースのプロパティの名前。 このプロパティは、検索用語のいずれかに一致する文字列です。 (object_url から返される JSON では、fragment の完全なコンテンツは、この名前でプロパティから検索できます。)
fragmentproperty の値のサブセット。 これは、1 つ以上の検索用語に一致するテキストフラグメントです。
matchesfragment に存在する 1 つ以上の検索用語の配列。 インデックス (すなわち「オフセット」) は、フラグメントと関連しています。 (それらは property の_完全な_コンテンツに対して相対的ではありません。)

例

curl コマンドと、上記のイシュー検索の例を使用すると、API 要求は次のようになります。

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

応答には、検索結果ごとに text_matches 配列が含まれます。 次の JSON では、text_matches 配列に 2 つのオブジェクトがあります。

最初のテキスト一致は、issue のbody プロパティで発生しました。 Issue 本文から、テキストのフラグメントが表示されています。 検索用語 (windows) はそのフラグメント内に 2 回表示され、それぞれにインデックスがあります。

2 番目のテキスト一致は、issue のコメントのうちの 1 つの body プロパティで発生しました。 Issue コメントの URL があります。 そしてもちろん、コメント本文から、テキストのフラグメントが表示されています。 そのフラグメント内に検索用語 (windows) が 1 回表示されます。

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

"Search code" のきめ細かいアクセス トークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンにはアクセス許可が必要ありません。

パブリック リソースのみが要求された場合、このエンドポイントは認証なしで使用できます。

"Search code" のパラメーター

ヘッダー
accept string

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

クエリ パラメーター
q string 必須

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

Value: 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.

Default: desc

次のいずれかにできます: desc, asc

per_page integer

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

Default: 30

page integer

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

Default: 1

"Search code" の HTTP 応答状態コード

状態コード説明
200

OK

304

Not modified

403

Forbidden

422

Validation failed, or the endpoint has been spammed.

503

Service unavailable

"Search code" のコード サンプル

要求の例

get/search/code
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ "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

"Search commits" のきめ細かいアクセス トークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンにはアクセス許可が必要ありません。

パブリック リソースのみが要求された場合、このエンドポイントは認証なしで使用できます。

"Search commits" のパラメーター

ヘッダー
accept string

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

クエリ パラメーター
q string 必須

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

次のいずれかにできます: 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.

Default: desc

次のいずれかにできます: desc, asc

per_page integer

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

Default: 30

page integer

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

Default: 1

"Search commits" の HTTP 応答状態コード

状態コード説明
200

OK

304

Not modified

"Search commits" のコード サンプル

要求の例

get/search/commits
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ "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."

"Search issues and pull requests" のきめ細かいアクセス トークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンにはアクセス許可が必要ありません。

パブリック リソースのみが要求された場合、このエンドポイントは認証なしで使用できます。

"Search issues and pull requests" のパラメーター

ヘッダー
accept string

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

クエリ パラメーター
q string 必須

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

次のいずれかにできます: 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.

Default: desc

次のいずれかにできます: desc, asc

per_page integer

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

Default: 30

page integer

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

Default: 1

"Search issues and pull requests" の HTTP 応答状態コード

状態コード説明
200

OK

304

Not modified

403

Forbidden

422

Validation failed, or the endpoint has been spammed.

503

Service unavailable

"Search issues and pull requests" のコード サンプル

要求の例

get/search/issues
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ "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.

"Search labels" のきめ細かいアクセス トークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

  • "Metadata" repository permissions (read)

このエンドポイントは、パブリック リソースのみが要求される場合は、認証または前述メンションアクセス許可なしで使用できます。

"Search labels" のパラメーター

ヘッダー
accept string

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

クエリ パラメーター
repository_id integer 必須

The id of the repository.

q string 必須

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

次のいずれかにできます: 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.

Default: desc

次のいずれかにできます: desc, asc

per_page integer

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

Default: 30

page integer

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

Default: 1

"Search labels" の HTTP 応答状態コード

状態コード説明
200

OK

304

Not modified

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

"Search labels" のコード サンプル

要求の例

get/search/labels
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ "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.

"Search repositories" のきめ細かいアクセス トークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンにはアクセス許可が必要ありません。

パブリック リソースのみが要求された場合、このエンドポイントは認証なしで使用できます。

"Search repositories" のパラメーター

ヘッダー
accept string

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

クエリ パラメーター
q string 必須

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

次のいずれかにできます: 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.

Default: desc

次のいずれかにできます: desc, asc

per_page integer

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

Default: 30

page integer

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

Default: 1

"Search repositories" の HTTP 応答状態コード

状態コード説明
200

OK

304

Not modified

422

Validation failed, or the endpoint has been spammed.

503

Service unavailable

"Search repositories" のコード サンプル

要求の例

get/search/repositories
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ "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.

"Search topics" のきめ細かいアクセス トークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンにはアクセス許可が必要ありません。

パブリック リソースのみが要求された場合、このエンドポイントは認証なしで使用できます。

"Search topics" のパラメーター

ヘッダー
accept string

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

クエリ パラメーター
q string 必須

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

Default: 30

page integer

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

Default: 1

"Search topics" の HTTP 応答状態コード

状態コード説明
200

OK

304

Not modified

"Search topics" のコード サンプル

要求の例

get/search/topics
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ "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."

"Search users" のきめ細かいアクセス トークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンにはアクセス許可が必要ありません。

パブリック リソースのみが要求された場合、このエンドポイントは認証なしで使用できます。

"Search users" のパラメーター

ヘッダー
accept string

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

クエリ パラメーター
q string 必須

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

次のいずれかにできます: 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.

Default: desc

次のいずれかにできます: desc, asc

per_page integer

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

Default: 30

page integer

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

Default: 1

"Search users" の HTTP 応答状態コード

状態コード説明
200

OK

304

Not modified

422

Validation failed, or the endpoint has been spammed.

503

Service unavailable

"Search users" のコード サンプル

要求の例

get/search/users
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ "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 } ] }