CEX Ticker¶

Bases: API

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: str,
    currency: str = None,
    conversion_base: str = None,
    pandas: bool = True,
) -> Union[Dict, pd.DataFrame]

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)
pandas (bool, default: True ) –

Return data as pandas DataFrame

Returns:

Union[Dict, DataFrame] –

CexTicker data in pandas DataFrame

exchanges ¶

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

Fetch supported exchanges accepted by datamaxi.CexTicker.get API.

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 exchange

symbols ¶

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

Fetch supported symbols accepted by datamaxi.CexTicker.get API.

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