crypticorn 2.13.0__py3-none-any.whl → 2.13.1__py3-none-any.whl

crypticorn/trade/client/models/futures_trading_action_create.py

@@ -17,20 +17,12 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import (
-    BaseModel,
-    ConfigDict,
-    Field,
-    StrictBool,
-    StrictFloat,
-    StrictInt,
-    StrictStr,
-)
-from typing import Any, ClassVar, Dict, List, Optional, Union
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
 from crypticorn.trade.client.models.margin_mode import MarginMode
 from crypticorn.trade.client.models.market_type import MarketType
-from crypticorn.trade.client.models.tpsl import TPSL
+from crypticorn.trade.client.models.tpsl_create import TPSLCreate
 from crypticorn.trade.client.models.trading_action_type import TradingActionType
 from typing import Optional, Set
 from typing_extensions import Self
@@ -41,6 +33,8 @@ class FuturesTradingActionCreate(BaseModel):
     Model for sending futures trading actions
     """  # noqa: E501
 
+    leverage: Optional[Annotated[int, Field(strict=True, ge=1)]]
+    margin_mode: Optional[MarginMode] = None
     execution_id: Optional[StrictStr] = None
     open_order_execution_id: Optional[StrictStr] = None
     action_type: TradingActionType = Field(description="The type of action.")
@@ -50,22 +44,16 @@ class FuturesTradingActionCreate(BaseModel):
         description="Trading symbol or asset pair in format: 'symbol/quote_currency' (see market service for valid symbols)"
     )
     is_limit: Optional[StrictBool] = None
-    limit_price: Optional[Union[StrictFloat, StrictInt]] = None
-    allocation: Optional[
-        Union[
-            Annotated[float, Field(le=1.0, strict=True)],
-            Annotated[int, Field(le=1, strict=True)],
-        ]
-    ] = Field(
-        default=None,
-        description="How much of bot's balance to use for the order (for open actions). How much of the reference open order (open_order_execution_id) to close (for close actions). 0=0%, 1=100%.",
+    limit_price: Optional[StrictStr] = None
+    allocation: StrictStr = Field(
+        description="How much of bot's balance to use for the order (for open actions). How much of the reference open order (open_order_execution_id) to close (for close actions). 0=0%, 1=100%."
     )
-    take_profit: Optional[List[TPSL]] = None
-    stop_loss: Optional[List[TPSL]] = None
+    take_profit: Optional[List[TPSLCreate]] = None
+    stop_loss: Optional[List[TPSLCreate]] = None
     expiry_timestamp: Optional[StrictInt] = None
-    leverage: Optional[Annotated[int, Field(strict=True, ge=1)]]
-    margin_mode: Optional[MarginMode] = None
     __properties: ClassVar[List[str]] = [
+        "leverage",
+        "margin_mode",
         "execution_id",
         "open_order_execution_id",
         "action_type",
@@ -78,8 +66,6 @@ class FuturesTradingActionCreate(BaseModel):
         "take_profit",
         "stop_loss",
         "expiry_timestamp",
-        "leverage",
-        "margin_mode",
     ]
 
     model_config = ConfigDict(
@@ -133,6 +119,16 @@ class FuturesTradingActionCreate(BaseModel):
                 if _item_stop_loss:
                     _items.append(_item_stop_loss.to_dict())
             _dict["stop_loss"] = _items
+        # set to None if leverage (nullable) is None
+        # and model_fields_set contains the field
+        if self.leverage is None and "leverage" in self.model_fields_set:
+            _dict["leverage"] = None
+
+        # set to None if margin_mode (nullable) is None
+        # and model_fields_set contains the field
+        if self.margin_mode is None and "margin_mode" in self.model_fields_set:
+            _dict["margin_mode"] = None
+
         # set to None if execution_id (nullable) is None
         # and model_fields_set contains the field
         if self.execution_id is None and "execution_id" in self.model_fields_set:
@@ -174,16 +170,6 @@ class FuturesTradingActionCreate(BaseModel):
         ):
             _dict["expiry_timestamp"] = None
 
-        # set to None if leverage (nullable) is None
-        # and model_fields_set contains the field
-        if self.leverage is None and "leverage" in self.model_fields_set:
-            _dict["leverage"] = None
-
-        # set to None if margin_mode (nullable) is None
-        # and model_fields_set contains the field
-        if self.margin_mode is None and "margin_mode" in self.model_fields_set:
-            _dict["margin_mode"] = None
-
         return _dict
 
     @classmethod
@@ -197,6 +183,10 @@ class FuturesTradingActionCreate(BaseModel):
 
         _obj = cls.model_validate(
             {
+                "leverage": (
+                    obj.get("leverage") if obj.get("leverage") is not None else 1
+                ),
+                "margin_mode": obj.get("margin_mode"),
                 "execution_id": obj.get("execution_id"),
                 "open_order_execution_id": obj.get("open_order_execution_id"),
                 "action_type": obj.get("action_type"),
@@ -207,20 +197,16 @@ class FuturesTradingActionCreate(BaseModel):
                 "limit_price": obj.get("limit_price"),
                 "allocation": obj.get("allocation"),
                 "take_profit": (
-                    [TPSL.from_dict(_item) for _item in obj["take_profit"]]
+                    [TPSLCreate.from_dict(_item) for _item in obj["take_profit"]]
                     if obj.get("take_profit") is not None
                     else None
                 ),
                 "stop_loss": (
-                    [TPSL.from_dict(_item) for _item in obj["stop_loss"]]
+                    [TPSLCreate.from_dict(_item) for _item in obj["stop_loss"]]
                     if obj.get("stop_loss") is not None
                     else None
                 ),
                 "expiry_timestamp": obj.get("expiry_timestamp"),
-                "leverage": (
-                    obj.get("leverage") if obj.get("leverage") is not None else 1
-                ),
-                "margin_mode": obj.get("margin_mode"),
             }
         )
         return _obj

crypticorn/trade/client/models/order.py

@@ -17,9 +17,8 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional, Union
-from typing_extensions import Annotated
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
 from crypticorn.trade.client.models.api_error_identifier import ApiErrorIdentifier
 from crypticorn.trade.client.models.exchange import Exchange
 from crypticorn.trade.client.models.margin_mode import MarginMode
@@ -55,37 +54,21 @@ class Order(BaseModel):
     exchange: Optional[Exchange] = None
     symbol: Optional[StrictStr] = None
     common_symbol: Optional[StrictStr] = None
-    price: Optional[Union[StrictFloat, StrictInt]] = None
+    price: Optional[StrictStr] = None
     action_type: Optional[TradingActionType] = None
     market_type: Optional[MarketType] = None
     margin_mode: Optional[MarginMode] = None
     status_code: Optional[ApiErrorIdentifier] = None
     status: Optional[OrderStatus] = None
-    filled_perc: Optional[
-        Union[
-            Annotated[float, Field(le=1.0, strict=True, ge=0.0)],
-            Annotated[int, Field(le=1, strict=True, ge=0)],
-        ]
-    ] = Field(default=0, description="Percentage of the order filled")
-    filled_qty: Optional[
-        Union[
-            Annotated[float, Field(strict=True, ge=0.0)],
-            Annotated[int, Field(strict=True, ge=0)],
-        ]
-    ] = Field(
-        default=0,
-        description="Quantity filled. Needed for pnl calculation. In the symbol's base currency.",
-    )
-    fee: Optional[Union[StrictFloat, StrictInt]] = Field(
-        default=0, description="Fees for the order"
-    )
-    leverage: Optional[Union[StrictFloat, StrictInt]] = None
+    filled_perc: Optional[StrictStr] = None
+    filled_qty: Optional[StrictStr] = None
+    sent_qty: Optional[StrictStr] = None
+    fee: Optional[StrictStr] = None
+    leverage: Optional[StrictInt] = None
     order_details: Optional[Any] = Field(
         default=None, description="Exchange specific details of the order"
     )
-    pnl: Optional[Union[StrictFloat, StrictInt]] = Field(
-        default=0, description="Profit and loss for the order"
-    )
+    pnl: Optional[StrictStr] = None
     order_time: Optional[StrictInt] = None
     __properties: ClassVar[List[str]] = [
         "created_at",
@@ -110,6 +93,7 @@ class Order(BaseModel):
         "status",
         "filled_perc",
         "filled_qty",
+        "sent_qty",
         "fee",
         "leverage",
         "order_details",
@@ -248,6 +232,26 @@ class Order(BaseModel):
         if self.status is None and "status" in self.model_fields_set:
             _dict["status"] = None
 
+        # set to None if filled_perc (nullable) is None
+        # and model_fields_set contains the field
+        if self.filled_perc is None and "filled_perc" in self.model_fields_set:
+            _dict["filled_perc"] = None
+
+        # set to None if filled_qty (nullable) is None
+        # and model_fields_set contains the field
+        if self.filled_qty is None and "filled_qty" in self.model_fields_set:
+            _dict["filled_qty"] = None
+
+        # set to None if sent_qty (nullable) is None
+        # and model_fields_set contains the field
+        if self.sent_qty is None and "sent_qty" in self.model_fields_set:
+            _dict["sent_qty"] = None
+
+        # set to None if fee (nullable) is None
+        # and model_fields_set contains the field
+        if self.fee is None and "fee" in self.model_fields_set:
+            _dict["fee"] = None
+
         # set to None if leverage (nullable) is None
         # and model_fields_set contains the field
         if self.leverage is None and "leverage" in self.model_fields_set:
@@ -258,6 +262,11 @@ class Order(BaseModel):
         if self.order_details is None and "order_details" in self.model_fields_set:
             _dict["order_details"] = None
 
+        # set to None if pnl (nullable) is None
+        # and model_fields_set contains the field
+        if self.pnl is None and "pnl" in self.model_fields_set:
+            _dict["pnl"] = None
+
         # set to None if order_time (nullable) is None
         # and model_fields_set contains the field
         if self.order_time is None and "order_time" in self.model_fields_set:
@@ -296,20 +305,17 @@ class Order(BaseModel):
                 "margin_mode": obj.get("margin_mode"),
                 "status_code": obj.get("status_code"),
                 "status": obj.get("status"),
-                "filled_perc": (
-                    obj.get("filled_perc") if obj.get("filled_perc") is not None else 0
-                ),
-                "filled_qty": (
-                    obj.get("filled_qty") if obj.get("filled_qty") is not None else 0
-                ),
-                "fee": obj.get("fee") if obj.get("fee") is not None else 0,
+                "filled_perc": obj.get("filled_perc"),
+                "filled_qty": obj.get("filled_qty"),
+                "sent_qty": obj.get("sent_qty"),
+                "fee": obj.get("fee"),
                 "leverage": obj.get("leverage"),
                 "order_details": (
                     AnyOf.from_dict(obj["order_details"])
                     if obj.get("order_details") is not None
                     else None
                 ),
-                "pnl": obj.get("pnl") if obj.get("pnl") is not None else 0,
+                "pnl": obj.get("pnl"),
                 "order_time": obj.get("order_time"),
             }
         )

crypticorn/trade/client/models/spot_trading_action_create.py

@@ -17,19 +17,10 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import (
-    BaseModel,
-    ConfigDict,
-    Field,
-    StrictBool,
-    StrictFloat,
-    StrictInt,
-    StrictStr,
-)
-from typing import Any, ClassVar, Dict, List, Optional, Union
-from typing_extensions import Annotated
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
 from crypticorn.trade.client.models.market_type import MarketType
-from crypticorn.trade.client.models.tpsl import TPSL
+from crypticorn.trade.client.models.tpsl_create import TPSLCreate
 from crypticorn.trade.client.models.trading_action_type import TradingActionType
 from typing import Optional, Set
 from typing_extensions import Self
@@ -49,18 +40,12 @@ class SpotTradingActionCreate(BaseModel):
         description="Trading symbol or asset pair in format: 'symbol/quote_currency' (see market service for valid symbols)"
     )
     is_limit: Optional[StrictBool] = None
-    limit_price: Optional[Union[StrictFloat, StrictInt]] = None
-    allocation: Optional[
-        Union[
-            Annotated[float, Field(le=1.0, strict=True)],
-            Annotated[int, Field(le=1, strict=True)],
-        ]
-    ] = Field(
-        default=None,
-        description="How much of bot's balance to use for the order (for open actions). How much of the reference open order (open_order_execution_id) to close (for close actions). 0=0%, 1=100%.",
+    limit_price: Optional[StrictStr] = None
+    allocation: StrictStr = Field(
+        description="How much of bot's balance to use for the order (for open actions). How much of the reference open order (open_order_execution_id) to close (for close actions). 0=0%, 1=100%."
     )
-    take_profit: Optional[List[TPSL]] = None
-    stop_loss: Optional[List[TPSL]] = None
+    take_profit: Optional[List[TPSLCreate]] = None
+    stop_loss: Optional[List[TPSLCreate]] = None
     expiry_timestamp: Optional[StrictInt] = None
     __properties: ClassVar[List[str]] = [
         "execution_id",
@@ -192,12 +177,12 @@ class SpotTradingActionCreate(BaseModel):
                 "limit_price": obj.get("limit_price"),
                 "allocation": obj.get("allocation"),
                 "take_profit": (
-                    [TPSL.from_dict(_item) for _item in obj["take_profit"]]
+                    [TPSLCreate.from_dict(_item) for _item in obj["take_profit"]]
                     if obj.get("take_profit") is not None
                     else None
                 ),
                 "stop_loss": (
-                    [TPSL.from_dict(_item) for _item in obj["stop_loss"]]
+                    [TPSLCreate.from_dict(_item) for _item in obj["stop_loss"]]
                     if obj.get("stop_loss") is not None
                     else None
                 ),

crypticorn/trade/client/models/strategy_exchange_info.py

@@ -17,8 +17,8 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
-from typing import Any, ClassVar, Dict, List, Union
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
+from typing import Any, ClassVar, Dict, List
 from crypticorn.trade.client.models.exchange import Exchange
 from typing import Optional, Set
 from typing_extensions import Self
@@ -30,7 +30,7 @@ class StrategyExchangeInfo(BaseModel):
     """  # noqa: E501
 
     exchange: Exchange = Field(description="Exchange name. Of type Exchange")
