Rate Limit Status

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

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

Example

If you want to simply show the Twitter response with all rate limit information without having to mess with variables and templating, you can simply use the following tag:

{exp:ce_tweet:rate_limit_status:dump show_response="yes"}

Or you can elect to template the response in a custom, clean way, showing only the pieces of information you want:

Search: 179/180 - resets 5:30 PM, Feb 16th (PST)
Status Mentions: 15/15 - resets 5:42 PM, Feb 16th (PST)
Show Id: 180/180 - resets 5:42 PM, Feb 16th (PST)
oEmbed: 176/180 - resets 5:27 PM, Feb 16th (PST)
Home Timeline: 15/15 - resets 5:42 PM, Feb 16th (PST)
User Timeline: 173/180 - resets 5:27 PM, Feb 16th (PST)
Retweets of Me: 15/15 - resets 5:42 PM, Feb 16th (PST)

{exp:ce_tweet:rate_limit_status}
<p>
    <b>Search</b>: {search_tweets_remaining}/{search_tweets_limit} - resets {search_tweets_reset format="%g:%i %A, %M %j%S (%T)"}<br>
    <b>Status Mentions</b>: {statuses_mentions_timeline_remaining}/{statuses_mentions_timeline_limit} - resets {statuses_mentions_timeline_reset format="%g:%i %A, %M %j%S (%T)"}<br>
    <b>Show Id</b>: {statuses_show_id_remaining}/{statuses_show_id_limit} - resets {statuses_show_id_reset format="%g:%i %A, %M %j%S (%T)"}<br>
    <b>oEmbed</b>: {statuses_oembed_remaining}/{statuses_oembed_limit} - resets {statuses_oembed_reset format="%g:%i %A, %M %j%S (%T)"}<br>
    <b>Home Timeline</b>: {statuses_home_timeline_remaining}/{statuses_home_timeline_limit} - resets {statuses_home_timeline_reset format="%g:%i %A, %M %j%S (%T)"}<br>
    <b>User Timeline</b>: {statuses_user_timeline_remaining}/{statuses_user_timeline_limit} - resets {statuses_user_timeline_reset format="%g:%i %A, %M %j%S (%T)"}<br>
    <b>Retweets of Me</b>: {statuses_retweets_of_me_remaining}/{statuses_retweets_of_me_limit} - resets {statuses_retweets_of_me_reset format="%g:%i %A, %M %j%S (%T)"}
</p>
{/exp:ce_tweet:rate_limit_status}

Parameters

Note: There are no required parameters for this tag. The following parameter is optional.

resources=

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. You can leave this blank to get all results. Example values: statuses,search,lists,application,help,account,favorites

Variables

The variables returned will largely depend on the which resource families are selected. If none are specified, then all of them are returned:

