This vignette provides a quick tour of the package.
First you should set up your own credentials (see also the vignette on authentication)
The mastodon API allows different access levels. Setting up a token with your own account grants you the most access.
In contrast to twitter, mastodon is not a single instance, but a
federation of different servers. You sign up at a specific server (say
“mastodon.social”) but can still communicate with others from other
servers (say “fosstodon.org”). The existence of different instances
makes API calls more complex. For example, some calls can only be made
within your own instance (e.g
can access all instances but you need to specify the instance as a
A list of active instances can be obtained with
get_fedi_instances(). The results are sorted by number of
General information about an instance can be obtained with
get_instance_general(instance = "mastodon.social")
get_instance_activity() shows the activity for the last
three months and
get_instance_trends() the trending
hashtags of the week.
get_instance_activity(instance = "mastodon.social") get_instance_trends(instance = "mastodon.social")
To get the most recent toots of a specific instance use
get_timeline_public(instance = "mastodon.social")
To get the most recent toots containing a specific hashtag use
get_timeline_hashtag(hashtag = "rstats", instance = "mastodon.social")
get_timeline_home() allows you to get the
most recent toots from your own timeline.
rtoot exposes several account level endpoints. Most
require the account id instead of the username as an input. There is, to
our knowledge, no straightforward way of obtaining the account id. With
the package you can get the id via
(Future versions will allow to use the username and user id interchangeably)
Using the id, you can get the followers and following users with
get_account_following() and statuses with
<- "109302436954721982" id get_account_followers(id) get_account_following(id) get_account_statuses(id)
You can post toots with:
post_toot(status = "my first rtoot #rstats")
It can also include media and alt_text.
post_toot(status = "my first rtoot #rstats", media="path/to/media", alt_text = "description of media")
You can mark the toot as sensitive by setting
sensitive = TRUE and add a spoiler text with
Be aware that excessive automated posting is frowned upon (or even against the ToS) in many instances. Make sure to check the ToS of your instance and be mindful when using this function.
All relevant functions in the package support pagination of results
limit parameter is larger than the default page size
(which is 40 in most cases). In this case, you may get more results than
requested since the pages are always fetched as a whole. If you for
example request 70 records, you will get 80 back, given that many