-    min_amount: Union[StrictFloat, StrictInt] = Field(
+    min_amount: StrictInt = Field(
         description="Minimum amount for the strategy on the exchange"
     )
     __properties: ClassVar[List[str]] = ["exchange", "min_amount"]

crypticorn/trade/client/models/tpsl.py

@@ -17,30 +17,21 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional, Union
-from typing_extensions import Annotated
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
 
 class TPSL(BaseModel):
     """
-    Model for take profit and stop loss targets
+    Runtime fields for take profit and stop loss
     """  # noqa: E501
 
-    price_delta: Optional[
-        Union[
-            Annotated[float, Field(strict=True, ge=0.0)],
-            Annotated[int, Field(strict=True, ge=0)],
-        ]
-    ] = None
-    price: Optional[Union[StrictFloat, StrictInt]] = None
-    allocation: Union[
-        Annotated[float, Field(le=1.0, strict=True, ge=0.0)],
-        Annotated[int, Field(le=1, strict=True, ge=0)],
-    ] = Field(
-        description="Percentage of the open order to sell. All allocations must sum up to 1."
+    price_delta: Optional[StrictStr] = None
+    price: Optional[StrictStr] = None
+    allocation: StrictStr = Field(
+        description="Percentage of the open order to sell. All allocations must sum up to 1. Use this allocation again when closing the order."
     )
     execution_id: Optional[StrictStr] = None
     client_order_id: Optional[StrictStr] = None

crypticorn/trade/client/models/tpsl_create.py

@@ -0,0 +1,103 @@
+# 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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class TPSLCreate(BaseModel):
+    """
+    Model for take profit and stop loss
+    """  # noqa: E501
+
+    price_delta: Optional[StrictStr] = None
+    price: Optional[StrictStr] = None
+    allocation: StrictStr = Field(
+        description="Percentage of the open order to sell. All allocations must sum up to 1. Use this allocation again when closing the order."
+    )
+    __properties: ClassVar[List[str]] = ["price_delta", "price", "allocation"]
+
+    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 TPSLCreate 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,
+        )
+        # set to None if price_delta (nullable) is None
+        # and model_fields_set contains the field
+        if self.price_delta is None and "price_delta" in self.model_fields_set:
+            _dict["price_delta"] = None
+
+        # set to None if price (nullable) is None
+        # and model_fields_set contains the field
+        if self.price is None and "price" in self.model_fields_set:
+            _dict["price"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TPSLCreate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "price_delta": obj.get("price_delta"),
+                "price": obj.get("price"),
+                "allocation": obj.get("allocation"),
+            }
+        )
+        return _obj

