crypticorn 2.16.0__py3-none-any.whl → 2.17.0__py3-none-any.whl

crypticorn/trade/client/models/__init__.py

@@ -14,6 +14,7 @@ Do not edit the class manually.
 
 
 # import models into model package
+from crypticorn.trade.client.models.actions_count import ActionsCount
 from crypticorn.trade.client.models.api_error_identifier import ApiErrorIdentifier
 from crypticorn.trade.client.models.api_error_level import ApiErrorLevel
 from crypticorn.trade.client.models.api_error_type import ApiErrorType
@@ -24,6 +25,7 @@ from crypticorn.trade.client.models.bot_update import BotUpdate
 from crypticorn.trade.client.models.exception_detail import ExceptionDetail
 from crypticorn.trade.client.models.exchange import Exchange
 from crypticorn.trade.client.models.exchange_key import ExchangeKey
+from crypticorn.trade.client.models.exchange_key_balance import ExchangeKeyBalance
 from crypticorn.trade.client.models.exchange_key_create import ExchangeKeyCreate
 from crypticorn.trade.client.models.exchange_key_update import ExchangeKeyUpdate
 from crypticorn.trade.client.models.execution_ids import ExecutionIds
@@ -40,7 +42,16 @@ from crypticorn.trade.client.models.notification_create import NotificationCreat
 from crypticorn.trade.client.models.notification_update import NotificationUpdate
 from crypticorn.trade.client.models.order import Order
 from crypticorn.trade.client.models.order_status import OrderStatus
+from crypticorn.trade.client.models.orders_count import OrdersCount
+from crypticorn.trade.client.models.paginated_response_futures_trading_action import (
+    PaginatedResponseFuturesTradingAction,
+)
+from crypticorn.trade.client.models.paginated_response_order import (
+    PaginatedResponseOrder,
+)
+from crypticorn.trade.client.models.pn_l import PnL
 from crypticorn.trade.client.models.post_futures_action import PostFuturesAction
+from crypticorn.trade.client.models.spot_balance import SpotBalance
 from crypticorn.trade.client.models.spot_trading_action_create import (
     SpotTradingActionCreate,
 )

crypticorn/trade/client/models/actions_count.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+Trading API
+
+API for automated trading and exchange interface. This API is used to trade on the exchange and manage bots, API keys, orders, and more.
+
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class ActionsCount(BaseModel):
+    """
+    The number of actions for a user by day
+    """  # noqa: E501
+
+    timestamp: StrictInt = Field(
+        description="Timestamp of the latest action for the day"
+    )
+    count: StrictInt = Field(description="The number of actions for the day")
+    __properties: ClassVar[List[str]] = ["timestamp", "count"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ActionsCount from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ActionsCount from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"timestamp": obj.get("timestamp"), "count": obj.get("count")}
+        )
+        return _obj

crypticorn/trade/client/models/api_error_identifier.py

@@ -65,6 +65,7 @@ class ApiErrorIdentifier(str, Enum):
     INSUFFICIENT_MARGIN = "insufficient_margin"
     INSUFFICIENT_SCOPES = "insufficient_scopes"
     INVALID_API_KEY = "invalid_api_key"
+    INVALID_BASIC_AUTH = "invalid_basic_auth"
     INVALID_BEARER = "invalid_bearer"
     INVALID_DATA = "invalid_data"
     INVALID_DATA_RESPONSE = "invalid_data_response"

crypticorn/trade/client/models/bot.py

@@ -18,8 +18,7 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional, Union
-from typing_extensions import Annotated
+from typing import Any, ClassVar, Dict, List, Optional
 from crypticorn.trade.client.models.api_error_identifier import ApiErrorIdentifier
 from crypticorn.trade.client.models.bot_status import BotStatus
 from typing import Optional, Set
@@ -49,22 +48,12 @@ class Bot(BaseModel):
     )
     api_key_id: StrictStr = Field(description="UID for the API key")
     status_code: Optional[ApiErrorIdentifier] = None
