Struct crypto_rest_client::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 RefUnwindSafe for OkxRestClient

impl Send for OkxRestClient

impl Sync for OkxRestClient

impl Unpin for OkxRestClient

impl UnwindSafe for OkxRestClient

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 Twhere
U: From<T>,

const: unstable · 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, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::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

Struct crypto_rest_client::OkxRestClient

Implementations

impl OkxRestClient

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

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

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

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

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

Auto Trait Implementations

impl RefUnwindSafe for OkxRestClient

impl Send for OkxRestClient

impl Sync for OkxRestClient

impl Unpin for OkxRestClient

impl UnwindSafe for OkxRestClient

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Struct crypto_rest_client::OkxRestClient

Implementations

impl OkxRestClient

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

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

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

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

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

Auto Trait Implementations

impl RefUnwindSafe for OkxRestClient

impl Send for OkxRestClient

impl Sync for OkxRestClient

impl Unpin for OkxRestClient

impl UnwindSafe for OkxRestClient

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

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

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

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

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

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