Skip to main content

Market

rust_okx::api::market

Struct Market 

Source 
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>

Source

pub async fn get_ticker(&self, inst_id: &str) -> 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 Error::Api on a non-zero OKX code, or Error::Transport/Error::Decode on transport/parsing failure.

Source

pub async fn get_tickers( &self, inst_type: InstType, inst_family: Option<&str>, ) -> 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.

Source

pub async fn get_index_tickers( &self, quote_ccy: Option<&str>, inst_id: Option<&str>, ) -> 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.

Source

pub async fn get_orderbook( &self, inst_id: &str, depth: Option<u32>, ) -> 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.

Source

pub async fn get_order_lite_book( &self, inst_id: &str, ) -> Result<Vec<OrderBook>, Error>

Retrieve the lightweight order book for an instrument.

GET /api/v5/market/books-lite. Public.

§Errors

See get_ticker.

Source

pub async fn get_candlesticks( &self, inst_id: &str, bar: Option<&str>, limit: Option<u32>, ) -> 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.

Source

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.

Source

pub async fn get_index_candlesticks( &self, request: &CandlesticksRequest, ) -> Result<Vec<Candle>, Error>

Retrieve index candlestick data.

GET /api/v5/market/index-candles. Public.

§Errors

See get_ticker.

Source

pub async fn get_mark_price_candlesticks( &self, request: &CandlesticksRequest, ) -> Result<Vec<Candle>, Error>

Retrieve mark-price candlestick data.

GET /api/v5/market/mark-price-candles. Public.

§Errors

See get_ticker.

Source

pub async fn get_trades( &self, inst_id: &str, limit: Option<u32>, ) -> Result<Vec<MarketTrade>, Error>

Retrieve recent trades for an instrument.

GET /api/v5/market/trades. Public.

§Errors

See get_ticker.

Source

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.

Source

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.

Source

pub async fn get_index_components( &self, index: &str, ) -> Result<Vec<IndexComponents>, Error>

Retrieve index components.

GET /api/v5/market/index-components. Public.

§Errors

See get_ticker.

Source

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.

Source

pub async fn get_block_ticker( &self, inst_id: &str, ) -> Result<Vec<BlockTicker>, Error>

Retrieve a block-trading ticker for a single instrument.

GET /api/v5/market/block-ticker. Public.

§Errors

See get_ticker.

Source

pub async fn get_block_tickers( &self, inst_type: InstType, inst_family: Option<&str>, ) -> Result<Vec<BlockTicker>, Error>

Retrieve block-trading tickers for an instrument type.

GET /api/v5/market/block-tickers. Public.

§Errors

See get_ticker.

Source

pub async fn get_block_trades( &self, inst_id: &str, limit: Option<u32>, ) -> Result<Vec<BlockTrade>, Error>

Retrieve recent block trades for an instrument.

GET /api/v5/market/block-trades. Public.

§Errors

See get_ticker.

Source

pub async fn get_option_instrument_family_trades( &self, inst_family: &str, ) -> Result<Vec<OptionInstrumentFamilyTrade>, Error>

Retrieve option trades aggregated by instrument family.

GET /api/v5/market/option/instrument-family-trades. Public.

§Errors

See get_ticker.

Auto Trait Implementations§

§

impl<'a, T> Freeze for Market<'a, T>

§

impl<'a, T> RefUnwindSafe for Market<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for Market<'a, T>
where T: Sync,

§

impl<'a, T> Sync for Market<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for Market<'a, T>

§

impl<'a, T> UnsafeUnpin for Market<'a, T>

§

impl<'a, T> UnwindSafe for Market<'a, T>
where T: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more