-    current_allocation: Optional[
-        Union[
-            Annotated[float, Field(strict=True, ge=0.0)],
-            Annotated[int, Field(strict=True, ge=0)],
-        ]
-    ] = Field(
-        default=0,
+    current_allocation: Optional[StrictStr] = Field(
+        default="0",
         description="Initial allocation for the bot + accumulated PnL of the orders after the last allocation change",
     )
-    current_exposure: Optional[
-        Union[
-            Annotated[float, Field(strict=True, ge=0.0)],
-            Annotated[int, Field(strict=True, ge=0)],
-        ]
-    ] = Field(
-        default=0,
+    current_exposure: Optional[StrictStr] = Field(
+        default="0",
         description="Current exposure of the bot, aka. the sum of the absolute values of the open positions",
     )
     __properties: ClassVar[List[str]] = [
@@ -150,12 +139,12 @@ class Bot(BaseModel):
                 "current_allocation": (
                     obj.get("current_allocation")
                     if obj.get("current_allocation") is not None
-                    else 0
+                    else "0"
                 ),
                 "current_exposure": (
                     obj.get("current_exposure")
                     if obj.get("current_exposure") is not None
-                    else 0
+                    else "0"
                 ),
             }
         )

crypticorn/trade/client/models/bot_create.py

@@ -36,6 +36,7 @@ class BotCreate(BaseModel):
         description="UID for the trading strategy used by the bot"
     )
     api_key_id: StrictStr = Field(description="UID for the API key")
+    additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = [
         "name",
         "allocation",
@@ -73,14 +74,24 @@ class BotCreate(BaseModel):
         * `None` is only added to the output dict for nullable fields that
           were set at model initialization. Other fields with value `None`
           are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
         """
-        excluded_fields: Set[str] = set([])
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
 
         _dict = self.model_dump(
             by_alias=True,
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
         return _dict
 
     @classmethod
@@ -101,4 +112,9 @@ class BotCreate(BaseModel):
                 "api_key_id": obj.get("api_key_id"),
             }
         )
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
         return _obj

crypticorn/trade/client/models/bot_update.py

@@ -32,6 +32,7 @@ class BotUpdate(BaseModel):
     name: Optional[StrictStr] = None
     allocation: Optional[StrictInt] = None
     status: Optional[BotStatus] = None
+    additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["name", "allocation", "status"]
 
     model_config = ConfigDict(
@@ -63,14 +64,24 @@ class BotUpdate(BaseModel):
         * `None` is only added to the output dict for nullable fields that
           were set at model initialization. Other fields with value `None`
           are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
         """
-        excluded_fields: Set[str] = set([])
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
 
         _dict = self.model_dump(
             by_alias=True,
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
         # set to None if name (nullable) is None
         # and model_fields_set contains the field
         if self.name is None and "name" in self.model_fields_set:
@@ -104,4 +115,9 @@ class BotUpdate(BaseModel):
                 "status": obj.get("status"),
             }
         )
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
         return _obj

crypticorn/trade/client/models/exchange.py

@@ -20,7 +20,7 @@ from typing_extensions import Self
 
 class Exchange(str, Enum):
     """
-    Supported exchanges for trading
+    All exchanges used in the crypticorn ecosystem. Refer to the APIs for support for a specific usecase (data, trading, etc.).
     """
 
     """
@@ -28,7 +28,12 @@ class Exchange(str, Enum):
     """
     KUCOIN = "kucoin"
     BINGX = "bingx"
+    BINANCE = "binance"
+    BYBIT = "bybit"
     HYPERLIQUID = "hyperliquid"
+    BITGET = "bitget"
+    GATEIO = "gateio"
+    BITSTAMP = "bitstamp"
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

crypticorn/trade/client/models/exchange_key.py

@@ -26,7 +26,7 @@ from typing_extensions import Self
 
 class ExchangeKey(BaseModel):
     """
-    Exchange key model not containing sensitive information for read operations.
+    Exchange API key model without sensitive credentials for safe read operations.
     """  # noqa: E501
 
     user_id: StrictStr = Field(description="UID for the user")

