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

crypticorn/klines/client/models/search_symbol.py

@@ -0,0 +1,94 @@
+# 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, 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
+
+
+class SearchSymbol(BaseModel):
+    """
+    SearchSymbol
+    """  # noqa: E501
+
+    symbol: StrictStr
+    description: StrictStr
+    exchange: InternalExchange
+    type: StrictStr
+    __properties: ClassVar[List[str]] = ["symbol", "description", "exchange", "type"]
+
+    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 SearchSymbol 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 SearchSymbol 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"),
+                "description": obj.get("description"),
+                "exchange": obj.get("exchange"),
+                "type": obj.get("type"),
+            }
+        )
+        return _obj

crypticorn/klines/client/models/sort_direction.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/symbol_group.py

@@ -0,0 +1,83 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class SymbolGroup(BaseModel):
+    """
+    SymbolGroup
+    """  # noqa: E501
+
+    symbol: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["symbol"]
+
+    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 SymbolGroup 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 SymbolGroup 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")})
+        return _obj

crypticorn/klines/client/models/symbol_info.py

@@ -0,0 +1,131 @@
+# 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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class SymbolInfo(BaseModel):
+    """
+    SymbolInfo
+    """  # noqa: E501
+
+    name: StrictStr
+    exchange_traded: StrictStr = Field(alias="exchange-traded")
+    exchange_listed: StrictStr = Field(alias="exchange-listed")
+    timezone: StrictStr
+    minmov: StrictInt
+    minmov2: StrictInt
+    pointvalue: StrictInt
+    session: StrictStr
+    has_intraday: StrictBool
+    has_no_volume: StrictBool
+    description: StrictStr
+    type: StrictStr
+    supported_resolutions: List[StrictStr]
+    pricescale: StrictInt
+    ticker: StrictStr
+    __properties: ClassVar[List[str]] = [
+        "name",
+        "exchange-traded",
+        "exchange-listed",
+        "timezone",
+        "minmov",
+        "minmov2",
+        "pointvalue",
+        "session",
+        "has_intraday",
+        "has_no_volume",
+        "description",
+        "type",
+        "supported_resolutions",
+        "pricescale",
+        "ticker",
+    ]
+
+    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 SymbolInfo 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 SymbolInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "name": obj.get("name"),
+                "exchange-traded": obj.get("exchange-traded"),
+                "exchange-listed": obj.get("exchange-listed"),
+                "timezone": obj.get("timezone"),
+                "minmov": obj.get("minmov"),
+                "minmov2": obj.get("minmov2"),
+                "pointvalue": obj.get("pointvalue"),
+                "session": obj.get("session"),
+                "has_intraday": obj.get("has_intraday"),
+                "has_no_volume": obj.get("has_no_volume"),
+                "description": obj.get("description"),
+                "type": obj.get("type"),
+                "supported_resolutions": obj.get("supported_resolutions"),
+                "pricescale": obj.get("pricescale"),
+                "ticker": obj.get("ticker"),
+            }
+        )
+        return _obj

crypticorn/klines/client/models/symbol_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/timeframe.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/udf_config.py

@@ -0,0 +1,149 @@
+# 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, 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
+
+
+class UDFConfig(BaseModel):
+    """
+    UDFConfig
+    """  # noqa: E501
+
+    supported_resolutions: List[StrictStr]
+    supports_group_request: Optional[StrictBool] = False
+    supports_marks: Optional[StrictBool] = False
+    supports_search: Optional[StrictBool] = True
+    supports_timescale_marks: Optional[StrictBool] = False
+    supports_time: Optional[StrictBool] = True
+    exchanges: List[InternalExchange]
+    symbols_types: List[SymbolType]
+    currency_codes: List[StrictStr]
+    supported_markets: List[StrictStr]
+    __properties: ClassVar[List[str]] = [
+        "supported_resolutions",
+        "supports_group_request",
+        "supports_marks",
+        "supports_search",
+        "supports_timescale_marks",
+        "supports_time",
+        "exchanges",
+        "symbols_types",
+        "currency_codes",
+        "supported_markets",
+    ]
+
+    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 UDFConfig 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 symbols_types (list)
+        _items = []
+        if self.symbols_types:
+            for _item_symbols_types in self.symbols_types:
+                if _item_symbols_types:
+                    _items.append(_item_symbols_types.to_dict())
+            _dict["symbols_types"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UDFConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "supported_resolutions": obj.get("supported_resolutions"),
+                "supports_group_request": (
+                    obj.get("supports_group_request")
+                    if obj.get("supports_group_request") is not None
+                    else False
+                ),
+                "supports_marks": (
+                    obj.get("supports_marks")
+                    if obj.get("supports_marks") is not None
+                    else False
+                ),
+                "supports_search": (
+                    obj.get("supports_search")
+                    if obj.get("supports_search") is not None
+                    else True
+                ),
+                "supports_timescale_marks": (
+                    obj.get("supports_timescale_marks")
+                    if obj.get("supports_timescale_marks") is not None
+                    else False
+                ),
+                "supports_time": (
+                    obj.get("supports_time")
+                    if obj.get("supports_time") is not None
+                    else True
+                ),
+                "exchanges": obj.get("exchanges"),
+                "symbols_types": (
+                    [SymbolType.from_dict(_item) for _item in obj["symbols_types"]]
+                    if obj.get("symbols_types") is not None
+                    else None
+                ),
+                "currency_codes": obj.get("currency_codes"),
+                "supported_markets": obj.get("supported_markets"),
+            }
+        )
+        return _obj

