Skip to content

Premium

Bases: API

Client to fetch premium 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(
    sort: str = None,
    limit: int = None,
    symbol: str = None,
    sourceExchange: str = None,
    targetExchange: str = None,
    pandas: bool = True,
) -> Union[List, pd.DataFrame]

Fetch premium data

GET /api/v1/premium https://docs.datamaxiplus.com/api/datasets/premium/premium

Parameters:

  • sort (str, default: None ) –

    Sort data by asc or desc

  • limit (int, default: None ) –

    Limit number of data to return

  • symbol (str, default: None ) –

    Symbol name

  • sourceExchange (str, default: None ) –

    Source exchange name

  • targetExchange (str, default: None ) –

    Target exchange name

  • pandas (bool, default: True ) –

    Return data as pandas DataFrame

Returns:

  • Union[List, DataFrame] –

    Premium data in pandas DataFrame

exchanges 

exchanges() -> List[str]

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

GET /api/v1/Premium/exchanges

https://docs.datamaxiplus.com/api/datasets/Premium/exchanges

Returns:

  • List[str] –

    List of supported exchange

symbols 

symbols(
    sourceExchange: str, targetExchange: str
) -> List[str]

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

GET /api/v1/premium/symbols

https://docs.datamaxiplus.com/api/datasets/premium/symbols

Parameters:

  • sourceExchange (str) –

    Source exchange name

  • targetExchange (str) –

    Target exchange name

Returns:

  • List[str] –

    List of supported symbols