Python SDK for the Tickers Data API
Project description
tickers-py
Python SDK for the Tickers Data API
pip install tickers
Quick Start
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
# Via constructor
td = TickersData(api_key="td_live_...")
# Via environment variable
# export TICKERS_API_KEY=td_live_...
td = TickersData()
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
tickers-0.1.0.tar.gz
(7.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tickers-0.1.0.tar.gz.
File metadata
- Download URL: tickers-0.1.0.tar.gz
- Upload date:
- Size: 7.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ba55b2357534224b93087dc3d1d18e5f98ff779aa5989fa3a1096d83cf97a4f9
|
|
| MD5 |
90444a1306540ea353ee39989cbbe50d
|
|
| BLAKE2b-256 |
6d6441d4f963a844b10511dd453cd38103c6a5d133e7512ab7dd5c6d77f4d3b3
|
File details
Details for the file tickers-0.1.0-py3-none-any.whl.
File metadata
- Download URL: tickers-0.1.0-py3-none-any.whl
- Upload date:
- Size: 6.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c34a51fb023d50a3cf7dc4d57b0622795d2341bfbd803f495e8ceab9efb21f0c
|
|
| MD5 |
73d526aaabe454bf3143821e51f1c415
|
|
| BLAKE2b-256 |
9f4c6aec10c997db13bf4057b05d1203c8cf818885b49559b63a81d5b7ae443a
|