pydantic-market-data

Shared Pydantic models and interfaces for financial data sources. Defines a standard contract (DataSource) and data structures (OHLCV, Security, History) to ensure interoperability between finance packages.

Installation

pip install pydantic-market-data

Usage

Models

Standardized data models for financial entities.

from pydantic_market_data.models import Security, OHLCV, SecurityQuery

# Security Definition
s = Security(
    symbol="AAPL",
    name="Apple Inc.",
    exchange="NASDAQ",
    currency="USD",
    asset_class="equity",  # AssetClass value
    isin="US0378331005"
)

# Historical Data Point
candle = OHLCV(
    date="2023-12-01", # Coerced to FlexibleDatetime
    open=150.0,
    high=155.0,
    low=149.0,
    close=154.0,
    volume=50000000
)

# Security Lookup Query
query = SecurityQuery(
    symbol="AAPL",
    asset_class="equity",
    price_on={"price": 190.0, "date": "2023-12-01"}  # Known price, coerced to list[PriceOnDate]
)

Protocol

Implement the DataSource protocol to create compatible data providers.

from pydantic_market_data.interfaces import DataSource
from pydantic_market_data.models import SecurityQuery, Security, History, Symbol, HistoryPeriod

class MySource(DataSource):
    def resolve(self, criteria: SecurityQuery) -> Security | None:
        # Implementation...
        pass

    def history(self, symbol: Symbol.Input, period: HistoryPeriod = HistoryPeriod.MO1) -> History:
        # Implementation...
        pass

    def search(self, query: str) -> list[Security]:
        # Implementation...
        pass

    # ...plus get_price() and validate()

CLI Support

The package provides optimized pydantic-settings models for building professional CLI tools.

from pydantic_market_data.cli_models import SearchArgs, PatchedCliSettingsSource
from pydantic_settings import BaseSettings, CliSubCommand

class MyCliSettings(BaseSettings):
    search: CliSubCommand[SearchArgs]

    @classmethod
    def settings_customise_sources(cls, settings_cls, **kwargs):
        return (PatchedCliSettingsSource(settings_cls, cli_parse_args=True),)

# Usage:
# my-tool search --symbol AAPL -vv --format json

Key CLI features:

Clean Help: Automatically removes default values from help text for a cleaner look.
Improved Flags: Normalizes double-dash flags like --vv to -vv.
JSON Schema: Adds a --schema flag to output the interface definition.
Consistent Defaults: Whatever order your BaseSettings subclass lists its bases in, multi-word fields become --asset-class, -v/-vv are valueless flags, and optional values show as --symbol SYMBOL (not {SYMBOL,null}). Pass cli_kebab_case, cli_implicit_flags or cli_hide_none_type to the source to override.
Metavars: Custom types (SYMBOL, ISIN, etc.) provide descriptive help labels.

SearchArgs and HistoryArgs are SecurityQueryArgs and HistoryQueryArgs plus GlobalArgs (-v, -vv, --format, --schema). SearchArgs also adds --limit, a paging option that list-command frameworks are expected to own. If your CLI framework already owns those options, use the domain-only *QueryArgs models instead:

from pydantic_market_data import SecurityQueryArgs

class SearchCommand(SecurityQueryArgs):
    pass  # --symbol, --isin, ... without -v/--format/--schema/--limit

License

MIT

Metadata

Release files for pydantic-market-data 0.8.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 pydantic-market-data 0.8.0
File	Size	Uploaded
pydantic_market_data-0.8.0.tar.gz	34.6 kB	Oct 2, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for pydantic-market-data 0.8.0
File	Interpreter	ABI	Platform	Reset
pydantic_market_data-0.8.0-py3-none-any.whl 14.2 kB Oct 2, 2026	Python 3	none	any	Details

Total release size: 48.8 kB

Release files / pydantic_market_data-0.8.0.tar.gz

Download URL	pydantic_market_data-0.8.0.tar.gz
Size	34.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`b7ba4abddc11f69cdd7196b83fff87e49df6cb3521f9d7ef55b297fb8f480328`
BLAKE2b-256 checksum How to use checksums	`4f2668de5284b1d612799fa8a4edf11cdc01bf05144830dc1d8192d816c25f8b`
Upload date	Oct 2, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`uv/0.12.22 {"installer":{"name":"uv","version":"0.12.22","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 / pydantic_market_data-0.8.0-py3-none-any.whl

Download URL	pydantic_market_data-0.8.0-py3-none-any.whl
Size	14.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`c59c542d48248b93043d31ce6d8285719b49afdea5d6a5671fa3e635f2bce019`
BLAKE2b-256 checksum How to use checksums	`e552f94dbe6848e6f9601f7b52e4d41e63d6ca6ea4e05d5f54430093f0373436`
Upload date	Oct 2, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`uv/0.12.22 {"installer":{"name":"uv","version":"0.12.22","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}`