trio-binance 0.3.0__py3-none-any.whl

trio_binance/enums.py

@@ -0,0 +1,70 @@
+from enum import Enum
+
+SYMBOL_TYPE_SPOT = "SPOT"
+
+ORDER_STATUS_NEW = "NEW"
+ORDER_STATUS_PARTIALLY_FILLED = "PARTIALLY_FILLED"
+ORDER_STATUS_FILLED = "FILLED"
+ORDER_STATUS_CANCELED = "CANCELED"
+ORDER_STATUS_PENDING_CANCEL = "PENDING_CANCEL"
+ORDER_STATUS_REJECTED = "REJECTED"
+ORDER_STATUS_EXPIRED = "EXPIRED"
+
+KLINE_INTERVAL_1MINUTE = "1m"
+KLINE_INTERVAL_3MINUTE = "3m"
+KLINE_INTERVAL_5MINUTE = "5m"
+KLINE_INTERVAL_15MINUTE = "15m"
+KLINE_INTERVAL_30MINUTE = "30m"
+KLINE_INTERVAL_1HOUR = "1h"
+KLINE_INTERVAL_2HOUR = "2h"
+KLINE_INTERVAL_4HOUR = "4h"
+KLINE_INTERVAL_6HOUR = "6h"
+KLINE_INTERVAL_8HOUR = "8h"
+KLINE_INTERVAL_12HOUR = "12h"
+KLINE_INTERVAL_1DAY = "1d"
+KLINE_INTERVAL_3DAY = "3d"
+KLINE_INTERVAL_1WEEK = "1w"
+KLINE_INTERVAL_1MONTH = "1M"
+
+SIDE_BUY = "BUY"
+SIDE_SELL = "SELL"
+
+ORDER_TYPE_LIMIT = "LIMIT"
+ORDER_TYPE_MARKET = "MARKET"
+ORDER_TYPE_STOP_LOSS = "STOP_LOSS"
+ORDER_TYPE_STOP_LOSS_LIMIT = "STOP_LOSS_LIMIT"
+ORDER_TYPE_TAKE_PROFIT = "TAKE_PROFIT"
+ORDER_TYPE_TAKE_PROFIT_LIMIT = "TAKE_PROFIT_LIMIT"
+ORDER_TYPE_LIMIT_MAKER = "LIMIT_MAKER"
+
+FUTURE_ORDER_TYPE_LIMIT = "LIMIT"
+FUTURE_ORDER_TYPE_MARKET = "MARKET"
+FUTURE_ORDER_TYPE_STOP = "STOP"
+FUTURE_ORDER_TYPE_STOP_MARKET = "STOP_MARKET"
+FUTURE_ORDER_TYPE_TAKE_PROFIT = "TAKE_PROFIT"
+FUTURE_ORDER_TYPE_TAKE_PROFIT_MARKET = "TAKE_PROFIT_MARKET"
+FUTURE_ORDER_TYPE_LIMIT_MAKER = "LIMIT_MAKER"
+
+TIME_IN_FORCE_GTC = "GTC"  # Good till cancelled
+TIME_IN_FORCE_IOC = "IOC"  # Immediate or cancel
+TIME_IN_FORCE_FOK = "FOK"  # Fill or kill
+TIME_IN_FORCE_GTX = "GTX"  # Post only order
+
+ORDER_RESP_TYPE_ACK = "ACK"
+ORDER_RESP_TYPE_RESULT = "RESULT"
+ORDER_RESP_TYPE_FULL = "FULL"
+
+WEBSOCKET_DEPTH_5 = "5"
+WEBSOCKET_DEPTH_10 = "10"
+WEBSOCKET_DEPTH_20 = "20"
+
+
+class FuturesType(Enum):
+    USD_M = 1
+    COIN_M = 2
+
+
+class ContractType(Enum):
+    PERPETUAL = "perpetual"
+    CURRENT_QUARTER = "current_quarter"
+    NEXT_QUARTER = "next_quarter"

