yfinance
A structured Python interface for retrieving and validating market data using yfinance.
Implements the DataSource protocol from pydantic-market-data to provide type-safe security resolution and historical data fetching.
Features
- Protocol-Oriented: Implements
DataSourceinterface. - Security Resolution: Resolve ISINs and Symbols to valid
yfinancetickers. - Validation:
- Price Validation: Verify tickers against daily high/low range.
- Date Validation: Validate prices on specific historical dates.
- CLI: Optional command-line interface for lookup and history.
Installation
# Basic installation
uv pip install yfinance
Usage
As a Library
from py_yfinance.source import YFinanceDataSource
from pydantic_market_data.models import SecurityCriteria
source = YFinanceDataSource()
# 1. Simple Lookup by Symbol
criteria = SecurityCriteria(symbol="AAPL")
result = source.resolve(criteria)
print(result)
# Symbol(ticker='AAPL', name='Apple Inc.', exchange='NMS', currency='USD', ...)
# 2. Strict Validation using Date & Price
# Useful for verifying ISIN mappings or ensuring data quality
criteria = SecurityCriteria(
isin="NL0010273215",
target_date="2025-12-15",
target_price=923.4 # Validates against history
)
match = source.resolve(criteria)
if match:
print(f"Verified: {match.ticker}")
else:
print("Validation failed: Price mismatch or symbol not found")
CLI Usage
Lookup
Resolve a security by Symbol or ISIN.
# Basic Lookup
uv run yfinance lookup --symbol AAPL
# ISIN Lookup with Strict Validation
# Verifies that NL0010273215 commanded a price of ~923.4 on 2025-12-15
uv run yfinance lookup --isin NL0010273215 --date 2025-12-15 --price 923.4
History
Fetch historical candles.
uv run yfinance history AAPL --period 5d
Development
This project uses uv for dependency management.
# Sync dependencies
uv sync
# Run Tests
uv run pytest
License
MIT
1 maintainer
Metadata
1 maintainer
Release files for py-yfinance 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| py_yfinance-0.2.0.tar.gz | 16.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| py_yfinance-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 27.3 kB
Release files / py_yfinance-0.2.0.tar.gz
| Download URL | py_yfinance-0.2.0.tar.gz |
|---|---|
| Size | 16.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8ad43812044ee2edfccef060faf3135622417760ee8ca02759bc1e3331eb55e0
|
|
BLAKE2b-256 checksum How to use checksums |
4a1a7506fc1251b809d20458794e1453226a4df419e5a74e92548ef726662134
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / py_yfinance-0.2.0-py3-none-any.whl
| Download URL | py_yfinance-0.2.0-py3-none-any.whl |
|---|---|
| Size | 11.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
418d4c2511fc2c314decc39d6658616ace5e225e744e7fb0ed273fb8fe79088d
|
|
BLAKE2b-256 checksum How to use checksums |
745abcfdb2a15d520b8150d9e9461a63c8222615fdb979700e6001e63814618c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