crypticorn/trade/client/models/exchange_key_balance.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+"""
+Trading API
+
+API for automated trading and exchange interface. This API is used to trade on the exchange and manage bots, API keys, orders, and more.
+
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from crypticorn.trade.client.models.futures_balance import FuturesBalance
+from crypticorn.trade.client.models.spot_balance import SpotBalance
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class ExchangeKeyBalance(BaseModel):
+    """
+    Balance information for an exchange API key including futures and spot balances.
+    """  # noqa: E501
+
+    api_key_id: StrictStr = Field(description="API key ID.")
+    futures: FuturesBalance = Field(description="Futures balance information.")
+    spot: List[SpotBalance] = Field(description="Spot balance information.")
+    __properties: ClassVar[List[str]] = ["api_key_id", "futures", "spot"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ExchangeKeyBalance from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of futures
+        if self.futures:
+            _dict["futures"] = self.futures.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in spot (list)
+        _items = []
+        if self.spot:
+            for _item_spot in self.spot:
+                if _item_spot:
+                    _items.append(_item_spot.to_dict())
+            _dict["spot"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ExchangeKeyBalance from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "api_key_id": obj.get("api_key_id"),
+                "futures": (
+                    FuturesBalance.from_dict(obj["futures"])
+                    if obj.get("futures") is not None
+                    else None
+                ),
+                "spot": (
+                    [SpotBalance.from_dict(_item) for _item in obj["spot"]]
+                    if obj.get("spot") is not None
+                    else None
+                ),
+            }
+        )
+        return _obj

crypticorn/trade/client/models/exchange_key_create.py

@@ -34,6 +34,7 @@ class ExchangeKeyCreate(BaseModel):
     secret: StrictStr = Field(description="API secret")
     passphrase: Optional[StrictStr] = None
     exchange: Exchange = Field(description="The exchange the API key is for.")
+    additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = [
         "label",
         "api_key",
@@ -71,14 +72,24 @@ class ExchangeKeyCreate(BaseModel):
         * `None` is only added to the output dict for nullable fields that
           were set at model initialization. Other fields with value `None`
           are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
         """
-        excluded_fields: Set[str] = set([])
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
 
         _dict = self.model_dump(
             by_alias=True,
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
         # set to None if passphrase (nullable) is None
         # and model_fields_set contains the field
         if self.passphrase is None and "passphrase" in self.model_fields_set:
@@ -104,4 +115,9 @@ class ExchangeKeyCreate(BaseModel):
                 "exchange": obj.get("exchange"),
             }
         )
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
         return _obj

crypticorn/trade/client/models/exchange_key_update.py

@@ -32,6 +32,7 @@ class ExchangeKeyUpdate(BaseModel):
     api_key: Optional[StrictStr] = None
     secret: Optional[StrictStr] = None
     passphrase: Optional[StrictStr] = None
