Skip to content

CEX Candle

Bases: API

Client to fetch CEX candle data from DataMaxi+ API.

Parameters:

  • api_key (str, default: None ) –

    The DataMaxi+ API key

  • **kwargs (Any, default: {} ) –

    Keyword arguments used by datamaxi.api.API.

__call__ 

__call__(
    exchange: str,
    market: str,
    symbol: str,
    interval: str = INTERVAL_1D,
    from_unix: str = None,
    to_unix: str = None,
    currency: str = USD,
    pandas: bool = True,
) -> Union[
    Tuple[Dict, Callable], Tuple[pd.DataFrame, Callable]
]

Fetch candle data

GET /api/v1/cex/candle

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

Parameters:

  • exchange (str) –

    Exchange name

  • market (str) –

    Market type (spot/futures)

  • symbol (str) –

    Symbol name

  • interval (str, default: INTERVAL_1D ) –

    Candle interval

  • from_unix (str, default: None ) –

    Start time in Unix timestamp

  • to_unix (str, default: None ) –

    End time in Unix timestamp

  • currency (str, default: USD ) –

    Currency

  • pandas (bool, default: True ) –

    Return data as pandas DataFrame

Returns:

  • Union[Tuple[Dict, Callable], Tuple[DataFrame, Callable]] –

    Candle data in pandas DataFrame and next request function

exchanges 

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

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

GET /api/v1/cex/candle/exchanges

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

Parameters:

  • market (str) –

    Market type (spot/futures)

Returns:

  • List[str] –

    List of supported exchanges

symbols 

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

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

GET /api/v1/cex/candle/symbols

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

Parameters:

  • exchange (str, default: None ) –

    Exchange name

  • market (str, default: None ) –

    Market type (spot/futures)

Returns:

  • List[Dict] –

    List of supported symbols

intervals 

intervals() -> List[str]

Fetch supported intervals accepted by datamaxi.CexCandle.get API.

GET /api/v1/candle/intervals

https://docs.datamaxiplus.com/rest/cex/candle/intervals

Returns:

  • List[str] –

    List of supported intervals