brm_finance

brm_finance

A ruby gem that retrieves real-time stock quotes and historical pricing from google yahoo.

Update

On November 1, 2013, Google discontinued iGoogle, which contained the api endpoint brm_finance utilized, rendering the gem inoperable.

As of November 2nd, 2013, the brm_finance gem has been rebuilt to use the Yahoo finance api, starting with version 1.1.0. All applications leveraging this gem should update to 1.1.0 to resume operation. The gem methods are the same, but responses have been modified to leverage the new api. Documentation has been updated to reflect these changes.

Installation

To install the 'brm_finance' ruby gem:

gem install brm_finance

Gem Configuration

To use the gem in your Rails Application, include it:

Rails 2+

Include the gem in config/environments.rb:

config.gem "brm_finance"

Rails 3+

Include the gem in your Gemfile:

gem "brm_finance"

Usage

BrmFinance::Stock.quote("symbol")

You can get a current quote with the following syntax:

stock = BrmFinance::Stock.quote("symbol")

Where symbol equals the company stock symbol you want a quote for. For example, "aapl" for Apple, Inc.

You may search for multiple stocks by separating symbols with a comma. For example:

stocks = BrmFinance::Stock.quote("aapl,tsla")

Or as an array.

stocks = BrmFinance::Stock.quote(["aapl", "tsla"])

These queries will return a Stock object or an array of Stock objects which you may iterate through. Each stock object has the following values:

• symbol
• ask
• average_daily_volume
• bid
• ask_realtime
• bid_realtime
• book_value
• change_percent_change
• change
• commission
• change_realtime
• after_hours_change_realtime
• dividend_share
• last_trade_date
• trade_date
• earnings_share
• eps_estimate_current_year
• eps_estimate_next_year
• eps_estimate_next_quarter
• days_low
• days_high
• year_low
• year_high
• holdings_gain_percent
• annualized_gain
• holdings_gain
• holdings_gain_percent_realtime
• holdings_gain_realtime
• more_info
• order_book_realtime
• market_capitalization
• market_cap_realtime
• ebitda
• change_from_year_low
• percent_change_from_year_low
• last_trade_realtime_with_time
• change_percent_realtime
• change_from_year_high
• percebt_change_from_year_high
• last_trade_with_time
• last_trade_price_only
• high_limit
• low_limit
• days_range
• days_range_realtime
• fiftyday_moving_average
• two_hundredday_moving_average
• change_from_two_hundredday_moving_average
• percent_change_from_two_hundredday_moving_average
• change_from_fiftyday_moving_average
• percent_change_from_fiftyday_moving_average
• name
• notes
• open
• previous_close
• price_paid
• changein_percent
• price_sales
• price_book
• ex_dividend_date
• pe_ratio
• dividend_pay_date
• pe_ratio_realtime
• peg_ratio
• price_eps_estimate_current_year
• price_eps_estimate_next_year
• symbol
• shares_owned
• short_ratio
• last_trade_time
• ticker_trend
• oneyr_target_price
• volume
• holdings_value
• holdings_value_realtime
• year_range
• days_value_change
• days_value_change_realtime
• stock_exchange
• dividend_yield
• percent_change",

BrmFinance::Stock.history(symbol, start_date, end_date)

BrmFinance::Stock.history(symbol, start_date, end_date) is as alias to BrmFinance::Stock.quote(symbol, start_date, end_date).

If you pass quote a start_date and end_date it will do a historical query within the date range as opposed to a realtime quote. Only one stock symbol should be used for historical quotes.

Historical queries provide an array of Price objects with the following values:

• symbol
• date
• open
• high
• low
• close
• volume

Values

Values may be accessed off the Stock or Price object like so:

BrmFinance::Stock.quote("SYMBOL").last

Or:

stock = BrmFinance::Stock.quote("SYMBOL")

stock.last

You can always convert the queries results to json with the following commands:

BrmFinance::Stock.quote("SYMBOL").to_json

Or:

BrmFinance::Stock.history("SYMBOL").to_json

Response Codes

Stock instances now include a response_code: 200 and 404.

> @stock = BrmFinance::Stock.quote('aapl')
> @stock.response_code
  => 200

Additionally, stock instances now have a success? and failure? method.

> @stock.success?
  => true

In the event that a stock symbol is incorrect, the returned instance will provide a response code of 404 and respond in the affirmative to a failure? method call.

> @stock = BrmFinance::Stock.quote('asdf')
> @stock.response_code
  => 404
> @stock.failure?
  => true

Special thanks to

...Google Yahoo for making this api publicly available.

License

Copyright (c) 2011 Ty Rauber

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.