CEX Ticker¶
Real-time ticker snapshots for centralized exchanges.
Usage¶
from datamaxi import Datamaxi
maxi = Datamaxi(api_key="YOUR_API_KEY")
exchanges = maxi.cex.ticker.exchanges(market="spot")
symbols = maxi.cex.ticker.symbols(exchange="binance", market="spot")
ticker = maxi.cex.ticker.get(
exchange="binance",
symbol="BTC-USDT",
market="spot",
currency="USD",
)
Notes¶
- Use
conversion_basewhen you need cross-currency conversions. - Set
pandas=Falseto return the raw dict response.
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,
market: str,
currency: str = None,
conversion_base: str = None,
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
-
market(str) –Market type (spot/futures)
-
currency(str, default:None) –Price currency
-
conversion_base(str, default:None) –Conversion base currency
-
pandas(bool, default:True) –Return data as pandas DataFrame
Returns:
-
Union[Dict, DataFrame]–Ticker data in pandas DataFrame or dict response
exchanges
¶
exchanges(market: str) -> List[str]
Fetch supported exchanges for ticker data.
GET /api/v1/ticker/exchanges
https://docs.datamaxiplus.com/rest/cex/ticker/exchanges
Parameters:
-
market(str) –Market type (spot/futures)
Returns:
-
List[str]–List of supported exchanges
symbols
¶
symbols(exchange: str, market: str) -> List[str]
Fetch supported symbols for ticker data.
GET /api/v1/ticker/symbols
https://docs.datamaxiplus.com/rest/cex/ticker/symbols
Parameters:
-
exchange(str) –Exchange name
-
market(str) –Market type (spot/futures)
Returns:
-
List[str]–List of supported symbols