crypticorn 2.11.7__tar.gz → 2.11.9__tar.gz

{crypticorn-2.11.7 → crypticorn-2.11.9}/CHANGELOG.md

@@ -1,6 +1,22 @@
 # CHANGELOG
 
 
+## v2.11.9 (2025-05-18)
+
+### Bug Fixes
+
+- Update status code on actions endpoints
+  ([`0c1ff41`](https://github.com/crypticorn-ai/api-client/commit/0c1ff417c1bc976cb63537c5ab0ba127585e46d4))
+
+
+## v2.11.8 (2025-05-18)
+
+### Bug Fixes
+
+- New error code `object_locked`
+  ([`d2c79a1`](https://github.com/crypticorn-ai/api-client/commit/d2c79a1c8e77c5801981b5fe2c4f0c99d9ef0943))
+
+
 ## v2.11.7 (2025-05-18)
 
 ### Bug Fixes

{crypticorn-2.11.7/crypticorn.egg-info → crypticorn-2.11.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.11.7
+Version: 2.11.9
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 License-Expression: MIT

{crypticorn-2.11.7 → crypticorn-2.11.9}/crypticorn/common/errors.py

@@ -74,6 +74,7 @@ class ApiErrorIdentifier(StrEnum):
     OBJECT_ALREADY_EXISTS = "object_already_exists"
     OBJECT_CREATED = "object_created"
     OBJECT_DELETED = "object_deleted"
+    OBJECT_LOCKED = "object_locked"
     OBJECT_NOT_FOUND = "object_not_found"
     OBJECT_UPDATED = "object_updated"
     ORDER_ALREADY_FILLED = "order_is_already_filled"
@@ -362,6 +363,11 @@ class ApiError(Enum, metaclass=ApiErrorFallback):
         ApiErrorType.SERVER_ERROR,
         ApiErrorLevel.INFO,
     )
+    OBJECT_LOCKED = (
+        ApiErrorIdentifier.OBJECT_LOCKED,
+        ApiErrorType.NO_ERROR,
+        ApiErrorLevel.INFO,
+    )
     OBJECT_NOT_FOUND = (
         ApiErrorIdentifier.OBJECT_NOT_FOUND,
         ApiErrorType.SERVER_ERROR,
@@ -842,6 +848,11 @@ class StatusCodeMapper:
             status.HTTP_204_NO_CONTENT,
             status.WS_1000_NORMAL_CLOSURE,
         ),
+        # Miscellaneous
+        ApiError.OBJECT_LOCKED: (
+            status.HTTP_423_LOCKED,
+            status.WS_1013_TRY_AGAIN_LATER,
+        ),
     }
 
     @classmethod

{crypticorn-2.11.7 → crypticorn-2.11.9}/crypticorn/trade/client/api/notifications_api.py

@@ -544,7 +544,7 @@ class NotificationsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> object:
+    ) -> None:
         """Delete Notifications
 
         Delete all notifications for the authenticated user
@@ -579,7 +579,7 @@ class NotificationsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "object",
+            "204": None,
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -604,7 +604,7 @@ class NotificationsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[object]:
+    ) -> ApiResponse[None]:
         """Delete Notifications
 
         Delete all notifications for the authenticated user
@@ -639,7 +639,7 @@ class NotificationsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "object",
+            "204": None,
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -699,7 +699,7 @@ class NotificationsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "object",
+            "204": None,
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -1034,7 +1034,7 @@ class NotificationsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> Notification:
+    ) -> None:
         """Update Notification
 
         Update a notification's viewed status
@@ -1075,7 +1075,7 @@ class NotificationsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "Notification",
+            "204": None,
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -1102,7 +1102,7 @@ class NotificationsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[Notification]:
+    ) -> ApiResponse[None]:
         """Update Notification
 
         Update a notification's viewed status
@@ -1143,7 +1143,7 @@ class NotificationsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "Notification",
+            "204": None,
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -1211,7 +1211,7 @@ class NotificationsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "Notification",
+            "204": None,
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -1300,7 +1300,7 @@ class NotificationsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> object:
+    ) -> None:
         """Update Notifications
 
         Bulk update notifications
@@ -1338,7 +1338,7 @@ class NotificationsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "object",
+            "204": None,
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -1364,7 +1364,7 @@ class NotificationsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[object]:
+    ) -> ApiResponse[None]:
         """Update Notifications
 
         Bulk update notifications
@@ -1402,7 +1402,7 @@ class NotificationsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "object",
+            "204": None,
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -1466,7 +1466,7 @@ class NotificationsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "object",
+            "204": None,
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout

