bpx_api_client/routes/
order.rs

1use bpx_api_types::order::{CancelOpenOrdersPayload, CancelOrderPayload, ExecuteOrderPayload, Order};
2
3use crate::error::{Error, Result};
4use crate::BpxClient;
5
6#[doc(hidden)]
7pub const API_ORDER: &str = "/api/v1/order";
8#[doc(hidden)]
9pub const API_ORDERS: &str = "/api/v1/orders";
10
11impl BpxClient {
12    /// Fetches a specific open order by symbol and either order ID or client ID.
13    pub async fn get_open_order(&self, symbol: &str, order_id: Option<&str>, client_id: Option<u32>) -> Result<Order> {
14        let mut url = format!("{}{}?symbol={}", self.base_url, API_ORDER, symbol);
15        if let Some(order_id) = order_id {
16            url.push_str(&format!("&orderId={order_id}"));
17        } else {
18            url.push_str(&format!(
19                "&clientId={}",
20                client_id.ok_or_else(|| Error::InvalidRequest("either order_id or client_id is required".into()))?
21            ));
22        }
23        let res = self.get(url).await?;
24        res.json().await.map_err(Into::into)
25    }
26
27    /// Executes a new order with the given payload.
28    pub async fn execute_order(&self, payload: ExecuteOrderPayload) -> Result<Order> {
29        let endpoint = format!("{}{}", self.base_url, API_ORDER);
30        let res = self.post(endpoint, payload).await?;
31        res.json().await.map_err(Into::into)
32    }
33
34    /// Cancels a specific order by symbol and either order ID or client ID.
35    pub async fn cancel_order(&self, symbol: &str, order_id: Option<&str>, client_id: Option<u32>) -> Result<Order> {
36        let url = format!("{}{}", self.base_url, API_ORDER);
37        let payload = CancelOrderPayload {
38            symbol: symbol.to_string(),
39            order_id: order_id.map(|s| s.to_string()),
40            client_id,
41        };
42
43        let res = self.delete(url, payload).await?;
44        res.json().await.map_err(Into::into)
45    }
46
47    /// Retrieves all open orders, optionally filtered by symbol.
48    pub async fn get_open_orders(&self, symbol: Option<&str>) -> Result<Vec<Order>> {
49        let mut url = format!("{}{}", self.base_url, API_ORDERS);
50        if let Some(s) = symbol {
51            url.push_str(&format!("?symbol={s}"));
52        }
53        let res = self.get(url).await?;
54        res.json().await.map_err(Into::into)
55    }
56
57    /// Cancels all open orders matching the specified payload.
58    pub async fn cancel_open_orders(&self, payload: CancelOpenOrdersPayload) -> Result<Vec<Order>> {
59        let url = format!("{}{}", self.base_url, API_ORDERS);
60        let res = self.delete(url, payload).await?;
61        res.json().await.map_err(Into::into)
62    }
63}