Add new CEX clients (#8)

* feat: binance intervals

* feat: okx

* feat: bybit

* feat: huobi candle

* feat: coinone candle

* feat: upbit candle

* feat: bithumb candle

* feat: generate documentation only on `workflow_dispatch`

Author: martinkersner

.github/workflows/docs.yml

@@ -1,9 +1,6 @@
 name: Publish Documentation
 
 on:
-  push:
-    branches:
-      - main
   workflow_dispatch:
 
 jobs:

README.md

@@ -24,7 +24,7 @@ This package is compatible with Python v3.8+.
 ## Installation
 
 ```shell
-pip install datamaxi
+pip3 install datamaxi
 ```
 
 ## Configuration
@@ -54,6 +54,12 @@ You may use environment variables to configure the DataMaxi+ client to avoid any
 DataMaxi+ Python package currently includes the following clients:
 
 - `Binance`
+- `Bithumb`
+- `Bybit`
+- `Coinone`
+- `Huobi`
+- `Okx`
+- `Upbit`
 - `Defillama`
 - `Naver`
 - `Google`
@@ -62,17 +68,39 @@ All clients accept the same parameters that are described at [Configuration](#co
 First, import the clients,
 
 ```python
+# CEX
 from datamaxi.binance import Binance
+from datamaxi.bithumb import Bithumb
+from datamaxi.bybit import Bybit
+from datamaxi.coinone import Coinone
+from datamaxi.huobi import Huobi
+from datamaxi.okx import Okx
+from datamaxi.upbit import Upbit
+
+# DeFi
 from datamaxi.defillama import Defillama
+
+# Trend
 from datamaxi.naver import Naver
 from datamaxi.google import Google
 ```
 
 and initialize them.
 
 ```python
+# CEX
 binance = Binance(api_key=api_key)
+bithumb = Bithumb(api_key=api_key)
+bybit = Bybit(api_key=api_key)
+coinone = Coinone(api_key=api_key)
+huobi = Huobi(api_key=api_key)
+okx = Okx(api_key=api_key)
+upbit = Upbit(api_key=api_key)
+
+# DeFi
 defillama = Defillama(api_key=api_key)
+
+# Trend
 naver = Naver(api_key=api_key)
 google = Google(api_key=api_key)
 ```
@@ -87,9 +115,9 @@ If you wish to work on local development please clone/fork the git repo and use
 
 ```shell
 # In case packages are not installed yet
-pip install -r requirements/requirements-test.txt
+pip3 install -r requirements/requirements-test.txt
 
-python -m pytest tests/
+python3 -m pytest tests/
 ```
 
 ## Links

datamaxi/binance/__init__.py

@@ -18,7 +18,8 @@ def __init__(self, api_key=None, **kwargs: Any):
         """
         if "base_url" not in kwargs:
             kwargs["base_url"] = BASE_URL
-            super().__init__(api_key, **kwargs)
+
+        super().__init__(api_key, **kwargs)
 
     def symbols(self) -> List[str]:
         """Supported Binance supported symbols
@@ -33,24 +34,37 @@ def symbols(self) -> List[str]:
         url_path = "/v1/raw/binance/symbols"
         return self.query(url_path)
 
+    def intervals(self) -> List[str]:
+        """Supported Binance supported intervals
+
+        `GET /v1/raw/binance/intervals`
+
+        <https://docs.datamaxiplus.com/cex/binance/intervals>
+
+        Returns:
+            List of supported Binance intervals
+        """
+        url_path = "/v1/raw/binance/intervals"
+        return self.query(url_path)
+
     @postprocess()
-    def kline(
+    def candle(
         self, symbol: str, interval: str = "1d", pandas: bool = True
     ) -> Union[List, pd.DataFrame]:
-        """Get Binance k-line data
+        """Get Binance candle data
 
-        `GET /v1/raw/binance/kline`
+        `GET /v1/raw/binance/candle`
 
-        <https://docs.datamaxiplus.com/cex/binance/kline>
+        <https://docs.datamaxiplus.com/cex/binance/candle>
 
         Args:
             symbol (str): Binance symbol
-            interval (str): Kline interval
+            interval (str): Candle interval
             pandas (bool): Return data as pandas DataFrame
 
         Returns:
-            Binance kline data for a given symbol and interval in pandas DataFrame
+            Binance candle data for a given symbol and interval in pandas DataFrame
         """
         check_required_parameters([[symbol, "symbol"], [interval, "interval"]])
         params = {"symbol": symbol, "interval": interval}
-        return self.query("/v1/raw/binance/kline", params)
+        return self.query("/v1/raw/binance/candle", params)

datamaxi/bithumb/__init__.py

@@ -0,0 +1,70 @@
+from typing import Any, List, Union
+import pandas as pd
+from datamaxi.api import API
+from datamaxi.lib.utils import check_required_parameters
+from datamaxi.lib.utils import postprocess
+from datamaxi.lib.constants import BASE_URL
+
+
+class Bithumb(API):
+    """Client to fetch Bithumb data from DataMaxi+ API."""
+
+    def __init__(self, api_key=None, **kwargs: Any):
+        """Initialize the object.
+
+        Args:
+            api_key (str): The DataMaxi+ API key
+            **kwargs: Keyword arguments used by `datamaxi.api.API`.
+        """
+        if "base_url" not in kwargs:
+            kwargs["base_url"] = BASE_URL
+
+        super().__init__(api_key, **kwargs)
+
+    def symbols(self) -> List[str]:
+        """Supported Bithumb supported symbols
+
+        `GET /v1/raw/bithumb/symbols`
+
+        <https://docs.datamaxiplus.com/cex/bithumb/symbols>
+
+        Returns:
+            List of supported Bithumb symbols
+        """
+        url_path = "/v1/raw/bithumb/symbols"
+        return self.query(url_path)
+
+    def intervals(self) -> List[str]:
+        """Supported Bithumb supported intervals
+
+        `GET /v1/raw/bithumb/intervals`
+
+        <https://docs.datamaxiplus.com/cex/bithumb/intervals>
+
+        Returns:
+            List of supported Bithumb intervals
+        """
+        url_path = "/v1/raw/bithumb/intervals"
+        return self.query(url_path)
+
+    @postprocess()
+    def candle(
+        self, symbol: str, interval: str = "1d", pandas: bool = True
+    ) -> Union[List, pd.DataFrame]:
+        """Get Bithumb candle data
+
+        `GET /v1/raw/bithumb/candle`
+
+        <https://docs.datamaxiplus.com/cex/bithumb/candle>
+
+        Args:
+            symbol (str): Bithumb symbol
+            interval (str): Candle interval
+            pandas (bool): Return data as pandas DataFrame
+
+        Returns:
+            Bithumb candle data for a given symbol and interval in pandas DataFrame
+        """
+        check_required_parameters([[symbol, "symbol"], [interval, "interval"]])
+        params = {"symbol": symbol, "interval": interval}
+        return self.query("/v1/raw/bithumb/candle", params)

datamaxi/bybit/__init__.py

@@ -0,0 +1,70 @@
+from typing import Any, List, Union
+import pandas as pd
+from datamaxi.api import API
+from datamaxi.lib.utils import check_required_parameters
+from datamaxi.lib.utils import postprocess
+from datamaxi.lib.constants import BASE_URL
+
+
+class Bybit(API):
+    """Client to fetch Bybit data from DataMaxi+ API."""
+
+    def __init__(self, api_key=None, **kwargs: Any):
+        """Initialize the object.
+
+        Args:
+            api_key (str): The DataMaxi+ API key
+            **kwargs: Keyword arguments used by `datamaxi.api.API`.
+        """
+        if "base_url" not in kwargs:
+            kwargs["base_url"] = BASE_URL
+
+        super().__init__(api_key, **kwargs)
+
+    def symbols(self) -> List[str]:
+        """Supported Bybit supported symbols
+
+        `GET /v1/raw/bybit/symbols`
+
+        <https://docs.datamaxiplus.com/cex/bybit/symbols>
+
+        Returns:
+            List of supported Bybit symbols
+        """
+        url_path = "/v1/raw/bybit/symbols"
+        return self.query(url_path)
+
+    def intervals(self) -> List[str]:
+        """Supported Bybit supported intervals
+
+        `GET /v1/raw/bybit/intervals`
+
+        <https://docs.datamaxiplus.com/cex/bybit/intervals>
+
+        Returns:
+            List of supported Bybit intervals
+        """
+        url_path = "/v1/raw/bybit/intervals"
+        return self.query(url_path)
+
+    @postprocess()
+    def candle(
+        self, symbol: str, interval: str = "1d", pandas: bool = True
+    ) -> Union[List, pd.DataFrame]:
+        """Get Bybit candle data
+
+        `GET /v1/raw/bybit/candle`
+
+        <https://docs.datamaxiplus.com/cex/bybit/candle>
+
+        Args:
+            symbol (str): Bybit symbol
+            interval (str): Candle interval
+            pandas (bool): Return data as pandas DataFrame
+
+        Returns:
+            Bybit candle data for a given symbol and interval in pandas DataFrame
+        """
+        check_required_parameters([[symbol, "symbol"], [interval, "interval"]])
+        params = {"symbol": symbol, "interval": interval}
+        return self.query("/v1/raw/bybit/candle", params)

datamaxi/coinone/__init__.py

@@ -0,0 +1,70 @@
+from typing import Any, List, Union
+import pandas as pd
+from datamaxi.api import API
+from datamaxi.lib.utils import check_required_parameters
+from datamaxi.lib.utils import postprocess
+from datamaxi.lib.constants import BASE_URL
+
+
+class Coinone(API):
+    """Client to fetch Coinone data from DataMaxi+ API."""
+
+    def __init__(self, api_key=None, **kwargs: Any):
+        """Initialize the object.
+
+        Args:
+            api_key (str): The DataMaxi+ API key
+            **kwargs: Keyword arguments used by `datamaxi.api.API`.
+        """
+        if "base_url" not in kwargs:
+            kwargs["base_url"] = BASE_URL
+
+        super().__init__(api_key, **kwargs)
+
+    def symbols(self) -> List[str]:
+        """Supported Coinone supported symbols
+
+        `GET /v1/raw/coinone/symbols`
+
+        <https://docs.datamaxiplus.com/cex/coinone/symbols>
+
+        Returns:
+            List of supported Coinone symbols
+        """
+        url_path = "/v1/raw/coinone/symbols"
+        return self.query(url_path)
+
+    def intervals(self) -> List[str]:
+        """Supported Coinone supported intervals
+
+        `GET /v1/raw/coinone/intervals`
+
+        <https://docs.datamaxiplus.com/cex/coinone/intervals>
+
+        Returns:
+            List of supported Coinone intervals
+        """
+        url_path = "/v1/raw/coinone/intervals"
+        return self.query(url_path)
+
+    @postprocess()
+    def candle(
+        self, symbol: str, interval: str = "1d", pandas: bool = True
+    ) -> Union[List, pd.DataFrame]:
+        """Get Coinone candle data
+
+        `GET /v1/raw/coinone/candle`
+
+        <https://docs.datamaxiplus.com/cex/coinone/candle>
+
+        Args:
+            symbol (str): Coinone symbol
+            interval (str): Candle interval
+            pandas (bool): Return data as pandas DataFrame
+
+        Returns:
+            Coinone candle data for a given symbol and interval in pandas DataFrame
+        """
+        check_required_parameters([[symbol, "symbol"], [interval, "interval"]])
+        params = {"symbol": symbol, "interval": interval}
+        return self.query("/v1/raw/coinone/candle", params)