Skip to content

Latest commit

 

History

History
139 lines (78 loc) · 5.91 KB

README.md

File metadata and controls

139 lines (78 loc) · 5.91 KB
Raw

stock_quote

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 stock_quote utilized, rendering the gem inoperable.

As of November 2nd, 2013, the stock_quote 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 'stock_quote' ruby gem:

gem install stock_quote

Gem Configuration

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

Rails 2+

Include the gem in config/environments.rb:

config.gem "stock_quote"

Rails 3+

Include the gem in your Gemfile:

gem "stock_quote"

Usage

StockQuote::Stock.quote("symbol")

You can get a current quote with the following syntax:

stock = StockQuote::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 = StockQuote::Stock.quote("aapl,tsla")

Or as an array.

stocks = StockQuote::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, AverageDailyVolume, Bid, AskRealtime, BidRealtime, BookValue, Change_PercentChange, Change, Commission, ChangeRealtime, AfterHoursChangeRealtime, DividendShare, LastTradeDate, TradeDate, EarningsShare, ErrorIndicationreturnedforsymbolchangedinvalid, EPSEstimateCurrentYear, EPSEstimateNextYear, EPSEstimateNextQuarter, DaysLow, DaysHigh, YearLow, YearHigh, HoldingsGainPercent, AnnualizedGain, HoldingsGain, HoldingsGainPercentRealtime, HoldingsGainRealtime, MoreInfo, OrderBookRealtime, MarketCapitalization, MarketCapRealtime, EBITDA, ChangeFromYearLow, PercentChangeFromYearLow, LastTradeRealtimeWithTime, ChangePercentRealtime, ChangeFromYearHigh, PercebtChangeFromYearHigh, LastTradeWithTime, LastTradePriceOnly, HighLimit, LowLimit, DaysRange, DaysRangeRealtime, FiftydayMovingAverage, TwoHundreddayMovingAverage, ChangeFromTwoHundreddayMovingAverage, PercentChangeFromTwoHundreddayMovingAverage, ChangeFromFiftydayMovingAverage, PercentChangeFromFiftydayMovingAverage, Name, Notes, Open, PreviousClose, PricePaid, ChangeinPercent, PriceSales, PriceBook, ExDividendDate, PERatio, DividendPayDate, PERatioRealtime, PEGRatio, PriceEPSEstimateCurrentYear, PriceEPSEstimateNextYear, Symbol, SharesOwned, ShortRatio, LastTradeTime, TickerTrend, OneyrTargetPrice, Volume, HoldingsValue, HoldingsValueRealtime, YearRange, DaysValueChange, DaysValueChangeRealtime, StockExchange, DividendYield, PercentChange, ErrorIndicationreturnedforsymbolchangedinvalid, Date, Open, High, Low, Close, AdjClose

Date Range

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, How, Close, Volume

A alias is also available: StockQuote::Stock.history(symbol, start_date, end_date)

Field Selection

By supplying a select parameter you may query only specific fields. Supplying nil as the start_date and end_date will return the last market quote. The select parameter can either by a comma separated string of field names, or an array of field names.

For example, to query the Symbol, Ask and Bid for AAPL:

stocks = StockQuote::Stock.quote('aapl', nil, nil, ['Symbol, 'Ask', 'Bid'])

You may also query multiple symbols:

stocks = StockQuote::Stock.quote(['aapl', 'tsla'], nil, nil, ['Symbol, 'Ask', 'Bid'])

Format

If you prefer raw json as opposed to Stock instances, you may use the following convenience methods:

stocks = StockQuote::Stock.json_quote('aapl')

stocks = StockQuote::Stock.json_history('aapl')

All other options are also available.

Response Codes

Stock instances now include a response_code: 200 and 404.

> @stock = StockQuote::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 = StockQuote::Stock.quote('asdf')
> @stock.response_code
  => 404
> @stock.failure?
  => true

Response codes and success failure methods are not available with json responses.

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.