trio_binance/exceptions.py

@@ -0,0 +1,76 @@
+import orjson
+
+
+class BinanceAPIException(Exception):
+    def __init__(self, response, status_code, text):
+        self.code = 0
+        try:
+            json_res = orjson.loads(text)
+        except ValueError:
+            self.message = "Invalid JSON error message from Binance: {}".format(response.text)
+        else:
+            self.code = json_res["code"]
+            self.message = json_res["msg"]
+        self.status_code = status_code
+        self.response = response
+        self.request = getattr(response, "request", None)
+
+    def __str__(self):  # pragma: no cover
+        return "APIError(code=%s): %s" % (self.code, self.message)
+
+
+class BinanceRequestException(Exception):
+    def __init__(self, message):
+        self.message = message
+
+    def __str__(self):
+        return "BinanceRequestException: %s" % self.message
+
+
+class BinanceOrderException(Exception):
+    def __init__(self, code, message):
+        self.code = code
+        self.message = message
+
+    def __str__(self):
+        return "BinanceOrderException(code=%s): %s" % (self.code, self.message)
+
+
+class BinanceOrderMinAmountException(BinanceOrderException):
+    def __init__(self, value):
+        message = "Amount must be a multiple of %s" % value
+        super().__init__(-1013, message)
+
+
+class BinanceOrderMinPriceException(BinanceOrderException):
+    def __init__(self, value):
+        message = "Price must be at least %s" % value
+        super().__init__(-1013, message)
+
+
+class BinanceOrderMinTotalException(BinanceOrderException):
+    def __init__(self, value):
+        message = "Total must be at least %s" % value
+        super().__init__(-1013, message)
+
+
+class BinanceOrderUnknownSymbolException(BinanceOrderException):
+    def __init__(self, value):
+        message = "Unknown symbol %s" % value
+        super().__init__(-1013, message)
+
+
+class BinanceOrderInactiveSymbolException(BinanceOrderException):
+    def __init__(self, value):
+        message = "Attempting to trade an inactive symbol %s" % value
+        super().__init__(-1013, message)
+
+
+class BinanceWebsocketUnableToConnect(Exception):
+    pass
+
+
+class NotImplementedException(Exception):
+    def __init__(self, value):
+        message = f"Not implemented: {value}"
+        super().__init__(message)

trio_binance/helpers.py

@@ -0,0 +1,49 @@
+from decimal import Decimal
+from typing import Union, Optional, Dict
+
+import dateparser
+import math
+import pytz
+
+from datetime import datetime
+
+
+def date_to_milliseconds(date_str: str) -> int:
+    """Convert UTC date to milliseconds
+
+    If using offset strings add "UTC" to date string e.g. "now UTC", "11 hours ago UTC"
+
+    See dateparse docs for formats http://dateparser.readthedocs.io/en/latest/
+
+    :param date_str: date in readable format, i.e. "January 01, 2018", "11 hours ago UTC", "now UTC"
+    """
+    # get epoch value in UTC
+    epoch: datetime = datetime.utcfromtimestamp(0).replace(tzinfo=pytz.utc)
+    # parse our date string
+    d: Optional[datetime] = dateparser.parse(date_str, settings={"TIMEZONE": "UTC"})
+    # if the date is not timezone aware apply UTC timezone
+    if d.tzinfo is None or d.tzinfo.utcoffset(d) is None:
+        d = d.replace(tzinfo=pytz.utc)
+
+    # return the difference in time
+    return int((d - epoch).total_seconds() * 1000.0)
+
+
+def round_step_size(quantity: Union[float, Decimal], step_size: Union[float, Decimal]) -> float:
+    """Rounds a given quantity to a specific step size
+
+    :param quantity: required
+    :param step_size: required
+
+    :return: decimal
+    """
+    precision: int = int(round(-math.log(step_size, 10), 0))
+    return float(round(quantity, precision))
+
+
+def convert_ts_str(ts_str):
+    if ts_str is None:
+        return ts_str
+    if type(ts_str) == int:
+        return ts_str
+    return date_to_milliseconds(ts_str)

