CEX Ticker¶

Real-time ticker snapshots for centralized exchanges.

Usage¶

Sync

from datamaxi import Datamaxi

maxi = Datamaxi(api_key="YOUR_API_KEY")

exchanges = maxi.cex.ticker.exchanges(market="spot")
symbols = maxi.cex.ticker.symbols(exchange="binance", market="spot")

ticker = maxi.cex.ticker.get(
    exchange="binance",
    symbol="BTC-USDT",
    market="spot",
    currency="USD",
)

Async

import asyncio
from datamaxi.aio import AsyncDatamaxi


async def main():
    async with AsyncDatamaxi(api_key="YOUR_API_KEY") as client:
        exchanges = await client.cex.ticker.exchanges(market="spot")
        symbols = await client.cex.ticker.symbols(exchange="binance", market="spot")

        ticker = await client.cex.ticker.get(
            exchange="binance",
            symbol="BTC-USDT",
            market="spot",
            currency="USD",
        )


asyncio.run(main())

Notes¶

Use conversion_base when you need cross-currency conversions.
Set pandas=False to return the raw dict response.

Bases: Resource

Client to fetch ticker data from DataMaxi+ API.

Parameters:

api_key (str, default: None ) –

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

Keyword arguments used by datamaxi.api.API.

get ¶

get(
    exchange: str,
    symbol: str,
    market: Market,
    currency: Optional[str] = None,
    conversion_base: Optional[str] = None,
    include_source: bool = False,
    pandas: bool = True,
) -> Union[pd.DataFrame, TickerResponse]

Fetch ticker data

GET /api/v1/ticker

https://docs.datamaxiplus.com/rest/cex/ticker/data

Parameters:

exchange (str) –

Exchange name
symbol (str) –

Symbol name
market (str) –

Market type (spot/futures)
currency (str, default: None ) –

Price currency
conversion_base (str, default: None ) –

Conversion base currency
include_source (bool, default: False ) –

Include the frame's transport source (ws|rest) in the response
pandas (bool, default: True ) –

Return data as pandas DataFrame

Returns:

Union[DataFrame, TickerResponse] –

Ticker data in pandas DataFrame or dict response

exchanges ¶

exchanges(market: Market) -> List[str]

Fetch supported exchanges for ticker data.

GET /api/v1/ticker/exchanges

https://docs.datamaxiplus.com/rest/cex/ticker/exchanges

Parameters:

market (str) –

Market type (spot/futures)

Returns:

List[str] –

List of supported exchanges

symbols ¶

symbols(exchange: str, market: Market) -> List[str]

Fetch supported symbols for ticker data.

GET /api/v1/ticker/symbols

https://docs.datamaxiplus.com/rest/cex/ticker/symbols

Parameters:

exchange (str) –

Exchange name
market (str) –

Market type (spot/futures)

Returns:

List[str] –

List of supported symbols