Added get_stock_market_tick_data func

Author: Nawado-gg

eodhd/APIs/StockMarketTickDataAPI.py

@@ -0,0 +1,26 @@
+from .BaseAPI import BaseAPI
+
+class StockMarketTickDataAPI(BaseAPI):
+
+    def get_stock_market_tick_data(self, api_token: str, symbol: str, from_timestamp: str, to_timestamp: str, limit: int):
+        
+        endpoint = 'ticks'
+
+        query_string = ''
+
+        if symbol is None:
+            raise ValueError("symbol is empty. Need to add symbol to args")
+        if from_timestamp is None:
+            raise ValueError("from_timestamp is empty. Need to add from_timestamp to args")
+        if to_timestamp is None:
+            raise ValueError("to_timestamp is empty. Need to add to_timestamp to args")
+
+        query_string += '&s=' + str(symbol)
+        query_string += '&from=' + str(from_timestamp)
+        query_string += '&to=' + str(to_timestamp)
+
+        if limit is not None:
+            query_string += '&limit=' + str(limit)
+
+        
+        return self._rest_get_method(api_key = api_token, endpoint = endpoint, querystring = query_string)

eodhd/APIs/__init__.py

@@ -18,4 +18,5 @@
 from .FinancialNewsAPI import FinancialNewsAPI
 from .OptionsDataAPI import OptionsDataAPI
 from .IntradayDataAPI import IntradayDataAPI
-from .EodHistoricalStockMarketDataAPI import EodHistoricalStockMarketDataAPI
+from .EodHistoricalStockMarketDataAPI import EodHistoricalStockMarketDataAPI
+from .StockMarketTickDataAPI import StockMarketTickDataAPI

eodhd/__init__.py

@@ -8,4 +8,4 @@
 
 
 # Version of eodhd package
-__version__ = "1.0.24"
+__version__ = "1.0.25"

eodhd/apiclient.py

@@ -36,6 +36,7 @@
 from eodhd.APIs import OptionsDataAPI
 from eodhd.APIs import IntradayDataAPI
 from eodhd.APIs import EodHistoricalStockMarketDataAPI
+from eodhd.APIs import StockMarketTickDataAPI
 
 # minimal traceback
 sys.tracebacklimit = 1
@@ -845,6 +846,33 @@ def get_eod_historical_stock_market_data(
             from_date=from_date,
             order=order
         )
+    
+    def get_stock_market_tick_data(
+        self,
+        symbol,
+        from_timestamp,
+        to_timestamp,
+        limit=None
+    ):
+        """
+        Available args:
+            symbol - , for example, AAPL.US, consists of two parts: {SYMBOL_NAME}.{EXCHANGE_ID}. 
+                This API works only for US exchanges for the moment, 
+                then you can use 'AAPL' or 'AAPL.US' to get the data as well for other US tickers.
+            from_timestamp and to_timestamp - use these parameters to filter data by datetime. 
+                Parameters should be passed in UNIX time with UTC timezone, 
+                for example, these values are correct: “from=1627896900&to=1630575300” and 
+                correspond to ' 2021-08-02 09:35:00 ' and ' 2021-09-02 09:35:00 '.
+            limit - the maximum number of ticks will be provided.
+        """
+        api_call = StockMarketTickDataAPI()
+        return api_call.get_stock_market_tick_data(
+            api_token=self._api_key,
+            symbol=symbol,
+            to_timestamp=to_timestamp,
+            from_timestamp=from_timestamp,
+            limit=limit
+        )
 
 
 class ScannerClient:

example_api.py

@@ -130,5 +130,8 @@ def main() -> None:
     resp = api.get_eod_historical_stock_market_data(symbol = 'AAPL.MX', period='d', from_date = '2023-01-01', to_date = '2023-01-15', order='a')
     print(resp)
 
+    resp = api.get_stock_market_tick_data(from_timestamp = '1627896900', to_timestamp = '1630575300', symbol = 'AAPL', limit = 1)
+    print(resp)
+
 if __name__ == "__main__":
     main()

setup.py

@@ -16,7 +16,7 @@
 # This call to setup() does all the work
 setup(
     name="eodhd",
-    version="1.0.24",
+    version="1.0.25",
     description="Official EODHD API Python Library",
     long_description=long_description,
     long_description_content_type="text/markdown",