1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/list_get.R
\name{list_get}
\alias{list_get}
\title{List information}
\usage{
list_get(
ids,
n = 100,
expansions = NULL,
fields = NULL,
...,
token = NULL,
parse = TRUE,
verbose = FALSE
)
}
\arguments{
\item{ids}{A list id.}
\item{n}{Number of users to query.}
\item{expansions}{Set \code{NULL} to not use any expansion, set \code{NA} to get all
expansions, or provide a vector with the expansions you want (create it with
\code{\link[=set_expansions]{set_expansions()}}).}
\item{fields}{Set \code{NULL} to not use any field, get all allowed fields with \code{NA},
provide a list with the fields you want (create it with \code{\link[=set_fields]{set_fields()}}).}
\item{...}{Other parameters passed to the body of the request.}
\item{token}{These endpoints only accept a bearer token (can be created via
\code{\link[=rtweet_app]{rtweet_app()}}). In most cases you
are better of changing the default for all calls via \code{\link[=auth_as]{auth_as()}}.}
\item{parse}{If \code{TRUE}, the default, returns a tidy data frame. Use \code{FALSE}
to return the "raw" list corresponding to the JSON returned from the
Twitter API.}
\item{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 \code{expansions} and \code{fields} requested.
Accepted values are:
\itemize{
\item Expansions: \code{set_expansions(tweet = NULL, user = NULL)}
\item Fields: \code{set_fields(place = NULL, poll = NULL, media = NULL, tweet = NULL)}.
}
}
\description{
Looks up information about a list.
}
\examples{
if (FALSE) {
lg <- list_get("1306285118877831168")
}
}
\references{
\url{https://developer.twitter.com/en/docs/twitter-api/lists/list-lookup/api-reference/get-lists-id}
}
|
