Gem Version License Discord Server Invite

brawlstarsrb is a Ruby implementation of BrawlAPI, the unofficial Brawl Stars API.


Add this line to your application's Gemfile:

gem 'brawlstars'

And then execute:

$ bundle

Or install it yourself as:

$ gem install brawlstars


Example usage:

require 'brawlstars'

client = "token") # check below to get token
player = client.getPlayer("LQL")
puts player["name"]

More documentation can be found at rubydoc

Getting API Token

  1. Join the Discord server
  2. Go to the dashboard and generate a token


After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to


The gem is available as open source under the terms of the MIT License.