Skip to main content

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 DataSource interface.
  • Security Resolution: Resolve ISINs and Symbols to valid yfinance tickers.
  • 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

Metadata

Release files for py-yfinance 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for py-yfinance 0.3.0
File Size Uploaded
py_yfinance-0.3.0.tar.gz 16.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for py-yfinance 0.3.0
File Interpreter ABI Platform
py_yfinance-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 26.2 kB

Release files / py_yfinance-0.3.0.tar.gz

Download URL py_yfinance-0.3.0.tar.gz
Size 16.0 kB
Tags Source
SHA-256 checksum
How to use checksums
4183205c59dfdf57557c506d4b4976491a02b1b27bfd4c7a7de08324812d0aae
BLAKE2b-256 checksum
How to use checksums
91e609fe57d4e889f8e3aa66a6886cae3e12c5597c374a021f1ad860edbe142a
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.3.0-py3-none-any.whl

Download URL py_yfinance-0.3.0-py3-none-any.whl
Size 10.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d0481293b0af935c30dc0a5d910a52453f4e0d9380d6748b95de97915525e056
BLAKE2b-256 checksum
How to use checksums
a5e66b995bffec2cdd13f25f0926fd2d16f5925a15ea359a7ae29c65f5f8cd2d
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 history Release notifications | RSS feed

0.5.0

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.1

2 release files

This release

0.3.0 This release

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.18

2 release files

0.1.15

2 release files

0.1.14

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page