feat: add security endpoints (#105)

Author: udsamani

client/src/routes/markets.rs

@@ -1,5 +1,6 @@
 use bpx_api_types::markets::{
-    Asset, FundingRate, Kline, MarkPrice, Market, OrderBookDepth, OrderBookDepthLimit, Ticker,
+    Asset, FundingRate, Kline, MarkPrice, Market, OrderBookDepth, OrderBookDepthLimit, Security,
+    Ticker,
 };
 
 use crate::BpxClient;
@@ -13,6 +14,7 @@ const API_DEPTH: &str = "/api/v1/depth";
 const API_KLINES: &str = "/api/v1/klines";
 const API_FUNDING: &str = "/api/v1/fundingRates";
 const API_MARK_PRICES: &str = "/api/v1/markPrices";
+const API_SECURITIES: &str = "/api/v1/securities";
 
 impl BpxClient {
     /// Fetches available assets and their associated tokens.
@@ -74,6 +76,13 @@ impl BpxClient {
         res.json().await.map_err(Into::into)
     }
 
+    /// Retrieves tradable securities.
+    pub async fn get_securities(&self) -> Result<Vec<Security>> {
+        let url = self.base_url.join(API_SECURITIES)?;
+        let res = self.get(url).await?;
+        res.json().await.map_err(Into::into)
+    }
+
     /// Fetches historical K-line (candlestick) data for a given symbol and interval.
     pub async fn get_k_lines(
         &self,

types/src/markets.rs

@@ -398,6 +398,24 @@ pub struct MarkPriceUpdate {
     pub engine_timestamp: i64,
 }
 
+/// A tradable equity security.
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct Security {
+    /// Asset symbol.
+    pub asset: String,
+    /// Name.
+    pub name: String,
+    /// Minimum order quantity.
+    pub min_quantity: Decimal,
+    /// Maximum order quantity.
+    pub max_quantity: Option<Decimal>,
+    /// Minimum quantity increment.
+    pub step_size: Decimal,
+    /// CUSIP identifier for the security.
+    pub cusip: Option<String>,
+}
+
 impl TryFrom<u32> for OrderBookDepthLimit {
     type Error = &'static str;