pub struct Market<'a, T> { /* private fields */ }Expand description
Accessor for the public market-data endpoints.
Obtain one via OkxClient::market.
Implementations§
Source§impl<'a, T: Transport> Market<'a, T>
impl<'a, T: Transport> Market<'a, T>
Sourcepub async fn get_ticker(
&self,
request: &InstIdRequest<'_>,
) -> Result<Vec<Ticker>, Error>
pub async fn get_ticker( &self, request: &InstIdRequest<'_>, ) -> Result<Vec<Ticker>, Error>
Retrieve the latest ticker for a single instrument.
GET /api/v5/market/ticker. Public (unauthenticated). The returned
vector contains exactly one Ticker.
§Errors
Returns RestError::Okx on a non-zero OKX code, or
RestError::Transport/RestError::Decode on transport/parsing failure.
Sourcepub async fn get_tickers(
&self,
request: &TickersRequest<'_>,
) -> Result<Vec<Ticker>, Error>
pub async fn get_tickers( &self, request: &TickersRequest<'_>, ) -> Result<Vec<Ticker>, Error>
Retrieve tickers for an instrument type.
GET /api/v5/market/tickers. Public. underlying and inst_family
are useful for derivatives and omitted when None.
§Errors
See get_ticker.
Sourcepub async fn get_index_tickers(
&self,
request: &IndexTickersRequest<'_>,
) -> Result<Vec<IndexTicker>, Error>
pub async fn get_index_tickers( &self, request: &IndexTickersRequest<'_>, ) -> Result<Vec<IndexTicker>, Error>
Retrieve index tickers.
GET /api/v5/market/index-tickers. Public. Filter by quote currency,
index instrument ID, or neither.
§Errors
See get_ticker.
Sourcepub async fn get_orderbook(
&self,
request: &OrderBookRequest<'_>,
) -> Result<Vec<OrderBook>, Error>
pub async fn get_orderbook( &self, request: &OrderBookRequest<'_>, ) -> Result<Vec<OrderBook>, Error>
Retrieve the order book for an instrument.
GET /api/v5/market/books. depth is the number of levels per side
(OKX default 1, max 400). Public.
§Errors
See get_ticker.
Sourcepub async fn get_candlesticks(
&self,
request: &CandlesRequest<'_>,
) -> Result<Vec<Candle>, Error>
pub async fn get_candlesticks( &self, request: &CandlesRequest<'_>, ) -> Result<Vec<Candle>, Error>
Retrieve candlestick (OHLCV) data.
GET /api/v5/market/candles. bar is the bar size, e.g. 1m, 1H,
1D (OKX default 1m). limit caps the number of bars (max 300).
Public.
§Errors
See get_ticker.
Sourcepub async fn get_history_candlesticks(
&self,
request: &CandlesticksRequest<'_>,
) -> Result<Vec<Candle>, Error>
pub async fn get_history_candlesticks( &self, request: &CandlesticksRequest<'_>, ) -> Result<Vec<Candle>, Error>
Retrieve historical candlestick data for top currencies.
GET /api/v5/market/history-candles. Public.
§Errors
See get_ticker.
Sourcepub async fn get_index_candlesticks(
&self,
request: &CandlesticksRequest<'_>,
) -> Result<Vec<IndexCandle>, Error>
pub async fn get_index_candlesticks( &self, request: &CandlesticksRequest<'_>, ) -> Result<Vec<IndexCandle>, Error>
Sourcepub async fn get_mark_price_candlesticks(
&self,
request: &CandlesticksRequest<'_>,
) -> Result<Vec<IndexCandle>, Error>
pub async fn get_mark_price_candlesticks( &self, request: &CandlesticksRequest<'_>, ) -> Result<Vec<IndexCandle>, Error>
Retrieve mark-price candlestick data.
GET /api/v5/market/mark-price-candles. Public.
§Errors
See get_ticker.
Sourcepub async fn get_trades(
&self,
request: &TradesRequest<'_>,
) -> Result<Vec<MarketTrade>, Error>
pub async fn get_trades( &self, request: &TradesRequest<'_>, ) -> Result<Vec<MarketTrade>, Error>
Retrieve recent trades for an instrument.
GET /api/v5/market/trades. Public.
§Errors
See get_ticker.
Sourcepub async fn get_history_trades(
&self,
request: &HistoryTradesRequest<'_>,
) -> Result<Vec<MarketTrade>, Error>
pub async fn get_history_trades( &self, request: &HistoryTradesRequest<'_>, ) -> Result<Vec<MarketTrade>, Error>
Retrieve historical trades for an instrument.
GET /api/v5/market/history-trades. Public.
§Errors
See get_ticker.
Sourcepub async fn get_platform_24_volume(&self) -> Result<Vec<PlatformVolume>, Error>
pub async fn get_platform_24_volume(&self) -> Result<Vec<PlatformVolume>, Error>
Retrieve OKX platform 24-hour volume.
GET /api/v5/market/platform-24-volume. Public.
§Errors
See get_ticker.
Sourcepub async fn get_index_components(
&self,
request: &IndexRequest<'_>,
) -> Result<Vec<IndexComponents>, Error>
pub async fn get_index_components( &self, request: &IndexRequest<'_>, ) -> Result<Vec<IndexComponents>, Error>
Sourcepub async fn get_exchange_rate(&self) -> Result<Vec<ExchangeRate>, Error>
pub async fn get_exchange_rate(&self) -> Result<Vec<ExchangeRate>, Error>
Retrieve the USD/CNY exchange rate used by OKX.
GET /api/v5/market/exchange-rate. Public.
§Errors
See get_ticker.
Sourcepub async fn get_block_ticker(
&self,
request: &InstIdRequest<'_>,
) -> Result<Vec<BlockTicker>, Error>
pub async fn get_block_ticker( &self, request: &InstIdRequest<'_>, ) -> Result<Vec<BlockTicker>, Error>
Retrieve a block-trading ticker for a single instrument.
GET /api/v5/market/block-ticker. Public.
§Errors
See get_ticker.
Sourcepub async fn get_block_tickers(
&self,
request: &TickersRequest<'_>,
) -> Result<Vec<BlockTicker>, Error>
pub async fn get_block_tickers( &self, request: &TickersRequest<'_>, ) -> Result<Vec<BlockTicker>, Error>
Retrieve block-trading tickers for an instrument type.
GET /api/v5/market/block-tickers. Public.
§Errors
See get_ticker.
Sourcepub async fn get_option_instrument_family_trades(
&self,
request: &InstFamilyRequest<'_>,
) -> Result<Vec<OptionFamilyTradeGroup>, Error>
pub async fn get_option_instrument_family_trades( &self, request: &InstFamilyRequest<'_>, ) -> Result<Vec<OptionFamilyTradeGroup>, Error>
Retrieve option trades aggregated by instrument family.
GET /api/v5/market/option/instrument-family-trades. Public.
§Errors
See get_ticker.