CEX Symbol¶

Per-base / per-symbol CEX metadata and aggregates: trading status, tags, cautions, delistings, volume, Open Interest, and liquidation.

Usage¶

Sync

from datamaxi import Datamaxi

maxi = Datamaxi(api_key="YOUR_API_KEY")

# Trading status + caution + tags + delisting metadata
metadata = maxi.cex.symbol.metadata(exchange="binance", base="BTC")

# Exchange-assigned tags (e.g. seed, alpha)
tags = maxi.cex.symbol.tags(exchange="binance", base="BTC")

# Active caution / investment-warning flags
cautions = maxi.cex.symbol.cautions(exchange="binance")

# Scheduled delistings with timestamps
delistings = maxi.cex.symbol.delistings(exchange="binance")

# Per-exchange 24h volume for a single base asset
volume = maxi.cex.symbol.volume(base="BTC")

# Per-exchange Open Interest for a single base asset
oi = maxi.cex.symbol.oi(base="BTC", exchange="binance")

# Per-exchange OI snapshot with 1h / 4h / 24h deltas
oi_stats = maxi.cex.symbol.oi_stats(base="BTC", exchange="binance", currency="USD")

# Per-exchange long / short liquidation aggregates over a window
liquidation = maxi.cex.symbol.liquidation(base="BTC", window="24h")

Async

import asyncio
from datamaxi.aio import AsyncDatamaxi


async def main():
    async with AsyncDatamaxi(api_key="YOUR_API_KEY") as client:
        # Trading status + caution + tags + delisting metadata
        metadata = await client.cex.symbol.metadata(exchange="binance", base="BTC")

        # Exchange-assigned tags (e.g. seed, alpha)
        tags = await client.cex.symbol.tags(exchange="binance", base="BTC")

        # Active caution / investment-warning flags
        cautions = await client.cex.symbol.cautions(exchange="binance")

        # Scheduled delistings with timestamps
        delistings = await client.cex.symbol.delistings(exchange="binance")

        # Per-exchange 24h volume for a single base asset
        volume = await client.cex.symbol.volume(base="BTC")

        # Per-exchange Open Interest for a single base asset
        oi = await client.cex.symbol.oi(base="BTC", exchange="binance")

        # Per-exchange OI snapshot with 1h / 4h / 24h deltas
        oi_stats = await client.cex.symbol.oi_stats(base="BTC", exchange="binance", currency="USD")

        # Per-exchange long / short liquidation aggregates over a window
        liquidation = await client.cex.symbol.liquidation(base="BTC", window="24h")


asyncio.run(main())

Notes¶

metadata and tags take optional exchange / base filters; cautions and delistings filter by exchange (and market). Omit filters to fetch across all symbols.
oi_stats accepts currency of USD or KRW.

Bases: Resource

Client to fetch per-base / per-symbol CEX metadata + aggregates.

Parameters:

api_key (str, default: None ) –

The DataMaxi+ API key
**kwargs (Any, default: {} ) –

Keyword arguments used by datamaxi.api.API.

metadata ¶

metadata(
    exchange: Optional[str] = None,
    base: Optional[str] = None,
    market: Optional[str] = None,
    quote: Optional[str] = None,
    status: Optional[str] = None,
) -> Dict[str, Any]

Trading status + caution + tags + delisting metadata.

GET /api/v1/cex/symbol/metadata

Parameters:

exchange (str, default: None ) –

Comma-separated exchange names (empty = all).
base (str, default: None ) –

Base asset filter.
market (str, default: None ) –

spot or futures (empty = both).
quote (str, default: None ) –

Quote asset filter.
status (str, default: None ) –

trading_status filter (comma-separated).

tags ¶

tags(
    exchange: Optional[str] = None,
    base: Optional[str] = None,
    tag: Optional[str] = None,
    market: Optional[str] = None,
    source: Optional[str] = None,
    min_confidence: Optional[int] = None,
) -> Dict[str, Any]

Exchange-assigned tags (e.g. seed, alpha) per symbol.

GET /api/v1/cex/symbol/tags

Parameters:

exchange (str, default: None ) –

Exchange filter (comma-separated).
base (str, default: None ) –

Base asset filter.
tag (str, default: None ) –

Tag filter (comma-separated).
market (str, default: None ) –

spot or futures.
source (str, default: None ) –

Tag source filter (rest_native, announcement, cmc, manual).
min_confidence (int, default: None ) –

Minimum confidence (0-100).

cautions ¶

cautions(
    exchange: Optional[str] = None,
    market: Optional[str] = None,
    min_level: Optional[str] = None,
    active_only: Optional[bool] = None,
) -> Dict[str, Any]

Active caution / investment-warning flags per symbol.

GET /api/v1/cex/symbol/cautions

Parameters:

exchange (str, default: None ) –

Exchange filter (comma-separated, empty = all).
market (str, default: None ) –

spot or futures.
min_level (str, default: None ) –

Minimum severity (caution, warning, danger).
active_only (bool, default: None ) –

Exclude rows whose end_at is in the past.

delistings ¶

delistings(
    exchange: Optional[str] = None,
    market: Optional[str] = None,
    from_ms: Optional[int] = None,
    to_ms: Optional[int] = None,
    include_past: Optional[bool] = None,
) -> Dict[str, Any]

Scheduled delistings with timestamps.

GET /api/v1/cex/symbol/delistings

Parameters:

exchange (str, default: None ) –

Exchange filter (comma-separated).
market (str, default: None ) –

spot or futures.
from_ms (int, default: None ) –

Lower bound for delisting_at (ms epoch).
to_ms (int, default: None ) –

Upper bound for delisting_at (ms epoch).
include_past (bool, default: None ) –

Include already-delisted rows.

volume ¶

volume(
    base: str, market: Optional[str] = None
) -> Dict[str, Any]

Per-exchange 24h volume for a single base asset.

GET /api/v1/cex/symbol/volume

Parameters:

base (str) –

Base asset (e.g. BTC).
market (str, default: None ) –

Filter to spot or futures.

oi ¶

oi(
    base: str, exchange: Optional[str] = None
) -> Dict[str, Any]

Per-exchange Open Interest for a single base asset.

GET /api/v1/cex/symbol/oi

oi_stats ¶

oi_stats(
    base: str,
    exchange: Optional[str] = None,
    currency: str = "USD",
) -> Dict[str, Any]

Per-exchange OI snapshot with 1h / 4h / 24h deltas.

GET /api/v1/cex/symbol/oi-stats

Parameters:

base (str) –

Base asset (e.g. BTC).
exchange (str, default: None ) –

Optional single-exchange filter.
currency (str, default: 'USD' ) –

USD or KRW.

liquidation ¶

liquidation(
    base: str, window: str = "24h"
) -> Dict[str, Any]

Per-exchange long / short liquidation aggregates over a window.

GET /api/v1/cex/symbol/liquidation

Parameters:

base (str) –

Base asset (e.g. BTC).
window (str, default: '24h' ) –

Time window (1h, 24h, 7d — server caps at 30d).