crypticorn 2.5.0rc5__py3-none-any.whl → 2.5.1__py3-none-any.whl

crypticorn/klines/client/models/api_error_identifier.py

@@ -0,0 +1,108 @@
+# coding: utf-8
+
+"""
+Klines Service API
+
+API for retrieving OHLCV data, funding rates, and symbol information from Binance.
+
+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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class ApiErrorIdentifier(str, Enum):
+    """
+    API error identifiers
+    """
+
+    """
+    allowed enum values
+    """
+    ALLOCATION_BELOW_CURRENT_EXPOSURE = "allocation_below_current_exposure"
+    ALLOCATION_BELOW_MIN_AMOUNT = "allocation_below_min_amount"
+    ALPHANUMERIC_CHARACTERS_ONLY = "alphanumeric_characters_only"
+    BLACK_SWAN = "black_swan"
+    BOT_ALREADY_DELETED = "bot_already_deleted"
+    BOT_DISABLED = "bot_disabled"
+    BOT_STOPPING_COMPLETED = "bot_stopping_completed"
+    CLIENT_ORDER_ID_ALREADY_EXISTS = "client_order_id_already_exists"
+    INVALID_CONTENT_TYPE = "invalid_content_type"
+    DELETE_BOT_ERROR = "delete_bot_error"
+    EXCHANGE_INVALID_SIGNATURE = "exchange_invalid_signature"
+    EXCHANGE_INVALID_TIMESTAMP = "exchange_invalid_timestamp"
+    EXCHANGE_IP_ADDRESS_IS_NOT_AUTHORIZED = "exchange_ip_address_is_not_authorized"
+    EXCHANGE_KEY_ALREADY_EXISTS = "exchange_key_already_exists"
+    EXCHANGE_KEY_IN_USE = "exchange_key_in_use"
+    EXCHANGE_SYSTEM_UNDER_MAINTENANCE = "exchange_system_under_maintenance"
+    EXCHANGE_RATE_LIMIT_EXCEEDED = "exchange_rate_limit_exceeded"
+    INSUFFICIENT_PERMISSIONS_SPOT_AND_FUTURES_REQUIRED = (
+        "insufficient_permissions_spot_and_futures_required"
+    )
+    EXCHANGE_SERVICE_TEMPORARILY_UNAVAILABLE = (
+        "exchange_service_temporarily_unavailable"
+    )
+    EXCHANGE_SYSTEM_IS_BUSY = "exchange_system_is_busy"
+    EXCHANGE_SYSTEM_CONFIGURATION_ERROR = "exchange_system_configuration_error"
+    EXCHANGE_INTERNAL_SYSTEM_ERROR = "exchange_internal_system_error"
+    EXCHANGE_USER_ACCOUNT_IS_FROZEN = "exchange_user_account_is_frozen"
+    FORBIDDEN = "forbidden"
+    HEDGE_MODE_NOT_ACTIVE = "hedge_mode_not_active"
+    HTTP_REQUEST_ERROR = "http_request_error"
+    INSUFFICIENT_BALANCE = "insufficient_balance"
+    INSUFFICIENT_MARGIN = "insufficient_margin"
+    INSUFFICIENT_SCOPES = "insufficient_scopes"
+    INVALID_API_KEY = "invalid_api_key"
+    INVALID_BEARER = "invalid_bearer"
+    INVALID_DATA = "invalid_data"
+    INVALID_DATA_RESPONSE = "invalid_data_response"
+    INVALID_EXCHANGE_KEY = "invalid_exchange_key"
+    INVALID_MARGIN_MODE = "invalid_margin_mode"
+    INVALID_PARAMETER_PROVIDED = "invalid_parameter_provided"
+    JWT_EXPIRED = "jwt_expired"
+    LEVERAGE_LIMIT_EXCEEDED = "leverage_limit_exceeded"
+    ORDER_VIOLATES_LIQUIDATION_PRICE_CONSTRAINTS = (
+        "order_violates_liquidation_price_constraints"
+    )
+    NO_CREDENTIALS = "no_credentials"
+    NOW_API_DOWN = "now_api_down"
+    OBJECT_NOT_FOUND = "object_not_found"
+    OBJECT_ALREADY_EXISTS = "object_already_exists"
+    ORDER_IS_ALREADY_FILLED = "order_is_already_filled"
+    ORDER_IS_BEING_PROCESSED = "order_is_being_processed"
+    ORDER_QUANTITY_LIMIT_EXCEEDED = "order_quantity_limit_exceeded"
+    ORDER_DOES_NOT_EXIST = "order_does_not_exist"
+    ORDER_PRICE_IS_INVALID = "order_price_is_invalid"
+    ORDER_SIZE_TOO_LARGE = "order_size_too_large"
+    ORDER_SIZE_TOO_SMALL = "order_size_too_small"
+    POSITION_LIMIT_EXCEEDED = "position_limit_exceeded"
+    POSITION_DOES_NOT_EXIST = "position_does_not_exist"
+    POSITION_OPENING_TEMPORARILY_SUSPENDED = "position_opening_temporarily_suspended"
+    POST_ONLY_ORDER_WOULD_IMMEDIATELY_MATCH = "post_only_order_would_immediately_match"
+    REQUEST_SCOPE_LIMIT_EXCEEDED = "request_scope_limit_exceeded"
+    RISK_LIMIT_EXCEEDED = "risk_limit_exceeded"
+    RPC_TIMEOUT = "rpc_timeout"
+    SYSTEM_SETTLEMENT_IN_PROCESS = "system_settlement_in_process"
+    STRATEGY_DISABLED = "strategy_disabled"
+    STRATEGY_LEVERAGE_MISMATCH = "strategy_leverage_mismatch"
+    STRATEGY_NOT_SUPPORTING_EXCHANGE = "strategy_not_supporting_exchange"
+    SUCCESS = "success"
+    SYMBOL_DOES_NOT_EXIST = "symbol_does_not_exist"
+    TRADING_ACTION_EXPIRED = "trading_action_expired"
+    TRADING_ACTION_SKIPPED = "trading_action_skipped"
+    TRADING_HAS_BEEN_LOCKED = "trading_has_been_locked"
+    TRADING_IS_SUSPENDED = "trading_is_suspended"
+    UNKNOWN_ERROR_OCCURRED = "unknown_error_occurred"
+    REQUESTED_RESOURCE_NOT_FOUND = "requested_resource_not_found"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ApiErrorIdentifier from a JSON string"""
+        return cls(json.loads(json_str))

