rate_limit.Rd
Returns rate limit information for one or more Twitter tokens, optionally filtered by rtweet function or specific Twitter API path(s)
rate_limit(token = NULL, query = NULL, parse = TRUE) rate_limits(token = NULL, query = NULL, parse = TRUE)
token | One or more OAuth tokens. By default token = NULL
fetches a non-exhausted token from an environment variable. Find
instructions on how to create tokens and setup an environment
variable in the tokens vignette (in r, send |
---|---|
query | Specific API (path) or a character function name, e.g., query = "get_timelines", used to subset the returned data. If null, this function returns entire rate limit request object as a tibble 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. |
parse | Logical indicating whether to parse response object into a data frame. |
Tibble data frame with rate limit information pertaining to the limit (max allowed), remaining (specific to token), reset (minutes until reset), and reset_at (time of rate limit reset). If query is specified, only relevant rows are returned.
If multiple tokens are provided, this function will return the names of the associated [token] applications as new variable (column) or as a named element (if parse = FALSE).
Other tokens: create_token
,
get_tokens
# NOT RUN { ## get all rate_limit information for default token rate_limit() ## get rate limit info for API used in lookup_statuses rate_limit("lookup_statuses") ## get rate limit info for specific token token <- get_tokens() rate_limit(token) rate_limit(token, "search_tweets") # }