レート制限

Rate Limit API を使うと、さまざまな REST API の現在のレート制限のステータスを確認できます。

Rate Limit API について

REST API の概要ドキュメントでは、レート制限のルールについて説明しています。以下で説明する Rate Limit API を使用して、現在のレート制限ステータスをいつでも確認できます。

レート制限のステータスを理解する

Search API には、残りの REST API に適用されるレート制限とは別の、カスタ� のレート制限があります。 GraphQL API にも、REST API のレート制限とは別の、別の方法で計算されるカスタ� レート制限があります。

そのため、Rate Limit APIのレスポンスは、レート制限を分類します。 resources の下に、次の 4 つのオブジェクトがあります。

core オブジェクトは、REST API の検索に関連しないすべてのリソースに関するレート制限の状態を示します。
search オブジェクトは、Search API のレート制限の状態を示します。
graphql オブジェクトは、GraphQL API のレート制限の状態を示します。
integration_manifest オブジェクトは、GitHub App Manifest コード変換エンドポイントのレート制限の状態を示します。

レート制限の応答のヘッダーと値の詳細については、「Resources in the REST API」 (REST API のリソース) を参照してく� さい。

Get rate limit status for the authenticated user

次のもので機能します GitHub Apps

Note: Accessing this endpoint does not count against your REST API rate limit.

Note: The rate object is deprecated. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.

HTTP 応答状態コード

status code	説明
`200`	OK
`304`	Not modified
`404`	Resource not found

コードサンプル

get/rate_limit

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/rate_limit

Response

Status: 200

{
  "resources": {
    "core": {
      "limit": 5000,
      "remaining": 4999,
      "reset": 1372700873,
      "used": 1
    },
    "search": {
      "limit": 30,
      "remaining": 18,
      "reset": 1372697452,
      "used": 12
    },
    "graphql": {
      "limit": 5000,
      "remaining": 4993,
      "reset": 1372700389,
      "used": 7
    },
    "integration_manifest": {
      "limit": 5000,
      "remaining": 4999,
      "reset": 1551806725,
      "used": 1
    },
    "code_scanning_upload": {
      "limit": 500,
      "remaining": 499,
      "reset": 1551806725,
      "used": 1
    }
  },
  "rate": {
    "limit": 5000,
    "remaining": 4999,
    "reset": 1372700873,
    "used": 1
  }
}

レート制限

Rate Limit API について