rust-okx 0.6.4

Async Rust client for the OKX v5 REST API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

use crate::client::OkxClient;
use crate::error::Error;
use crate::transport::Transport;

use super::endpoints::*;
use super::requests::*;
use super::responses::*;

/// Accessor for the public system-status endpoints.
///
/// Obtain one via [`OkxClient::status`](crate::OkxClient::status).
pub struct Status<'a, T> {
    client: &'a OkxClient<T>,
}

impl<'a, T: Transport> Status<'a, T> {
    pub(crate) fn new(client: &'a OkxClient<T>) -> Self {
        Self { client }
    }

    /// Retrieve system maintenance status.
    ///
    /// `GET /api/v5/system/status`. Public (unauthenticated). Pass
    /// `state` to filter by a specific maintenance state; omit it to receive
    /// `scheduled`, `ongoing`, and `pre_open` events by default.
    ///
    /// # Errors
    ///
    /// Returns [`RestError::Okx`](crate::RestError::Okx) on a non-zero OKX code, or
    /// [`RestError::Transport`](crate::RestError::Transport)/[`RestError::Decode`](crate::RestError::Decode) on transport/parsing failure.
    pub async fn get_status(&self, request: &StatusRequest<'_>) -> Result<Vec<StatusItem>, Error> {
        self.client.get(STATUS, request, false).await
    }
}