crypticorn 2.8.0rc9__py3-none-any.whl → 2.9.0rc1__py3-none-any.whl

crypticorn/klines/client/models/funding_rate.py

@@ -17,8 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from datetime import datetime
-from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr
+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
@@ -26,13 +25,12 @@ from typing_extensions import Self
 
 class FundingRate(BaseModel):
     """
-    FundingRate
+    Model for a single funding rate
     """  # noqa: E501
 
-    symbol: StrictStr
-    timestamp: datetime
-    funding_rate: Union[StrictFloat, StrictInt]
-    __properties: ClassVar[List[str]] = ["symbol", "timestamp", "funding_rate"]
+    timestamp: StrictInt = Field(description="The timestamp of the funding rate")
+    funding_rate: Union[StrictFloat, StrictInt] = Field(description="The funding rate")
+    __properties: ClassVar[List[str]] = ["timestamp", "funding_rate"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -83,10 +81,6 @@ class FundingRate(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate(
-            {
-                "symbol": obj.get("symbol"),
-                "timestamp": obj.get("timestamp"),
-                "funding_rate": obj.get("funding_rate"),
-            }
+            {"timestamp": obj.get("timestamp"), "funding_rate": obj.get("funding_rate")}
         )
         return _obj

crypticorn/klines/client/models/funding_rate_response.py

@@ -0,0 +1,103 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from crypticorn.klines.client.models.funding_rate import FundingRate
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class FundingRateResponse(BaseModel):
+    """
+    Response model for fetching funding rates
+    """  # noqa: E501
+
+    symbol: StrictStr = Field(description="The symbol of the funding rate")
+    funding_interval: StrictStr = Field(description="The funding interval")
+    funding_rates: List[FundingRate] = Field(description="The funding rates")
+    __properties: ClassVar[List[str]] = ["symbol", "funding_interval", "funding_rates"]
+
+    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 FundingRateResponse 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 each item in funding_rates (list)
+        _items = []
+        if self.funding_rates:
+            for _item_funding_rates in self.funding_rates:
+                if _item_funding_rates:
+                    _items.append(_item_funding_rates.to_dict())
+            _dict["funding_rates"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FundingRateResponse 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"),
+                "funding_interval": obj.get("funding_interval"),
+                "funding_rates": (
+                    [FundingRate.from_dict(_item) for _item in obj["funding_rates"]]
+                    if obj.get("funding_rates") is not None
+                    else None
+                ),
+            }
+        )
+        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/log_level.py

@@ -0,0 +1,38 @@
+# 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 LogLevel(str, Enum):
+    """
+    LogLevel
+    """
+
+    """
+    allowed enum values
+    """
+    DEBUG = "DEBUG"
+    INFO = "INFO"
+    WARNING = "WARNING"
+    ERROR = "ERROR"
+    CRITICAL = "CRITICAL"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of LogLevel from a JSON string"""
+        return cls(json.loads(json_str))

crypticorn/klines/client/models/market_type.py

@@ -0,0 +1,35 @@
+# 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 MarketType(str, Enum):
+    """
+    Market types
+    """
+
+    """
+    allowed enum values
+    """
+    SPOT = "spot"
+    FUTURES = "futures"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of MarketType from a JSON string"""
+        return cls(json.loads(json_str))

crypticorn/klines/client/models/{ohlcv_history.py → ohlcv.py}

@@ -17,26 +17,25 @@ 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):
+class OHLCV(BaseModel):
     """
-    OHLCVHistory
+    OHLCV
     """  # 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")
