list_members: List of members from a specified List

In rtweet: Collecting Twitter Data

List of members from a specified List

Description

Looks up the users of a list.

Usage

list_members(
  ids,
  n = 100,
  expansions = NULL,
  fields = NULL,
  ...,
  token = NULL,
  parse = TRUE,
  verbose = FALSE
)

Arguments

ids	A list id.
n	Number of users to query.
expansions	Set NULL to not use any expansion, set NA to get all expansions, or provide a vector with the expansions you want (create it with set_expansions()).
fields	Set NULL to not use any field, get all allowed fields with NA, provide a list with the fields you want (create it with set_fields()).
...	Other parameters passed to the body of the request.
token	These endpoints only accept a bearer token (can be created via rtweet_app()). In most cases you are better of changing the default for all calls via auth_as().
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.
verbose	A logical value to provide more information about paginated queries.

Value

A data.frame with the user information of who is included in the list: id, name, and username.

Other information depends on the expansions and fields requested. Accepted values are:

• Expansions: set_expansions(tweet = NULL, list = NULL)

• Fields: set_fields(place = NULL, poll = NULL, media = NULL, list = NULL).

References

https://developer.twitter.com/en/docs/twitter-api/lists/list-lookup/api-reference/get-lists-id

Examples

if (FALSE) {
  lm <- list_members("1306285118877831168")
}

rtweet documentation built on May 29, 2024, 7:47 a.m.