GitHub: Get rate limit status for the authenticated user

← Rate limit operations · Get started

Operation github.rate_limit_get

Provider route: GET /rate_limit. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["rateLimit"]["rateLimitGet"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.rateLimit.rateLimitGet(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.rate_limit.rate_limit_get(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get rate limit status for the authenticated user — response body

Referenced models: Get rate limit status for the authenticated user — response body

Schemas

Get rate limit status for the authenticated user — response body

Field	Type	Presence	Description and constraints
$	object	Root	Rate limit status for the applicable requester and resource category. Requests authenticated as a user share the user's rate limit across credentials. Requests without authentication use the requesting IP address. API requests routed through either an API hostname or a web hostname can count against the same applicable limit.
resources	object	Required within parent
resources.actions_runner_registration	Model	Optional	Expand Get rate limit status for the authenticated user — response body — resources core
resources.code_scanning_autofix	Model	Optional	Expand Get rate limit status for the authenticated user — response body — resources core
resources.code_search	Model	Optional	Expand Get rate limit status for the authenticated user — response body — resources core
resources.copilot_usage_records	Model	Optional	Expand Get rate limit status for the authenticated user — response body — resources core
resources.core	Model	Required within parent	Expand Get rate limit status for the authenticated user — response body — resources core
resources.dependency_sbom	Model	Optional	Expand Get rate limit status for the authenticated user — response body — resources core
resources.dependency_snapshots	Model	Optional	Expand Get rate limit status for the authenticated user — response body — resources core
resources.graphql	Model	Optional	Expand Get rate limit status for the authenticated user — response body — resources core
resources.integration_manifest	Model	Optional	Expand Get rate limit status for the authenticated user — response body — resources core
resources.scim	Model	Optional	Expand Get rate limit status for the authenticated user — response body — resources core
resources.search	Model	Required within parent	Expand Get rate limit status for the authenticated user — response body — resources core
resources.source_import	Model	Optional	Expand Get rate limit status for the authenticated user — response body — resources core

Referenced models: Get rate limit status for the authenticated user — response body — resources core

Get rate limit status for the authenticated user — response body — resources core

Field	Type	Presence	Description and constraints
$	object	Root
limit	JSON	Required within parent
limit (anyOf 1)	integer	Alternative
limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
remaining	JSON	Required within parent
remaining (anyOf 1)	integer	Alternative
remaining (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reset	JSON	Required within parent
reset (anyOf 1)	integer	Alternative
reset (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
used	JSON	Required within parent
used (anyOf 1)	integer	Alternative
used (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: github.rate_limit_get. Catalog operation: rate-limit/get. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source