GitHub API
GitHubはオープンソースのコードをホストするサービスです。repositoryは1つのリポジトリのスター数、フォーク数、言語、トピック、ライセンスを取得します。repository_issues、contributors、forksは、それぞれリポジトリのIssue、コントリビューター、フォークを一覧表示します。search_issuesはGitHub全体のIssueとプルリクエストを検索します。userとuser_repositoriesはアカウント情報を取得し、trendingは当日のTrendingリストを取得します。
リポジトリはリンクまたはowner/repo、アカウントはユーザー名、issueは完全なリンクで指定します。リストは1ページ最大100件を返します(user_repositoriesは最大30件)。名前の変更や移管があったリポジトリは、新しい名前で返ります。
プラットフォームの稼働状況
- 24時間の稼働状況
- 正常
過去30日間
利用可能な機能
GitHubの各アクションについて、内容、料金、過去24時間の稼働状況を掲載しています。アクションを開くと、パラメータ、レスポンスフィールド、コードサンプルを確認できます。
| 機能 | できること | 1,000リクエストあたり | 24時間の稼働状況 |
|---|---|---|---|
リポジトリ詳細repository | リンクまたはowner/repoを指定して、GitHubリポジトリ1件の情報を取得します。スター数、フォーク数、オープンなIssue数、言語、トピック、ライセンス、デフォルトブランチ、アーカイブ済みフラグとフォークフラグ、サイズ、作成日時、更新日時、最終プッシュ日時を返します。 | 1,000リクエストあたり$0.96 | 正常 |
ユーザープロフィールuser | GitHubユーザーまたはOrganizationの公開プロフィールを取得します。名前、自己紹介、所属企業、所在地、Webサイト、Xのユーザー名、フォロワー数、フォロー数、公開リポジトリ数とGist数、登録日を返します。 | 1,000リクエストあたり$0.96 | 正常 |
ユーザーのリポジトリuser_repositories | GitHubアカウント1件が所有する公開リポジトリを最大30件取得します。スター数、フォーク数、言語、トピック、ライセンス、プッシュ日時を含み、作成日時、更新日時、プッシュ日時、名前のいずれかで並べ替えられます。 | 1,000リクエストあたり$0.96 | 正常 |
リポジトリのIssueとPRrepository_issues | GitHubリポジトリ1件のIssueとプルリクエストを、オープン、クローズ、またはすべての状態で一覧取得します。番号、タイトル、本文、ラベル、コメント数とリアクション数、作成者、日付を含み、1回の呼び出しで最大100件まで取得できます。 | 1,000リクエストあたり$0.96 | 正常 |
Issue検索search_issues | repo:、is:pr、label:などGitHub独自の検索修飾子を使ってGitHub全体のIssueとプルリクエストを検索し、最大100件の一致結果を取得します。タイトル、本文、状態、ラベル、各種カウント、作成者、リポジトリを含みます。 | 1,000リクエストあたり$1.92 | 正常 |
Issueのコメントissue_comments | GitHubのIssueまたはプルリクエスト1件のコメントを投稿順に取得します。1回の呼び出しで最大100件まで取得でき、各コメントには本文、投稿者、投稿者とリポジトリの関係、リアクション、直接リンクが含まれます。 | 1,000リクエストあたり$0.96 | 正常 |
リポジトリのコントリビューターcontributors | GitHubリポジトリのコントリビューターをコミット数順に一覧取得します。1回の呼び出しで最大100件まで、ユーザー名、アバター、アカウント種別、コミット数を返します。 | 1,000リクエストあたり$0.96 | 正常 |
リポジトリのフォークforks | GitHubリポジトリのフォークを、新しい順またはスター数順で一覧取得します。1回の呼び出しで最大100件まで、各フォークのオーナー、スター数、フォーク数、言語、トピック、プッシュ日時を返します。 | 1,000リクエストあたり$0.96 | 正常 |
トレンドtrending | 当日のGitHub Trendingリストを取得します。通常は約14件のリポジトリがランキング順に並び、それぞれオーナー、名前、リンク、説明を含みます。 | 1,000リクエストあたり$0.81 | 正常 |
機能を開くと、パラメータ、レスポンスフィールド、コードサンプル、トライアルを確認できます。
GitHubの各アクションではどのような入力を指定できますか?
以下の各回答では、呼び出し可能なアクション1つとその実際の入力を対応付けています。パラメータの意味と指定可能な値はアクションごとに異なります。同じ名前でも、すべてのプラットフォームで同じ意味になるとは限りません。
公式情報源へのリンクは、横に記載したプラットフォーム用語を説明する目的でのみ掲載しています。プラットフォームによる認可や推奨を意味するものではありません。また、このページに記載がない限り、公式サイトの機能はEveryInfra APIには含まれません。
| アクション | 必須 | 任意 | 提供方式 | 上限 | 1,000件あたり | レスポンスフィールド |
|---|---|---|---|---|---|---|
repositoryリポジトリ詳細 リンクまたはowner/repoを指定して、GitHubリポジトリ1件の情報を取得します。スター数、フォーク数、オープンなIssue数、言語、トピック、ライセンス、デフォルトブランチ、アーカイブ済みフラグとフォークフラグ、サイズ、作成日時、更新日時、最終プッシュ日時を返します。 | url | — | Sync配信 | — | 1,000リクエストあたり$0.96 | id · full_name · name · owner_username · owner_url · owner_avatar_url · url · description · homepage · language · license · topics · star_count · fork_count · open_issue_count · default_branch · is_fork · is_archived · size_kb · created_at · updated_at · pushed_at · platform |
userユーザープロフィール GitHubユーザーまたはOrganizationの公開プロフィールを取得します。名前、自己紹介、所属企業、所在地、Webサイト、Xのユーザー名、フォロワー数、フォロー数、公開リポジトリ数とGist数、登録日を返します。 | username | — | Sync配信 | — | 1,000リクエストあたり$0.96 | username · id · display_name · bio · company · location · website · twitter_username · follower_count · following_count · public_repo_count · public_gist_count · avatar_url · url · account_type · created_at · platform |
user_repositoriesユーザーのリポジトリ GitHubアカウント1件が所有する公開リポジトリを最大30件取得します。スター数、フォーク数、言語、トピック、ライセンス、プッシュ日時を含み、作成日時、更新日時、プッシュ日時、名前のいずれかで並べ替えられます。 | username | sort | Sync配信 | カタログ値:defaultLimit=30、maxLimit=30。アクションによってはlimitがページ数や親要素ごとの展開数を制御するため、必ずしも最終的な行数にはなりません。 | 1,000リクエストあたり$0.96 | id · full_name · name · owner_username · owner_url · owner_avatar_url · url · description · homepage · language · license · topics · star_count · fork_count · open_issue_count · default_branch · is_fork · is_archived · size_kb · created_at · updated_at · pushed_at · platform |
repository_issuesリポジトリのIssueとPR GitHubリポジトリ1件のIssueとプルリクエストを、オープン、クローズ、またはすべての状態で一覧取得します。番号、タイトル、本文、ラベル、コメント数とリアクション数、作成者、日付を含み、1回の呼び出しで最大100件まで取得できます。 | url | sort, state | Sync配信 | カタログ値:defaultLimit=30、maxLimit=100。アクションによってはlimitがページ数や親要素ごとの展開数を制御するため、必ずしも最終的な行数にはなりません。 | 1,000リクエストあたり$0.96 | id · number · url · title · text · state · is_pull_request · is_draft · labels · comment_count · reaction_count · repository · author_username · author_id · author_avatar_url · author_type · author_association · posted_at · updated_at · closed_at · merged_at · platform |
search_issuesIssue検索 repo:、is:pr、label:などGitHub独自の検索修飾子を使ってGitHub全体のIssueとプルリクエストを検索し、最大100件の一致結果を取得します。タイトル、本文、状態、ラベル、各種カウント、作成者、リポジトリを含みます。 | keyword | sort | Sync配信 | カタログ値:defaultLimit=30、maxLimit=100。アクションによってはlimitがページ数や親要素ごとの展開数を制御するため、必ずしも最終的な行数にはなりません。 | 1,000リクエストあたり$1.92 | id · number · url · title · text · state · is_pull_request · is_draft · labels · comment_count · reaction_count · repository · author_username · author_id · author_avatar_url · author_type · author_association · posted_at · updated_at · closed_at · merged_at · platform |
issue_commentsIssueのコメント GitHubのIssueまたはプルリクエスト1件のコメントを投稿順に取得します。1回の呼び出しで最大100件まで取得でき、各コメントには本文、投稿者、投稿者とリポジトリの関係、リアクション、直接リンクが含まれます。 | url | — | Sync配信 | カタログ値:defaultLimit=30、maxLimit=100。アクションによってはlimitがページ数や親要素ごとの展開数を制御するため、必ずしも最終的な行数にはなりません。 | 1,000リクエストあたり$0.96 | id · url · text · reaction_count · author_username · author_id · author_avatar_url · author_type · author_association · posted_at · updated_at · issue_url · platform |
contributorsリポジトリのコントリビューター GitHubリポジトリのコントリビューターをコミット数順に一覧取得します。1回の呼び出しで最大100件まで、ユーザー名、アバター、アカウント種別、コミット数を返します。 | url | — | Sync配信 | カタログ値:defaultLimit=30、maxLimit=100。アクションによってはlimitがページ数や親要素ごとの展開数を制御するため、必ずしも最終的な行数にはなりません。 | 1,000リクエストあたり$0.96 | rank · username · id · url · avatar_url · contribution_count · account_type · platform |
forksリポジトリのフォーク GitHubリポジトリのフォークを、新しい順またはスター数順で一覧取得します。1回の呼び出しで最大100件まで、各フォークのオーナー、スター数、フォーク数、言語、トピック、プッシュ日時を返します。 | url | sort | Sync配信 | カタログ値:defaultLimit=30、maxLimit=100。アクションによってはlimitがページ数や親要素ごとの展開数を制御するため、必ずしも最終的な行数にはなりません。 | 1,000リクエストあたり$0.96 | id · full_name · name · owner_username · owner_url · owner_avatar_url · owner_type · url · description · homepage · language · topics · star_count · fork_count · open_issue_count · default_branch · is_archived · size_kb · created_at · updated_at · pushed_at · platform |
trendingトレンド 当日のGitHub Trendingリストを取得します。通常は約14件のリポジトリがランキング順に並び、それぞれオーナー、名前、リンク、説明を含みます。 | — | Sync配信 | カタログ値:defaultLimit=25、maxLimit=25。アクションによってはlimitがページ数や親要素ごとの展開数を制御するため、必ずしも最終的な行数にはなりません。 | 1,000リクエストあたり$0.81 | rank · full_name · owner_username · name · url · description · platform |
GitHubのrepositoryのパラメータはそれぞれどういう意味ですか?
リンクまたはowner/repoを指定して、GitHubリポジトリ1件の情報を取得します。スター数、フォーク数、オープンなIssue数、言語、トピック、ライセンス、デフォルトブランチ、アーカイブ済みフラグとフォークフラグ、サイズ、作成日時、更新日時、最終プッシュ日時を返します。
完全なAPIリファレンス:パラメータ、コードサンプル、レスポンス例、稼働状況url必須- GitHubリポジトリのリンク(例:
https://github.com/facebook/react)、またはfacebook/reactの形式で指定します。issue_commentsでは、IssueまたはPull Requestの完全なリンクを指定します(例:https://github.com/openai/whisper/pull/1838)。その他の形式は課金前に拒否されます。GitHub REST API:リポジトリの取得 — GitHubのRESTリファレンスには、リポジトリをオーナーと名前で指定する方法と、返されるスター数、フォーク数、未解決のIssue数、言語、トピック、ライセンス、プッシュ日時が記載されています。これにより`url`のowner/repoの意味を確認できますが、すべてのリポジトリですべてのフィールドが設定されることを保証するものではありません。 · 確認日
GitHubのuserのパラメータはそれぞれどういう意味ですか?
GitHubユーザーまたはOrganizationの公開プロフィールを取得します。名前、自己紹介、所属企業、所在地、Webサイト、Xのユーザー名、フォロワー数、フォロー数、公開リポジトリ数とGist数、登録日を返します。
完全なAPIリファレンス:パラメータ、コードサンプル、レスポンス例、稼働状況username必須- GitHubのユーザー名(例:
torvalds)またはプロフィールのリンクです。Organizationにも対応しています。GitHub REST API:ユーザーの取得 — GitHubのRESTリファレンスでは、公開アカウントをユーザー名で取得する方法と、公開プロフィールのフィールドが記載されています。これにより、`username`が表示名ではなくGitHubのログイン名であることを確認できます。 · 確認日
GitHubのuser_repositoriesのパラメータはそれぞれどういう意味ですか?
GitHubアカウント1件が所有する公開リポジトリを最大30件取得します。スター数、フォーク数、言語、トピック、ライセンス、プッシュ日時を含み、作成日時、更新日時、プッシュ日時、名前のいずれかで並べ替えられます。
完全なAPIリファレンス:パラメータ、コードサンプル、レスポンス例、稼働状況username必須- GitHubのユーザー名(例:
torvalds)またはプロフィールのリンクです。Organizationにも対応しています。GitHub REST API:ユーザーの取得 — GitHubのRESTリファレンスでは、公開アカウントをユーザー名で取得する方法と、公開プロフィールのフィールドが記載されています。これにより、`username`が表示名ではなくGitHubのログイン名であることを確認できます。 · 確認日 sort任意- 一覧の並び順です。
repository_issues:created(デフォルト)、updated、comments。search_issues:デフォルトは一致度の高い順で、comments、created、updated、reactionsも指定できます。forks:newest(デフォルト)、oldest、stargazers、watchers。user_repositories:created、updated、pushed、full_name。指定可能な値:createdfull_namepushedupdated
GitHubのrepository_issuesのパラメータはそれぞれどういう意味ですか?
GitHubリポジトリ1件のIssueとプルリクエストを、オープン、クローズ、またはすべての状態で一覧取得します。番号、タイトル、本文、ラベル、コメント数とリアクション数、作成者、日付を含み、1回の呼び出しで最大100件まで取得できます。
完全なAPIリファレンス:パラメータ、コードサンプル、レスポンス例、稼働状況url必須- GitHubリポジトリのリンク(例:
https://github.com/facebook/react)、またはfacebook/reactの形式で指定します。issue_commentsでは、IssueまたはPull Requestの完全なリンクを指定します(例:https://github.com/openai/whisper/pull/1838)。その他の形式は課金前に拒否されます。GitHub REST API:リポジトリの取得 — GitHubのRESTリファレンスには、リポジトリをオーナーと名前で指定する方法と、返されるスター数、フォーク数、未解決のIssue数、言語、トピック、ライセンス、プッシュ日時が記載されています。これにより`url`のowner/repoの意味を確認できますが、すべてのリポジトリですべてのフィールドが設定されることを保証するものではありません。 · 確認日 sort任意- 一覧の並び順です。
repository_issues:created(デフォルト)、updated、comments。search_issues:デフォルトは一致度の高い順で、comments、created、updated、reactionsも指定できます。forks:newest(デフォルト)、oldest、stargazers、watchers。user_repositories:created、updated、pushed、full_name。指定可能な値:commentscreatedupdated state任意repository_issuesで取得するIssueの状態です。open(デフォルト)、closed、allのいずれかを指定します。指定可能な値:allclosedopen
GitHubのsearch_issuesのパラメータはそれぞれどういう意味ですか?
repo:、is:pr、label:などGitHub独自の検索修飾子を使ってGitHub全体のIssueとプルリクエストを検索し、最大100件の一致結果を取得します。タイトル、本文、状態、ラベル、各種カウント、作成者、リポジトリを含みます。
完全なAPIリファレンス:パラメータ、コードサンプル、レスポンス例、稼働状況keyword必須search_issues用のGitHub Issue検索クエリです。repo:openai/whisper is:pr、is:issue label:bug、author:octocatなどのGitHub修飾子を使用できます。GitHub Docs:Issueとプルリクエストの検索 — GitHubの検索ドキュメントには、Issue検索で使用できるrepo:、is:pr、is:issue、label:、author:などの修飾子が記載されています。これは`keyword`に含められる内容を説明するもので、結果の件数や並び順はGitHub側の仕様に従います。 · 確認日sort任意- 一覧の並び順です。
repository_issues:created(デフォルト)、updated、comments。search_issues:デフォルトは一致度の高い順で、comments、created、updated、reactionsも指定できます。forks:newest(デフォルト)、oldest、stargazers、watchers。user_repositories:created、updated、pushed、full_name。指定可能な値:commentscreatedreactionsupdated
GitHubのissue_commentsのパラメータはそれぞれどういう意味ですか?
GitHubのIssueまたはプルリクエスト1件のコメントを投稿順に取得します。1回の呼び出しで最大100件まで取得でき、各コメントには本文、投稿者、投稿者とリポジトリの関係、リアクション、直接リンクが含まれます。
完全なAPIリファレンス:パラメータ、コードサンプル、レスポンス例、稼働状況url必須- GitHubリポジトリのリンク(例:
https://github.com/facebook/react)、またはfacebook/reactの形式で指定します。issue_commentsでは、IssueまたはPull Requestの完全なリンクを指定します(例:https://github.com/openai/whisper/pull/1838)。その他の形式は課金前に拒否されます。GitHub REST API:Issueコメントの一覧取得 — GitHubのRESTリファレンスでは、リポジトリと番号を指定してIssueのコメントを一覧取得する方法が記載されており、すべてのプルリクエストはIssueでもあると説明されています。そのため、`url`のissues/<number>とpull/<number>のどちらのリンクも同じ会話を指します。コード行に対するレビューコメントは含まれません。 · 確認日
GitHubのcontributorsのパラメータはそれぞれどういう意味ですか?
GitHubリポジトリのコントリビューターをコミット数順に一覧取得します。1回の呼び出しで最大100件まで、ユーザー名、アバター、アカウント種別、コミット数を返します。
完全なAPIリファレンス:パラメータ、コードサンプル、レスポンス例、稼働状況url必須- GitHubリポジトリのリンク(例:
https://github.com/facebook/react)、またはfacebook/reactの形式で指定します。issue_commentsでは、IssueまたはPull Requestの完全なリンクを指定します(例:https://github.com/openai/whisper/pull/1838)。その他の形式は課金前に拒否されます。GitHub REST API:リポジトリの取得 — GitHubのRESTリファレンスには、リポジトリをオーナーと名前で指定する方法と、返されるスター数、フォーク数、未解決のIssue数、言語、トピック、ライセンス、プッシュ日時が記載されています。これにより`url`のowner/repoの意味を確認できますが、すべてのリポジトリですべてのフィールドが設定されることを保証するものではありません。 · 確認日
GitHubのforksのパラメータはそれぞれどういう意味ですか?
GitHubリポジトリのフォークを、新しい順またはスター数順で一覧取得します。1回の呼び出しで最大100件まで、各フォークのオーナー、スター数、フォーク数、言語、トピック、プッシュ日時を返します。
完全なAPIリファレンス:パラメータ、コードサンプル、レスポンス例、稼働状況url必須- GitHubリポジトリのリンク(例:
https://github.com/facebook/react)、またはfacebook/reactの形式で指定します。issue_commentsでは、IssueまたはPull Requestの完全なリンクを指定します(例:https://github.com/openai/whisper/pull/1838)。その他の形式は課金前に拒否されます。GitHub REST API:リポジトリの取得 — GitHubのRESTリファレンスには、リポジトリをオーナーと名前で指定する方法と、返されるスター数、フォーク数、未解決のIssue数、言語、トピック、ライセンス、プッシュ日時が記載されています。これにより`url`のowner/repoの意味を確認できますが、すべてのリポジトリですべてのフィールドが設定されることを保証するものではありません。 · 確認日 sort任意- 一覧の並び順です。
repository_issues:created(デフォルト)、updated、comments。search_issues:デフォルトは一致度の高い順で、comments、created、updated、reactionsも指定できます。forks:newest(デフォルト)、oldest、stargazers、watchers。user_repositories:created、updated、pushed、full_name。指定可能な値:newestoldeststargazerswatchers
GitHubのtrendingのパラメータはそれぞれどういう意味ですか?
当日のGitHub Trendingリストを取得します。通常は約14件のリポジトリがランキング順に並び、それぞれオーナー、名前、リンク、説明を含みます。
完全なAPIリファレンス:パラメータ、コードサンプル、レスポンス例、稼働状況このアクションには固有のパラメータがありません。プラットフォームとアクションの識別子のみを送信してください。
GitHub APIの使い方
- 01公開カタログからプラットフォームのアクションを選択します。
- 02プラットフォーム、アクション、必須パラメータをPOST /api/v1/socialに送信します。
- 03レスポンスから結果を読み取ります。非同期のアクションの場合は、返されたジョブIDをポーリングします。
- 04アプリケーションで必要なレスポンスフィールドを保存します。
curl -X POST https://api.everyinfra.com/api/v1/social \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"platform":"github","action":"repository","params":{"url":"<url>"}}'
GitHub APIに関する質問
GitHub APIでは何を取得できますか?
platformをgithubに設定します。現在のカタログにはリポジトリ詳細、ユーザープロフィール、ユーザーのリポジトリ、リポジトリのIssueとPR、issue検索、moreが掲載されています。これらのアクション名はそれぞれ異なるGitHubのオブジェクトやビューを表すもので、互いに置き換えられる検索モードではありません。
GitHubのrepositoryリクエストを開始するには、どの入力を使用しますか?
GitHubリポジトリのリンク(例:https://github.com/facebook/react)、またはfacebook/reactの形式で指定します。issue_commentsでは、IssueまたはPull Requestの完全なリンクを指定します(例:https://github.com/openai/whisper/pull/1838)。その他の形式は課金前に拒否されます。params内のurlとして送信してください。
GitHubのrepositoryはどのフィールドを返しますか?
宣言されたスキーマにはfull_name、name、owner_username、owner_urlが含まれます。宣言されたフィールドでも個々のレコードには含まれない場合があり、他のアクションにはそれぞれ独自のフィールド一覧があります。
GitHubのアクションはすべて即座に結果を返しますか?
非同期と表示されたアクションはジョブIDを返すので、そのIDをポーリングします。それ以外のすべてのアクションも非同期で実行できます。リクエストボディに"mode": "async"を追加するとすぐにジョブIDが返されるため、時間のかかるタスクや上限値を大きく設定する場合に便利です。現在のカタログにはsync配信が含まれています。