crypticorn/klines/client/models/api_error_level.py

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+"""
+Klines Service API
+
+API for retrieving OHLCV data, funding rates, and symbol information from Binance.
+
+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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class ApiErrorLevel(str, Enum):
+    """
+    API error levels
+    """
+
+    """
+    allowed enum values
+    """
+    ERROR = "error"
+    INFO = "info"
+    SUCCESS = "success"
+    WARNING = "warning"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ApiErrorLevel from a JSON string"""
+        return cls(json.loads(json_str))

crypticorn/klines/client/models/api_error_type.py

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+"""
+Klines Service API
+
+API for retrieving OHLCV data, funding rates, and symbol information from Binance.
+
+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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class ApiErrorType(str, Enum):
+    """
+    Type of API error
+    """
+
+    """
+    allowed enum values
+    """
+    USER_ERROR = "user error"
+    EXCHANGE_ERROR = "exchange error"
+    SERVER_ERROR = "server error"
+    NO_ERROR = "no error"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ApiErrorType from a JSON string"""
+        return cls(json.loads(json_str))

crypticorn/klines/client/models/change_in_timeframe.py

@@ -0,0 +1,86 @@
+# coding: utf-8
+
+"""
+Klines Service API
+
+API for retrieving OHLCV data, funding rates, and symbol information from Binance.
+
+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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class ChangeInTimeframe(BaseModel):
+    """
+    ChangeInTimeframe
+    """  # noqa: E501
+
+    pair: StrictStr
+    change: Union[StrictFloat, StrictInt]
+    __properties: ClassVar[List[str]] = ["pair", "change"]
+
+    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 ChangeInTimeframe 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 ChangeInTimeframe from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"pair": obj.get("pair"), "change": obj.get("change")}
+        )
+        return _obj

crypticorn/klines/client/models/exception_detail.py

@@ -0,0 +1,117 @@
+# coding: utf-8
+
+"""
+Klines Service API
+
+API for retrieving OHLCV data, funding rates, and symbol information from Binance.
+
+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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from crypticorn.klines.client.models.api_error_identifier import ApiErrorIdentifier
+from crypticorn.klines.client.models.api_error_level import ApiErrorLevel
+from crypticorn.klines.client.models.api_error_type import ApiErrorType
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class ExceptionDetail(BaseModel):
+    """
+    This is the detail of the exception. It is used to enrich the exception with additional information by unwrapping the ApiError into its components.
+    """  # noqa: E501
+
+    message: Optional[StrictStr] = None
+    code: ApiErrorIdentifier = Field(description="The unique error code")
+    type: ApiErrorType = Field(description="The type of error")
+    level: ApiErrorLevel = Field(description="The level of the error")
+    status_code: StrictInt = Field(description="The HTTP status code")
+    details: Optional[Any] = None
+    __properties: ClassVar[List[str]] = [
+        "message",
+        "code",
+        "type",
+        "level",
+        "status_code",
+        "details",
+    ]
+
+    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 ExceptionDetail 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 message (nullable) is None
+        # and model_fields_set contains the field
+        if self.message is None and "message" in self.model_fields_set:
+            _dict["message"] = None
+
+        # set to None if details (nullable) is None
+        # and model_fields_set contains the field
+        if self.details is None and "details" in self.model_fields_set:
+            _dict["details"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ExceptionDetail from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "message": obj.get("message"),
+                "code": obj.get("code"),
+                "type": obj.get("type"),
+                "level": obj.get("level"),
+                "status_code": obj.get("status_code"),
+                "details": obj.get("details"),
+            }
+        )
+        return _obj

