feat: add demo trading support

README.rst

@@ -63,7 +63,8 @@ Features
 
 - Implementation of all General, Market Data and Account endpoints.
 - Asyncio implementation
-- Testnet support for Spot, Futures and Vanilla Options
+- Demo trading support (by providing demo=True)
+- Testnet support for Spot, Futures and Vanilla Options (deprecated)
 - Simple handling of authentication include RSA and EDDSA keys
 - No need to generate timestamps yourself, the wrapper does it for you
 - RecvWindow sent by default

binance/async_client.py

@@ -31,6 +31,7 @@ def __init__(
         tld: str = "com",
         base_endpoint: str = BaseClient.BASE_ENDPOINT_DEFAULT,
         testnet: bool = False,
+        demo: bool = False,
         loop=None,
         session_params: Optional[Dict[str, Any]] = None,
         private_key: Optional[Union[str, Path]] = None,
@@ -48,6 +49,7 @@ def __init__(
             tld,
             base_endpoint,
             testnet,
+            demo,
             private_key,
             private_key_pass,
             time_unit=time_unit,
@@ -62,6 +64,7 @@ async def create(
         tld: str = "com",
         base_endpoint: str = BaseClient.BASE_ENDPOINT_DEFAULT,
         testnet: bool = False,
+        demo: bool = False,
         loop=None,
         session_params: Optional[Dict[str, Any]] = None,
         private_key: Optional[Union[str, Path]] = None,
@@ -76,6 +79,7 @@ async def create(
             tld,
             base_endpoint,
             testnet,
+            demo,
             loop,
             session_params,
             private_key,
@@ -1876,6 +1880,77 @@ async def futures_create_order(self, **params):
             params["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
         return await self._request_futures_api("post", "order", True, data=params)
 
+    async def futures_limit_order(self, **params):
+        """Send in a new futures limit order.
+
+        https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api
+
+        """
+        if "newClientOrderId" not in params:
+            params["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
+        params["type"] = "LIMIT"
+        return await self._request_futures_api("post", "order", True, data=params)
+
+    async def futures_market_order(self, **params):
+        """Send in a new futures market order.
+
+        https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api
+
+        """
+        if "newClientOrderId" not in params:
+            params["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
+        params["type"] = "MARKET"
+        return await self._request_futures_api("post", "order", True, data=params)
+
+
+    async def futures_limit_buy_order(self, **params):
+        """Send in a new futures limit buy order.
+
+        https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api
+
+        """
+        if "newClientOrderId" not in params:
+            params["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
+        params["side"] = "BUY"
+        params["type"] = "LIMIT"
+        return await self._request_futures_api("post", "order", True, data=params)
+
+    async def futures_limit_sell_order(self, **params):
+        """Send in a new futures limit sell order.
+
+        https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api
+
+        """
+        if "newClientOrderId" not in params:
+            params["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
+        params["side"] = "SELL"
+        params["type"] = "LIMIT"
+        return await self._request_futures_api("post", "order", True, data=params)
+
+    async def futures_market_buy_order(self, **params):
+        """Send in a new futures market buy order.
+
+        https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api
+
+        """
+        if "newClientOrderId" not in params:
+            params["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
+        params["side"] = "BUY"
+        params["type"] = "MARKET"
+        return await self._request_futures_api("post", "order", True, data=params)
+
+    async def futures_market_sell_order(self, **params):
+        """Send in a new futures market sell order.
+
+        https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api
+
+        """
+        if "newClientOrderId" not in params:
+            params["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
+        params["side"] = "SELL"
+        params["type"] = "MARKET"
+        return await self._request_futures_api("post", "order", True, data=params)
+
     async def futures_modify_order(self, **params):
         """Modify an existing order. Currently only LIMIT order modification is supported.
 

binance/base_client.py

@@ -22,23 +22,28 @@
 class BaseClient:
     API_URL = "https://api{}.binance.{}/api"
     API_TESTNET_URL = "https://testnet.binance.vision/api"
+    API_DEMO_URL = "https://demo-api.binance.com/api"
     MARGIN_API_URL = "https://api{}.binance.{}/sapi"
     WEBSITE_URL = "https://www.binance.{}"
     FUTURES_URL = "https://fapi.binance.{}/fapi"
     FUTURES_TESTNET_URL = "https://testnet.binancefuture.com/fapi"
+    FUTURES_DEMO_URL = "https://demo-fapi.binance.com/fapi"
     FUTURES_DATA_URL = "https://fapi.binance.{}/futures/data"
     FUTURES_DATA_TESTNET_URL = "https://testnet.binancefuture.com/futures/data"
     FUTURES_COIN_URL = "https://dapi.binance.{}/dapi"
     FUTURES_COIN_TESTNET_URL = "https://testnet.binancefuture.com/dapi"
+    FUTURES_COIN_DEMO_URL = "https://demo-dapi.binance.com/dapi"
     FUTURES_COIN_DATA_URL = "https://dapi.binance.{}/futures/data"
     FUTURES_COIN_DATA_TESTNET_URL = "https://testnet.binancefuture.com/futures/data"
     OPTIONS_URL = "https://eapi.binance.{}/eapi"
     OPTIONS_TESTNET_URL = "https://testnet.binanceops.{}/eapi"
     PAPI_URL = "https://papi.binance.{}/papi"
     WS_API_URL = "wss://ws-api.binance.{}/ws-api/v3"
     WS_API_TESTNET_URL = "wss://ws-api.testnet.binance.vision/ws-api/v3"
+    WS_API_DEMO_URL = "wss://demo-ws-api.binance.com/ws-api/v3"
     WS_FUTURES_URL = "wss://ws-fapi.binance.{}/ws-fapi/v1"
     WS_FUTURES_TESTNET_URL = "wss://testnet.binancefuture.com/ws-fapi/v1"
+    WS_FUTURES_DEMO_URL = "wss://demo-ws-fapi.binance.com/ws-fapi/v1"
     PUBLIC_API_VERSION = "v3"
     PRIVATE_API_VERSION = "v3"
     MARGIN_API_VERSION = "v1"
@@ -157,6 +162,7 @@ def __init__(
         tld: str = "com",
         base_endpoint: str = BASE_ENDPOINT_DEFAULT,
         testnet: bool = False,
+        demo: bool = False,
         private_key: Optional[Union[str, Path]] = None,
         private_key_pass: Optional[str] = None,
         loop: Optional[asyncio.AbstractEventLoop] = None,
@@ -201,14 +207,21 @@ def __init__(
         self._requests_params = requests_params
         self.response = None
         self.testnet = testnet
+        self.demo = demo
         self.timestamp_offset = 0
-        ws_api_url = self.WS_API_TESTNET_URL if testnet else self.WS_API_URL.format(tld)
+        ws_api_url = self.WS_API_URL.format(tld)
+        if testnet:
+            ws_api_url = self.WS_API_TESTNET_URL
+        elif demo:
+            ws_api_url = self.WS_API_DEMO_URL
         if self.TIME_UNIT:
             ws_api_url += f"?timeUnit={self.TIME_UNIT}"
         self.ws_api = WebsocketAPI(url=ws_api_url, tld=tld)
-        ws_future_url = (
-            self.WS_FUTURES_TESTNET_URL if testnet else self.WS_FUTURES_URL.format(tld)
-        )
+        ws_future_url = self.WS_FUTURES_URL.format(tld)
+        if testnet:
+            ws_future_url = self.WS_FUTURES_TESTNET_URL
+        elif demo:
+            ws_future_url = self.WS_FUTURES_DEMO_URL
         self.ws_future = WebsocketAPI(url=ws_future_url, tld=tld)
         self.loop = loop or get_loop()
 
@@ -250,6 +263,8 @@ def _create_api_uri(
         url = self.API_URL
         if self.testnet:
             url = self.API_TESTNET_URL
+        elif self.demo:
+            url = self.API_DEMO_URL
         v = self.PRIVATE_API_VERSION if signed else version
         return url + "/" + v + "/" + path
 
@@ -273,6 +288,8 @@ def _create_futures_api_uri(self, path: str, version: int = 1) -> str:
         url = self.FUTURES_URL
         if self.testnet:
             url = self.FUTURES_TESTNET_URL
+        elif self.demo:
+            url = self.FUTURES_DEMO_URL
         options = {
             1: self.FUTURES_API_VERSION,
             2: self.FUTURES_API_VERSION2,
@@ -290,6 +307,8 @@ def _create_futures_coin_api_url(self, path: str, version: int = 1) -> str:
         url = self.FUTURES_COIN_URL
         if self.testnet:
             url = self.FUTURES_COIN_TESTNET_URL
+        elif self.demo:
+            url = self.FUTURES_COIN_DEMO_URL
         options = {
             1: self.FUTURES_API_VERSION,
             2: self.FUTURES_API_VERSION2,

binance/client.py

@@ -29,6 +29,7 @@ def __init__(
         tld: str = "com",
         base_endpoint: str = BaseClient.BASE_ENDPOINT_DEFAULT,
         testnet: bool = False,
+        demo: bool = False,
         private_key: Optional[Union[str, Path]] = None,
         private_key_pass: Optional[str] = None,
         ping: Optional[bool] = True,
@@ -41,6 +42,7 @@ def __init__(
             tld,
             base_endpoint,
             testnet,
+            demo,
             private_key,
             private_key_pass,
             time_unit=time_unit,
@@ -7779,6 +7781,77 @@ def futures_create_order(self, **params):
             params["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
         return self._request_futures_api("post", "order", True, data=params)
 
+    def futures_limit_order(self, **params):
+        """Send in a new futures limit order.
+
+        https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api
+
+        """
+        if "newClientOrderId" not in params:
+            params["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
+        params["type"] = "LIMIT"
+        return self._request_futures_api("post", "order", True, data=params)
+
+    def futures_market_order(self, **params):
+        """Send in a new futures market order.
+
+        https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api
+
+        """
+        if "newClientOrderId" not in params:
+            params["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
+        params["type"] = "MARKET"
+        return self._request_futures_api("post", "order", True, data=params)
+
+
+    def futures_limit_buy_order(self, **params):
+        """Send in a new futures limit buy order.
+
+        https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api
+
+        """
+        if "newClientOrderId" not in params:
+            params["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
+        params["side"] = "BUY"
+        params["type"] = "LIMIT"
+        return self._request_futures_api("post", "order", True, data=params)
+
+    def futures_limit_sell_order(self, **params):
+        """Send in a new futures limit sell order.
+
+        https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api
+
+        """
+        if "newClientOrderId" not in params:
+            params["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
+        params["side"] = "SELL"
+        params["type"] = "LIMIT"
+        return self._request_futures_api("post", "order", True, data=params)
+
+    def futures_market_buy_order(self, **params):
+        """Send in a new futures market buy order.
+
+        https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api
+
+        """
+        if "newClientOrderId" not in params:
+            params["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
+        params["side"] = "BUY"
+        params["type"] = "MARKET"
+        return self._request_futures_api("post", "order", True, data=params)
+
+    def futures_market_sell_order(self, **params):
+        """Send in a new futures market sell order.
+
+        https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api
+
+        """
+        if "newClientOrderId" not in params:
+            params["newClientOrderId"] = self.CONTRACT_ORDER_PREFIX + self.uuid22()
+        params["side"] = "SELL"
+        params["type"] = "MARKET"
+        return self._request_futures_api("post", "order", True, data=params)
+
     def futures_modify_order(self, **params):
         """Modify an existing order. Currently only LIMIT order modification is supported.
 
@@ -13999,7 +14072,7 @@ def futures_historical_data_link(self, **params):
                 "data": [
                     {
                         "day": "2023-06-30",
-                        "url": "https://bin-prod-user-rebate-bucket.s3.ap-northeast-1.amazonaws.com/future-data-symbol-update/2023-06-30/BTCUSDT_T_DEPTH_2023-06-30.tar.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230925T025710Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86399&X-Amz-Credential=AKIAVL364M5ZNFZ74IPP%2F20230925%2Fap-northeast-1%2Fs3%2Faws4_request&X-Amz-Signature=5fffcb390d10f34d71615726f81f99e42d80a11532edeac77b858c51a88cbf59"
+                        "url": ""
                     }
                 ]
             }