v2_search_fullarchive: v2_search_fullarchive

Description Usage Arguments Value Author(s)

View source: R/v2_search_fullarchive.R

Description

Get tweets data on statuses identified via search query.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
v2_search_fullarchive(
  token,
  safe.dir = NULL,
  query,
  start_time = NULL,
  end_time = NULL,
  max_results = 10,
  next_token = NULL,
  since_id = NULL,
  until_id = NULL,
  expansions = NULL,
  tweet.fields = NULL,
  user.fields = NULL,
  media.fields = NULL,
  place.fields = NULL,
  poll.fields = NULL
)

Arguments

token

object of class v2_create_token(). Bearer token associated with a user-created APP (requires a developer account).

safe.dir

string (e.g. "~/home/..."). Default=NULL. Path to an existing directory (serving as a data backup). If NULL, considers the home directory.

query

string (e.g. "btc -is:retweet"). One query for matching Tweets.

start_time

string {"%Y-%m-%dT%H:%M:%SZ"} (ISO 8601/RFC 3339). The oldest UTC timestamp from which the Tweets will be provided. Timestamp is in second granularity and is inclusive (for example, 12:00:01 includes the first second of the minute).

end_time

string {"%Y-%m-%dT%H:%M:%SZ"} (ISO 8601/RFC 3339).

max_results

integer [10, 500]. The maximum number of search results to be returned by a request. A number between 10 an the system limit (currently 500). By default, a request response will return 10 results.

next_token

string. This parameter is used to get the next "page" of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.

since_id

string. Returns results with a Tweet ID greater than the specified ID. The ID specified is exclusive and responses will not include it. If included with the same request as a 'start_time' parameter, only 'since_id' will be used.

until_id

string. Returns results with a Tweet ID less than (that is, older than) the specified ID. Used with 'since_id'. The ID specified is exclusive and responses will not include it.

expansions

vector of strings (e.g. "expansion_{1}", ...). Specifies a subset of expansions to be returned (accepts "all"). To request all but some expansions, append "-" in front of each expansion in the input vector (e.g. "-expansion_{1}", ...).

product_track

string {"academic" or "standard"}. Type of product track.

_.fields

vector of strings (e.g. "field_{1}", ...). Specifies a subset of fields to be returned (accepts "all"). To request all but some fields, append "-" in front of each field in the input vector (e.g. "-field_{1}", ...).

Value

A list of tweets and their expansions (with attached errors if encountered).

Author(s)

Victor Plesco


victorplesco/Racademic documentation built on Jan. 8, 2022, 12:06 a.m.