crypticorn/trade/main.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+from typing import TYPE_CHECKING
 from crypticorn.trade import (
     ApiClient,
     APIKeysApi,
@@ -12,6 +14,9 @@ from crypticorn.trade import (
     TradingActionsApi,
 )
 
+if TYPE_CHECKING:
+    from aiohttp import ClientSession
+
 
 class TradeClient:
     """
@@ -21,11 +26,12 @@ class TradeClient:
     config_class = Configuration
 
     def __init__(
-        self,
-        config: Configuration,
+        self, config: Configuration, http_client: Optional[ClientSession] = None
     ):
         self.config = config
         self.base_client = ApiClient(configuration=self.config)
+        if http_client is not None:
+            self.base_client.rest_client.pool_manager = http_client
         # Instantiate all the endpoint clients
         self.bots = BotsApi(self.base_client)
         self.exchanges = ExchangesApi(self.base_client)

{crypticorn-2.13.0.dist-info → crypticorn-2.13.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.13.0
+Version: 2.13.1
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 License-Expression: MIT
@@ -191,14 +191,41 @@ This utility allows direct data streaming to your local disk, instead of only re
 
 ## Advanced Usage
 
+### Sub Client Configuration
+
 You can override some configuration for specific services. If you just want to use the API as is, you don't need to configure anything.
 This might be of use if you are testing a specific API locally.
 
 To override e.g. the host for the Hive client to connect to localhost:8000 instead of the default proxy, you would do:
 ```python
-from crypticorn.hive import Configuration as Hiveconfig
+from crypticorn.hive import Configuration as HiveConfig
 from crypticorn.common import Service
 
 async with ApiClient() as client:
-        client.configure(config=HiveConfig(host="http://localhost:8000"), client=Service.HIVE)
+    client.configure(config=HiveConfig(host="http://localhost:8000"), service=Service.HIVE)
+```
+
+### Session Management
+
+By default `ApiClient` manages a single shared `aiohttp.ClientSession` for all service wrappers. You can pass your own configured `aiohttp.ClientSession` for advanced use cases (for custom retry, logging, or mocking):
+
+```python
+import aiohttp
+from crypticorn import ApiClient
+
+custom_http_client = aiohttp.ClientSession(timeout=aiohttp.ClientTimeout(total=10), headers={"X-Test": "1"})
+api = ApiClient(api_key="your-key")
+api._http_client = custom_http_client
+
+for service in api._services.values():
+    service.base_client.rest_client.pool_manager = custom_http_client
+```
+
+### Disable Logging
+
+In case you don't want any logging statements by the `crypticorn` logger to be logged to stdout, you can disable it with:
+
+```python
+from crypticorn.common import disable_logging
+disable_logging()
 ```