Merge pull request #33 from binance/rc-v2.0.0

Release v2.0.0

Author: dimitrisn442

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.0.0 - 2025-06-17
+
+### Added (1)
+
+- `get_list_schedule()` (`GET /sapi/v1/margin/list-schedule`)
+
 ## 1.0.0 - 2025-06-12
 
 - Initial release.

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "binance-sdk"
-version = "1.0.0"
+version = "2.0.0"
 authors = [ "Binance" ]
 edition = "2024"
 resolver = "3"

examples/margin_trading/rest_api/market_data_api/get_list_schedule.rs

@@ -0,0 +1,37 @@
+use anyhow::{Context, Result};
+use std::env;
+use tracing::info;
+
+use binance_sdk::config::ConfigurationRestApi;
+use binance_sdk::margin_trading::{MarginTradingRestApi, rest_api::GetListScheduleParams};
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    // Load credentials from env
+    let api_key = env::var("API_KEY").context("API_KEY must be set")?;
+    let api_secret = env::var("API_SECRET").context("API_SECRET must be set")?;
+
+    // Build REST config
+    let rest_conf = ConfigurationRestApi::builder()
+        .api_key(api_key)
+        .api_secret(api_secret)
+        .build()?;
+
+    // Create the MarginTrading REST API client
+    let rest_client = MarginTradingRestApi::production(rest_conf);
+
+    // Setup the API parameters
+    let params = GetListScheduleParams::default();
+
+    // Make the API call
+    let response = rest_client
+        .get_list_schedule(params)
+        .await
+        .context("get_list_schedule request failed")?;
+
+    info!(?response.rate_limits, "get_list_schedule rate limits");
+    let data = response.data().await?;
+    info!(?data, "get_list_schedule data");
+
+    Ok(())
+}

src/margin_trading/rest_api/apis/market_data_api.rs

@@ -49,6 +49,10 @@ pub trait MarketDataApi: Send + Sync {
         &self,
         params: GetDelistScheduleParams,
     ) -> anyhow::Result<RestApiResponse<Vec<models::GetDelistScheduleResponseInner>>>;
+    async fn get_list_schedule(
+        &self,
+        params: GetListScheduleParams,
+    ) -> anyhow::Result<RestApiResponse<Vec<models::GetListScheduleResponseInner>>>;
     async fn query_isolated_margin_tier_data(
         &self,
         params: QueryIsolatedMarginTierDataParams,
@@ -187,6 +191,31 @@ impl GetDelistScheduleParams {
         GetDelistScheduleParamsBuilder::default()
     }
 }
+/// Request parameters for the [`get_list_schedule`] operation.
+///
+/// This struct holds all of the inputs you can pass when calling
+/// [`get_list_schedule`](#method.get_list_schedule).
+#[derive(Clone, Debug, Builder, Default)]
+#[builder(pattern = "owned", build_fn(error = "ParamBuildError"))]
+pub struct GetListScheduleParams {
+    /// No more than 60000
+    ///
+    /// This field is **optional.
+    #[builder(setter(into), default)]
+    pub recv_window: Option<i64>,
+}
+
+impl GetListScheduleParams {
+    /// Create a builder for [`get_list_schedule`].
+    ///
+    /// Required parameters:
+    ///
+    ///
+    #[must_use]
+    pub fn builder() -> GetListScheduleParamsBuilder {
+        GetListScheduleParamsBuilder::default()
+    }
+}
 /// Request parameters for the [`query_isolated_margin_tier_data`] operation.
 ///
 /// This struct holds all of the inputs you can pass when calling
@@ -415,6 +444,33 @@ impl MarketDataApi for MarketDataApiClient {
         .await
     }
 
