GET application/rate_limit_status

Updated on Tue, 2014-06-24 02:19

Returns the current rate limits for methods belonging to the specified resource families.

Each 1.1 API resource belongs to a "resource family" which is indicated in its method documentation. You can typically determine a method's resource family from the first component of the path after the resource version.

This method responds with a map of methods belonging to the families specified by the resources parameter, the current remaining uses for each of those resources within the current rate limiting window, and its expiration time in epoch time. It also includes a rate_limit_context field that indicates the current access token or application-only authentication context.

You may also issue requests to this method without any parameters to receive a map of all rate limited GET methods. If your application only uses a few of methods, please explicitly provide a resources parameter with the specified resource families you work with.

When using app-only auth, this method's response indicates the app-only auth rate limiting context.

Read more about REST API Rate Limiting in v1.1 and review the limits.

Resource URL

https://api.twitter.com/1.1/application/rate_limit_status.json

Parameters

resources optional

A comma-separated list of resource families you want to know the current rate limit disposition for. For best performance, only specify the resource families pertinent to your application.

See Rate Limiting in API v1.1 for more information.

Example Values: statuses,friends,trends,help

Example Request

GET

https://api.twitter.com/1.1/application/rate_limit_status.json?resources=help,users,search,statuses

  1. {
  2.   "rate_limit_context": {
  3.     "access_token": "786491-24zE39NUezJ8UTmOGOtLhgyLgCkPyY4dAcx6NA6sDKw"
  4.   },
  5.   "resources": {
  6.     "users": {
  7.       "/users/profile_banner": {
  8.         "limit": 180,
  9.         "remaining": 180,
  10.         "reset": 1403602426
  11.       },
  12.       "/users/suggestions/:slug/members": {
  13.         "limit": 15,
  14.         "remaining": 15,
  15.         "reset": 1403602426
  16.       },
  17.       "/users/show/:id": {
  18.         "limit": 180,
  19.         "remaining": 180,
  20.         "reset": 1403602426
  21.       },
  22.       "/users/suggestions": {
  23.         "limit": 15,
  24.         "remaining": 15,
  25.         "reset": 1403602426
  26.       },
  27.       "/users/lookup": {
  28.         "limit": 180,
  29.         "remaining": 180,
  30.         "reset": 1403602426
  31.       },
  32.       "/users/search": {
  33.         "limit": 180,
  34.         "remaining": 180,
  35.         "reset": 1403602426
  36.       },
  37.       "/users/contributors": {
  38.         "limit": 15,
  39.         "remaining": 15,
  40.         "reset": 1403602426
  41.       },
  42.       "/users/contributees": {
  43.         "limit": 15,
  44.         "remaining": 15,
  45.         "reset": 1403602426
  46.       },
  47.       "/users/suggestions/:slug": {
  48.         "limit": 15,
  49.         "remaining": 15,
  50.         "reset": 1403602426
  51.       }
  52.     },
  53.     "statuses": {
  54.       "/statuses/mentions_timeline": {
  55.         "limit": 15,
  56.         "remaining": 15,
  57.         "reset": 1403602426
  58.       },
  59.       "/statuses/lookup": {
  60.         "limit": 180,
  61.         "remaining": 180,
  62.         "reset": 1403602426
  63.       },
  64.       "/statuses/show/:id": {
  65.         "limit": 180,
  66.         "remaining": 180,
  67.         "reset": 1403602426
  68.       },
  69.       "/statuses/oembed": {
  70.         "limit": 180,
  71.         "remaining": 180,
  72.         "reset": 1403602426
  73.       },
  74.       "/statuses/retweeters/ids": {
  75.         "limit": 15,
  76.         "remaining": 15,
  77.         "reset": 1403602426
  78.       },
  79.       "/statuses/home_timeline": {
  80.         "limit": 15,
  81.         "remaining": 15,
  82.         "reset": 1403602426
  83.       },
  84.       "/statuses/user_timeline": {
  85.         "limit": 180,
  86.         "remaining": 180,
  87.         "reset": 1403602426
  88.       },
  89.       "/statuses/retweets/:id": {
  90.         "limit": 60,
  91.         "remaining": 60,
  92.         "reset": 1403602426
  93.       },
  94.       "/statuses/retweets_of_me": {
  95.         "limit": 15,
  96.         "remaining": 15,
  97.         "reset": 1403602426
  98.       }
  99.     },
  100.     "help": {
  101.       "/help/privacy": {
  102.         "limit": 15,
  103.         "remaining": 15,
  104.         "reset": 1403602426
  105.       },
  106.       "/help/tos": {
  107.         "limit": 15,
  108.         "remaining": 15,
  109.         "reset": 1403602426
  110.       },
  111.       "/help/configuration": {
  112.         "limit": 15,
  113.         "remaining": 15,
  114.         "reset": 1403602426
  115.       },
  116.       "/help/languages": {
  117.         "limit": 15,
  118.         "remaining": 15,
  119.         "reset": 1403602426
  120.       }
  121.     },
  122.     "search": {
  123.       "/search/tweets": {
  124.         "limit": 180,
  125.         "remaining": 180,
  126.         "reset": 1403602426
  127.       }
  128.     }
  129.   }
  130. }