Struct GetOrderbook 

pub struct GetOrderbook {
    pub currency_pair: String,
    pub interval: Option<String>,
    pub limit: Option<i64>,
    pub with_id: Option<bool>,
    pub credentials: Option<Credentials>,
}

Request for retrieving order book data for a currency pair

Fields

currency_pair: String

Currency pair to get order book for

interval: Option<String>

Price interval aggregation (“0” for no aggregation)

limit: Option<i64>

Maximum depth of order book entries to return

with_id: Option<bool>

Whether to return order IDs with the book data

credentials: Option<Credentials>

API credentials for authentication (optional for public data)

Implementations

impl GetOrderbook

pub fn new(currency_pair: &str) -> Self

Creates a new GetOrderbook request for the specified currency pair

pub fn interval(self, interval: &str) -> Self

Sets the price interval for aggregation

Examples found in repository

examples/sync/get_orderbook.rs (line 14)

fn main() -> Result<(), Box<gateio_rs::ureq::Error>> {
    dotenv::dotenv().ok();

    let api_key = std::env::var("GATE_API_KEY").expect("GATE_API_KEY not set");
    let api_secret = std::env::var("GATE_API_SECRET").expect("GATE_API_SECRET not set");
    let credentials = Credentials::new(api_key, api_secret);

    let client = GateHttpClient::default().credentials(credentials.clone());

    // Get orderbook for BTC_USDT
    let req = spot::get_orderbook("BTC_USDT").limit(100).interval("0");

    let resp = client.send(req)?;
    let body = resp.into_body_str()?;
    let resp_obj: Value = serde_json::from_str(&body).unwrap();
    println!("{:?}", resp_obj);

    Ok(())
}

pub fn limit(self, limit: i64) -> Self

Sets the maximum depth of order book entries

Examples found in repository

examples/sync/get_orderbook.rs (line 14)

fn main() -> Result<(), Box<gateio_rs::ureq::Error>> {
    dotenv::dotenv().ok();

    let api_key = std::env::var("GATE_API_KEY").expect("GATE_API_KEY not set");
    let api_secret = std::env::var("GATE_API_SECRET").expect("GATE_API_SECRET not set");
    let credentials = Credentials::new(api_key, api_secret);

    let client = GateHttpClient::default().credentials(credentials.clone());

    // Get orderbook for BTC_USDT
    let req = spot::get_orderbook("BTC_USDT").limit(100).interval("0");

    let resp = client.send(req)?;
    let body = resp.into_body_str()?;
    let resp_obj: Value = serde_json::from_str(&body).unwrap();
    println!("{:?}", resp_obj);

    Ok(())
}

pub fn with_id(self, with_id: bool) -> Self

Sets whether to include order IDs in the response

pub fn credentials(self, creds: Credentials) -> Self

Sets the API credentials for authentication

Trait Implementations

impl From<GetOrderbook> for Request

fn from(request: GetOrderbook) -> Request

Converts to this type from the input type.