Skip to content

Latest commit

 

History

History
51 lines (39 loc) · 1.62 KB

File metadata and controls

51 lines (39 loc) · 1.62 KB
title Rate Limit | GitHub API

Rate Limit

The overview documentation describes the rate limit rules. You can check your current rate limit status at any time using the Rate Limit API described below.

Get your current rate limit status

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

GET /rate_limit

Response

<%= headers 200, 'X-RateLimit-Limit' => 5000, 'X-RateLimit-Remaining' => 4999, 'X-RateLimit-Reset' => 1372700873 %> <%= json :resources => { :core => {:limit => 5000, :remaining => 4999, :reset => 1372700873}, :search => {:limit => 20, :remaining => 18, :reset => 1372697452}, }, :rate => {:limit => 5000, :remaining => 4999, :reset => 1372700873} %>

Understanding Your Rate Limit Status

The Search API has a custom rate limit, separate from the rate limit governing the rest of the API. For that reason, the response (shown above) categorizes your rate limit by resource. Within the "resources" hash, the "search" hash provides your rate limit status for the Search API. The "core" hash provides your rate limit status for all the rest of the API.

Deprecation Notice

The "rate" hash (shown at the bottom of the response above) is deprecated and is scheduled for removal in the next version of the API.

If you're writing new API client code (or updating your existing code), you should use the "core" hash instead of the "rate" hash. The "core" hash contains the same information that is present in the "rate" hash.