Skip to content

Commit f8e5c9f

Browse files
docs: add Liquidation, OpenInterest, CexSymbol pages + nav (#110)
Document the three undocumented client surfaces (client.liquidation, client.open_interest, client.cex.symbol) with usage snippets derived from actual method signatures and mkdocstrings blocks. Add top-level Liquidation/Open Interest nav entries and Symbol under the CEX group. Closes #108
1 parent 0b157c9 commit f8e5c9f

4 files changed

Lines changed: 134 additions & 0 deletions

File tree

docs/cex-symbol.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# CEX Symbol
2+
3+
Per-base / per-symbol CEX metadata and aggregates: trading status, tags, cautions, delistings, volume, Open Interest, and liquidation.
4+
5+
## Usage
6+
7+
```python
8+
from datamaxi import Datamaxi
9+
10+
maxi = Datamaxi(api_key="YOUR_API_KEY")
11+
12+
# Trading status + caution + tags + delisting metadata
13+
metadata = maxi.cex.symbol.metadata(exchange="binance", base="BTC")
14+
15+
# Exchange-assigned tags (e.g. seed, alpha)
16+
tags = maxi.cex.symbol.tags(exchange="binance", base="BTC")
17+
18+
# Active caution / investment-warning flags
19+
cautions = maxi.cex.symbol.cautions(exchange="binance", base="BTC")
20+
21+
# Scheduled delistings with timestamps
22+
delistings = maxi.cex.symbol.delistings(exchange="binance", base="BTC")
23+
24+
# Per-exchange 24h volume for a single base asset
25+
volume = maxi.cex.symbol.volume(base="BTC", exchange="binance")
26+
27+
# Per-exchange Open Interest for a single base asset
28+
oi = maxi.cex.symbol.oi(base="BTC", exchange="binance")
29+
30+
# Per-exchange OI snapshot with 1h / 4h / 24h deltas
31+
oi_stats = maxi.cex.symbol.oi_stats(base="BTC", exchange="binance", currency="USD")
32+
33+
# Per-exchange long / short liquidation aggregates over a window
34+
liquidation = maxi.cex.symbol.liquidation(base="BTC", window="24h")
35+
```
36+
37+
## Notes
38+
39+
- `metadata`, `tags`, `cautions`, and `delistings` take optional `exchange` / `base` filters; omit both to fetch across all symbols.
40+
- `oi_stats` accepts `currency` of `USD` or `KRW`.
41+
42+
::: datamaxi.datamaxi.CexSymbol
43+
options:
44+
show_submodules: true
45+
show_source: false

docs/liquidation.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Liquidation
2+
3+
CEX futures liquidation data: recent events, firehose feed, heatmaps, maps, and bucketed history.
4+
5+
## Usage
6+
7+
```python
8+
from datamaxi import Datamaxi
9+
10+
maxi = Datamaxi(api_key="YOUR_API_KEY")
11+
12+
# Recent liquidation events for a single futures symbol
13+
events = maxi.liquidation(exchange="binance", symbol="BTC-USDT", limit=100)
14+
15+
# Firehose: most recent events across every symbol
16+
feed = maxi.liquidation.feed(limit=100)
17+
18+
# Token x exchange liquidation heatmap over a rolling window
19+
heatmap = maxi.liquidation.heatmap(window="1h", topN=10)
20+
21+
# Coinglass-style liquidation map (price x leverage tier)
22+
liq_map = maxi.liquidation.map(base="BTC", exchange="binance", quote="USDT")
23+
24+
# Bucketed long / short liquidation USD time series + price line
25+
history = maxi.liquidation.symbol_history(
26+
symbol="BTC",
27+
quote="USDT",
28+
exchange="binance",
29+
interval="5m",
30+
window="24h",
31+
)
32+
```
33+
34+
## Notes
35+
36+
- `heatmap` accepts `window` of `1h`, `4h`, or `24h`; `topN` must be between 1 and 30.
37+
- `symbol_history` accepts `interval` of `5m`, `15m`, or `1h` and `window` of `24h`, `72h`, or `7d`.
38+
39+
::: datamaxi.datamaxi.Liquidation
40+
options:
41+
show_submodules: true
42+
show_source: false

docs/open-interest.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Open Interest
2+
3+
CEX futures Open Interest: latest snapshots, reporting pairs, the token x exchange matrix, top-line aggregates, and aggregated history.
4+
5+
## Usage
6+
7+
```python
8+
from datamaxi import Datamaxi
9+
10+
maxi = Datamaxi(api_key="YOUR_API_KEY")
11+
12+
# Latest OI snapshot for a single futures symbol
13+
snapshot = maxi.open_interest(exchange="binance", symbol="BTC-USDT")
14+
15+
# List all (exchange, symbol) pairs currently reporting OI
16+
pairs = maxi.open_interest.list(exchange="binance")
17+
18+
# Paginated token x exchange OI matrix
19+
overview = maxi.open_interest.overview(
20+
page=1,
21+
limit=20,
22+
key="binance",
23+
sort="desc",
24+
)
25+
26+
# Top-line OI aggregates (total USD, top tokens, top exchanges)
27+
summary = maxi.open_interest.summary(topN=10)
28+
29+
# Per-exchange aggregated OI history for a single token
30+
history = maxi.open_interest.history_aggregated(
31+
token_id="bitcoin",
32+
interval="1h",
33+
)
34+
```
35+
36+
## Notes
37+
38+
- `overview` requires `sort` to be `asc` or `desc`; `summary` accepts `topN` between 1 and 30.
39+
- `history_aggregated` uses the token id (e.g. `bitcoin`), not a ticker, and accepts `interval` of `5m`, `15m`, `1h`, `4h`, or `1d`. Pass `from_` / `to` as unix-ms (`from_` maps to the wire param `from`).
40+
41+
::: datamaxi.datamaxi.OpenInterest
42+
options:
43+
show_submodules: true
44+
show_source: false

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,10 @@ nav:
3838
- Wallet Status: cex-wallet-status.md
3939
- Announcement: cex-announcement.md
4040
- Token: cex-token.md
41+
- Symbol: cex-symbol.md
4142
- Funding Rate: funding-rate.md
43+
- Liquidation: liquidation.md
44+
- Open Interest: open-interest.md
4245
- Premium: premium.md
4346
- Forex: forex.md
4447
- Naver Trend: naver-trend.md

0 commit comments

Comments
 (0)