Metadata-Version: 2.4
Name: depthy-python
Version: 0.1.0
Summary: Python SDK for Depthy — real-time crypto liquidity intelligence
Project-URL: Homepage, https://depthy.io
Project-URL: Documentation, https://depthy.io/api-docs
Project-URL: Repository, https://github.com/depthy-io/depthy-python
Author-email: Depthy <hello@depthy.io>
License-Expression: MIT
License-File: LICENSE
Keywords: crypto,hyperliquid,liquidity,order-book,polymarket,sdk
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Office/Business :: Financial
Requires-Python: >=3.10
Requires-Dist: httpx>=0.24.0
Description-Content-Type: text/markdown

# Depthy Python SDK

Python client for the [Depthy](https://depthy.io) API — real-time crypto order book depth, liquidity walls, liquidation clusters, and Polymarket signals.

## Install

```bash
pip install depthy-python
```

## Quick Start

```python
from depthy import DepthyClient

client = DepthyClient(api_key="dk_live_your_key_here")

# List available symbols
symbols = client.list_symbols()

# Order book depth
depth = client.get_depth("BTC")

# Liquidity walls
walls = client.get_walls("ETH", min_size_usd=200000)

# Liquidation clusters
clusters = client.get_liquidation_clusters("SOL")

# Market overview
market = client.get_market("BTC")

# Open interest changes
oi = client.get_oi_change("BTC")

# Compare multiple symbols (Pro key required)
comparison = client.compare_symbols(["BTC", "ETH", "SOL"])
```

## Async Usage

```python
from depthy import AsyncDepthyClient

async with AsyncDepthyClient(api_key="dk_live_your_key_here") as client:
    depth = await client.get_depth("BTC")
    walls = await client.get_walls("ETH")
```

## Polymarket

```python
# Active prediction markets
markets = client.list_pm_markets(market_type="crypto_15m")

# Smart-money signals
signals = client.get_pm_signals(limit=10)

# Top wallets by profit
wallets = client.get_pm_top_wallets(limit=5)
```

## Error Handling

```python
from depthy import DepthyClient, AuthError, RateLimitError, NotFoundError

client = DepthyClient(api_key="dk_live_...")

try:
    depth = client.get_depth("BTC")
except AuthError:
    print("Check your API key")
except RateLimitError:
    print("Slow down — free tier: 30 req/min")
except NotFoundError:
    print("Symbol not found")
```

## API Methods

| Method | Description | Free Tier |
|---|---|---|
| `list_symbols()` | List tradable symbols | Yes |
| `get_depth(symbol)` | Order book depth & imbalance | Yes (T1) |
| `get_depth_recent(symbol)` | Depth snapshots over time | Yes (T1) |
| `get_walls(symbol)` | Large resting orders | Yes (T1) |
| `get_liquidation_clusters(symbol)` | Liquidation risk zones | Yes (T1) |
| `get_market(symbol)` | Price, volume, funding, OI | Yes (T1) |
| `get_oi_change(symbol)` | Open interest changes | Yes |
| `compare_symbols(symbols)` | Multi-symbol comparison | Pro+ |
| `list_pm_markets()` | Polymarket markets | Yes |
| `get_pm_signals()` | Smart-money signals | Yes |
| `get_pm_top_wallets()` | Top wallets by profit | Yes |

## Get an API Key

Sign up for a free key at [depthy.io](https://depthy.io).

## Links

- [MCP Server](https://github.com/depthy-io/depthy-mcp) — For Claude Desktop, Cursor, etc.
- [API Docs](https://depthy.io/api-docs) — Full endpoint reference

## License

MIT