crypticorn/klines/client/rest.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/main.py

@@ -3,7 +3,7 @@ from crypticorn.klines import (
     ApiClient,
     Configuration,
     FundingRatesApi,
-    HealthCheckApi,
+    StatusApi,
     OHLCVDataApi,
     SymbolsApi,
     UDFApi,
@@ -16,10 +16,15 @@ class FundingRatesApiWrapper(FundingRatesApi):
     A wrapper for the FundingRatesApi class.
     """
 
-    def get_funding_rates_fmt(self) -> pd.DataFrame:
+    async def get_funding_rates_fmt(self, *args, **kwargs) -> pd.DataFrame:  # type: ignore
+        """
+        Get the funding rates in a pandas DataFrame.
+        """
         pd = optional_import("pandas", "extra")
-        response = self.funding_rate_funding_rates_symbol_get()
-        return pd.DataFrame(response.json())
+        response = await self.get_funding_rates_without_preload_content(*args, **kwargs)
+        response.raise_for_status()
+        json_data = await response.json()
+        return pd.DataFrame(json_data)
 
 
 class OHLCVDataApiWrapper(OHLCVDataApi):
@@ -27,10 +32,24 @@ class OHLCVDataApiWrapper(OHLCVDataApi):
     A wrapper for the OHLCVDataApi class.
     """
 
-    def get_ohlcv_data_fmt(self) -> pd.DataFrame:
+    async def get_ohlcv_data_fmt(self, *args, **kwargs) -> pd.DataFrame:  # type: ignore
+        """
+        Get the OHLCV data in a pandas DataFrame.
+        """
         pd = optional_import("pandas", "extra")
-        response = self.get_ohlcv_market_timeframe_symbol_get()
-        return pd.DataFrame(response.json())
+        response = await self.get_ohlcv_without_preload_content(*args, **kwargs)
+        response.raise_for_status()
+        json_data = await response.json()
+        return pd.DataFrame(
+            {
+                "timestamp": json_data["timestamp"],
+                "open": json_data["open"],
+                "high": json_data["high"],
+                "low": json_data["low"],
+                "close": json_data["close"],
+                "volume": json_data["volume"],
+            }
+        )
 
 
 class SymbolsApiWrapper(SymbolsApi):
@@ -38,21 +57,17 @@ class SymbolsApiWrapper(SymbolsApi):
     A wrapper for the SymbolsApi class.
     """
 
-    def get_symbols_fmt(self) -> pd.DataFrame:
+    async def get_symbols_fmt(self, *args, **kwargs) -> pd.DataFrame:  # type: ignore
+        """
+        Get the symbols in a pandas DataFrame.
+        """
         pd = optional_import("pandas", "extra")
-        response = self.symbols_symbols_market_get()
-        return pd.DataFrame(response.json())
-
-
-class UDFApiWrapper(UDFApi):
-    """
-    A wrapper for the UDFApi class.
-    """
-
-    def get_udf_fmt(self) -> pd.DataFrame:
-        pd = optional_import("pandas", "extra")
-        response = self.get_history_udf_history_get()
-        return pd.DataFrame(response.json())
+        response = await self.get_klines_symbols_without_preload_content(
+            *args, **kwargs
+        )
+        response.raise_for_status()
+        json_data = await response.json()
+        return pd.DataFrame(json_data["data"], columns=["symbol"])
 
 
 class KlinesClient:
@@ -60,6 +75,8 @@ class KlinesClient:
     A client for interacting with the Crypticorn Klines API.
     """
 
+    config_class = Configuration
+
     def __init__(
         self,
         config: Configuration,
@@ -70,5 +87,5 @@ class KlinesClient:
         self.funding = FundingRatesApiWrapper(self.base_client)
         self.ohlcv = OHLCVDataApiWrapper(self.base_client)
         self.symbols = SymbolsApiWrapper(self.base_client)
-        self.udf = UDFApiWrapper(self.base_client)
-        self.health = HealthCheckApi(self.base_client)
+        self.udf = UDFApi(self.base_client)
+        self.status = StatusApi(self.base_client)

crypticorn/metrics/client/__init__.py

@@ -5,7 +5,7 @@
 """
 Marketcap Service API
 
-     API for retrieving historical marketcap data, available exchanges, and indicators.          ## Features     - Historical marketcap data     - OHLCV data with marketcap     - Technical indicators (KER, SMA)     - Exchange and symbol mappings     - Error logs
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -18,11 +18,11 @@ __version__ = "1.0.0"
 
 # import apis into sdk package
 from crypticorn.metrics.client.api.exchanges_api import ExchangesApi
-from crypticorn.metrics.client.api.health_check_api import HealthCheckApi
 from crypticorn.metrics.client.api.indicators_api import IndicatorsApi
 from crypticorn.metrics.client.api.logs_api import LogsApi
 from crypticorn.metrics.client.api.marketcap_api import MarketcapApi
 from crypticorn.metrics.client.api.markets_api import MarketsApi
+from crypticorn.metrics.client.api.status_api import StatusApi
 from crypticorn.metrics.client.api.tokens_api import TokensApi
 
 # import ApiClient
@@ -37,26 +37,12 @@ from crypticorn.metrics.client.exceptions import ApiAttributeError
 from crypticorn.metrics.client.exceptions import ApiException
 
 # import models into sdk package
-from crypticorn.metrics.client.models.base_response_dict import BaseResponseDict
-from crypticorn.metrics.client.models.base_response_health_check_response import (
-    BaseResponseHealthCheckResponse,
-)
-from crypticorn.metrics.client.models.base_response_list_dict import (
-    BaseResponseListDict,
-)
-from crypticorn.metrics.client.models.base_response_list_exchange_mapping import (
-    BaseResponseListExchangeMapping,
-)
-from crypticorn.metrics.client.models.base_response_list_str import BaseResponseListStr
-from crypticorn.metrics.client.models.error_response import ErrorResponse
-from crypticorn.metrics.client.models.exchange_mapping import ExchangeMapping
-from crypticorn.metrics.client.models.http_validation_error import HTTPValidationError
-from crypticorn.metrics.client.models.health_check_response import HealthCheckResponse
+from crypticorn.metrics.client.models.api_error_identifier import ApiErrorIdentifier
+from crypticorn.metrics.client.models.api_error_level import ApiErrorLevel
+from crypticorn.metrics.client.models.api_error_type import ApiErrorType
+from crypticorn.metrics.client.models.exception_detail import ExceptionDetail
+from crypticorn.metrics.client.models.internal_exchange import InternalExchange
 from crypticorn.metrics.client.models.market_type import MarketType
 from crypticorn.metrics.client.models.severity import Severity
 from crypticorn.metrics.client.models.time_interval import TimeInterval
 from crypticorn.metrics.client.models.trading_status import TradingStatus
-from crypticorn.metrics.client.models.validation_error import ValidationError
-from crypticorn.metrics.client.models.validation_error_loc_inner import (
-    ValidationErrorLocInner,
-)

crypticorn/metrics/client/api/__init__.py

@@ -2,9 +2,9 @@
 
 # import apis into api package
 from crypticorn.metrics.client.api.exchanges_api import ExchangesApi
-from crypticorn.metrics.client.api.health_check_api import HealthCheckApi
 from crypticorn.metrics.client.api.indicators_api import IndicatorsApi
 from crypticorn.metrics.client.api.logs_api import LogsApi
 from crypticorn.metrics.client.api.marketcap_api import MarketcapApi
 from crypticorn.metrics.client.api.markets_api import MarketsApi
+from crypticorn.metrics.client.api.status_api import StatusApi
 from crypticorn.metrics.client.api.tokens_api import TokensApi