Skip to content

Latest commit

 

History

History
90 lines (77 loc) · 2.6 KB

rate_limits.md

File metadata and controls

90 lines (77 loc) · 2.6 KB
Raw

Rate Limit API

Back to the navigation

Get rate limit wrappers from GitHub Rate Limit API.

Get All Rate Limits

new way
/** @var \Github\Api\RateLimit\RateLimitResource[] $rateLimits */
$rateLimits = $client->api('rate_limit')->getResources();

var_dump() output:

array(4) {
  ["core"]=>
  object(Github\Api\RateLimit\RateLimitResource)#30 (4) {
    ["name":"Github\Api\RateLimit\RateLimitResource":private]=>
    string(4) "core"
    ["limit":"Github\Api\RateLimit\RateLimitResource":private]=>
    int(5000)
    ["reset":"Github\Api\RateLimit\RateLimitResource":private]=>
    int(1566137712)
    ["remaining":"Github\Api\RateLimit\RateLimitResource":private]=>
    int(5000)
  }
  ["search"]=>
  object(Github\Api\RateLimit\RateLimitResource)#32 (4) {
    ["name":"Github\Api\RateLimit\RateLimitResource":private]=>
    string(6) "search"
    ["limit":"Github\Api\RateLimit\RateLimitResource":private]=>
    int(30)
    ["reset":"Github\Api\RateLimit\RateLimitResource":private]=>
    int(1566134172)
    ["remaining":"Github\Api\RateLimit\RateLimitResource":private]=>
    int(30)
  }
  ["graphql"]=>
  object(Github\Api\RateLimit\RateLimitResource)#43 (4) {
    ["name":"Github\Api\RateLimit\RateLimitResource":private]=>
    string(7) "graphql"
    ["limit":"Github\Api\RateLimit\RateLimitResource":private]=>
    int(5000)
    ["reset":"Github\Api\RateLimit\RateLimitResource":private]=>
    int(1566137712)
    ["remaining":"Github\Api\RateLimit\RateLimitResource":private]=>
    int(5000)
  }
  ["integration_manifest"]=>
  object(Github\Api\RateLimit\RateLimitResource)#44 (4) {
    ["name":"Github\Api\RateLimit\RateLimitResource":private]=>
    string(20) "integration_manifest"
    ["limit":"Github\Api\RateLimit\RateLimitResource":private]=>
    int(5000)
    ["reset":"Github\Api\RateLimit\RateLimitResource":private]=>
    int(1566137712)
    ["remaining":"Github\Api\RateLimit\RateLimitResource":private]=>
    int(5000)
  }
}
deprecated way
/** @var array $rateLimits */
$rateLimits = $client->api('rate_limit')->getRateLimits();

Get Core Rate Limit

$coreLimit = $client->api('rate_limit')->getResource('core')->getLimit();
$remaining = $client->api('rate_limit')->getResource('core')->getRemaining();
$reset = $client->api('rate_limit')->getResource('core')->getReset();

Get Search Rate Limit

$searchLimit = $client->api('rate_limit')->getResource('search')->getLimit();

Get GraphQL Rate Limit

$searchLimit = $client->api('rate_limit')->getResource('graphql')->getLimit();