Skip to main content

Retrieves financial quotes from the web

Project description

pipeline status coverage report PyPI version Python 3.11+ License: GPL v3

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:

  1. Environment variable: FINQUOTES_<PROVIDER>_API_KEY (e.g. FINQUOTES_QUANDL_API_KEY)
  2. File: ~/.finquotes/api_keys.txt with 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) and Split.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    # bump version, update files, create tag
git push && git push --tags

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

finquotes-0.70.0.tar.gz (46.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

finquotes-0.70.0-py3-none-any.whl (52.7 kB view details)

Uploaded Python 3

File details

Details for the file finquotes-0.70.0.tar.gz.

File metadata

  • Download URL: finquotes-0.70.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

Hashes for finquotes-0.70.0.tar.gz
Algorithm Hash digest
SHA256 0d3994faf4849955960209ddbacff888f9b46aa9b4d9e787bb28ce1ff3a4d3a1
MD5 dc6c0c8d14b3e11e56df4421185424ba
BLAKE2b-256 fb4eae19f555242d76a25846a5791b028c9cda66c33d08b7b9832117f4da6b3d

See more details on using hashes here.

File details

Details for the file finquotes-0.70.0-py3-none-any.whl.

File metadata

  • Download URL: finquotes-0.70.0-py3-none-any.whl
  • Upload date:
  • Size: 52.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for finquotes-0.70.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5212d6e99e9d8cc94b2080382588d345f96c3fdc5ae3e57221a6b288e9fee71d
MD5 d524d26732e298a98e95c43d36d3a30a
BLAKE2b-256 8525f616e78ec106b672d2a819a66a9a4f9be656ee271f73993ff72e3b81d426

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page