Metadata-Version: 2.4
Name: datacaptain
Version: 0.1.0
Summary: Official Python SDK for the DataCaptain US ETF Data API
License: MIT
Project-URL: Homepage, https://www.datacaptain.in
Project-URL: Documentation, https://www.datacaptain.in/docs
Keywords: etf,api,fintech,datacaptain,backtesting
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Typing :: Typed
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# datacaptain

Official Python SDK for the [DataCaptain](https://www.datacaptain.in) US ETF Data API.

## Install

```bash
pip install datacaptain
```

For local development from this repo:

```bash
pip install -e packages/datacaptain-python
```

## Quick start

```python
from datacaptain import DataCaptain

dc = DataCaptain(api_key="sdata_your_key_here")

# ETF screener
screen = dc.etf_screener(return_min=10, dividend_yield_min=2, period="1y")
print(screen["data"][:5])

# Heatmap
heatmap = dc.etf_heatmap(basket="broad", period="1y")

# Backtest
bt = dc.backtest_buy_and_hold(
    symbol="SPY",
    start_date="2015-01-01",
    end_date="2025-01-01",
    investment=10000,
)

# Portfolio rebalance
rebalance = dc.portfolio_rebalance(
    holdings=[{"symbol": "VOO", "shares": 63}, {"symbol": "QQQ", "shares": 37}],
    target=[{"symbol": "VOO", "weight": 60}, {"symbol": "QQQ", "weight": 40}],
    drift_threshold=2,
)
```

Get your API key at [datacaptain.in](https://www.datacaptain.in/auth/signup).
