whitebit-python-sdk 1.1.0__tar.gz

whitebit_python_sdk-1.1.0/HISTORY.txt

@@ -0,0 +1,20 @@
+v1.0.5 - March 16, 2023
+
+#### Breaking Changes:
+- Margin balance response format changed
+
+#### Highlights
+- feature: Add postOnly flag to order responses
+- feature: Add ioc flag to order responses
+- feature: Add ioc and postOnly parameters to create margin/spot limit
+- feature: Add endpoints for get user custom fee and user fee for some market
+- doc: Added an example of using websocket
+
+
+v1.1.0 - August 28, 2023
+
+#### Highlights
+- feature: The parameter "market" in the function "get_unexecuted_orders" has become optional.
+- feature: Add the put_kill_switch endpoint to cancel orders after a specified time (sec) in the "timeout" parameter.
+- feature: Add the get_kill_switch_status endpoint retrieves the status of kill-switch timer.
+- feature: Add the bulk endpoint creates bulk limit trading orders.

whitebit_python_sdk-1.1.0/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 UAB Clear White Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

whitebit_python_sdk-1.1.0/MANIFEST.in

@@ -0,0 +1,10 @@
+include README.md
+include LICENSE
+include HISTORY.txt
+include requirements.txt
+recursive-include src/whitebit *.py
+recursive-include src/whitebit *.typed
+recursive-include examples *.py
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude * .DS_Store

