README.md

nubank-ruby (deprecated)

deprecation note: Nubank now has an option that lets you export CSV files that solves the same problem that made me create this gem.

This gem provides a wrapper to Nubank's public API.

It does not have any official support from Nubank nor is endorsed by them. This code is provided as is, I can't give you any guarantee that Nubank won't change the API calls in the future or you block your access accidentaly by overloading their API.

Installation

Add this line to your application's Gemfile:

gem 'nubank'

And then execute:

$ bundle

Or install it yourself as:

$ gem install nubank

Usage

tl;dr:

require 'nubank'
nubank = Nubank.new('<CPF>', '<PASSWORD>')
nubank.login
nubank.events # => [{"description":"Táxi do Zé","category":"transaction","amount ...
nubank.account # => {"payment_method":{"account_id":"<ACCOUNT-ID>","kind":"bolet ...
nubank.bills_summary # => [{"state":"open","summary":{"payments":"55","interest_ ...

Login

Autenticates in the service using your cpf and password. Returns the list of account's services available.

nubank = Nubank.new('<CPF>', '<PASSWORD>')
nubank.login

Account

Returns account's details like balance, interest rate, cards, payment method and links.

nubank.account

Bills summary

Returns informations about past, present and future bills.

nubank.bills_summary

Events feed

The main source of information. Here you will get information about transactions and notifications.

nubank.events

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. 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 rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/alfakini/nubank-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

Code of Conduct

Everyone interacting in this gem, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.