+    additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["label", "api_key", "secret", "passphrase"]
 
     model_config = ConfigDict(
@@ -63,14 +64,24 @@ class ExchangeKeyUpdate(BaseModel):
         * `None` is only added to the output dict for nullable fields that
           were set at model initialization. Other fields with value `None`
           are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
         """
-        excluded_fields: Set[str] = set([])
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
 
         _dict = self.model_dump(
             by_alias=True,
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
         # set to None if label (nullable) is None
         # and model_fields_set contains the field
         if self.label is None and "label" in self.model_fields_set:
@@ -110,4 +121,9 @@ class ExchangeKeyUpdate(BaseModel):
                 "passphrase": obj.get("passphrase"),
             }
         )
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
         return _obj

crypticorn/trade/client/models/execution_ids.py

@@ -25,7 +25,7 @@ from typing_extensions import Self
 
 class ExecutionIds(BaseModel):
     """
-    ExecutionIds
+    Execution IDs for trading actions including main order and stop loss/take profit orders.
     """  # noqa: E501
 
     main: StrictStr = Field(description="Main execution ID.")

crypticorn/trade/client/models/futures_balance.py

@@ -28,29 +28,35 @@ class FuturesBalance(BaseModel):
     Model for futures balance
     """  # noqa: E501
 
-    api_key_id: StrictStr = Field(description="API key ID", alias="apiKeyId")
-    asset: StrictStr = Field(description="Asset/Currency code")
-    balance: Union[StrictFloat, StrictInt] = Field(description="Total balance/equity")
+    asset: StrictStr = Field(description="Asset the balance values are in")
+    equity: Union[StrictFloat, StrictInt] = Field(
+        description="Net asset value including unrealized profit and loss"
+    )
+    balance: Union[StrictFloat, StrictInt] = Field(
+        description="Actual account balance (equity - unrealized)"
+    )
     available: Union[StrictFloat, StrictInt] = Field(
         description="Available balance for trading/withdrawal"
     )
-    unrealized_pnl: Union[StrictFloat, StrictInt] = Field(
-        description="Unrealized profit and loss", alias="unrealizedPnl"
+    unrealized: Union[StrictFloat, StrictInt] = Field(
+        description="Unrealized profit and loss"
     )
-    used_margin: Optional[Union[StrictFloat, StrictInt]] = Field(
-        default=None, alias="usedMargin"
+    used: Union[StrictFloat, StrictInt] = Field(
+        description="Margin used in open positions"
     )
-    frozen_amount: Optional[Union[StrictFloat, StrictInt]] = Field(
-        default=None, alias="frozenAmount"
+    frozen: Union[StrictFloat, StrictInt] = Field(
+        description="Frozen funds not available for use"
     )
+    allocated: Optional[Union[StrictFloat, StrictInt]] = None
     __properties: ClassVar[List[str]] = [
-        "apiKeyId",
         "asset",
+        "equity",
         "balance",
         "available",
-        "unrealizedPnl",
-        "usedMargin",
-        "frozenAmount",
+        "unrealized",
+        "used",
+        "frozen",
+        "allocated",
     ]
 
     model_config = ConfigDict(
@@ -90,15 +96,10 @@ class FuturesBalance(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # set to None if used_margin (nullable) is None
-        # and model_fields_set contains the field
-        if self.used_margin is None and "used_margin" in self.model_fields_set:
-            _dict["usedMargin"] = None
-
-        # set to None if frozen_amount (nullable) is None
+        # set to None if allocated (nullable) is None
         # and model_fields_set contains the field
-        if self.frozen_amount is None and "frozen_amount" in self.model_fields_set:
-            _dict["frozenAmount"] = None
+        if self.allocated is None and "allocated" in self.model_fields_set:
+            _dict["allocated"] = None
 
         return _dict
 
@@ -113,13 +114,14 @@ class FuturesBalance(BaseModel):
 
         _obj = cls.model_validate(
             {
-                "apiKeyId": obj.get("apiKeyId"),
                 "asset": obj.get("asset"),
+                "equity": obj.get("equity"),
                 "balance": obj.get("balance"),
                 "available": obj.get("available"),
-                "unrealizedPnl": obj.get("unrealizedPnl"),
-                "usedMargin": obj.get("usedMargin"),
-                "frozenAmount": obj.get("frozenAmount"),
+                "unrealized": obj.get("unrealized"),
+                "used": obj.get("used"),
+                "frozen": obj.get("frozen"),
+                "allocated": obj.get("allocated"),
             }
         )
         return _obj

crypticorn/trade/client/models/notification.py

@@ -56,6 +56,7 @@ class Notification(BaseModel):
     type: ApiErrorType = Field(
         description="Type of the notification. Of type ApiErrorType"
     )
+    additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = [
         "user_id",
         "created_at",
@@ -97,14 +98,24 @@ class Notification(BaseModel):
         * `None` is only added to the output dict for nullable fields that
           were set at model initialization. Other fields with value `None`
           are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
         """
-        excluded_fields: Set[str] = set([])
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
 
         _dict = self.model_dump(
             by_alias=True,
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
         return _dict
 
     @classmethod
@@ -129,4 +140,9 @@ class Notification(BaseModel):
                 "type": obj.get("type"),
             }
         )
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
         return _obj