bpx-api-client 0.20.2

Backpack Exchange API client
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
84
85
86
87
88
89
90
91
92
93
94
95

use crate::error::Result;
use std::collections::HashMap;

use bpx_api_types::{
    Blockchain,
    capital::{Balance, Collateral, Deposit, DepositAddress, RequestWithdrawalPayload, Withdrawal},
};

use crate::BpxClient;

#[doc(hidden)]
pub const API_CAPITAL: &str = "/api/v1/capital";
#[doc(hidden)]
pub const API_DEPOSITS: &str = "/wapi/v1/capital/deposits";
#[doc(hidden)]
pub const API_DEPOSIT_ADDRESS: &str = "/wapi/v1/capital/deposit/address";
#[doc(hidden)]
pub const API_WITHDRAWALS: &str = "/wapi/v1/capital/withdrawals";
#[doc(hidden)]
pub const API_COLLATERAL: &str = "/api/v1/capital/collateral";

impl BpxClient {
    /// Fetches the account's current balances.
    pub async fn get_balances(&self) -> Result<HashMap<String, Balance>> {
        let url = self.base_url.join(API_CAPITAL)?;
        let res = self.get(url).await?;
        res.json().await.map_err(Into::into)
    }

    /// Retrieves a list of deposits with optional pagination.
    pub async fn get_deposits(
        &self,
        limit: Option<i64>,
        offset: Option<i64>,
    ) -> Result<Vec<Deposit>> {
        let mut url = self.base_url.join(API_DEPOSITS)?;
        {
            let mut query = url.query_pairs_mut();
            if let Some(limit) = limit {
                query.append_pair("limit", &limit.to_string());
            }
            if let Some(offset) = offset {
                query.append_pair("offset", &offset.to_string());
            }
        }
        let res = self.get(url).await?;
        res.json().await.map_err(Into::into)
    }

    /// Fetches the deposit address for a specified blockchain.
    pub async fn get_deposit_address(&self, blockchain: Blockchain) -> Result<DepositAddress> {
        let mut url = self.base_url.join(API_DEPOSIT_ADDRESS)?;
        url.query_pairs_mut()
            .append_pair("blockchain", &blockchain.to_string());
        let res = self.get(url).await?;
        res.json().await.map_err(Into::into)
    }

    /// Retrieves a list of withdrawals with optional pagination.
    pub async fn get_withdrawals(
        &self,
        limit: Option<i64>,
        offset: Option<i64>,
    ) -> Result<Vec<Withdrawal>> {
        let mut url = self.base_url.join(API_WITHDRAWALS)?;
        {
            let mut query = url.query_pairs_mut();
            if let Some(limit) = limit {
                query.append_pair("limit", &limit.to_string());
            }
            if let Some(offset) = offset {
                query.append_pair("offset", &offset.to_string());
            }
        }
        let res = self.get(url).await?;
        res.json().await.map_err(Into::into)
    }

    /// Submits a withdrawal request for the specified payload.
    pub async fn request_withdrawal(
        &self,
        payload: RequestWithdrawalPayload,
    ) -> Result<Withdrawal> {
        let endpoint = self.base_url.join(API_WITHDRAWALS)?;
        let res = self.post(endpoint, payload).await?;
        res.json().await.map_err(Into::into)
    }

    /// Fetches the subaccount's collateral information.
    pub async fn get_collateral(&self) -> Result<Collateral> {
        let url = self.base_url.join(API_COLLATERAL)?;
        let res = self.get(url).await?;
        res.json().await.map_err(Into::into)
    }
}