Learn R Programming

⚠️There's a newer version (2.0.0) of this package.Take me there.

rtweet

Use twitter from R. Get started by reading vignette("rtweet").

Installation

To get the current released version from CRAN:

install.packages("rtweet")

You can install the development version of rtweet from GitHub with:

install.packages("rtweet", repos = 'https://ropensci.r-universe.dev')

Usage

All users must be authenticated to interact with Twitter’s APIs. The easiest way to authenticate is to use your personal twitter account - this will happen automatically (via a browser popup) the first time you use an rtweet function. See auth_setup_default() for details. Using your personal account is fine for casual use, but if you are trying to collect a lot of data it’s a good idea to authentication with your own Twitter “app”. See vignette("auth", package = "rtweet") for details.

library(rtweet)

rtweet should be used in strict accordance with Twitter’s developer terms.

Search tweets or users

Search for up to 1000 tweets containing #rstats, the common hashtag used to refer to the R language, excluding retweets:

rt <- search_tweets("#rstats", n = 1000, include_rts = FALSE)

Twitter rate limits cap the number of search results returned to 18,000 every 15 minutes. To request more than that, set retryonratelimit = TRUE and rtweet will wait for rate limit resets for you.

Search for 200 users with the #rstats in their profile:

useRs <- search_users("#rstats", n = 200)

Stream tweets

Randomly sample (approximately 1%) from the live stream of all tweets:

random_stream <- stream_tweets("")

Stream all geo-located tweets from London for 60 seconds:

stream_london <- stream_tweets(location = lookup_coords("london"), timeout = 60)

Get friends and followers

Get all accounts followed by a user:

## get user IDs of accounts followed by R Foundation
R_Foundation_fds <- get_friends("_R_Foundation")

## lookup data on those accounts
R_Foundation_fds_data <- lookup_users(R_Foundation_fds$to_id)

Get all accounts following a user:

## get user IDs of accounts following R Foundation
R_Foundation_flw <- get_followers("_R_Foundation", n = 100)
R_Foundation_flw_data <- lookup_users(R_Foundation_flw$from_id)

If you want all followers, you’ll need you’ll need to set n = Inf and retryonratelimit = TRUE but be warned that this might take a long time.

Get timelines

Get the most recent 200 tweets from R Foundation:

## get user IDs of accounts followed by R Foundation
tmls <- get_timeline("_R_Foundation", n = 100)

Get favorites

Get the 10 most recently favorited statuses by R Foundation:

favs <- get_favorites("_R_Foundation", n = 10)

Contact

Communicating with Twitter’s APIs relies on an internet connection, which can sometimes be inconsistent.

If you have questions, or needs an example or want to share a use case, you can post them on rOpenSci’s discuss. Were you can browse uses of rtweet too.

With that said, if you encounter an obvious bug for which there is not already an active issue, please create a new issue with all code used (preferably a reproducible example) on Github.

Code of Conduct

Please note that this package is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Copy Link

Version

Install

install.packages('rtweet')

Monthly Downloads

38

Version

1.0.2

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Llu<c3><ad>s Revilla Sancho

Last Published

July 21st, 2022

Functions in rtweet (1.0.2)

get_mentions

Get mentions for the authenticating user.
get_friends

Get user IDs of accounts followed by target user(s).
get_favorites

Get tweets liked/favorited by one or more users
get_followers

Get user IDs for accounts following target user.
lists_members

Get Twitter list members (users on a given list).
lat_lng

Adds single-point latitude and longitude variables to tweets data.
bearer_token

Bearer token
get_timeline

Get one or more user timelines
get_retweets

Get the most recent retweets/retweeters
direct_messages_received

(DEPRECATED) Get the most recent direct messages sent to the authenticating user.
my_friendships

Lookup friendship information between users.
max_id

Extract min/max id (for id based pagination)
emojis

Defunct: Emojis codes and descriptions data.
get_token

Fetch Twitter OAuth token
get_trends

Get Twitter trends data.
do_call_rbind

Binds list of data frames while preserving attribute (tweets or users) data.
lookup_users

Get Twitter users data for given users (user IDs or screen names).
lookup_tweets

Get tweets data for given statuses (status IDs).
flatten

flatten/unflatten data frame
invalidate_bearer

Invalidate bearer token
langs

Defunct: Language codes recognized by Twitter data.
parse_stream

Parser of stream
post_destroy

Delete status of user's Twitter account
post_favorite

Favorites target status id.
plain_tweets

Clean up character vector (tweets) to more of a plain text.
post_friendship

Updates friendship notifications and retweet abilities.
post_follow

Follows target Twitter user.
search_users

Search for users
search_tweets

Get tweets data on statuses identified via search query.
lists_memberships

Get Twitter list memberships (lists containing a given user)
tweet_embed

Create a Tweet Embed
rate_limit

Rate limit helpers
ts_data

Converts tweets data into time series-like data object.
network_data

Network data
ts_plot

Plots tweets data as a time series-like data object.
lookup_friendships

Lookup friendship information between two specified users.
lists_subscriptions

Get list subscriptions of a given user but does not include the user's own lists.
lookup_coords

Get coordinates of specified location.
lists_subscribers

Get subscribers of a specified list.
next_cursor

Extract cursor (for cursor based pagination)
post_tweet

Posts status update to user's Twitter account
stopwordslangs

Defunct: Twitter stop words in multiple languages data.
stream_tweets

Collect a live stream of Twitter data
lists_statuses

Get a timeline of tweets authored by members of a specified list.
tweet_shot

Capture an image of a tweet/thread
rtweet_user

Authentication options
previous_cursor

Previous cursor
search_fullarchive

Premium Twitter searches
stream_tweets2

A more robust version of stream_tweets
read_twitter_csv

Read comma separated value Twitter data.
trends_available

Available Twitter trends along with associated WOEID.
user_block

Blocking or unblocking twitter users
users_data

Get tweets from users, or users from tweets
lists_users

Get all lists a specified user subscribes to, including their own.
post_list

Manage Twitter lists
lookup_collections

Collections API
post_message

Posts direct message from user's Twitter account
round_time

A generic function for rounding date and time values
rtweet-package

rtweet: Collect Twitter data from R
tweet_threading

Collect statuses contained in a thread
tweets_with_users

Parsing data into tweets/users data tibbles
write_as_csv

Save Twitter data as a comma separated value file.
as_screenname

Mark a user id as a screen name
auth_as

Set default authentication for the current session
auth_sitrep

Twitter Tokens sitrep
create_token

Create custom Twitter OAuth token
direct_messages

Get direct messages sent to and received by the authenticating user from the past 30 days
auth_get

Get the current authentication mechanism
auth_save

Save an authentication mechanism for use in a future session
TWIT_paginate_max_id

Pagination
auth_setup_default

Set up default authentication