Struct OkxRestClient

Source

pub struct OkxRestClient { /* private fields */ }

Expand description

The REST client for OKEx.

OKEx has Spot, Future, Swap and Option markets.

API doc: https://www.okx.com/docs-v5/en/
Trading at:
- Spot https://www.okx.com/trade-spot
- Future https://www.okx.com/trade-futures
- Swap https://www.okx.com/trade-swap
- Option https://www.okx.com/trade-option

Implementations§

Source §

impl OkxRestClient

Source

pub fn new(api_key: Option<String>, api_secret: Option<String>) -> Self

Source

pub fn fetch_trades(symbol: &str) -> Result<String, Error>

Get most recent trades.

500 trades are returned.

For example: https://www.okx.com/api/v5/market/trades?instId=BTC-USDT&limit=500

Source

pub fn fetch_l2_snapshot(symbol: &str) -> Result<String, Error>

Get the latest Level2 snapshot of orderbook.

Top 400 bids and asks are returned.

For example:

Rate limit: 20 requests per 2 seconds

Source

pub fn fetch_option_underlying() -> Result<Vec<String>, Error>

Get option underlying.

Source

pub fn fetch_open_interest( market_type: MarketType, symbol: Option<&str>, ) -> Result<String, Error>

Get open interest.

inst_type: SWAP, FUTURES, OPTION

For example:

Auto Trait Implementations§

§

impl UnwindSafe for OkxRestClient

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 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §