A ruby interface for the Mastodon API
Switch branches/tags
Nothing to show
Clone or download
Gargron Merge pull request #37 from renatolond/feature/accept_headers
Add headers from options to rest requests
Latest commit 189deb8 Jun 10, 2018


Mastodon API Ruby Gem

Gem Version Build Status Dependency Status

A ruby interface for the Mastodon API.


gem 'mastodon-api', require: 'mastodon'


All the documentation is available on RubyDoc.


Assuming that you already have an access token for a user on a given Mastodon instance:

client = Mastodon::REST::Client.new(base_url: 'https://mastodon.social', bearer_token: 'your_access_token')

If you need to get an access token, you must first ensure that you have the client ID and client secret for your app on the given Mastodon instance (you should save those for future calls):

client.create_app('My Ruby App', 'http://mywebsite.com/callback')

You can then use the client ID and secret in a standard OAuth 2 authorization flow.