{rate_limit_context_access_token}
{lists_subscribers_limit}
{lists_subscribers_remaining}
{lists_subscribers_reset}
{lists_list_limit}
{lists_list_remaining}
{lists_list_reset}
{lists_memberships_limit}
{lists_memberships_remaining}
{lists_memberships_reset}
{lists_subscriptions_limit}
{lists_subscriptions_remaining}
{lists_subscriptions_reset}
{lists_members_limit}
{lists_members_remaining}
{lists_members_reset}
{lists_subscribers_show_limit}
{lists_subscribers_show_remaining}
{lists_subscribers_show_reset}
{lists_statuses_limit}
{lists_statuses_remaining}
{lists_statuses_reset}
{lists_show_limit}
{lists_show_remaining}
{lists_show_reset}
{lists_members_show_limit}
{lists_members_show_remaining}
{lists_members_show_reset}
{application_rate_limit_status_limit}
{application_rate_limit_status_remaining}
{application_rate_limit_status_reset}
{friendships_incoming_limit}
{friendships_incoming_remaining}
{friendships_incoming_reset}
{friendships_lookup_limit}
{friendships_lookup_remaining}
{friendships_lookup_reset}
{friendships_outgoing_limit}
{friendships_outgoing_remaining}
{friendships_outgoing_reset}
{friendships_no_retweets_ids_limit}
{friendships_no_retweets_ids_remaining}
{friendships_no_retweets_ids_reset}
{friendships_show_limit}
{friendships_show_remaining}
{friendships_show_reset}
{blocks_ids_limit}
{blocks_ids_remaining}
{blocks_ids_reset}
{blocks_list_limit}
{blocks_list_remaining}
{blocks_list_reset}
{geo_similar_places_limit}
{geo_similar_places_remaining}
{geo_similar_places_reset}
{geo_search_limit}
{geo_search_remaining}
{geo_search_reset}
{geo_reverse_geocode_limit}
{geo_reverse_geocode_remaining}
{geo_reverse_geocode_reset}
{geo_id_place_id_limit}
{geo_id_place_id_remaining}
{geo_id_place_id_reset}
{users_profile_banner_limit}
{users_profile_banner_remaining}
{users_profile_banner_reset}
{users_suggestions_slug_members_limit}
{users_suggestions_slug_members_remaining}
{users_suggestions_slug_members_reset}
{users_show_id_limit}
{users_show_id_remaining}
{users_show_id_reset}
{users_suggestions_limit}
{users_suggestions_remaining}
{users_suggestions_reset}
{users_lookup_limit}
{users_lookup_remaining}
{users_lookup_reset}
{users_search_limit}
{users_search_remaining}
{users_search_reset}
{users_contributors_limit}
{users_contributors_remaining}
{users_contributors_reset}
{users_contributees_limit}
{users_contributees_remaining}
{users_contributees_reset}
{users_suggestions_slug_limit}
{users_suggestions_slug_remaining}
{users_suggestions_slug_reset}
{followers_list_limit}
{followers_list_remaining}
{followers_list_reset}
{followers_ids_limit}
{followers_ids_remaining}
{followers_ids_reset}
{statuses_mentions_timeline_limit}
{statuses_mentions_timeline_remaining}
{statuses_mentions_timeline_reset}
{statuses_scoped_timeline_limit}
{statuses_scoped_timeline_remaining}
{statuses_scoped_timeline_reset}
{statuses_show_id_limit}
{statuses_show_id_remaining}
{statuses_show_id_reset}
{statuses_oembed_limit}
{statuses_oembed_remaining}
{statuses_oembed_reset}
{statuses_home_timeline_limit}
{statuses_home_timeline_remaining}
{statuses_home_timeline_reset}
{statuses_user_timeline_limit}
{statuses_user_timeline_remaining}
{statuses_user_timeline_reset}
{statuses_retweets_of_me_limit}
{statuses_retweets_of_me_remaining}
{statuses_retweets_of_me_reset}
{statuses_retweets_id_limit}
{statuses_retweets_id_remaining}
{statuses_retweets_id_reset}
{help_privacy_limit}
{help_privacy_remaining}
{help_privacy_reset}
{help_tos_limit}
{help_tos_remaining}
{help_tos_reset}
{help_configuration_limit}
{help_configuration_remaining}
{help_configuration_reset}
{help_languages_limit}
{help_languages_remaining}
{help_languages_reset}
{friends_friends_ids_limit}
{friends_friends_ids_remaining}
{friends_friends_ids_reset}
{friends_friends_list_limit}
{friends_friends_list_remaining}
{friends_friends_list_reset}
{direct_messages_show_limit}
{direct_messages_show_remaining}
{direct_messages_show_reset}
{direct_messages_sent_and_received_limit}
{direct_messages_sent_and_received_remaining}
{direct_messages_sent_and_received_reset}
{direct_messages_sent_limit}
{direct_messages_sent_remaining}
{direct_messages_sent_reset}
{direct_messages_limit}
{direct_messages_remaining}
{direct_messages_reset}
{account_verify_credentials_limit}
{account_verify_credentials_remaining}
{account_verify_credentials_reset}
{account_settings_limit}
{account_settings_remaining}
{account_settings_reset}
{favorites_list_limit}
{favorites_list_remaining}
{favorites_list_reset}
{saved_searches_list_limit}
{saved_searches_list_remaining}
{saved_searches_list_reset}
{saved_searches_show_id_limit}
{saved_searches_show_id_remaining}
{saved_searches_show_id_reset}
{search_tweets_limit}
{search_tweets_remaining}
{search_tweets_reset}
{trends_available_limit}
{trends_available_remaining}
{trends_available_reset}
{trends_place_limit}
{trends_place_remaining}
{trends_place_reset}
{trends_closest_limit}
{trends_closest_remaining}
{trends_closest_reset}

Twitter Resources

This method is an implementation of the Twitter account/rate_limit_status REST API.