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,
    conversion_base: str = None,
    min_pd: str = None,
    max_pd: str = None,
    min_pdp: str = None,
    max_pdp: str = None,
    min_pdp24h: str = None,
    max_pdp24h: str = None,
    min_pdp4h: str = None,
    max_pdp4h: str = None,
    min_pdp1h: str = None,
    max_pdp1h: str = None,
    min_pdp30m: str = None,
    max_pdp30m: str = None,
    min_pdp15m: str = None,
    max_pdp15m: str = None,
    min_pdp5m: str = None,
    max_pdp5m: str = None,
    min_dsp: str = None,
    max_dsp: str = None,
    min_dtp: str = None,
    max_dtp: str = None,
    min_spdp24h: str = None,
    max_spdp24h: str = None,
    min_spdp4h: str = None,
    max_spdp4h: str = None,
    min_spdp1h: str = None,
    max_spdp1h: str = None,
    min_spdp30m: str = None,
    max_spdp30m: str = None,
    min_spdp15m: str = None,
    max_spdp15m: str = None,
    min_spdp5m: str = None,
    max_spdp5m: str = None,
    min_sv: str = None,
    max_sv: str = None,
    min_tv: str = None,
    max_tv: str = None,
    min_net_funding_rate: str = None,
    max_net_funding_rate: str = None,
    min_source_funding_rate: str = None,
    max_source_funding_rate: str = None,
    min_target_funding_rate: str = None,
    max_target_funding_rate: str = None,
    source_market: str = None,
    target_market: str = None,
    only_transferable: bool = False,
    network: str = None,
    source_funding_rate_interval: str = None,
    target_funding_rate_interval: str = None,
    premium_type: str = None,
    token_include: str = None,
    token_exclude: 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

• 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

• currency (str, default: None ) –

  Currency applied to cross-exchange price differences

• conversion_base (str, default: None ) –

  conversion base for price difference calculation

• min_pd (str, default: None ) –

  Return results with price difference in USD above min_pd

• max_pd (str, default: None ) –

  Return results with price difference in USD below max_pd

• min_pdp (str, default: None ) –

  Return results with price difference percentage above min_pdp

• max_pdp (str, default: None ) –

  Return results with price difference percentage below max_pdp

• min_pdp24h (str, default: None ) –

  Return results with price difference percentage from 24h ago above min_pdp24h

• max_pdp24h (str, default: None ) –

  Return results with price difference percentage from 24h ago below max_pdp24h

• min_pdp4h (str, default: None ) –

  Return results with price difference percentage from 4h ago above min_pdp4h

• max_pdp4h (str, default: None ) –

  Return results with price difference percentage from 4h ago below max_pdp4h

• min_pdp1h (str, default: None ) –

  Return results with price difference percentage from 1h ago above min_pdp1h

• max_pdp1h (str, default: None ) –

  Return results with price difference percentage from 1h ago below max_pdp1h

• min_pdp30m (str, default: None ) –

  Return results with price difference percentage from 30m ago above min_pdp30m

• max_pdp30m (str, default: None ) –

  Return results with price difference percentage from 30m ago below max_pdp30m

• min_pdp15m (str, default: None ) –

  Return results with price difference percentage from 15m ago above min_pdp15m

• max_pdp15m (str, default: None ) –

  Return results with price difference percentage from 15m ago below max_pdp15m

• min_pdp5m (str, default: None ) –

  Return results with price difference percentage from 5m ago above min_pdp5m

• max_pdp5m (str, default: None ) –

  Return results with price difference percentage from 5m ago below max_pdp5m

• min_dsp (str, default: None ) –

  Return results with price in fiat on source exchange above min_dsp

• max_dsp (str, default: None ) –

  Return results with price in fiat on source exchange below max_dsp

• min_dtp (str, default: None ) –

  Return results with price in fiat on target exchange above min_dtp

• max_dtp (str, default: None ) –

  Return results with price in fiat on target exchange below max_dtp

• min_spdp24h (str, default: None ) –

  Return results with price difference percentage (between now and 24h ago on source exchange) above min_spdp24h

• max_spdp24h (str, default: None ) –

  Return results with price difference percentage (between now and 24h ago on source exchange) below max_spdp24h

• min_spdp4h (str, default: None ) –

  Return results with price difference percentage (between now and 4h ago on source exchange) above min_spdp4h

• max_spdp4h (str, default: None ) –

  Return results with price difference percentage (between now and 4h ago on source exchange) below max_spdp4h

• min_spdp1h (str, default: None ) –

  Return results with price difference percentage (between now and 1h ago on source exchange) above min_spdp1h

• max_spdp1h (str, default: None ) –

  Return results with price difference percentage (between now and 1h ago on source exchange) below max_spdp1h

• min_spdp30m (str, default: None ) –

  Return results with price difference percentage (between now and 30m ago on source exchange) above min_spdp30m

• max_spdp30m (str, default: None ) –

  Return results with price difference percentage (between now and 30m ago on source exchange) below max_spdp30m

• min_spdp15m (str, default: None ) –

  Return results with price difference percentage (between now and 15m ago on source exchange) above min_spdp15m

• max_spdp15m (str, default: None ) –

  Return results with price difference percentage (between now and 15m ago on source exchange) below max_spdp15m

• min_spdp5m (str, default: None ) –

  Return results with price difference percentage (between now and 5m ago on source exchange) above min_spdp5m

• max_spdp5m (str, default: None ) –

  Return results with price difference percentage (between now and 5m ago on source exchange) below max_spdp5m

• min_sv (str, default: None ) –

  Return results with 24h volume in fiat on source exchange above min_sv

• max_sv (str, default: None ) –

  Return results with 24h volume in fiat on source exchange below max_sv

• min_tv (str, default: None ) –

  Return results with 24h volume in fiat on target exchange above min_tv

• max_tv (str, default: None ) –

  Return results with 24h volume in fiat on target exchange below max_tv

• min_net_funding_rate (str, default: None ) –

  Return results with net funding rate above min_net_funding_rate

• max_net_funding_rate (str, default: None ) –

  Return results with net funding rate below max_net_funding_rate

• min_source_funding_rate (str, default: None ) –

  Return results with source funding rate above min_source_funding_rate

• max_source_funding_rate (str, default: None ) –

  Return results with source funding rate below max_source_funding_rate

• min_target_funding_rate (str, default: None ) –

  Return results with target funding rate above min_target_funding_rate

• max_target_funding_rate (str, default: None ) –

  Return results with target funding rate below max_target_funding_rate

• source_market (str, default: None ) –

  Return results matching source market

• target_market (str, default: None ) –

  Return results matching target market

• only_transferable (bool, default: False ) –

  Return only transferable if set true

• network (str, default: None ) –

  Return results containing only specified network

• source_funding_rate_interval (str, default: None ) –

  Return results with min source funding rate interval

• target_funding_rate_interval (str, default: None ) –

  Return results with min target funding rate interval

• premium_type (str, default: None ) –

  Return based on matching premium_type

• token_include (str, default: None ) –

  Return results containing only specified token

• token_exclude (str, default: None ) –

  Return results not containing specified token

• 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