Metadata-Version: 2.4
Name: tickers
Version: 0.1.0
Summary: Python SDK for the Tickers Data API
Project-URL: Homepage, https://tickersdata.com
Project-URL: API Documentation, https://tickersdata.com/developers
Project-URL: Repository, https://github.com/tickersdata/tickers-py
Author-email: Tickers Data <api@tickersdata.com>
License-Expression: MIT
Keywords: api,edgar,filings,finance,sec,stocks
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Office/Business :: Financial
Requires-Python: >=3.9
Requires-Dist: httpx>=0.25.0
Requires-Dist: pydantic>=2.0
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-asyncio; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Description-Content-Type: text/markdown

# tickers-py

> Python SDK for the [Tickers Data API](https://api.tickersdata.com)

```bash
pip install tickers
```

## Quick Start

```python
from tickers import TickersData

td = TickersData(api_key="td_live_...")

# List filings
filings = td.filings.list(ticker="AAPL", form="10-K", limit=5)
for f in filings:
    print(f"{f.filed_date} — {f.form} — {f.description}")

# Search filings
results = td.filings.search(q="cybersecurity incident", form="8-K", start_date="2024-01-01")

# Semantic search (vector)
chunks = td.filings.chunks(query="supply chain risks", ticker="AAPL")

# Ask with citations (streaming)
for event in td.filings.ask("What are Apple's main revenue risks?", ticker="AAPL"):
    if event.type == "sources":
        print(f"Sources: {len(event.mapping)} documents")
    elif event.type == "chunk":
        print(event.content, end="")
    elif event.type == "done":
        print(f"\n\nLatency: {event.usage.latency_ms}ms")

# Reference data
types = td.reference.filing_types()
```

## Authentication

```python
# Via constructor
td = TickersData(api_key="td_live_...")

# Via environment variable
# export TICKERS_API_KEY=td_live_...
td = TickersData()
```

## License

MIT
