Skip to main content

OkxClient

Struct OkxClient 

Source
pub struct OkxClient<T = DefaultTransport> { /* private fields */ }
Expand description

An OKX v5 REST API client, generic over the HTTP Transport.

Construct one with OkxClient::builder (uses the default ReqwestTransport) or OkxClient::with_transport for a custom transport. The client is cheap to share behind an Arc and all request methods take &self.

API groups are reached through accessor methods: market, public_data, status, support, account, funding, convert, finance, and trade.

Implementations§

Source§

impl OkxClient

Source

pub fn builder() -> OkxClientBuilder<DefaultTransport>

Start building a client backed by the default ReqwestTransport.

Source§

impl<T> OkxClient<T>

Source

pub fn with_transport(transport: T) -> OkxClientBuilder<T>

Start building a client around a custom Transport.

Source§

impl<T: Transport> OkxClient<T>

Source

pub fn market(&self) -> Market<'_, T>

Access the public market-data endpoints.

Source

pub fn public_data(&self) -> PublicData<'_, T>

Access the public reference-data endpoints.

Source

pub fn status(&self) -> Status<'_, T>

Access the public system-status endpoints.

Source

pub fn support(&self) -> Support<'_, T>

Access the public support and announcement endpoints.

Source

pub fn account(&self) -> Account<'_, T>

Access the (authenticated) account endpoints.

Source

pub fn funding(&self) -> Funding<'_, T>

Access the (authenticated) funding-account and asset endpoints.

Source

pub fn convert(&self) -> Convert<'_, T>

Access the (authenticated) asset conversion endpoints.

Source

pub fn finance(&self) -> Finance<'_, T>

Access the finance endpoints.

Source

pub fn sub_account(&self) -> SubAccount<'_, T>

Access the (authenticated) sub-account management endpoints.

Source

pub fn trade(&self) -> Trade<'_, T>

Access the (authenticated) trading endpoints.

Auto Trait Implementations§

§

impl<T> Freeze for OkxClient<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for OkxClient<T>
where T: RefUnwindSafe,

§

impl<T> Send for OkxClient<T>
where T: Send,

§

impl<T> Sync for OkxClient<T>
where T: Sync,

§

impl<T> Unpin for OkxClient<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for OkxClient<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for OkxClient<T>
where T: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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