Skip to content
forgit api docs

Get rate limit status for the authenticated user

GET
/rate_limit

[!NOTE] Accessing this endpoint does not count against your REST API rate limit.

Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you’ll see objects relating to different categories:

  • The core object provides your rate limit status for all non-search-related resources in the REST API.
  • The search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see “Search.”
  • The code_search object provides your rate limit status for the REST API for searching code. For more information, see “Search code.”
  • The graphql object provides your rate limit status for the GraphQL API. For more information, see “Resource limitations.”
  • The integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see “Creating a GitHub App from a manifest.”
  • The dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see “Dependency graph.”
  • The dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see “Dependency graph.”
  • The actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see “Self-hosted runners.”
  • The source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see “API Versions.”

[!NOTE] The rate object is closing down. 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.

API method documentation

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Rate Limit Overview

Rate Limit Overview

object
resources
required
object
core
required
Rate Limit
object
limit
required
integer
remaining
required
integer
reset
required
integer
used
required
integer
graphql
Rate Limit
object
limit
required
integer
remaining
required
integer
reset
required
integer
used
required
integer
search
required
Rate Limit
object
limit
required
integer
remaining
required
integer
reset
required
integer
used
required
integer
code_search
Rate Limit
object
limit
required
integer
remaining
required
integer
reset
required
integer
used
required
integer
source_import
Rate Limit
object
limit
required
integer
remaining
required
integer
reset
required
integer
used
required
integer
integration_manifest
Rate Limit
object
limit
required
integer
remaining
required
integer
reset
required
integer
used
required
integer
actions_runner_registration
Rate Limit
object
limit
required
integer
remaining
required
integer
reset
required
integer
used
required
integer
scim
Rate Limit
object
limit
required
integer
remaining
required
integer
reset
required
integer
used
required
integer
dependency_snapshots
Rate Limit
object
limit
required
integer
remaining
required
integer
reset
required
integer
used
required
integer
dependency_sbom
Rate Limit
object
limit
required
integer
remaining
required
integer
reset
required
integer
used
required
integer
code_scanning_autofix
Rate Limit
object
limit
required
integer
remaining
required
integer
reset
required
integer
used
required
integer
copilot_usage_records
Rate Limit
object
limit
required
integer
remaining
required
integer
reset
required
integer
used
required
integer
rate
required
Rate Limit
object
limit
required
integer
remaining
required
integer
reset
required
integer
used
required
integer
Examples
Example default 
{
  "resources": {
    "core": {
      "limit": 5000,
      "used": 1,
      "remaining": 4999,
      "reset": 1691591363
    },
    "search": {
      "limit": 30,
      "used": 12,
      "remaining": 18,
      "reset": 1691591091
    },
    "graphql": {
      "limit": 5000,
      "used": 7,
      "remaining": 4993,
      "reset": 1691593228
    },
    "integration_manifest": {
      "limit": 5000,
      "used": 1,
      "remaining": 4999,
      "reset": 1691594631
    },
    "source_import": {
      "limit": 100,
      "used": 1,
      "remaining": 99,
      "reset": 1691591091
    },
    "actions_runner_registration": {
      "limit": 10000,
      "used": 0,
      "remaining": 10000,
      "reset": 1691594631
    },
    "scim": {
      "limit": 15000,
      "used": 0,
      "remaining": 15000,
      "reset": 1691594631
    },
    "dependency_snapshots": {
      "limit": 100,
      "used": 0,
      "remaining": 100,
      "reset": 1691591091
    },
    "code_search": {
      "limit": 10,
      "used": 0,
      "remaining": 10,
      "reset": 1691591091
    },
    "code_scanning_autofix": {
      "limit": 10,
      "used": 0,
      "remaining": 10,
      "reset": 1691591091
    }
  },
  "rate": {
    "limit": 5000,
    "used": 1,
    "remaining": 4999,
    "reset": 1372700873
  }
}

Headers

Section titled “ Headers ”
X-RateLimit-Limit
integer
Example 
5000
X-RateLimit-Remaining
integer
Example 
4999
X-RateLimit-Reset
integer format: timestamp
Example 
1590701888

304

Section titled “ 304 ”

Not modified

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}