crypticorn/klines/client/models/funding_rate.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+Klines Service API
+
+API for retrieving OHLCV data, funding rates, and symbol information from Binance.
+
+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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class FundingRate(BaseModel):
+    """
+    FundingRate
+    """  # noqa: E501
+
+    symbol: StrictStr
+    timestamp: datetime
+    funding_rate: Union[StrictFloat, StrictInt]
+    __properties: ClassVar[List[str]] = ["symbol", "timestamp", "funding_rate"]
+
+    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 FundingRate 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 FundingRate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "symbol": obj.get("symbol"),
+                "timestamp": obj.get("timestamp"),
+                "funding_rate": obj.get("funding_rate"),
+            }
+        )
+        return _obj

crypticorn/klines/client/models/internal_exchange.py

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+"""
+Klines Service API
+
+API for retrieving OHLCV data, funding rates, and symbol information from Binance.
+
+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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class InternalExchange(str, Enum):
+    """
+    All exchanges we are using, including public (Exchange)
+    """
+
+    """
+    allowed enum values
+    """
+    KUCOIN = "kucoin"
+    BINGX = "bingx"
+    BINANCE = "binance"
+    BYBIT = "bybit"
+    HYPERLIQUID = "hyperliquid"
+    BITGET = "bitget"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of InternalExchange from a JSON string"""
+        return cls(json.loads(json_str))

crypticorn/klines/client/models/market_type.py

@@ -3,7 +3,7 @@
 """
 Klines Service API
 
-     API for retrieving OHLCV data, funding rates, and symbol information from Binance.          ## WebSocket Support     Connect to `/ws` to receive real-time OHLCV updates.          Example subscription message:     ```json     {         \"action\": \"subscribe\",         \"market\": \"spot\",         \"symbol\": \"BTCUSDT\",         \"timeframe\": \"15m\"     }     ```
+API for retrieving OHLCV data, funding rates, and symbol information from Binance.
 
 The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)

crypticorn/klines/client/models/ohlcv_history.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+Klines Service API
+
+API for retrieving OHLCV data, funding rates, and symbol information from Binance.
+
+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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class OHLCVHistory(BaseModel):
+    """
+    OHLCVHistory
+    """  # noqa: E501
+
+    timestamps: List[datetime] = Field(description="Timestamps in seconds")
+    open: List[Union[StrictFloat, StrictInt]] = Field(description="Open prices")
+    high: List[Union[StrictFloat, StrictInt]] = Field(description="High prices")
+    low: List[Union[StrictFloat, StrictInt]] = Field(description="Low prices")
+    close: List[Union[StrictFloat, StrictInt]] = Field(description="Close prices")
+    volume: List[Union[StrictFloat, StrictInt]] = Field(description="Volume")
+    __properties: ClassVar[List[str]] = [
+        "timestamps",
+        "open",
+        "high",
+        "low",
+        "close",
+        "volume",
+    ]
+
+    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 OHLCVHistory 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 OHLCVHistory from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "timestamps": obj.get("timestamps"),
+                "open": obj.get("open"),
+                "high": obj.get("high"),
+                "low": obj.get("low"),
+                "close": obj.get("close"),
+                "volume": obj.get("volume"),
+            }
+        )
+        return _obj

crypticorn/klines/client/models/resolution.py

@@ -3,7 +3,7 @@
 """
 Klines Service API
 
-     API for retrieving OHLCV data, funding rates, and symbol information from Binance.          ## WebSocket Support     Connect to `/ws` to receive real-time OHLCV updates.          Example subscription message:     ```json     {         \"action\": \"subscribe\",         \"market\": \"spot\",         \"symbol\": \"BTCUSDT\",         \"timeframe\": \"15m\"     }     ```
+API for retrieving OHLCV data, funding rates, and symbol information from Binance.
 
 The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)