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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/http.R
\name{TWIT_paginate_max_id}
\alias{TWIT_paginate_max_id}
\alias{TWIT_paginate_cursor}
\alias{TWIT_paginate_chunked}
\alias{TWIT_paginate_premium}
\title{Pagination}
\usage{
TWIT_paginate_max_id(
token,
api,
params,
get_id = function(x) x$id_str,
n = 1000,
page_size = 200,
since_id = NULL,
max_id = NULL,
count_param = "count",
retryonratelimit = NULL,
verbose = TRUE
)
TWIT_paginate_cursor(
token,
api,
params,
n = 5000,
page_size = 5000,
cursor = "-1",
get_id = function(x) x$ids,
retryonratelimit = NULL,
verbose = TRUE
)
TWIT_paginate_chunked(
token,
api,
params_list,
retryonratelimit = NULL,
verbose = TRUE
)
TWIT_paginate_premium(
token,
api,
params,
n = 100,
page_size = 100,
cursor = "next",
retryonratelimit = NULL,
verbose = TRUE
)
}
\arguments{
\item{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 \code{\link[=auth_as]{auth_as()}} for details.}
\item{get_id}{A single argument function that returns a vector of ids given
the JSON response. The defaults are chosen to cover the most common cases,
but you'll need to double check whenever implementing pagination for
a new endpoint.}
\item{n}{Desired number of results to return. Results are downloaded
in pages when \code{n} is large; the default value will download a single
page. Set \code{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 \code{retryonratelimit = TRUE}.
You are not guaranteed to get exactly \code{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 \code{n = 150} and the page
size is 200, you'll get 200 results back.}
\item{since_id}{Supply a vector of ids or a data frame of previous results to
find tweets \strong{newer} than \code{since_id}.}
\item{max_id}{Supply a vector of ids or a data frame of previous results to
find tweets \strong{older} than \code{max_id}.}
\item{retryonratelimit}{If \code{TRUE}, and a rate limit is exhausted, will wait
until it refreshes. Most Twitter rate limits refresh every 15 minutes.
If \code{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, \code{NULL}, consults the option
\code{rtweet.retryonratelimit} so that you can globally set it to \code{TRUE},
if desired.
If you expect a query to take hours or days to perform, you should not
rely solely on \code{retryonratelimit} because it does not handle other common
failure modes like temporarily losing your internet connection.}
\item{verbose}{Show progress bars and other messages indicating current
progress?}
\item{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.}
}
\value{
A list with the json output of the API.
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}
These are internal functions used for pagination inside of rtweet.
}
\keyword{internal}
|
