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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

use std::env;

use rust_okx::{
    Credentials, OkxClient, OkxRegion,
    api::funding::{CurrencyRequest, DepositAddressRequest},
};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let _ = dotenvy::dotenv();
    let client = authenticated_client()?;
    let currency = env::var("OKX_EXAMPLE_FUNDING_CCY").unwrap_or_else(|_| "USDT".to_owned());

    let currency_request = CurrencyRequest::new().currency(&currency);
    let currencies = client.funding().get_currencies(&currency_request).await?;
    println!("{currency} currency metadata rows: {}", currencies.len());

    let balances = client.funding().get_balances(&currency_request).await?;
    for balance in &balances {
        println!(
            "funding balance: ccy={} bal={} availBal={}",
            balance.ccy, balance.bal, balance.avail_bal
        );
    }

    let deposit_addresses = client
        .funding()
        .get_deposit_address(&DepositAddressRequest::new(&currency))
        .await?;
    println!(
        "{currency} deposit address rows: {}",
        deposit_addresses.len()
    );

    let valuation_ccy = env::var("OKX_EXAMPLE_VALUATION_CCY").unwrap_or_else(|_| "USD".to_owned());
    let valuation = client
        .funding()
        .get_asset_valuation(&CurrencyRequest::new().currency(&valuation_ccy))
        .await?;
    if let Some(row) = valuation.first() {
        println!("asset valuation in {valuation_ccy}: {}", row.total_bal);
    } else {
        println!("asset valuation returned no rows");
    }

    Ok(())
}

fn authenticated_client() -> Result<OkxClient, Box<dyn std::error::Error>> {
    Ok(OkxClient::builder()
        .region(example_region()?)
        .credentials(live_credentials()?)
        .demo_trading(env_flag("OKX_DEMO_TRADING"))
        .build())
}

fn live_credentials() -> Result<Credentials, Box<dyn std::error::Error>> {
    Ok(Credentials::new(
        env::var("OKX_API_KEY")?,
        env::var("OKX_API_SECRET")?,
        env::var("OKX_PASSPHRASE")?,
    ))
}

fn example_region() -> Result<OkxRegion, Box<dyn std::error::Error>> {
    match env::var("OKX_REGION")
        .unwrap_or_else(|_| "global".to_owned())
        .to_ascii_lowercase()
        .as_str()
    {
        "global" => Ok(OkxRegion::Global),
        "us" | "au" => Ok(OkxRegion::Us),
        "eea" | "eu" => Ok(OkxRegion::Eea),
        other => Err(format!("OKX_REGION must be global, us, au, eea, or eu; got {other}").into()),
    }
}

fn env_flag(name: &str) -> bool {
    matches!(
        env::var(name).as_deref(),
        Ok("1") | Ok("true") | Ok("TRUE") | Ok("yes") | Ok("YES")
    )
}