crypticorn 1.0.0__py3-none-any.whl → 1.0.2rc1__py3-none-any.whl

crypticorn/{api.py → hive/main.py}

@@ -2,23 +2,23 @@ from typing import Any
 import pandas as pd
 import requests
 import os
-from .utils import download_file, SingleModel, ModelEvaluation, DataInfo
+from crypticorn.hive.utils import download_file, SingleModel, ModelEvaluation, DataInfo
 
 
-class Crypticorn:
+class HiveClient:
     """
-    A client for interacting with the crypticorn API, offering functionality to create and evaluate models,
+    A client for interacting with the Crypticorn Hive API, offering functionality to create and evaluate models,
     download data, and retrieve information about available coins, targets, and features.
     """
 
-    def __init__(self, api_key: str, headers: dict = None, base_url='https://api.crypticorn.com'):
+    def __init__(self, base_url='https://api.crypticorn.com', api_key: str = None, jwt: str = None):
         """@private
-        Initializes the crypticorn API client with an API key.
+        Initializes the Crypticorn Hive API client with an API key.
 
         :param api_key: The API key required for authenticating requests.
         """
         self._base_url = base_url + "/v1/hive"
-        self._headers = headers if headers else {"Authorization": f"ApiKey {api_key}"}
+        self._headers = {"Authorization": f"ApiKey {api_key}"}
 
     def create_model(self, coin_id: int, target: str) -> SingleModel:
         """

crypticorn/hive/requirements.txt

@@ -0,0 +1,4 @@
+pandas >= 2.2.0, < 3.0.0
+requests >= 2.32.0, < 3.0.0
+tqdm >= 4.67.0, < 5.0.0
+pydantic >= 2.0.0, < 3.0.0

crypticorn/{utils.py → hive/utils.py}

@@ -37,7 +37,7 @@ def download_file(url: str, dest_path: str, show_progress_bars: bool = True):
 
         if file_size < total_size:
             # Download incomplete
-            logger.info(f" resuming download")
+            logger.info("  resuming download")
             resume_header = {'Range': f'bytes={file_size}-'}
             req = requests.get(url, headers=resume_header, stream=True,
                                verify=False, allow_redirects=True, timeout=600)
@@ -48,7 +48,7 @@ def download_file(url: str, dest_path: str, show_progress_bars: bool = True):
             file_size = 0
     else:
         # File does not exist, starting download
-        logger.info(f" starting download")
+        logger.info("  starting download")
 
     # write dataset to file and show progress bar
     pbar = tqdm.tqdm(total=total_size, unit='B', unit_scale=True,

crypticorn/klines/client/__init__.py

@@ -0,0 +1,62 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    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\"     }     ```     
+
+    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
+
+
+__version__ = "1.0.0"
+
+# import apis into sdk package
+from crypticorn.klines.client.api.funding_rates_api import FundingRatesApi
+from crypticorn.klines.client.api.health_check_api import HealthCheckApi
+from crypticorn.klines.client.api.ohlcv_data_api import OHLCVDataApi
+from crypticorn.klines.client.api.symbols_api import SymbolsApi
+from crypticorn.klines.client.api.udf_api import UDFApi
+
+# import ApiClient
+from crypticorn.klines.client.api_response import ApiResponse
+from crypticorn.klines.client.api_client import ApiClient
+from crypticorn.klines.client.configuration import Configuration
+from crypticorn.klines.client.exceptions import OpenApiException
+from crypticorn.klines.client.exceptions import ApiTypeError
+from crypticorn.klines.client.exceptions import ApiValueError
+from crypticorn.klines.client.exceptions import ApiKeyError
+from crypticorn.klines.client.exceptions import ApiAttributeError
+from crypticorn.klines.client.exceptions import ApiException
+
+# import models into sdk package
+from crypticorn.klines.client.models.base_response_health_check_response import BaseResponseHealthCheckResponse
+from crypticorn.klines.client.models.base_response_list_funding_rate_response import BaseResponseListFundingRateResponse
+from crypticorn.klines.client.models.base_response_list_str import BaseResponseListStr
+from crypticorn.klines.client.models.base_response_ohlcv_response import BaseResponseOHLCVResponse
+from crypticorn.klines.client.models.error_response import ErrorResponse
+from crypticorn.klines.client.models.exchange import Exchange
+from crypticorn.klines.client.models.funding_rate_response import FundingRateResponse
+from crypticorn.klines.client.models.http_validation_error import HTTPValidationError
+from crypticorn.klines.client.models.health_check_response import HealthCheckResponse
+from crypticorn.klines.client.models.history_error_response import HistoryErrorResponse
+from crypticorn.klines.client.models.history_no_data_response import HistoryNoDataResponse
+from crypticorn.klines.client.models.history_success_response import HistorySuccessResponse
+from crypticorn.klines.client.models.market import Market
+from crypticorn.klines.client.models.ohlcv_response import OHLCVResponse
+from crypticorn.klines.client.models.resolution import Resolution
+from crypticorn.klines.client.models.response_get_history_udf_history_get import ResponseGetHistoryUdfHistoryGet
+from crypticorn.klines.client.models.search_symbol_response import SearchSymbolResponse
+from crypticorn.klines.client.models.sort_direction import SortDirection
+from crypticorn.klines.client.models.symbol_group_response import SymbolGroupResponse
+from crypticorn.klines.client.models.symbol_info_response import SymbolInfoResponse
+from crypticorn.klines.client.models.symbol_type import SymbolType
+from crypticorn.klines.client.models.timeframe import Timeframe
+from crypticorn.klines.client.models.udf_config_response import UDFConfigResponse
+from crypticorn.klines.client.models.validation_error import ValidationError
+from crypticorn.klines.client.models.validation_error_loc_inner import ValidationErrorLocInner

crypticorn/klines/client/api/__init__.py

@@ -0,0 +1,9 @@
+# flake8: noqa
+
+# import apis into api package
+from crypticorn.klines.client.api.funding_rates_api import FundingRatesApi
+from crypticorn.klines.client.api.health_check_api import HealthCheckApi
+from crypticorn.klines.client.api.ohlcv_data_api import OHLCVDataApi
+from crypticorn.klines.client.api.symbols_api import SymbolsApi
+from crypticorn.klines.client.api.udf_api import UDFApi
+

crypticorn/klines/client/api/funding_rates_api.py

@@ -0,0 +1,362 @@
+# coding: utf-8
+
+"""
+    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\"     }     ```     
+
+    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
+
+import warnings
+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
+from typing import Optional
+from typing_extensions import Annotated
+from crypticorn.klines.client.models.base_response_list_funding_rate_response import BaseResponseListFundingRateResponse
+
+from crypticorn.klines.client.api_client import ApiClient, RequestSerialized
+from crypticorn.klines.client.api_response import ApiResponse
+from crypticorn.klines.client.rest import RESTResponseType
+
+
+class FundingRatesApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def funding_rate_funding_rates_symbol_get(
+        self,
+        symbol: Annotated[StrictStr, Field(description="Trading pair symbol (e.g., BTCUSDT)")],
+        start: Annotated[Optional[StrictInt], Field(description="Start timestamp in milliseconds")] = None,
+        end: Annotated[Optional[StrictInt], Field(description="End timestamp in milliseconds")] = None,
+        limit: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Number of funding rates to return")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> BaseResponseListFundingRateResponse:
+        """Funding Rate
+
+        Retrieve funding rate data for a specific symbol in the futures market.
+
+        :param symbol: Trading pair symbol (e.g., BTCUSDT) (required)
+        :type symbol: str
+        :param start: Start timestamp in milliseconds
+        :type start: int
+        :param end: End timestamp in milliseconds
+        :type end: int
+        :param limit: Number of funding rates to return
+        :type limit: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._funding_rate_funding_rates_symbol_get_serialize(
+            symbol=symbol,
+            start=start,
+            end=end,
+            limit=limit,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "BaseResponseListFundingRateResponse",
+            '400': "ErrorResponse",
+            '404': "ErrorResponse",
+            '500': "ErrorResponse",
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def funding_rate_funding_rates_symbol_get_with_http_info(
+        self,
+        symbol: Annotated[StrictStr, Field(description="Trading pair symbol (e.g., BTCUSDT)")],
+        start: Annotated[Optional[StrictInt], Field(description="Start timestamp in milliseconds")] = None,
+        end: Annotated[Optional[StrictInt], Field(description="End timestamp in milliseconds")] = None,
+        limit: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Number of funding rates to return")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[BaseResponseListFundingRateResponse]:
+        """Funding Rate
+
+        Retrieve funding rate data for a specific symbol in the futures market.
+
+        :param symbol: Trading pair symbol (e.g., BTCUSDT) (required)
+        :type symbol: str
+        :param start: Start timestamp in milliseconds
+        :type start: int
+        :param end: End timestamp in milliseconds
+        :type end: int
+        :param limit: Number of funding rates to return
+        :type limit: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._funding_rate_funding_rates_symbol_get_serialize(
+            symbol=symbol,
+            start=start,
+            end=end,
+            limit=limit,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "BaseResponseListFundingRateResponse",
+            '400': "ErrorResponse",
+            '404': "ErrorResponse",
+            '500': "ErrorResponse",
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def funding_rate_funding_rates_symbol_get_without_preload_content(
+        self,
+        symbol: Annotated[StrictStr, Field(description="Trading pair symbol (e.g., BTCUSDT)")],
+        start: Annotated[Optional[StrictInt], Field(description="Start timestamp in milliseconds")] = None,
+        end: Annotated[Optional[StrictInt], Field(description="End timestamp in milliseconds")] = None,
+        limit: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Number of funding rates to return")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Funding Rate
+
+        Retrieve funding rate data for a specific symbol in the futures market.
+
+        :param symbol: Trading pair symbol (e.g., BTCUSDT) (required)
+        :type symbol: str
+        :param start: Start timestamp in milliseconds
+        :type start: int
+        :param end: End timestamp in milliseconds
+        :type end: int
+        :param limit: Number of funding rates to return
+        :type limit: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._funding_rate_funding_rates_symbol_get_serialize(
+            symbol=symbol,
+            start=start,
+            end=end,
+            limit=limit,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "BaseResponseListFundingRateResponse",
+            '400': "ErrorResponse",
+            '404': "ErrorResponse",
+            '500': "ErrorResponse",
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _funding_rate_funding_rates_symbol_get_serialize(
+        self,
+        symbol,
+        start,
+        end,
+        limit,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if symbol is not None:
+            _path_params['symbol'] = symbol
+        # process the query parameters
+        if start is not None:
+            
+            _query_params.append(('start', start))
+            
+        if end is not None:
+            
+            _query_params.append(('end', end))
+            
+        if limit is not None:
+            
+            _query_params.append(('limit', limit))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/funding_rates/{symbol}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+