Retrieves financial quotes from the web
Project description
FinQuotes
FinQuotes is a small Python library to be used as a facade to fetch financial data from public sources through a single, consistent interface. It adapts various interface to a consistent one described below allowing one to quickly switch between service.
It supports close snapshots, historical OHLCV, distributions (dividends), splits, and security metadata across multiple providers (Yahoo Finance, yfinance, yahooquery, Stooq, Morningstar, Quandl).
- Python: 3.11–3.14
- License: GPL-3.0
Features
- Unified API and CLI for multiple data sources
- Normalized data models: Price, Distribution, Split, Security
- Deterministic CSV output for easy piping and testing
- Robust network options: retry, timeout, max retries
- Pluggable sources via lightweight “feed” builders
Install
python -m pip install --upgrade pip
python -m pip install finquotes
Optional extras:
- Types only:
python -m pip install 'finquotes[types]' - All optional dependencies:
python -m pip install -e '.[all]'
Quick start (Python)
Use typed builder helpers for clarity, or build_feed with a FeedType.
import finquotes as fq
# Historical OHLCV (yfinance)
hfeed = fq.build_historical_feed("finquotes.yfinance", auto_adjust=True)
for p in hfeed.fetch_hist_prices("MSFT", begin_date=fq.today(), end_date=fq.today()):
assert p.open is not None and p.high is not None and p.low is not None
# Distributions & splits (yahooquery)
qhist = fq.build_historical_feed("finquotes.yahooquery")
for d in qhist.fetch_hist_dists("BIL", begin_date=fq.today(), end_date=fq.today()):
print(d)
for s in qhist.fetch_hist_splits("AAPL", begin_date=fq.today(), end_date=fq.today()):
print(s)
Network parameters (timeout, max_retries, retry_delay, and provider-specific args) can be passed to feed builders as keyword arguments.
API keys
Some providers require an API key (e.g., Quandl). FinQuotes looks for keys in:
- Environment variable:
FINQUOTES_<PROVIDER>_API_KEY(e.g.FINQUOTES_QUANDL_API_KEY) - File:
~/.finquotes/api_keys.txtwith lines like:
finquotes.quandl=<YOUR_KEY>
On Windows the file path expands to %USERPROFILE%\.finquotes\api_keys.txt.
You can also pass --api-key on the CLI or api_key="..." to feed builders where applicable.
Data model at a glance
Price(symbol, date|datetime, close[, open, high, low, volume, source])Distribution(symbol, ex_date, amount[, pay_date])Split(symbol, ex_date, new_quantity, old_quantity)andSplit.from_ratio(...)Security(symbol, name[, type, currency, exchange, country, sector, industry, source, source_id])
Instances print to CSV for easy piping; attributes are typed (Decimal for prices) and validated by a helper (PriceValidator).
Tips & caveats
- Some providers adjust historical series (e.g., Stooq distributions are adjusted); check source notes before using for cash-flow analysis.
- Yahoo-derived OHLC fields may be dividend-adjusted; see in-code comments where noted.
- Timezone defaults to America/New_York for timestamp parsing.
Development
Set up a local environment once:
python -m venv venv
. .\venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install -e '.[all]'
Run tests:
pytest -q
Pre-commit hooks:
pre-commit install
pre-commit run --all-files
Publishing (maintainers)
cz bump -ch --retry # bump version, update files, create tag
git push && git push --tags
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file finquotes-0.71.0.tar.gz.
File metadata
- Download URL: finquotes-0.71.0.tar.gz
- Upload date:
- Size: 46.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0af6b3dba5eb9b75f952145dc2b31365fde5806ee62d1451f703fdbda7532d43
|
|
| MD5 |
632875912162304647e1d306948b9144
|
|
| BLAKE2b-256 |
670e6f63ab8b4266e2ffe2582d1d3e3b7f4bdcf966c153531d137ecf03b833a3
|
File details
Details for the file finquotes-0.71.0-py3-none-any.whl.
File metadata
- Download URL: finquotes-0.71.0-py3-none-any.whl
- Upload date:
- Size: 52.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fa988b13156a3be311137151c1aafc60c73160da38c37b3ebfd752a59e7b3bac
|
|
| MD5 |
e0bb80fb768b3c1554e3e816048278d7
|
|
| BLAKE2b-256 |
16354f908983bd5bbec9a4563036340d225dd16015458dbeee863873ceba2d2b
|