CEX Ticker¶
Bases: API
Client to fetch ticker 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(
exchange: str, symbol: str, pandas: bool = True
) -> Union[Dict, pd.DataFrame]
Fetch ticker data
GET /api/v1/ticker
https://docs.datamaxiplus.com/rest/cex/ticker/data
Parameters:
-
exchange
(str
) –Exchange name
-
symbol
(str
) –Symbol name
-
pandas
(bool
, default:True
) –Return data as pandas DataFrame
Returns:
-
Union[Dict, DataFrame]
–CexTicker data in pandas DataFrame
exchanges
¶
exchanges() -> List[str]
Fetch supported exchanges accepted by datamaxi.CexTicker.get API.
GET /api/v1/ticker/exchanges
https://docs.datamaxiplus.com/rest/cex/ticker/exchanges
Returns:
-
List[str]
–List of supported exchange
symbols
¶
symbols(exchange: str) -> List[str]
Fetch supported symbols accepted by datamaxi.CexTicker.get API.
GET /api/v1/ticker/symbols
https://docs.datamaxiplus.com/rest/cex/ticker/symbols
Parameters:
-
exchange
(str
) –Exchange name
Returns:
-
List[str]
–List of supported symbols