tvkit 0.4.0

tvkit is a Python library that fetches real-time stock data from TradingView, including price, market cap, P/E ratio, ROE, and more for stocks from multiple countries. Easily access and analyze financial metrics for global markets.

tvkit

tvkit — Async Python client for TradingView market data.

Access real-time and historical TradingView data with a modern async Python API. Designed for quantitative research, trading tools, and data pipelines.

Features

• Real-time OHLCV streaming via WebSocket with async generators
• Historical data retrieval by bar count or explicit date range
• Multi-market scanner: 69 global markets, 101+ financial metrics
• Multi-format data export: Polars DataFrames, JSON, CSV
• Symbol format auto-conversion: EXCHANGE-SYMBOL and EXCHANGE:SYMBOL both accepted
• Async symbol validation with retry and flexible format support
• Full type safety with Pydantic models throughout
• Python 3.11+ with async/await and context manager patterns

Installation

Available on PyPI: https://pypi.org/project/tvkit/

uv add tvkit        # recommended
pip install tvkit

Quick Example

import asyncio
from tvkit.api.chart.ohlcv import OHLCV

async def main() -> None:
    async with OHLCV() as client:
        # Fetch last 10 daily bars for Apple
        bars = await client.get_historical_ohlcv(
            exchange_symbol="NASDAQ:AAPL",
            interval="1D",
            bars_count=10,
        )
    for bar in bars:
        print(bar.timestamp, bar.close)
        # 2024-01-10 00:00:00  189.34

asyncio.run(main())

See more working examples in examples/.

Symbol Format Reference

Market	Example
US Equity	NASDAQ:AAPL
Crypto	BINANCE:BTCUSDT
Index / Macro	INDEX:NDFI

Canonical format: EXCHANGE:SYMBOL. Dash notation (EXCHANGE-SYMBOL) is automatically converted. See concepts/symbols.md for the full reference.

Documentation

Full documentation index → docs/index.md

Getting Started

• Installation — Python version, uv, pip, source install, verification
• Quickstart — Four self-contained examples in under 15 lines each
• First Script — Annotated walkthrough from install to first data fetch

Concepts

• Symbols — Format rules, exchange prefixes, auto-conversion
• Intervals — All supported timeframes and format strings
• Streaming vs Historical — When to use each method
• Scanner Columns — Column sets and when to use each

Guides

• Historical Data — Bar count mode, date-range mode, Polars integration
• Real-time Streaming — WebSocket streaming, multiple symbols, reconnection
• Scanner — 69 global markets, filters, sorting, regional analysis
• Exporting Data — DataExporter, CSV, JSON, Polars with metadata
• Macro Indicators — INDEX:NDFI, USI:PCC, regime detection

Reference

• Chart API — OHLCV client: all methods, parameters, return types
• Chart Utils — Interval validation, timestamp utilities
• Scanner API — ScannerService interface and filter syntax
• Markets — All 69 markets, regions, exchange identifiers
• Export API — DataExporter interface and export formats
• Full Reference Index

Architecture

• System Overview — Four modules, async rationale, module dependencies
• WebSocket Protocol — TradingView message format, session lifecycle

Development

• Release Process — Quality gates, version bump, publish
• Testing Strategy — Test organisation, mocking, coverage
• Architecture Decisions — Key decisions with rationale

Support

• FAQ — Symbol formats, bar limits, async requirement, disconnect handling
• Roadmap — Planned features
• Why tvkit — Design goals, vs rolling your own WebSocket
• Limitations — Bar caps, rate limits, data coverage gaps
• Data Sources — TradingView data origin, real-time vs delayed

Examples

Working scripts in examples/ — clone the repo and run immediately.

Why tvkit

TradingView provides powerful market data but does not offer an official Python SDK. tvkit implements the TradingView WebSocket protocol and provides:

• A clean async Python API
• Strong typing via Pydantic
• Structured OHLCV models
• High-level data utilities (export, scanners)

Without needing to reverse-engineer the protocol yourself. See docs/why-tvkit.md for the full rationale.

Stability

tvkit is under active development. The public API is expected to remain stable within minor versions. Breaking changes will follow semantic versioning.

Contributing

See CONTRIBUTING.md for the development environment setup, quality gate commands, and pull request process.

Quality gates before every commit:

uv run ruff check .
uv run ruff format .
uv run mypy tvkit/
uv run python -m pytest tests/ -v

License

MIT — see LICENSE