rtweet (version 0.1.7)

rate_limit: rate_limit

Description

Returns rate limit information for Twitter access tokens.

Usage

rate_limit(token, query = NULL, rest = TRUE)

Arguments

token

OAuth token (1.0 or 2.0). By default token = NULL fetches a non-exhausted token from an environment variable.

query

If null, returns entire rate limit request object as data frame. otherwise, query returns specific values matching the query of interest; e.g., query = "lookup/users" returns remaining limit for user lookup requests; type = "followers/ids" returns remaining limit for follower id requests; type = "friends/ids" returns remaining limit for friend id requests.

rest

Logical indicating whether to send request to REST API. At this time, this should always be TRUE.

Value

Data frame with rate limit respones details. If query is specified, only relevant rows are returned.

See Also

https://dev.twitter.com/overview/documentation