Keep updated about the stocks' fundamentals is essential. This gem export brazilian stock data from the best ones stock analysis websites in JSON format. You can export in CSV, HTML format soon.
Add this line to your application's Gemfile:
gem 'fundamenthus-client'And then execute:
$ bundle install
Or install it yourself as:
$ gem install fundamenthus-client
You can export the stock fundamentals and earnings from the following sources:
| Source | Fundamentals | Earnings |
|---|---|---|
| statusinvest.com.br | ✓ | 𐄂 |
| fundamentus.com.br | ✓ | 𐄂 |
| b3.com.br | 𐄂 | ✓ |
𐄂 not available ✓ available
To get the stock's earnings and its fundamentals just call .earnings and .stocks respectively. Check out the follow examples.
# Retrieve fundamentals data
Fundamenthus::Source::Fundamentus.stocks
# Retrieve earnings data
Fundamenthus::Source::Fundamentus.earnings# Retrieve fundamentals data
Fundamenthus::Source::StatusInvest.stocks
# Retrieve earnings data
Fundamenthus::Source::StatusInvest.earnings# Retrieve fundamentals data
Fundamenthus::Source::StatusInvest.stocks
# Retrieve earnings data
Fundamenthus::Source::StatusInvest.earningsThe default format is Hash. You will be able to export to others formats such as: CSV and HTML soon.
For while, the output is always Hash Object
After checking out the repo, run bundle install to install dependencies. Then, run bundle exec rspec to run the tests. You can also run bundle console for an interactive prompt that will allow you to experiment.
Bug reports and pull requests are welcome on GitHub at https://github.com/lucasgomide/fundamenthus-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Fundamenthus project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.