trio_binance/streams.py

@@ -0,0 +1,101 @@
+from contextlib import asynccontextmanager
+from random import randint
+
+import trio
+import trio_websocket
+import orjson
+from trio_websocket import open_websocket_url
+
+from trio_binance import AsyncClient
+
+
+class BinanceSocketManager:
+    URLS = {
+        "main": {
+            "spot": "wss://stream.binance.com:9443",
+            "linear": "wss://fstream.binance.com",
+            "inverse": "wss://dstream.binance.com",
+            "portfolio": "wss://fstream.binance.com/pm",
+        },
+        "test": {},
+    }
+
+    def __init__(
+        self,
+        client: AsyncClient,
+        endpoint: str = "spot",
+        alternative_net: str = "",
+        private=False,
+    ):
+        self.ws: trio_websocket.WebSocketConnection | None = None
+        self.endpoint: str = endpoint
+        self.alternative_net: str = alternative_net if alternative_net else "main"
+        self.client: AsyncClient = client
+        self.listen_key: str = ""
+        self.user_data_stream = private
+
+    @classmethod
+    async def create(
+        cls,
+        client: AsyncClient,
+        endpoint: str = "spot",
+        alternative_net: str = "",
+        private=False,
+    ):
+        self = cls(client, endpoint, alternative_net, private)
+        if self.endpoint == "spot":
+            self.listen_key = await self.client.stream_get_listen_key()
+        elif self.endpoint == "linear":
+            self.listen_key = await self.client.futures_stream_get_listen_key()
+        elif self.endpoint == "inverse":
+            self.listen_key = await self.client.futures_coin_stream_get_listen_key()
+        elif self.endpoint == "portfolio":
+            self.listen_key = await self.client.portfolio_margin_stream_get_listen_key()
+        return self
+
+    @asynccontextmanager
+    async def connect(self):
+        try:
+            base_url = self.URLS[self.alternative_net][self.endpoint]
+            if self.user_data_stream:
+                url = f"{base_url}/ws/{self.listen_key}"
+            else:
+                url = f"{base_url}/stream"
+        except KeyError:
+            raise ValueError(f"endpoint {self.endpoint} with net {self.alternative_net} not supported")
+        async with open_websocket_url(url) as ws:
+            self.ws = ws
+            async with trio.open_nursery() as nursery:
+                nursery.start_soon(self.keepalive)
+                yield self.ws
+                nursery.cancel_scope.cancel()
+
+    async def keepalive(self):
+        while True:
+            await trio.sleep(59 * 60)
+            with trio.fail_after(5):
+                if self.endpoint == "spot":
+                    await self.client.stream_keepalive()
+                elif self.endpoint == "linear":
+                    await self.client.futures_stream_keepalive()
+                elif self.endpoint == "inverse":
+                    await self.client.futures_coin_stream_keepalive()
+                elif self.endpoint == "portfolio":
+                    await self.client.portfolio_margin_stream_keepalive()
+
+    async def subscribe(self, params: list[str], sub_id: int | None = None):
+        if sub_id is None:
+            sub_id = randint(1, 2147483647)
+        await self.ws.send_message(orjson.dumps({"method": "SUBSCRIBE", "params": params, "id": sub_id}))
+
+    async def list_subscribe(self, sub_id: int | None = None):
+        await self.ws.send_message(orjson.dumps({"method": "LIST_SUBSCRIPTIONS", "id": sub_id}))
+
+    async def unsubscribe(self, params: list[str], sub_id: int | None = None):
+        await self.ws.send_message(orjson.dumps({"method": "UNSUBSCRIBE", "params": params, "id": sub_id}))
+
+    async def get_next_message(self):
+        while True:
+            raw_message = await self.ws.get_message()
+            message = orjson.loads(raw_message)
+            yield message

trio_binance-0.3.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Shu Wang
+
+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.