{crypticorn-2.11.7 → crypticorn-2.11.9}/crypticorn/trade/client/api/strategies_api.py

@@ -17,7 +17,7 @@ from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
 from pydantic import StrictInt, StrictStr
-from typing import Any, List, Optional
+from typing import List, Optional
 from crypticorn.trade.client.models.strategy import Strategy
 from crypticorn.trade.client.models.strategy_create import StrategyCreate
 from crypticorn.trade.client.models.strategy_update import StrategyUpdate
@@ -561,7 +561,7 @@ class StrategiesApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> object:
+    ) -> None:
         """Kill Strategy
 
         Kills a strategy by disabling it and deleting all bots associated with it.
@@ -599,7 +599,7 @@ class StrategiesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "object",
+            "204": None,
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -625,7 +625,7 @@ class StrategiesApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[object]:
+    ) -> ApiResponse[None]:
         """Kill Strategy
 
         Kills a strategy by disabling it and deleting all bots associated with it.
@@ -663,7 +663,7 @@ class StrategiesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "object",
+            "204": None,
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -727,7 +727,7 @@ class StrategiesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "object",
+            "204": None,
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout

{crypticorn-2.11.7 → crypticorn-2.11.9}/crypticorn/trade/client/api/trading_actions_api.py

@@ -320,7 +320,7 @@ class TradingActionsApi:
     ) -> PostFuturesAction:
         """Post Futures Action
 
-        Endpoint to receive futures trading actions from the trading strategy
+        Endpoint to receive futures trading actions. The action is queued for processing and the response is returned immediately.
 
         :param futures_trading_action_create: (required)
         :type futures_trading_action_create: FuturesTradingActionCreate
@@ -355,7 +355,7 @@ class TradingActionsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "PostFuturesAction",
+            "202": "PostFuturesAction",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -384,7 +384,7 @@ class TradingActionsApi:
     ) -> ApiResponse[PostFuturesAction]:
         """Post Futures Action
 
-        Endpoint to receive futures trading actions from the trading strategy
+        Endpoint to receive futures trading actions. The action is queued for processing and the response is returned immediately.
 
         :param futures_trading_action_create: (required)
         :type futures_trading_action_create: FuturesTradingActionCreate
