Premium¶

Cross-exchange premium data for arbitrage and market dislocation analysis.

Usage¶

Sync

from datamaxi import Datamaxi

maxi = Datamaxi(api_key="YOUR_API_KEY")

exchanges = maxi.premium.exchanges()

data = maxi.premium(
    source_exchange="binance",
    target_exchange="upbit",
    asset="BTC",
    source_market="spot",
    target_market="spot",
    sort="desc",
    key="pdp",
    limit=100,
)

Async

import asyncio
from datamaxi.aio import AsyncDatamaxi


async def main():
    async with AsyncDatamaxi(api_key="YOUR_API_KEY") as client:
        exchanges = await client.premium.exchanges()

        data = await client.premium(
            source_exchange="binance",
            target_exchange="upbit",
            asset="BTC",
            source_market="spot",
            target_market="spot",
            sort="desc",
            key="pdp",
            limit=100,
        )


asyncio.run(main())

Notes¶

Use min_/max_ filters to narrow price difference, volume, and funding data.
Set pandas=False to return the raw list response.

Bases: Resource

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: Optional[str] = None,
    target_exchange: Optional[str] = None,
    asset: Optional[str] = None,
    source_quote: Optional[str] = None,
    target_quote: Optional[str] = None,
    sort: Optional[SortOrder] = None,
    key: Optional[str] = None,
    page: int = 1,
    limit: int = 100,
    currency: Optional[str] = None,
    conversion_base: Optional[str] = None,
    min_sv: Optional[str] = None,
    min_tv: Optional[str] = None,
    source_market: Optional[Market] = None,
    target_market: Optional[Market] = None,
    only_transferable: bool = False,
    network: Optional[str] = None,
    premium_type: Optional[str] = None,
    token_include: Optional[str] = None,
    token_exclude: Optional[str] = None,
    query: Optional[str] = None,
    pandas: bool = True,
) -> Union[pd.DataFrame, PremiumResponse]

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_sv (str, default: None ) –

Return results with 24h volume in fiat on source exchange above min_sv
min_tv (str, default: None ) –

Return results with 24h volume in fiat on target exchange above min_tv
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
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
query (str, default: None ) –

Search query for filtering assets
pandas (bool, default: True ) –

Return data as pandas DataFrame

Returns:

Union[DataFrame, PremiumResponse] –

Premium data in pandas DataFrame

exchanges ¶

exchanges() -> List[str]

Fetch supported exchanges for premium data.

GET /api/v1/premium/exchanges

https://docs.datamaxiplus.com/rest/premium/exchanges