+    async fn get_list_schedule(
+        &self,
+        params: GetListScheduleParams,
+    ) -> anyhow::Result<RestApiResponse<Vec<models::GetListScheduleResponseInner>>> {
+        let GetListScheduleParams { recv_window } = params;
+
+        let mut query_params = BTreeMap::new();
+
+        if let Some(rw) = recv_window {
+            query_params.insert("recv_window".to_string(), json!(rw));
+        }
+
+        send_request::<Vec<models::GetListScheduleResponseInner>>(
+            &self.configuration,
+            "/sapi/v1/margin/list-schedule",
+            reqwest::Method::GET,
+            query_params,
+            if HAS_TIME_UNIT {
+                self.configuration.time_unit
+            } else {
+                None
+            },
+            false,
+        )
+        .await
+    }
+
     async fn query_isolated_margin_tier_data(
         &self,
         params: QueryIsolatedMarginTierDataParams,
@@ -691,6 +747,31 @@ mod tests {
             Ok(dummy.into())
         }
 
+        async fn get_list_schedule(
+            &self,
+            _params: GetListScheduleParams,
+        ) -> anyhow::Result<RestApiResponse<Vec<models::GetListScheduleResponseInner>>> {
+            if self.force_error {
+                return Err(
+                    ConnectorError::ConnectorClientError("ResponseError".to_string()).into(),
+                );
+            }
+
+            let resp_json: Value = serde_json::from_str(r#"[{"listTime":1686161202000,"crossMarginAssets":["BTC","USDT"],"isolatedMarginSymbols":["ADAUSDT","BNBUSDT"]},{"listTime":1686222232000,"crossMarginAssets":["ADA"],"isolatedMarginSymbols":[]}]"#).unwrap();
+            let dummy_response: Vec<models::GetListScheduleResponseInner> =
+                serde_json::from_value(resp_json.clone())
+                    .expect("should parse into Vec<models::GetListScheduleResponseInner>");
+
+            let dummy = DummyRestApiResponse {
+                inner: Box::new(move || Box::pin(async move { Ok(dummy_response) })),
+                status: 200,
+                headers: HashMap::new(),
+                rate_limits: None,
+            };
+
+            Ok(dummy.into())
+        }
+
         async fn query_isolated_margin_tier_data(
             &self,
             _params: QueryIsolatedMarginTierDataParams,
@@ -1045,6 +1126,56 @@ mod tests {
         });
     }
 
+    #[test]
+    fn get_list_schedule_required_params_success() {
+        TOKIO_SHARED_RT.block_on(async {
+            let client = MockMarketDataApiClient { force_error: false };
+
+            let params = GetListScheduleParams::builder().build().unwrap();
+
+            let resp_json: Value = serde_json::from_str(r#"[{"listTime":1686161202000,"crossMarginAssets":["BTC","USDT"],"isolatedMarginSymbols":["ADAUSDT","BNBUSDT"]},{"listTime":1686222232000,"crossMarginAssets":["ADA"],"isolatedMarginSymbols":[]}]"#).unwrap();
+            let expected_response : Vec<models::GetListScheduleResponseInner> = serde_json::from_value(resp_json.clone()).expect("should parse into Vec<models::GetListScheduleResponseInner>");
+
+            let resp = client.get_list_schedule(params).await.expect("Expected a response");
+            let data_future = resp.data();
+            let actual_response = data_future.await.unwrap();
+            assert_eq!(actual_response, expected_response);
+        });
+    }
+
+    #[test]
+    fn get_list_schedule_optional_params_success() {
+        TOKIO_SHARED_RT.block_on(async {
+            let client = MockMarketDataApiClient { force_error: false };
+
+            let params = GetListScheduleParams::builder().recv_window(5000).build().unwrap();
+
+            let resp_json: Value = serde_json::from_str(r#"[{"listTime":1686161202000,"crossMarginAssets":["BTC","USDT"],"isolatedMarginSymbols":["ADAUSDT","BNBUSDT"]},{"listTime":1686222232000,"crossMarginAssets":["ADA"],"isolatedMarginSymbols":[]}]"#).unwrap();
+            let expected_response : Vec<models::GetListScheduleResponseInner> = serde_json::from_value(resp_json.clone()).expect("should parse into Vec<models::GetListScheduleResponseInner>");
+
+            let resp = client.get_list_schedule(params).await.expect("Expected a response");
+            let data_future = resp.data();
+            let actual_response = data_future.await.unwrap();
+            assert_eq!(actual_response, expected_response);
+        });
+    }
+
+    #[test]
+    fn get_list_schedule_response_error() {
+        TOKIO_SHARED_RT.block_on(async {
+            let client = MockMarketDataApiClient { force_error: true };
+
+            let params = GetListScheduleParams::builder().build().unwrap();
+
+            match client.get_list_schedule(params).await {
+                Ok(_) => panic!("Expected an error"),
+                Err(err) => {
+                    assert_eq!(err.to_string(), "Connector client error: ResponseError");
+                }
+            }
+        });
+    }
+
     #[test]
     fn query_isolated_margin_tier_data_required_params_success() {
         TOKIO_SHARED_RT.block_on(async {

src/margin_trading/rest_api/mod.rs

@@ -1125,6 +1125,49 @@ impl RestApi {
             .await
     }
 
+    /// Get list Schedule (`MARKET_DATA`)
+    ///
+    /// Get the upcoming tokens or symbols listing schedule for Cross Margin and Isolated Margin.
+    ///
+    /// Weight: 100
+    ///
+    /// # Arguments
+    ///
+    /// - `params`: [`GetListScheduleParams`]
+    ///   The parameters for this operation.
+    ///
+    /// # Returns
+    ///
+    /// [`RestApiResponse<Vec<models::GetListScheduleResponseInner>>`] on success.
+    ///
+    /// # Errors
+    ///
+    /// This function will return an [`anyhow::Error`] if:
+    /// - the HTTP request fails
+    /// - any parameter is invalid
+    /// - the response cannot be parsed
+    /// - or one of the following occurs:
+    ///   - `RequiredError`
+    ///   - `ConnectorClientError`
+    ///   - `UnauthorizedError`
+    ///   - `ForbiddenError`
+    ///   - `TooManyRequestsError`
+    ///   - `RateLimitBanError`
+    ///   - `ServerError`
+    ///   - `NotFoundError`
+    ///   - `NetworkError`
+    ///   - `BadRequestError`
+    ///
+    ///
+    /// For full API details, see the [Binance API Documentation](https://developers.binance.com/docs/margin_trading/market-data/Get-list-Schedule).
+    ///
+    pub async fn get_list_schedule(
+        &self,
+        params: GetListScheduleParams,
+    ) -> anyhow::Result<RestApiResponse<Vec<models::GetListScheduleResponseInner>>> {
+        self.market_data_api_client.get_list_schedule(params).await
+    }
+
     /// Query Isolated Margin Tier Data (`USER_DATA`)
     ///
     /// Get isolated margin tier data collection with any tier as <https://www.binance.com/en/margin-data>

src/margin_trading/rest_api/models/get_list_schedule_response_inner.rs

@@ -0,0 +1,40 @@
+/*
+ * Binance Margin Trading REST API
+ *
+ * OpenAPI Specification for the Binance Margin Trading REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+#![allow(unused_imports)]
+use crate::margin_trading::rest_api::models;
+use serde::{Deserialize, Serialize};
+
+#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
+pub struct GetListScheduleResponseInner {
+    #[serde(rename = "listTime", skip_serializing_if = "Option::is_none")]
+    pub list_time: Option<i64>,
+    #[serde(rename = "crossMarginAssets", skip_serializing_if = "Option::is_none")]
+    pub cross_margin_assets: Option<Vec<String>>,
+    #[serde(
+        rename = "isolatedMarginSymbols",
+        skip_serializing_if = "Option::is_none"
+    )]
+    pub isolated_margin_symbols: Option<Vec<String>>,
+}
+
+impl GetListScheduleResponseInner {
+    #[must_use]
+    pub fn new() -> GetListScheduleResponseInner {
+        GetListScheduleResponseInner {
+            list_time: None,
+            cross_margin_assets: None,
+            isolated_margin_symbols: None,
+        }
+    }
+}

src/margin_trading/rest_api/models/mod.rs

@@ -47,6 +47,8 @@ pub mod get_interest_history_response;
 pub use self::get_interest_history_response::GetInterestHistoryResponse;
 pub mod get_interest_history_response_rows_inner;
 pub use self::get_interest_history_response_rows_inner::GetInterestHistoryResponseRowsInner;
+pub mod get_list_schedule_response_inner;
+pub use self::get_list_schedule_response_inner::GetListScheduleResponseInner;
 pub mod get_small_liability_exchange_coin_list_response_inner;
 pub use self::get_small_liability_exchange_coin_list_response_inner::GetSmallLiabilityExchangeCoinListResponseInner;
 pub mod get_small_liability_exchange_history_response;