@@ -419,7 +419,7 @@ class TradingActionsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "PostFuturesAction",
+            "202": "PostFuturesAction",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -448,7 +448,7 @@ class TradingActionsApi:
     ) -> RESTResponseType:
         """Post Futures Action
 
-        Endpoint to receive futures trading actions from the trading strategy
+        Endpoint to receive futures trading actions. The action is queued for processing and the response is returned immediately.
 
         :param futures_trading_action_create: (required)
         :type futures_trading_action_create: FuturesTradingActionCreate
@@ -483,7 +483,7 @@ class TradingActionsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "PostFuturesAction",
+            "202": "PostFuturesAction",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -606,7 +606,7 @@ class TradingActionsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "object",
+            "202": "object",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -669,7 +669,7 @@ class TradingActionsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "object",
+            "202": "object",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -732,7 +732,7 @@ class TradingActionsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "object",
+            "202": "object",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout

{crypticorn-2.11.7 → crypticorn-2.11.9}/crypticorn/trade/client/models/api_error_identifier.py

@@ -80,6 +80,7 @@ class ApiErrorIdentifier(str, Enum):
     OBJECT_ALREADY_EXISTS = "object_already_exists"
     OBJECT_CREATED = "object_created"
     OBJECT_DELETED = "object_deleted"
+    OBJECT_LOCKED = "object_locked"
     OBJECT_NOT_FOUND = "object_not_found"
     OBJECT_UPDATED = "object_updated"
     ORDER_IS_ALREADY_FILLED = "order_is_already_filled"

{crypticorn-2.11.7 → crypticorn-2.11.9}/crypticorn/trade/client/models/order.py

@@ -19,6 +19,7 @@ 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 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
@@ -60,14 +61,31 @@ class Order(BaseModel):
     margin_mode: Optional[MarginMode] = None
     status_code: Optional[ApiErrorIdentifier] = None
     status: Optional[OrderStatus] = None
-    filled_perc: Optional[Union[StrictFloat, StrictInt]] = None
-    filled_qty: Optional[Union[StrictFloat, StrictInt]] = None
-    fee: Optional[Union[StrictFloat, StrictInt]] = 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
     order_details: Optional[Any] = Field(
         default=None, description="Exchange specific details of the order"
     )
-    pnl: Optional[Union[StrictFloat, StrictInt]] = None
+    pnl: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=0, description="Profit and loss for the order"
+    )
     order_time: Optional[StrictInt] = None
     __properties: ClassVar[List[str]] = [
         "id",
@@ -230,21 +248,6 @@ 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 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:
@@ -255,11 +258,6 @@ 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:
@@ -298,16 +296,20 @@ 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"),
-                "filled_qty": obj.get("filled_qty"),
-                "fee": obj.get("fee"),
+                "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,
                 "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"),
+                "pnl": obj.get("pnl") if obj.get("pnl") is not None else 0,
                 "order_time": obj.get("order_time"),
             }
         )

{crypticorn-2.11.7 → crypticorn-2.11.9}/crypticorn/trade/client/models/strategy.py

@@ -20,6 +20,7 @@ import json
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
 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.strategy_exchange_info import StrategyExchangeInfo
 from typing import Optional, Set
@@ -55,6 +56,7 @@ class Strategy(BaseModel):
     identifier: StrictStr = Field(
         description="Unique human readable identifier for the strategy e.g. 'daily_trend_momentum'"
     )
+    margin_mode: Optional[MarginMode] = None
     leverage: StrictInt = Field(description="Leverage for the strategy")
     market_type: MarketType = Field(description="Market of operation of the strategy")
     __properties: ClassVar[List[str]] = [
@@ -67,6 +69,7 @@ class Strategy(BaseModel):
         "enabled",
         "performance_fee",
         "identifier",
+        "margin_mode",
         "leverage",
         "market_type",
     ]
@@ -115,6 +118,11 @@ class Strategy(BaseModel):
                 if _item_exchanges:
                     _items.append(_item_exchanges.to_dict())
             _dict["exchanges"] = _items
+        # 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
@@ -144,6 +152,7 @@ class Strategy(BaseModel):
                 "enabled": obj.get("enabled"),
                 "performance_fee": obj.get("performance_fee"),
                 "identifier": obj.get("identifier"),
+                "margin_mode": obj.get("margin_mode"),
                 "leverage": obj.get("leverage"),
                 "market_type": obj.get("market_type"),
             }

{crypticorn-2.11.7 → crypticorn-2.11.9}/crypticorn/trade/client/models/strategy_create.py

@@ -18,8 +18,9 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List, Union
+from typing import Any, ClassVar, Dict, List, Optional, Union
 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.strategy_exchange_info import StrategyExchangeInfo
 from typing import Optional, Set
@@ -46,6 +47,7 @@ class StrategyCreate(BaseModel):
     identifier: StrictStr = Field(
         description="Unique human readable identifier for the strategy e.g. 'daily_trend_momentum'"
     )
+    margin_mode: Optional[MarginMode] = None
     leverage: StrictInt = Field(description="Leverage for the strategy")
     market_type: MarketType = Field(description="Market of operation of the strategy")
     __properties: ClassVar[List[str]] = [
@@ -55,6 +57,7 @@ class StrategyCreate(BaseModel):
         "enabled",
         "performance_fee",
         "identifier",
+        "margin_mode",
         "leverage",
         "market_type",
     ]
@@ -103,6 +106,11 @@ class StrategyCreate(BaseModel):
                 if _item_exchanges:
                     _items.append(_item_exchanges.to_dict())
             _dict["exchanges"] = _items
+        # 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
@@ -129,6 +137,7 @@ class StrategyCreate(BaseModel):
                 "enabled": obj.get("enabled"),
                 "performance_fee": obj.get("performance_fee"),
                 "identifier": obj.get("identifier"),
+                "margin_mode": obj.get("margin_mode"),
                 "leverage": obj.get("leverage"),
                 "market_type": obj.get("market_type"),
             }

{crypticorn-2.11.7 → crypticorn-2.11.9/crypticorn.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.11.7
+Version: 2.11.9
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 License-Expression: MIT

{crypticorn-2.11.7 → crypticorn-2.11.9}/pyproject.toml

@@ -5,7 +5,7 @@ readme = "README.md"
 license = "MIT"
 requires-python = ">=3.9"
 authors = [{name = "Crypticorn", email = "timon@crypticorn.com"}]
-version = "2.11.7"
+version = "2.11.9"
 keywords = ["machine learning", "data science", "crypto", "modelling"]
 dynamic = ["dependencies", "optional-dependencies"]