lists_memberships {rtweet} | R Documentation |
Get Twitter list memberships (lists containing a given user)
Description
Due to deleted or removed lists, the returned number of memberships
is often less than the provided n value. This is a reflection of the API and
not a unique quirk of rtweet.
Usage
lists_memberships(
user = NULL,
n = 200,
cursor = "-1",
filter_to_owned_lists = FALSE,
token = NULL,
parse = TRUE,
retryonratelimit = NULL,
verbose = TRUE,
previous_cursor = NULL
)
Arguments
user |
Character vector of screen names or user ids.
See as_screenname() for more details.
|
n |
Desired number of results to return. Results are downloaded
in pages when n is large; the default value will download a single
page. Set n = Inf to download as many results as possible.
The Twitter API rate limits the number of requests you can perform
in each 15 minute period. The easiest way to download more than that is
to use retryonratelimit = TRUE .
You are not guaranteed to get exactly n results back. You will get
fewer results when tweets have been deleted or if you hit a rate limit.
You will get more results if you ask for a number of tweets that's not
a multiple of page size, e.g. if you request n = 150 and the page
size is 200, you'll get 200 results back.
|
cursor |
Which page of results to return. The default will return
the first page; you can supply the result from a previous call to
continue pagination from where it left off.
|
filter_to_owned_lists |
When TRUE , will return only lists that
authenticating user owns.
|
token |
Use this to override authentication for
a single API call. In many cases you are better off changing the
default for all calls. See auth_as() for details.
|
parse |
If TRUE , the default, returns a tidy data frame. Use FALSE
to return the "raw" list corresponding to the JSON returned from the
Twitter API.
|
retryonratelimit |
If TRUE , and a rate limit is exhausted, will wait
until it refreshes. Most Twitter rate limits refresh every 15 minutes.
If FALSE , and the rate limit is exceeded, the function will terminate
early with a warning; you'll still get back all results received up to
that point. The default value, NULL , consults the option
rtweet.retryonratelimit so that you can globally set it to TRUE ,
if desired.
If you expect a query to take hours or days to perform, you should not
rely solely on retryonratelimit because it does not handle other common
failure modes like temporarily losing your internet connection.
|
verbose |
Show progress bars and other messages indicating current
progress?
|
previous_cursor |
Please use
cursor instead.
|
References
https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-memberships
See Also
rtweet-deprecated
[Package
rtweet version 2.0.0
Index]