Fix/kline params (#3)

* refactor: use KlineType and PriceType enums for K-line API parameters

* chore: bump version to 0.3.0

Author: usherasnick

README.md

@@ -336,8 +336,24 @@ asyncio.run(main())
 
 ### Market Data
 
+#### Available Enums
+
+**KlineType (K-line intervals):**
+- `KlineType.MINUTE_1`, `KlineType.MINUTE_5`, `KlineType.MINUTE_15`, `KlineType.MINUTE_30`
+- `KlineType.HOUR_1`, `KlineType.HOUR_2`, `KlineType.HOUR_4`, `KlineType.HOUR_6`, `KlineType.HOUR_8`, `KlineType.HOUR_12`
+- `KlineType.DAY_1`, `KlineType.WEEK_1`, `KlineType.MONTH_1`
+
+**PriceType (price types):**
+- `PriceType.LAST_PRICE` (default) - Latest market price
+- `PriceType.INDEX_PRICE` - Index price
+- `PriceType.ORACLE_PRICE` - Oracle price
+- `PriceType.ASK1_PRICE` - Best ask price
+- `PriceType.BID1_PRICE` - Best bid price
+- `PriceType.OPEN_INTEREST` - Open interest
+
+
 ```python
-from edgex_sdk import Client, GetKLineParams, GetOrderBookDepthParams
+from edgex_sdk import Client, GetKLineParams, GetOrderBookDepthParams, KlineType, PriceType
 
 # Get 24-hour market quotes for BNB2USDT (contract ID: 10000004)
 quote = await client.get_24_hour_quote("10000004")
@@ -346,9 +362,22 @@ print(f"Current price: {quote}")
 # Get K-line data for BTCUSDT (contract ID: 10000001)
 kline_params = GetKLineParams(
     contract_id="10000001",  # BTCUSDT
-    interval="1m",
-    size="10"
+    kline_type=KlineType.MINUTE_1,
+    price_type=PriceType.LAST_PRICE,
+    size=10
 )
+
+# With time filters (optional)
+# kline_params = GetKLineParams(
+#     contract_id="10000001",
+#     kline_type=KlineType.HOUR_1,
+#     price_type=PriceType.LAST_PRICE,
+#     size=20,
+#     filter_begin_kline_time_inclusive="1640995200000",  # Start timestamp
+#     filter_end_kline_time_exclusive="1640998800000"     # End timestamp
+# )
+
+
 klines = await client.quote.get_k_line(kline_params)
 print(f"K-lines: {klines}")
 

edgex_sdk/__init__.py

@@ -23,7 +23,9 @@
 from .quote.client import (
     GetKLineParams,
     GetOrderBookDepthParams,
-    GetMultiContractKLineParams
+    GetMultiContractKLineParams,
+    KlineType,
+    PriceType
 )
 from .transfer.client import (
     GetTransferOutByIdParams,
@@ -40,7 +42,7 @@
 )
 from .ws.manager import Manager as WebSocketManager
 
-__version__ = "0.2.0"
+__version__ = "0.3.0"
 __all__ = [
     "Client",
     "OrderType",
@@ -57,6 +59,8 @@
     "GetKLineParams",
     "GetOrderBookDepthParams",
     "GetMultiContractKLineParams",
+    "KlineType",
+    "PriceType",
     "GetTransferOutByIdParams",
     "GetTransferInByIdParams",
     "GetWithdrawAvailableAmountParams",

edgex_sdk/quote/client.py

@@ -1,26 +1,78 @@
 from typing import Dict, Any, List
+from enum import Enum
 
 from ..internal.async_client import AsyncClient
 
 
+class KlineType(Enum):
+    """K-line type enumeration."""
+    UNKNOWN_KLINE_TYPE = 0
+    MINUTE_1 = 1
+    MINUTE_5 = 2
+    MINUTE_15 = 3
+    MINUTE_30 = 4
+    HOUR_1 = 11
+    HOUR_2 = 12
+    HOUR_4 = 13
+    HOUR_6 = 14
+    HOUR_8 = 15
+    HOUR_12 = 16
+    DAY_1 = 21
+    WEEK_1 = 31
+    MONTH_1 = 41
+
+
+class PriceType(Enum):
+    """Price type enumeration."""
+    UNKNOWN_PRICE_TYPE = 0
+    ORACLE_PRICE = 1
+    INDEX_PRICE = 2
+    LAST_PRICE = 3
+    ASK1_PRICE = 4
+    BID1_PRICE = 5
+    OPEN_INTEREST = 6
+
+
+
+
+
+
+
+
 class GetKLineParams:
     """Parameters for getting K-line data."""
 
     def __init__(
         self,
         contract_id: str,
-        interval: str,
-        size: str = "",
+        kline_type: KlineType,
+        price_type: PriceType = PriceType.LAST_PRICE,
+        size: int = 100,
         offset_data: str = "",
-        filter_start_time_inclusive: int = 0,
-        filter_end_time_exclusive: int = 0
+        filter_begin_kline_time_inclusive: str = "",
+        filter_end_kline_time_exclusive: str = ""
     ):
+        """
+        Initialize K-line parameters.
+
+        Args:
+            contract_id: Contract ID (string)
+            kline_type: K-line type (KlineType enum)
+            price_type: Price type (PriceType enum, defaults to LAST_PRICE)
+            size: Number of records to fetch (int, defaults to 100)
+            offset_data: Pagination offset data (string)
+            filter_begin_kline_time_inclusive: Start time filter (string timestamp)
+            filter_end_kline_time_exclusive: End time filter (string timestamp)
+        """
         self.contract_id = contract_id
-        self.interval = interval
+        self.kline_type = kline_type
+        self.price_type = price_type
         self.size = size
         self.offset_data = offset_data
-        self.filter_start_time_inclusive = filter_start_time_inclusive
-        self.filter_end_time_exclusive = filter_end_time_exclusive
+        self.filter_begin_kline_time_inclusive = filter_begin_kline_time_inclusive
+        self.filter_end_kline_time_exclusive = filter_end_kline_time_exclusive
+
+
 
 
 class GetOrderBookDepthParams:
@@ -169,26 +221,22 @@ async def get_k_line(self, params: GetKLineParams) -> Dict[str, Any]:
         url = f"{self.async_client.base_url}/api/v1/public/quote/getKline"
         query_params = {
             "contractId": params.contract_id,
-            "interval": params.interval
+            "klineType": params.kline_type.name,
+            "priceType": params.price_type.name,
+            "size": str(params.size)
         }
 
-        # Add pagination parameters
-        if params.size:
-            query_params["size"] = params.size
+        # Add optional parameters
         if params.offset_data:
             query_params["offsetData"] = params.offset_data
-
-        # Add time filters
-        if params.filter_start_time_inclusive > 0:
-            query_params["filterStartTimeInclusive"] = str(params.filter_start_time_inclusive)
-        if params.filter_end_time_exclusive > 0:
-            query_params["filterEndTimeExclusive"] = str(params.filter_end_time_exclusive)
+        if params.filter_begin_kline_time_inclusive:
+            query_params["filterBeginKlineTimeInclusive"] = params.filter_begin_kline_time_inclusive
+        if params.filter_end_kline_time_exclusive:
+            query_params["filterEndKlineTimeExclusive"] = params.filter_end_kline_time_exclusive
 
         # Public endpoint - use simple GET request
         await self.async_client._ensure_session()
 
-        url = f"{self.async_client.base_url}/api/v1/public/quote/getKline"
-
         try:
             async with self.async_client.session.get(url, params=query_params) as response:
                 if response.status != 200:

examples/advanced_usage.py

@@ -501,16 +501,16 @@ async def get_order_fill_transactions(
     async def get_k_line(
         self,
         contract_id: str,
-        interval: str,
-        size: str = "100",
+        kline_type: 'KlineType',
+        size: int = 100,
         offset_data: str = ""
     ) -> Dict[str, Any]:
         """
         Get K-line data.
-        
+
         Args:
             contract_id: The contract ID
-            interval: The K-line interval
+            kline_type: The K-line type (KlineType enum)
             size: The page size
             offset_data: The offset data for pagination
             
@@ -524,7 +524,7 @@ async def get_k_line(
             # Create parameters
             params = GetKLineParams(
                 contract_id=contract_id,
-                interval=interval,
+                kline_type=kline_type,
                 size=size,
                 offset_data=offset_data
             )

examples/basic_usage.py

@@ -18,6 +18,7 @@
     OrderSide,
     GetKLineParams,
     GetOrderBookDepthParams,
+    KlineType,
     WebSocketManager
 )
 
@@ -58,8 +59,8 @@ async def main():
     # Get K-line data for BTCUSDT (contract ID: 10000001)
     kline_params = GetKLineParams(
         contract_id="10000001",  # BTCUSDT
-        interval="1m",
-        size="10"
+        kline_type=KlineType.MINUTE_1,
+        size=10
     )
     klines = await client.quote.get_k_line(kline_params)
     print(f"K-lines: {klines}")

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "edgex-python-sdk"
-version = "0.2.0"
+version = "0.3.0"
 description = "A Python SDK for interacting with the EdgeX Exchange API"
 readme = "README.md"
 license = {text = "MIT"}

setup.py

@@ -7,7 +7,7 @@ def read_readme():
 
 setup(
     name="edgex-python-sdk",
-    version="0.2.0",
+    version="0.3.0",
     description="A Python SDK for interacting with the EdgeX Exchange API",
     long_description=read_readme(),
     long_description_content_type="text/markdown",

tests/integration/public/test_quote.py

@@ -3,7 +3,7 @@
 import unittest
 import logging
 
-from edgex_sdk import GetKLineParams, GetOrderBookDepthParams, GetMultiContractKLineParams
+from edgex_sdk import GetKLineParams, GetOrderBookDepthParams, GetMultiContractKLineParams, KlineType
 from tests.integration.public.base_test import BasePublicEndpointTest
 
 # Configure logging
@@ -40,8 +40,8 @@ def test_get_k_line(self):
         # Create parameters
         params = GetKLineParams(
             contract_id=TEST_CONTRACT_ID,
-            interval="HOUR_1",
-            size="10"
+            kline_type=KlineType.HOUR_1,
+            size=10
         )
 
         # Get K-line data

tests/integration/test_quote.py

@@ -4,7 +4,7 @@
 import logging
 from typing import Dict, Any
 
-from edgex_sdk import GetKLineParams, GetOrderBookDepthParams, GetMultiContractKLineParams
+from edgex_sdk import GetKLineParams, GetOrderBookDepthParams, GetMultiContractKLineParams, KlineType
 from tests.integration.base_test import BaseIntegrationTest
 from tests.integration.config import TEST_CONTRACT_ID
 
@@ -45,8 +45,8 @@ def test_get_k_line(self):
         # Create parameters
         params = GetKLineParams(
             contract_id=TEST_CONTRACT_ID,
-            interval="1m",
-            size="10"
+            kline_type=KlineType.MINUTE_1,
+            size=10
         )
 
         # Get K-line data