trio_binance-0.3.0.dist-info/METADATA

@@ -0,0 +1,62 @@
+Metadata-Version: 2.1
+Name: trio-binance
+Version: 0.3.0
+Summary: trio based asynchronous binance SDK
+Home-page: https://github.com/halfelf/trio-binance
+License: MIT
+Keywords: binance,python-trio
+Author: Shu Wang
+Author-email: halfelf.ronin@gmail.com
+Requires-Python: >=3.11,<4.0
+Classifier: Framework :: Trio
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: dateparser (>=1.1.0,<2.0.0)
+Requires-Dist: h2 (>=4.1.0,<5.0.0)
+Requires-Dist: httpx (>0.20.0)
+Requires-Dist: orjson (>=3.6.0,<4.0.0)
+Requires-Dist: pytz (>=2024.1,<2025.0)
+Requires-Dist: trio (>=0.25.0)
+Requires-Dist: trio-websocket (>=0.11.1,<0.12.0)
+Project-URL: Repository, https://github.com/halfelf/trio-binance
+Description-Content-Type: text/x-rst
+
+=================================
+Welcome to trio-binance
+=================================
+
+This is an unofficial Python wrapper for the `Binance exchange REST API v3 <https://binance-docs.github.io/apidocs/spot/en>`_. I am in no way affiliated with Binance, use at your own risk.
+
+And this repository is forked from `python-binance <https://github.com/sammchardy/python-binance>`_, but has only async client, and works **only** with `trio <https://trio.readthedocs.io/en/stable/index.html>`_ or `trio-compatible <https://trio.readthedocs.io/en/stable/awesome-trio-libraries.html#trio-asyncio-interoperability>`_ asynchronous frameworks.
+
+Source code
+  https://github.com/halfelf/trio-binance
+
+Quick Start
+-----------
+
+`Register an account with Binance <https://accounts.binance.com/en/register?ref=10099792>`_.
+
+`Generate an API Key <https://www.binance.com/en/my/settings/api-management>`_ and assign relevant permissions.
+
+.. code:: bash
+
+    pip install trio-binance
+
+
+Example
+-------------
+
+Check pytest file under ``tests``.
+
+Donate
+------
+
+If this library helps, feel free to donate.
+
+- ETH: 0xf560e5F7F234307A20670ed8A5778F350a8366d1
+

trio_binance-0.3.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+LICENSE,sha256=h6dW5yRP__7ICaHJi7ZbKAO5Eln9wBs9Yd84flq0VB0,1065
+trio_binance/__init__.py,sha256=8s8wr4KTwy9DmgUNbowHLksHnFLjdshF6bU1Q5neFYw,67
+trio_binance/client.py,sha256=pPqWWsAa6hdLSKMBWDT5UrPsGxFubOLMlZr0hA_FrvE,77725
+trio_binance/enums.py,sha256=YS2NARvK7nMfok_YUqip_Z85ju9eR0FKrHhyMMsk4hY,1891
+trio_binance/exceptions.py,sha256=EVEDajSR3MP-Oa_9O1OW5qe7SLKPv75RI30wH7KH9sg,2260
+trio_binance/helpers.py,sha256=7y6hcFACJnrP4x2Y0yfxBJmks6piy6qWwWHa3Vxop8U,1493
+trio_binance/streams.py,sha256=2xo2SW47lLtPL1mZmA4ZLqxTzLIueg1_mEluXhrWrLs,3780
+trio_binance-0.3.0.dist-info/LICENSE,sha256=h6dW5yRP__7ICaHJi7ZbKAO5Eln9wBs9Yd84flq0VB0,1065
+trio_binance-0.3.0.dist-info/METADATA,sha256=fiAsFBRQIj3JreU-crvlDLnMBM0LGu5OqfFr-7TDSHI,2134
+trio_binance-0.3.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+trio_binance-0.3.0.dist-info/RECORD,,

trio_binance-0.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.8.1
+Root-Is-Purelib: true
+Tag: py3-none-any