||6 months ago|
|stockquotes||9 months ago|
|.gitignore||4 years ago|
|CONTRIBUTING.md||2 years ago|
|README.md||6 months ago|
|requirements.txt||2 years ago|
|setup.py||2 years ago|
stockquotes is a Python module for collecting stock, ETF, and mutual fund
quotes and historical data from Yahoo! Finance.
devel: current development version
stable: latest stable release
All PRs should be made against devel.
- Python 3.6+
- Beautiful Soup 4
pip3 install git+https://git.kj7rrv.com/kj7rrv/stockquotes@stable
Do not install from PyPI; the PyPI package is no longer updated.
First, import the
To get a stock quote, instantiate a
stockquotes.Stock object. The only
parameter is the ticker symbol to look up.
kroger = stockquotes.Stock('KR')
To get the current price of a share, get the
kroger_price = kroger.current_price
To get the day gain in dollars, get the
kroger_gain_dollars = kroger.increase_dollars
The same value as a percent is available in the
increase_percent property. To
indicate losses, these values are negative.
The historical data for a stock can be accessed through the
historical property. This is an array of
dicts, with the first item
representing the most recent quote. The
date property is a
datetime object representing the date the quote is from.
open is the
opening price for that day.
low are the high and low prices,
respectively, for that day.
adjusted_close are the closing
price. The difference is that
adjClose is adjusted for splits and
close is adjusted only for splits.
volume is the
stock's volume for that day.
Typically, this should give at least a month of data. Obviously, it gives less for recent IPOs. Also, a known but unexplained bug causes it to only give two days of data for some stocks.
stockquotes.StockDoesNotExistError is raised when the stock does not (appear
stockquotes.NetworkError is raised when a connection to Yahoo! Finance
cannot be established.
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.
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 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.
For more information, please refer to https://unlicense.org/