+    timestamp: StrictInt = Field(description="Timestamp in seconds")
+    open: Union[StrictFloat, StrictInt] = Field(description="Open prices")
+    high: Union[StrictFloat, StrictInt] = Field(description="High prices")
+    low: Union[StrictFloat, StrictInt] = Field(description="Low prices")
+    close: Union[StrictFloat, StrictInt] = Field(description="Close prices")
+    volume: Union[StrictFloat, StrictInt] = Field(description="Volume")
     __properties: ClassVar[List[str]] = [
-        "timestamps",
+        "timestamp",
         "open",
         "high",
         "low",
@@ -61,7 +60,7 @@ class OHLCVHistory(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of OHLCVHistory from a JSON string"""
+        """Create an instance of OHLCV from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -85,7 +84,7 @@ class OHLCVHistory(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of OHLCVHistory from a dict"""
+        """Create an instance of OHLCV from a dict"""
         if obj is None:
             return None
 
@@ -94,7 +93,7 @@ class OHLCVHistory(BaseModel):
 
         _obj = cls.model_validate(
             {
-                "timestamps": obj.get("timestamps"),
+                "timestamp": obj.get("timestamp"),
                 "open": obj.get("open"),
                 "high": obj.get("high"),
                 "low": obj.get("low"),

crypticorn/klines/client/models/search_symbol.py

@@ -17,8 +17,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from pydantic import BaseModel, ConfigDict, StrictStr
 from typing import Any, ClassVar, Dict, List
+from crypticorn.klines.client.models.internal_exchange import InternalExchange
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -30,9 +31,7 @@ class SearchSymbol(BaseModel):
 
     symbol: StrictStr
     description: StrictStr
-    exchange: StrictStr = Field(
-        description="All exchanges we are using, including public (Exchange)"
-    )
+    exchange: InternalExchange
     type: StrictStr
     __properties: ClassVar[List[str]] = ["symbol", "description", "exchange", "type"]
 

crypticorn/klines/client/models/udf_config.py

@@ -19,6 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from crypticorn.klines.client.models.internal_exchange import InternalExchange
 from crypticorn.klines.client.models.symbol_type import SymbolType
 from typing import Optional, Set
 from typing_extensions import Self
@@ -35,7 +36,7 @@ class UDFConfig(BaseModel):
     supports_search: Optional[StrictBool] = True
     supports_timescale_marks: Optional[StrictBool] = False
     supports_time: Optional[StrictBool] = True
-    exchanges: List[StrictStr]
+    exchanges: List[InternalExchange]
     symbols_types: List[SymbolType]
     currency_codes: List[StrictStr]
     supported_markets: List[StrictStr]

crypticorn/klines/main.py

@@ -65,19 +65,7 @@ class OHLCVDataApiWrapper(OHLCVDataApi):
         """
         pd = optional_import("pandas", "extra")
         response = await self.get_ohlcv(*args, **kwargs)
-        df = pd.DataFrame(
-            {
-                "timestamp": [int(d.timestamp()) for d in response.timestamps],
-                "open": response.open,
-                "high": response.high,
-                "low": response.low,
-                "close": response.close,
-                "volume": response.volume,
-            }
-        )
-        df.sort_values(by="timestamp", ascending=False, inplace=True)
-        df.reset_index(drop=True, inplace=True)
-        return df
+        return pd.DataFrame(response)
 
 
 class SymbolsApiWrapper(SymbolsApi):

crypticorn/metrics/client/api/admin_api.py

@@ -16,8 +16,8 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
-from pydantic import Field, StrictInt, StrictStr, field_validator
-from typing import Any, Dict, List, Optional
+from pydantic import Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, Dict, List, Optional, Union
 from typing_extensions import Annotated
 from crypticorn.metrics.client.models.log_level import LogLevel
 
@@ -248,7 +248,7 @@ class AdminApi:
             )
 
         # authentication setting
-        _auth_settings: List[str] = []
+        _auth_settings: List[str] = ["APIKeyHeader", "HTTPBearer"]
 
         return self.api_client.param_serialize(
             method="GET",
@@ -509,7 +509,7 @@ class AdminApi:
             )
 
         # authentication setting
-        _auth_settings: List[str] = []
+        _auth_settings: List[str] = ["APIKeyHeader", "HTTPBearer"]
 
         return self.api_client.param_serialize(
             method="GET",
@@ -541,9 +541,9 @@ class AdminApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> LogLevel:
-        """Get Logging Level
+        """(Deprecated) Get Logging Level
 
-        Get the log level of the server logger.
+        Get the log level of the server logger. Will be removed in a future release.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -566,6 +566,7 @@ class AdminApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """  # noqa: E501
+        warnings.warn("GET /admin/log-level is deprecated.", DeprecationWarning)
 
         _param = self._get_log_level_serialize(
             _request_auth=_request_auth,
@@ -601,9 +602,9 @@ class AdminApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[LogLevel]:
-        """Get Logging Level
+        """(Deprecated) Get Logging Level
 
-        Get the log level of the server logger.
+        Get the log level of the server logger. Will be removed in a future release.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -626,6 +627,7 @@ class AdminApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """  # noqa: E501
+        warnings.warn("GET /admin/log-level is deprecated.", DeprecationWarning)
 
         _param = self._get_log_level_serialize(
             _request_auth=_request_auth,
@@ -661,9 +663,9 @@ class AdminApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Get Logging Level
+        """(Deprecated) Get Logging Level
 
-        Get the log level of the server logger.
+        Get the log level of the server logger. Will be removed in a future release.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -686,6 +688,7 @@ class AdminApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """  # noqa: E501
+        warnings.warn("GET /admin/log-level is deprecated.", DeprecationWarning)
 
         _param = self._get_log_level_serialize(
             _request_auth=_request_auth,
@@ -736,7 +739,7 @@ class AdminApi:
             )
 
         # authentication setting
-        _auth_settings: List[str] = []
+        _auth_settings: List[str] = ["APIKeyHeader", "HTTPBearer"]
 
         return self.api_client.param_serialize(
             method="GET",
@@ -767,7 +770,7 @@ class AdminApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> int:
+    ) -> float:
         """Get Memory Usage
 
         Resident Set Size (RSS) in MB — the actual memory used by the process in RAM. Represents the physical memory footprint. Important for monitoring real usage.
@@ -802,7 +805,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "int",
+            "200": "float",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -827,7 +830,7 @@ class AdminApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[int]:
+    ) -> ApiResponse[float]:
         """Get Memory Usage
 
         Resident Set Size (RSS) in MB — the actual memory used by the process in RAM. Represents the physical memory footprint. Important for monitoring real usage.
@@ -862,7 +865,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "int",
+            "200": "float",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -922,7 +925,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "int",
+            "200": "float",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -963,7 +966,7 @@ class AdminApi:
             )
 
         # authentication setting
-        _auth_settings: List[str] = []
+        _auth_settings: List[str] = ["APIKeyHeader", "HTTPBearer"]
 
         return self.api_client.param_serialize(
             method="GET",
@@ -1190,7 +1193,7 @@ class AdminApi:
             )
 
         # authentication setting
-        _auth_settings: List[str] = []
+        _auth_settings: List[str] = ["APIKeyHeader", "HTTPBearer"]
 
         return self.api_client.param_serialize(
             method="GET",
@@ -1434,7 +1437,7 @@ class AdminApi:
             )
 
         # authentication setting
-        _auth_settings: List[str] = []
+        _auth_settings: List[str] = ["APIKeyHeader", "HTTPBearer"]
 
         return self.api_client.param_serialize(
             method="GET",

crypticorn/metrics/client/api/status_api.py

@@ -17,7 +17,7 @@ from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
 from pydantic import StrictStr, field_validator
-from typing import Optional
+from typing import Any, Dict, Optional
 
 from crypticorn.metrics.client.api_client import ApiClient, RequestSerialized
 from crypticorn.metrics.client.api_response import ApiResponse
@@ -294,7 +294,7 @@ class StatusApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> str:
+    ) -> Dict[str, object]:
         """Ping
 
         Returns 'OK' if the API is running.
@@ -329,7 +329,7 @@ class StatusApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "str",
+            "200": "Dict[str, object]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -354,7 +354,7 @@ class StatusApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[str]:
+    ) -> ApiResponse[Dict[str, object]]:
         """Ping
 
         Returns 'OK' if the API is running.
@@ -389,7 +389,7 @@ class StatusApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "str",
+            "200": "Dict[str, object]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -449,7 +449,7 @@ class StatusApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "str",
+            "200": "Dict[str, object]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout

crypticorn/metrics/client/configuration.py

@@ -215,7 +215,9 @@ class Configuration:
         debug: Optional[bool] = None,
     ) -> None:
         """Constructor"""
-        self._base_path = "http://localhost/v1/metrics" if host is None else host
+        self._base_path = (
+            "https://api.crypticorn.dev/v1/metrics" if host is None else host
+        )
         """Default Base url
         """
         self.server_index = 0 if server_index is None and host is None else server_index
@@ -557,7 +559,7 @@ class Configuration:
         """
         return [
             {
-                "url": "http://localhost/v1/metrics",
+                "url": "https://api.crypticorn.dev/v1/metrics",
                 "description": "No description provided",
             }
         ]

{crypticorn-2.8.0rc9.dist-info → crypticorn-2.9.0rc1.dist-info}/METADATA

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