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.

__call__

__call__(
    source_exchange: str = None,
    target_exchange: str = None,
    asset: str = None,
    source_quote: str = None,
    target_quote: str = None,
    sort: str = None,
    key: str = None,
    page: int = 1,
    limit: int = 100,
    currency: str = None,
    pandas: bool = True,
) -> Union[List, pd.DataFrame]

Fetch premium data

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

Parameters:

• source_exchange (str, default: None ) –

  Source exchange name

• target_exchange (str, default: None ) –

  Target exchange name

• asset (str, default: None ) –

  Asset name

• source_quote (str, default: None ) –

  Source quote currency

• target_quote (str, default: None ) –

  Target quote currency

• currency (str, default: None ) –

  Currency applied to cross-exchange price differences

• sort (str, default: None ) –

  Sort data by asc or desc

• key (str, default: None ) –

  Key to sort data

• page (int, default: 1 ) –

  Page number

• limit (int, default: 100 ) –

  Page size

• 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/rest/Premium/exchanges

Returns:

• List[str] –

  List of supported exchange