Include new endpoints (#60)

* feat: include new endpoints * fix: new line at the end of the file * fix: black reformatting * docs: add missing comment * fix: fix wrong function usage * docs: fix misconfigured urls
Bisonai · Oct 10, 2024 · 10cffbb · 10cffbb
1 parent e0944e7
commit 10cffbb
Show file tree

Hide file tree

Showing 17 changed files with 242 additions and 49 deletions.
diff --git a/datamaxi/__version__.py b/datamaxi/__version__.py
@@ -1 +1 @@
-__version__ = "0.19.0"
+__version__ = "0.20.0"
diff --git a/datamaxi/announcement/__init__.py b/datamaxi/announcement/__init__.py
@@ -28,7 +28,7 @@ def get(
 
         `GET /api/v1/announcements`
 
-        <https://docs.datamaxiplus.com/api/datasets/announcements>
+        <https://docs.datamaxiplus.com/rest/announcements>
 
         Args:
             category (str): announcement category

diff --git a/datamaxi/datamaxi/cex_candle.py b/datamaxi/datamaxi/cex_candle.py
@@ -35,7 +35,7 @@ def get(
 
         `GET /api/v1/cex/candle`
 
-        <https://docs.datamaxiplus.com/api/datasets/cex-candle/candle>
+        <https://docs.datamaxiplus.com/rest/cex/candle/data>
 
         Args:
             exchange (str): Exchange name
@@ -121,7 +121,7 @@ def exchanges(self, market: str = "spot") -> List[str]:
 
         `GET /api/v1/cex/candle/exchanges`
 
-        <https://docs.datamaxiplus.com/api/datasets/cex-candle/exchanges>
+        <https://docs.datamaxiplus.com/rest/cex/candle/exchanges>
 
         Args:
             market (str): Market type (spot/futures)
@@ -145,7 +145,7 @@ def symbols(self, exchange: str = None, market: str = None) -> List[Dict]:
 
         `GET /api/v1/cex/candle/symbols`
 
-        <https://docs.datamaxiplus.com/api/datasets/cex-candle/symbols>
+        <https://docs.datamaxiplus.com/rest/cex/candle/symbols>
 
         Args:
             exchange (str): Exchange name
@@ -173,7 +173,7 @@ def intervals(self, exchange: str, market: str = "spot") -> List[str]:
 
         `GET /api/v1/candle/intervals`
 
-        <https://docs.datamaxiplus.com/api/datasets/cex-candle/intervals>
+        <https://docs.datamaxiplus.com/rest/cex/candle/intervals>
 
         Args:
             exchange (str): Exchange name

diff --git a/datamaxi/datamaxi/dex_candle.py b/datamaxi/datamaxi/dex_candle.py
@@ -34,7 +34,7 @@ def get(
 
         `GET /api/v1/dex/candle`
 
-        <https://docs.datamaxiplus.com/api/datasets/dex-candle/candle>
+        <https://docs.datamaxiplus.com/rest/dex/candle/data>
 
         Args:
             chain (str): Chain name
@@ -117,7 +117,7 @@ def chains(self) -> List[str]:
 
         `GET /api/v1/dex/candle/chains`
 
-        <https://docs.datamaxiplus.com/api/datasets/dex-candle/chains>
+        <https://docs.datamaxiplus.com/rest/dex/candle/chains>
 
         Returns:
             List of supported chains
@@ -133,7 +133,7 @@ def exchanges(self) -> List[str]:
 
         `GET /api/v1/dex/candle/exchanges`
 
-        <https://docs.datamaxiplus.com/api/datasets/dex-candle/exchanges>
+        <https://docs.datamaxiplus.com/rest/dex/candle/exchanges>
 
         Returns:
             List of supported exchanges
@@ -149,7 +149,7 @@ def pools(self, exchange: str = None, chain: str = None) -> List[Dict]:
 
         `GET /api/v1/dex/candle/pools`
 
-        <https://docs.datamaxiplus.com/api/datasets/dex-candle/poolsx>
+        <https://docs.datamaxiplus.com/rest/dex/candle/pools>
 
         Args:
             exchange (str): Exchange name
@@ -174,7 +174,7 @@ def intervals(self) -> List[str]:
 
         `GET /api/v1/dex/candle/intervals`
 
-        <https://docs.datamaxiplus.com/api/datasets/dex-candle/intervals>
+        <https://docs.datamaxiplus.com/rest/dex/candle/intervals>
 
         Returns:
             List of supported intervals

diff --git a/datamaxi/datamaxi/dex_trade.py b/datamaxi/datamaxi/dex_trade.py
@@ -33,7 +33,7 @@ def get(
 
         `GET /api/v1/dex/trade`
 
-        <https://docs.datamaxiplus.com/api/datasets/dex-trade/trade>
+        <https://docs.datamaxiplus.com/rest/dex/trade/data>
 
         Args:
             chain (str): Chain name
@@ -111,7 +111,7 @@ def chains(self) -> List[str]:
 
         `GET /api/v1/dex/trade/chains`
 
-        <https://docs.datamaxiplus.com/api/datasets/dex-trade/chains>
+        <https://docs.datamaxiplus.com/rest/dex/trade/chains>
 
         Returns:
             List of supported chains
@@ -127,7 +127,7 @@ def exchanges(self) -> List[str]:
 
         `GET /api/v1/dex/trade/exchanges`
 
-        <https://docs.datamaxiplus.com/api/datasets/dex-trade/exchanges>
+        <https://docs.datamaxiplus.com/rest/dex/trade/exchanges>
 
         Returns:
             List of supported exchanges
@@ -142,7 +142,7 @@ def pools(self, exchange: str = None, chain: str = None) -> List[Dict]:
 
         `GET /api/v1/dex/trade/pools`
 
-        <https://docs.datamaxiplus.com/api/datasets/dex-trade/pools>
+        <https://docs.datamaxiplus.com/rest/dex/trade/pools>
 
         Args:
             exchange (str): Exchange name

diff --git a/datamaxi/datamaxi/forex.py b/datamaxi/datamaxi/forex.py
@@ -25,7 +25,7 @@ def get(
 
         `GET /api/v1/forex`
 
-        <https://docs.datamaxiplus.com/api/datasets/forex/forex>
+        <https://docs.datamaxiplus.com/rest/forex/forex>
 
         Args:
             symbol (str): Symbol name
@@ -56,7 +56,7 @@ def symbols(self) -> List[str]:
 
         `GET /api/v1/forex/symbols`
 
-        <https://docs.datamaxiplus.com/api/datasets/forex/symbols>
+        <https://docs.datamaxiplus.com/rest/forex/symbols>
 
         Returns:
             List of supported symbols

diff --git a/datamaxi/datamaxi/funding_rate.py b/datamaxi/datamaxi/funding_rate.py
@@ -33,7 +33,7 @@ def get(
 
         `GET /api/v1/funding-rate`
 
-        <https://docs.datamaxiplus.com/api/datasets/funding-rate/historical-funding-rate>
+        <https://docs.datamaxiplus.com/rest/funding-rate/historical-funding-rate>
 
         Args:
             exchange (str): Exchange name
@@ -113,7 +113,7 @@ def getLatest(
 
         `GET /api/v1/funding-rate/latest`
 
-        <https://docs.datamaxiplus.com/api/datasets/funding-rate/latest-funding-rate>
+        <https://docs.datamaxiplus.com/rest/funding-rate/latest-funding-rate>
 
         Args:
             sort (str): Sort data by `asc` or `desc`
@@ -155,7 +155,7 @@ def exchanges(self) -> List[str]:
 
         `GET /api/v1/funding-rate/exchanges`
 
-        <https://docs.datamaxiplus.com/api/datasets/funding-rate/exchanges>
+        <https://docs.datamaxiplus.com/rest/funding-rate/exchanges>
 
         Returns:
             List of supported exchanges
@@ -170,7 +170,7 @@ def symbols(self, exchange: str, market: str = "spot") -> List[str]:
 
         `GET /api/v1/funding-rate/symbols`
 
-        <https://docs.datamaxiplus.com/api/datasets/funding-rate/symbols>
+        <https://docs.datamaxiplus.com/rest/funding-rate/symbols>
 
         Args:
             exchange (str): Exchange name

diff --git a/datamaxi/datamaxi/orderbook.py b/datamaxi/datamaxi/orderbook.py
@@ -0,0 +1,95 @@
+from typing import Any, List, Dict, Union
+import pandas as pd
+from datamaxi.api import API
+from datamaxi.lib.utils import check_required_parameters
+from datamaxi.lib.utils import check_required_parameter
+
+
+class Orderbook(API):
+    """Client to fetch orderbook data from DataMaxi+ API."""
+
+    def __init__(self, api_key=None, **kwargs: Any):
+        """Initialize orderbook client.
+
+        Args:
+            api_key (str): The DataMaxi+ API key
+            **kwargs: Keyword arguments used by `datamaxi.api.API`.
+        """
+        super().__init__(api_key, **kwargs)
+
+    def get(
+        self,
+        exchange: str,
+        symbol: str,
+        pandas: bool = True,
+    ) -> Union[Dict, pd.DataFrame]:
+        """Fetch orderbook data
+
+        `GET /api/v1/orderbook`
+
+        <https://docs.datamaxiplus.com/rest/orderbook/orderbook>
+
+        Args:
+            exchange (str): Exchange name
+            symbol (str): symbol name
+            pandas (bool): Return data as pandas DataFrame
+
+        Returns:
+            Orderbook data in pandas DataFrame
+        """
+
+        check_required_parameters(
+            [
+                [exchange, "exchange"],
+                [symbol, "symbol"],
+            ]
+        )
+
+        params = {"exchange": exchange, "symbol": symbol}
+
+        res = self.query("/api/v1/orderbook", params)
+        if pandas:
+            df = pd.DataFrame(res)
+            df = df.set_index("d")
+            return df
+
+        return res
+
+    def exchanges(self) -> List[str]:
+        """Fetch supported exchanges accepted by
+        [datamaxi.Orderbook.get](./#datamaxi.datamaxi.Orderbook.get)
+        API.
+
+        `GET /api/v1/orderbook/exchanges`
+
+        <https://docs.datamaxiplus.com/rest/orderbook/exchanges>
+
+        Returns:
+            List of supported exchange
+        """
+        url_path = "/api/v1/orderbook/exchanges"
+        return self.query(url_path)
+
+    def symbols(self, exchange: str) -> List[str]:
+        """Fetch supported symbols accepted by
+        [datamaxi.Orderbook.get](./#datamaxi.datamaxi.Orderbook.get)
+        API.
+
+        `GET /api/v1/orderbook/symbols`
+
+        <https://docs.datamaxiplus.com/rest/orderbook/symbols>
+
+        Args:
+            exchange (str): Exchange name
+
+        Returns:
+            List of supported symbols
+        """
+        check_required_parameter(exchange, "exchange")
+
+        params = {
+            "exchange": exchange,
+        }
+
+        url_path = "/api/v1/orderbook/symbols"
+        return self.query(url_path, params)
diff --git a/datamaxi/datamaxi/premium.py b/datamaxi/datamaxi/premium.py
@@ -28,7 +28,7 @@ def get(
         """Fetch premium data
 
         `GET /api/v1/premium`
-        <https://docs.datamaxiplus.com/api/datasets/premium/premium>
+        <https://docs.datamaxiplus.com/rest/premium/premium>
 
         Args:
             sort (str): Sort data by `asc` or `desc`
@@ -74,7 +74,7 @@ def exchanges(self) -> List[str]:
 
         `GET /api/v1/Premium/exchanges`
 
-        <https://docs.datamaxiplus.com/api/datasets/Premium/exchanges>
+        <https://docs.datamaxiplus.com/rest/Premium/exchanges>
 
         Returns:
             List of supported exchange
@@ -89,7 +89,7 @@ def symbols(self, sourceExchange: str, targetExchange: str) -> List[str]:
 
         `GET /api/v1/premium/symbols`
 
-        <https://docs.datamaxiplus.com/api/datasets/premium/symbols>
+        <https://docs.datamaxiplus.com/rest/premium/symbols>
 
         Args:
             sourceExchange (str): Source exchange name

diff --git a/datamaxi/datamaxi/ticker.py b/datamaxi/datamaxi/ticker.py
@@ -27,7 +27,7 @@ def get(
 
         `GET /api/v1/ticker`
 
-        <https://docs.datamaxiplus.com/api/datasets/ticker/ticker>
+        <https://docs.datamaxiplus.com/rest/ticker/ticker>
 
         Args:
             exchange (str): Exchange name
@@ -66,7 +66,7 @@ def exchanges(self) -> List[str]:
 
         `GET /api/v1/ticker/exchanges`
 
-        <https://docs.datamaxiplus.com/api/datasets/ticker/exchanges>
+        <https://docs.datamaxiplus.com/rest/ticker/exchanges>
 
         Returns:
             List of supported exchange
@@ -81,7 +81,7 @@ def symbols(self, exchange: str) -> List[str]:
 
         `GET /api/v1/ticker/symbols`
 
-        <https://docs.datamaxiplus.com/api/datasets/ticker/symbols>
+        <https://docs.datamaxiplus.com/rest/ticker/symbols>
 
         Args:
             exchange (str): Exchange name