DEX Trade¶
Bases: API
Client to fetch DEX trade 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(
chain: str,
exchange: str,
pool: str,
page: int = 1,
limit: int = 1000,
fromDateTime: str = None,
toDateTime: str = None,
sort: str = "desc",
pandas: bool = True,
) -> Union[
Tuple[Dict, Callable], Tuple[pd.DataFrame, Callable]
]
Fetch DEX trade data
GET /api/v1/dex/trade
https://docs.datamaxiplus.com/api/datasets/dex-trade/trade
Parameters:
-
chain
(str
) –Chain name
-
exchange
(str
) –Exchange name
-
pool
(str
) –Pool name
-
page
(int
, default:1
) –Page number
-
limit
(int
, default:1000
) –Limit of data
-
fromDateTime
(str
, default:None
) –Start date and time (accepts format "2006-01-02 15:04:05" or "2006-01-02")
-
toDateTime
(str
, default:None
) –End date and time (accepts format "2006-01-02 15:04:05" or "2006-01-02")
-
sort
(str
, default:'desc'
) –Sort order
-
pandas
(bool
, default:True
) –Return data as pandas DataFrame
Returns:
-
Union[Tuple[Dict, Callable], Tuple[DataFrame, Callable]]
–DEX trade data in pandas DataFrame and next request function
chains
¶
chains() -> List[str]
Fetch supported chains accepted by datamaxi.DexTrade.get API.
GET /api/v1/dex/trade/chains
https://docs.datamaxiplus.com/api/datasets/dex-trade/chains
Returns:
-
List[str]
–List of supported chains
exchanges
¶
exchanges() -> List[str]
Fetch supported exchanges accepted by datamaxi.DexTrade.get API.
GET /api/v1/dex/trade/exchanges
https://docs.datamaxiplus.com/api/datasets/dex-trade/exchanges
Returns:
-
List[str]
–List of supported exchanges
pools
¶
pools(
exchange: str = None, chain: str = None
) -> List[Dict]
Fetch supported pools accepted by datamaxi.DexTrade.get API.
GET /api/v1/dex/trade/pools
https://docs.datamaxiplus.com/api/datasets/dex-trade/pools
Parameters:
-
exchange
(str
, default:None
) –Exchange name
-
chain
(str
, default:None
) –Chain name
Returns:
-
List[Dict]
–List of supported pools