whitebit_python_sdk-1.1.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: whitebit-python-sdk
+Version: 1.1.0
+Summary: A Python SDK for WhiteBit cryptocurrency exchange API
+Author: WhiteBit SDK Team
+License: MIT
+Project-URL: Homepage, https://www.whitebit.com
+Project-URL: Documentation, https://whitebit-exchange.github.io/api-docs/
+Project-URL: Repository, https://github.com/whitebit-exchange/python-sdk
+Project-URL: Issues, https://github.com/whitebit-exchange/python-sdk/issues
+Keywords: whitebit,cryptocurrency,exchange,api,sdk,trading
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Office/Business :: Financial
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3.0.0,>=2.28.1
+Requires-Dist: websockets<11.0,>=10.4
+Requires-Dist: responses>=0.23.1
+Requires-Dist: urllib3<2.0.0,>=1.26.15
+Requires-Dist: pydantic<3.0.0,>=1.10.0
+Requires-Dist: httpx<1.0.0,>=0.23.0
+Dynamic: license-file
+
+## A Python SDK for [whitebit](https://www.whitebit.com)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Please read [whitebit API document](https://whitebit-exchange.github.io/api-docs/) before continuing.
+
+## API List
+
+- [Private API](https://whitebit-exchange.github.io/api-docs/private/http-trade-v4/)
+- [Public API](https://whitebit-exchange.github.io/api-docs/public/http-v4/)
+- [Private WS](https://whitebit-exchange.github.io/api-docs/private/websocket/)
+- [Public WS](https://whitebit-exchange.github.io/api-docs/public/websocket/)
+
+v4 is the preferred one to use
+
+## Disclaimer
+“You acknowledge that the software is provided “as is”. Author makes no representations or warranties with respect to
+the software whether express or implied, including but not limited to, implied warranties of merchantability and fitness
+for a particular purpose. author makes no representation or warranty that: (i) the use and distribution of the software
+will be uninterrupted or error free, and (ii) any use and distribution of the software is free from infringement of any
+third party intellectual property rights. It shall be your sole responsibility to make such determination before the use
+of software. Author disclaims any liability in case any such use and distribution infringe any third party’s
+intellectual property rights. Author hereby disclaims any warranty and liability whatsoever for any development created
+by or for you with respect to your customers. You acknowledge that you have relied on no warranties and that no
+warranties are made by author or granted by law whenever it is permitted by law.”
+
+## REST API
+
+### Setup
+
+#### Install the Python module:
+
+```bash
+python3 -m pip install python-whitebit-sdk
+```
+
+Init client for API services. Get APIKey/SecretKey from your whitebit account.
+
+```python
+from whitebit import MainAccountClient
+
+account = MainAccountClient(api_key="", api_secret=""))
+```
+
+Following are some simple examples.
+
+See the **examples** folder for full references.
+
+#### Create Spot Limit Order
+
+```python
+# Create order/spot client
+order = OrderClient(api_key="",
+                    api_secret="")
+
+# Call SDK function put_limit
+print(order.put_limit("BTC_USDT", "sell", "0.1", "40000", True))
+```
+
+## Websocket API
+
+### Setup
+
+Init bot class and "on_message" method for work with ws responses. Get APIKey/SecretKey from your whitebit account.
+
+```python
+class Bot(WhitebitWsClient):
+    def __init__(self):
+        super().__init__(key="", secret="")
+
+    async def on_message(self, event) -> None:
+        logging.info(event)
+        
+```
+
+Following are some simple examples.
+
+See the **examples** folder for full references.
+
+#### Subscribe on deals topic
+
+```python
+class Bot(WhitebitWsClient):
+    '''Can be used to create a custom trading strategy/bot'''
+
+    def __init__(self):
+        super().__init__(key="", secret="")
+
+    async def on_message(self, event) -> None:
+        '''receives the websocket events'''
+        if 'result' in event:
+            result = event['result']
+            match result:
+                case 'pong': return
+            logging.info(event['result'])
+            return
+        else:
+            method = event['method']
+            match method:
+                case WhitebitWsClient.DEALS_UPDATE:
+                    logging.info(event['params'])
+            return
+
+
+async def main() -> None:
+    bot = Bot()
+    await bot.get_deals("BTC_USDT", 0, 100)
+    await bot.subscribe_deals(["BTC_USDT"])
+    while not bot.exception_occur:
+        await asyncio.sleep(100)
+    return
+
+
+if __name__ == '__main__':
+    logging.basicConfig(level=logging.INFO)
+    loop = asyncio.new_event_loop()
+    asyncio.set_event_loop(loop)
+    try:
+        asyncio.run(main())
+    except KeyboardInterrupt:
+        pass
+    finally:
+        loop.close()
+```

whitebit_python_sdk-1.1.0/README.md

@@ -0,0 +1,123 @@
+## A Python SDK for [whitebit](https://www.whitebit.com)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Please read [whitebit API document](https://whitebit-exchange.github.io/api-docs/) before continuing.
+
+## API List
+
+- [Private API](https://whitebit-exchange.github.io/api-docs/private/http-trade-v4/)
+- [Public API](https://whitebit-exchange.github.io/api-docs/public/http-v4/)
+- [Private WS](https://whitebit-exchange.github.io/api-docs/private/websocket/)
+- [Public WS](https://whitebit-exchange.github.io/api-docs/public/websocket/)
+
+v4 is the preferred one to use
+
+## Disclaimer
+“You acknowledge that the software is provided “as is”. Author makes no representations or warranties with respect to
+the software whether express or implied, including but not limited to, implied warranties of merchantability and fitness
+for a particular purpose. author makes no representation or warranty that: (i) the use and distribution of the software
+will be uninterrupted or error free, and (ii) any use and distribution of the software is free from infringement of any
+third party intellectual property rights. It shall be your sole responsibility to make such determination before the use
+of software. Author disclaims any liability in case any such use and distribution infringe any third party’s
+intellectual property rights. Author hereby disclaims any warranty and liability whatsoever for any development created
+by or for you with respect to your customers. You acknowledge that you have relied on no warranties and that no
+warranties are made by author or granted by law whenever it is permitted by law.”
+
+## REST API
+
+### Setup
+
+#### Install the Python module:
+
+```bash
+python3 -m pip install python-whitebit-sdk
+```
+
+Init client for API services. Get APIKey/SecretKey from your whitebit account.
+
+```python
+from whitebit import MainAccountClient
+
+account = MainAccountClient(api_key="", api_secret=""))
+```
+
+Following are some simple examples.
+
+See the **examples** folder for full references.
+
+#### Create Spot Limit Order
+
+```python
+# Create order/spot client
+order = OrderClient(api_key="",
+                    api_secret="")
+
+# Call SDK function put_limit
+print(order.put_limit("BTC_USDT", "sell", "0.1", "40000", True))
+```
+
+## Websocket API
+
+### Setup
+
+Init bot class and "on_message" method for work with ws responses. Get APIKey/SecretKey from your whitebit account.
+
+```python
+class Bot(WhitebitWsClient):
+    def __init__(self):
+        super().__init__(key="", secret="")
+
+    async def on_message(self, event) -> None:
+        logging.info(event)
+        
+```
+
+Following are some simple examples.
+
+See the **examples** folder for full references.
+
+#### Subscribe on deals topic
+
+```python
+class Bot(WhitebitWsClient):
+    '''Can be used to create a custom trading strategy/bot'''
+
+    def __init__(self):
+        super().__init__(key="", secret="")
+
+    async def on_message(self, event) -> None:
+        '''receives the websocket events'''
+        if 'result' in event:
+            result = event['result']
+            match result:
+                case 'pong': return
+            logging.info(event['result'])
+            return
+        else:
+            method = event['method']
+            match method:
+                case WhitebitWsClient.DEALS_UPDATE:
+                    logging.info(event['params'])
+            return
+
+
+async def main() -> None:
+    bot = Bot()
+    await bot.get_deals("BTC_USDT", 0, 100)
+    await bot.subscribe_deals(["BTC_USDT"])
+    while not bot.exception_occur:
+        await asyncio.sleep(100)
+    return
+
+
+if __name__ == '__main__':
+    logging.basicConfig(level=logging.INFO)
+    loop = asyncio.new_event_loop()
+    asyncio.set_event_loop(loop)
+    try:
+        asyncio.run(main())
+    except KeyboardInterrupt:
+        pass
+    finally:
+        loop.close()
+```

whitebit_python_sdk-1.1.0/examples/collateral_examples.py

@@ -0,0 +1,62 @@
+import time
+import logging.config
+
+from whitebit.collateral.market.market import CollateralMarketClient
+from whitebit.collateral.account.account import CollateralAccountClient
+from whitebit.collateral.order.order import CollateralOrderClient
+
+logging.basicConfig(
+    format='%(asctime)s %(module)s,line: %(lineno)d %(levelname)8s | %(message)s',
+    datefmt='%Y/%m/%d %H:%M:%S',
+    level=logging.INFO
+)
+
+logging.getLogger().setLevel(logging.INFO)
+logging.getLogger('requests').setLevel(logging.WARNING)
+logging.getLogger('urllib3').setLevel(logging.WARNING)
+
+
+def market_examples() -> None:
+    """Example usage of the Market client"""
+    market = CollateralMarketClient()
+
+    print(market.get_markets_info())
+    print(market.get_futures_markets())
+
+    time.sleep(2)
+
+
+def account_examples() -> None:
+    account = CollateralAccountClient(api_key="",
+                                api_secret="")
+
+    print(account.get_balance())
+    print(account.get_open_positions("BTC_USDT"))
+    print(account.set_leverage("5"))
+    print(account.get_summary())
+    print(account.get_positions_history())
+    print(account.get_oco_orders("BTC_USDT"))
+
+
+def order_examples() ->None:
+    margin_order = CollateralOrderClient(api_key="",
+                        api_secret="")
+
+    print(margin_order.put_limit("BTC_USDT", "sell", "0.1", "40000", True))
+    print(margin_order.put_market("BTC_USDT", "sell", "6"))
+    print(margin_order.put_oco("BTC_USDT", "sell", "0.1", "30000", "20000", "21000"))
+    print(margin_order.put_stop_limit("BTC_USDT", "sell", "0.1", "30000", "31000"))
+    print(margin_order.put_stop_market("BTC_USDT", "sell", "0.1", "30000"))
+    print(margin_order.cancel_order("BTC_USDT", 168937230825))
+    print(margin_order.cancel_oco("BTC_USDT", 168937233685))
+
+
+
+def main() -> None:
+    market_examples()
+    account_examples()
+    order_examples()
+
+
+if __name__ == '__main__':
+    main()

whitebit_python_sdk-1.1.0/examples/main_examples.py

@@ -0,0 +1,40 @@
+import time
+import logging.config
+
+from whitebit.main.account.account import MainAccountClient
+
+logging.basicConfig(
+    format='%(asctime)s %(module)s,line: %(lineno)d %(levelname)8s | %(message)s',
+    datefmt='%Y/%m/%d %H:%M:%S',
+    level=logging.INFO
+)
+
+logging.getLogger().setLevel(logging.INFO)
+logging.getLogger('requests').setLevel(logging.WARNING)
+logging.getLogger('urllib3').setLevel(logging.WARNING)
+
+
+def main_examples() -> None:
+    """Example usage of the main account client"""
+    account = MainAccountClient(api_key="",
+                                api_secret="")
+
+    print(account.get_my_codes())
+    print(account.get_codes_history())
+    print(account.get_fee())
+    print(account.get_balance("USDT"))
+    print(account.get_history())
+    print(account.create_code("USDT", "10"))
+    print(account.apply_code("WB5cb61d11-baa5-40a9-a9ad-ee81f50909f4USDT"))
+    print(account.get_custom_fee())
+    print(account.get_custom_fee_by_market("BTC_USDT"))
+
+    time.sleep(2)
+
+
+def main() -> None:
+    main_examples()
+
+
+if __name__ == '__main__':
+    main()

whitebit_python_sdk-1.1.0/examples/trade_examples.py

@@ -0,0 +1,79 @@
+import time
+import logging.config
+
+from whitebit.trade.market.market import TradeMarketClient
+from whitebit.trade.account.account import TradeAccountClient
+from whitebit.trade.order.order import TradeOrderClient
+
+logging.basicConfig(
+    format='%(asctime)s %(module)s,line: %(lineno)d %(levelname)8s | %(message)s',
+    datefmt='%Y/%m/%d %H:%M:%S',
+    level=logging.INFO
+)
+
+logging.getLogger().setLevel(logging.INFO)
+logging.getLogger('requests').setLevel(logging.WARNING)
+logging.getLogger('urllib3').setLevel(logging.WARNING)
+
+
+def market_examples() -> None:
+    """Example usage of the Market client"""
+    market = TradeMarketClient()
+
+    print(market.get_tickers())
+    print(market.get_markets_info())
+    print(market.get_market_activity())
+    print(market.get_single_market_activity("BTC_USDT"))
+    print(market.get_symbols())
+    print(market.get_kline("BTC_USDT"))
+    print(market.get_trading_fee())
+    print(market.get_fee_list())
+    print(market.get_depth("BTC_USDT"))
+    print(market.get_order_book(market="BTC_USDT", limit="10", level="0.1"))
+    print(market.get_trade_history("BTC_USDT", 123))
+    print(market.get_deals("BTC_USDT"))
+    print(market.get_assets())
+    time.sleep(2)
+
+
+def account_examples():
+    account = TradeAccountClient(api_key="",
+                                 api_secret="")
+    print(account.get_balance())
+    print(account.get_history())
+    print(account.get_order_deals(1))
+    print(account.get_executed_history())
+    print(account.get_unexecuted_orders("BTC_USDT"))
+    print(account.get_ping())
+    print(account.get_time())
+    print(account.get_ws_token())
+
+
+def order_examples():
+    order = TradeOrderClient(api_key="",
+                             api_secret="")
+    print(order.put_limit("BTC_UzSDT", "sell", "0.1", "40000", True))
+    print(order.put_market("BTC_USDT", "buy", "6"))
+    print(order.put_market_stock("BTC_USDT", "sell", "0.1"))
+    print(order.put_stop_limit("BTC_USDT", "sell", "0.1", "30000", "31000"))
+    print(order.put_stop_market("BTC_USDT", "sell", "0.1", "30000"))
+    print(order.cancel_order("BTC_USDT", 168935136388))
+
+    bulk_orders = list()
+    bulk_orders.append(order.build_limit_order("BTC_USDT", "buy", "0.000199", "20000"))
+    bulk_orders.append(
+       order.build_limit_order("ETH_USDT", "buy", "0.00428", "1400", post_only=True, ioc=False, client_order_id="myId")
+    )
+    print(order.limit_bulk(bulk_orders))
+    print(order.put_kill_switch("BTC_USDT", "30", [order.ORDER_TYPE_SPOT]))
+    print(order.get_kill_switch_status())
+
+
+def main() -> None:
+    market_examples()
+    account_examples()
+    order_examples()
+
+
+if __name__ == '__main__':
+    main()

whitebit_python_sdk-1.1.0/examples/ws_example.py

@@ -0,0 +1,47 @@
+import asyncio
+import logging
+
+from whitebit.stream.ws import WhitebitWsClient
+
+
+class Bot(WhitebitWsClient):
+    '''Can be used to create a custom trading strategy/bot'''
+
+    def __init__(self):
+        super().__init__(key="", secret="")
+
+    async def on_message(self, event) -> None:
+        '''receives the websocket events'''
+        if 'result' in event:
+            result = event['result']
+            match result:
+                case 'pong': return
+            logging.info(event['result'])
+            return
+        else:
+            method = event['method']
+            match method:
+                case WhitebitWsClient.DEALS_UPDATE:
+                    logging.info(event['params'])
+            return
+
+
+async def main() -> None:
+    bot = Bot()
+    await bot.get_deals("BTC_USDT", 0, 100)
+    await bot.subscribe_deals(["BTC_USDT"])
+    while not bot.exception_occur:
+        await asyncio.sleep(100)
+    return
+
+
+if __name__ == '__main__':
+    logging.basicConfig(level=logging.INFO)
+    loop = asyncio.new_event_loop()
+    asyncio.set_event_loop(loop)
+    try:
+        asyncio.run(main())
+    except KeyboardInterrupt:
+        pass
+    finally:
+        loop.close()

whitebit_python_sdk-1.1.0/pyproject.toml

@@ -0,0 +1,53 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "whitebit-python-sdk"
+version = "1.1.0"
+description = "A Python SDK for WhiteBit cryptocurrency exchange API"
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "MIT"}
+keywords = ["whitebit", "cryptocurrency", "exchange", "api", "sdk", "trading"]
+authors = [
+    {name = "WhiteBit SDK Team"}
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Office/Business :: Financial",
+]
+dependencies = [
+    "requests>=2.28.1,<3.0.0",
+    "websockets>=10.4,<11.0",
+    "responses>=0.23.1",
+    "urllib3>=1.26.15,<2.0.0",
+    "pydantic>=1.10.0,<3.0.0",
+    "httpx>=0.23.0,<1.0.0",
+]
+
+[project.urls]
+Homepage = "https://www.whitebit.com"
+Documentation = "https://whitebit-exchange.github.io/api-docs/"
+Repository = "https://github.com/whitebit-exchange/python-sdk"
+Issues = "https://github.com/whitebit-exchange/python-sdk/issues"
+
+[tool.setuptools]
+# Автоматически найти пакеты в src/
+zip-safe = false
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["whitebit*"]
+namespaces = false
+
+[tool.setuptools.package-data]
+whitebit = ["py.typed"]

whitebit_python_sdk-1.1.0/requirements.txt

@@ -0,0 +1,4 @@
+requests==2.28.1
+websockets==10.4
+responses==0.23.1
+urllib3==1.26.15

whitebit_python_sdk-1.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+