features:Added new tools to the FinancialDatasetAPI

libs/community/langchain_community/agent_toolkits/financial_datasets/toolkit.py

@@ -10,6 +10,12 @@
 from langchain_community.tools.financial_datasets.cash_flow_statements import (
     CashFlowStatements,
 )
+from langchain_community.tools.financial_datasets.financial_metrics import (
+    FinancialMetrics,
+)
+from langchain_community.tools.financial_datasets.financial_snapshots import (
+    FinancialSnapshots,
+)
 from langchain_community.tools.financial_datasets.income_statements import (
     IncomeStatements,
 )
@@ -41,4 +47,6 @@ def get_tools(self) -> List[BaseTool]:
             BalanceSheets(api_wrapper=self.api_wrapper),
             CashFlowStatements(api_wrapper=self.api_wrapper),
             IncomeStatements(api_wrapper=self.api_wrapper),
+            FinancialMetrics(api_wrapper=self.api_wrapper),
+            FinancialSnapshots(api_wrapper=self.api_wrapper),
         ]

libs/community/langchain_community/tools/financial_datasets/__init__.py

@@ -6,6 +6,12 @@
 from langchain_community.tools.financial_datasets.cash_flow_statements import (
     CashFlowStatements,
 )
+from langchain_community.tools.financial_datasets.financial_metrics import (
+    FinancialMetrics,
+)
+from langchain_community.tools.financial_datasets.financial_snapshots import (
+    FinancialSnapshots,
+)
 from langchain_community.tools.financial_datasets.income_statements import (
     IncomeStatements,
 )
@@ -14,4 +20,6 @@
     "BalanceSheets",
     "CashFlowStatements",
     "IncomeStatements",
+    "FinancialMetrics",
+    "FinancialSnapshots",
 ]

libs/community/langchain_community/tools/financial_datasets/financial_metrics.py

@@ -0,0 +1,62 @@
+from typing import Optional, Type
+
+from langchain_core.callbacks import CallbackManagerForToolRun
+from langchain_core.tools import BaseTool
+from pydantic import BaseModel, Field
+
+from langchain_community.utilities.financial_datasets import FinancialDatasetsAPIWrapper
+
+
+class FinancialMetricsSchema(BaseModel):
+    """Input for FinancialMetrics."""
+
+    ticker: str = Field(
+        description="The ticker symbol to fetch  financial metrics for.",
+    )
+    period: str = Field(
+        description="The period of the financial metrics. "
+        "Possible values are: "
+        "annual, quarterly, ttm. "
+        "Default is 'annual'.",
+    )
+    limit: int = Field(
+        description="The number of financial metrics to return. Default is 10.",
+    )
+
+
+class FinancialMetrics(BaseTool):
+    """
+    Tool that gets  financial metrics for a given ticker over a given period.
+    """
+
+    mode: str = "get_financial_metrics"
+    name: str = "financial_metrics"
+    description: str = (
+        "A wrapper around financial datasets's  financial metrics API. "
+        "This tool is useful for fetching  financial metrics for a given ticker."
+        "The tool fetches  financial metrics for a given ticker over a given period."
+        "The period can be annual, quarterly, or trailing twelve months (ttm)."
+        "The number of  financial metrics to return can also be "
+        "specified using the limit parameter."
+    )
+    args_schema: Type[FinancialMetricsSchema] = FinancialMetricsSchema
+
+    api_wrapper: FinancialDatasetsAPIWrapper = Field(..., exclude=True)
+
+    def __init__(self, api_wrapper: FinancialDatasetsAPIWrapper):
+        super().__init__(api_wrapper=api_wrapper)
+
+    def _run(
+        self,
+        ticker: str,
+        period: str,
+        limit: Optional[int],
+        run_manager: Optional[CallbackManagerForToolRun] = None,
+    ) -> str:
+        """Use the  financial metrics API tool."""
+        return self.api_wrapper.run(
+            mode=self.mode,
+            ticker=ticker,
+            period=period,
+            limit=limit,
+        )

libs/community/langchain_community/tools/financial_datasets/financial_snapshots.py

@@ -0,0 +1,43 @@
+from typing import Optional, Type
+
+from langchain_core.callbacks import CallbackManagerForToolRun
+from langchain_core.tools import BaseTool
+from pydantic import BaseModel, Field
+
+from langchain_community.utilities.financial_datasets import FinancialDatasetsAPIWrapper
+
+
+class FinancialSnapshotsSchema(BaseModel):
+    """Input for FinancialSnapshots."""
+
+    ticker: str = Field(
+        description="The ticker symbol to fetch financial snapshots for.",
+    )
+
+
+class FinancialSnapshots(BaseTool):
+    """
+    Tool that gets financial snapshots for a given ticker over a given period.
+    """
+
+    mode: str = "get_financial_snapshots"
+    name: str = "financial_snapshots"
+    description: str = (
+        "A wrapper around financial datasets's financial snapshots API. "
+        "This tool is useful for fetching financial snapshots for a given ticker."
+        "The tool fetches financial snapshots for a given ticker."
+    )
+    args_schema: Type[FinancialSnapshotsSchema] = FinancialSnapshotsSchema
+
+    api_wrapper: FinancialDatasetsAPIWrapper = Field(..., exclude=True)
+
+    def __init__(self, api_wrapper: FinancialDatasetsAPIWrapper):
+        super().__init__(api_wrapper=api_wrapper)
+
+    def _run(
+        self,
+        ticker: str,
+        run_manager: Optional[CallbackManagerForToolRun] = None,
+    ) -> str:
+        """Use the financial snapshots API tool."""
+        return self.api_wrapper.run(mode=self.mode, ticker=ticker)

libs/community/langchain_community/utilities/financial_datasets.py

@@ -130,6 +130,62 @@ def get_cash_flow_statements(
 
         return data.get("cash_flow_statements", None)
 
+    def get_financial_metrics(
+        self,
+        ticker: str,
+        period: str,
+        limit: Optional[int],
+    ) -> List[dict]:
+        """
+        Get the financial metrics for a stock `ticker` over a `period` of time.
+
+        :param ticker: the stock ticker
+        :param period: the period of time to get the balance sheets for.
+            Possible values are: annual, quarterly, ttm.
+        :param limit: the number of results to return, default is 10
+        :return: a list of financial metrics
+        """
+
+        url = (
+            f"{FINANCIAL_DATASETS_BASE_URL}/financial-metrics"
+            f"?ticker={ticker}"
+            f"&period={period}"
+            f"&limit={limit if limit else 10}"
+        )
+
+        # Add the api key to the headers
+        headers = {"X-API-KEY": self._api_key}
+
+        # Execute the request
+        response = requests.get(url, headers=headers)
+        data = response.json()
+
+        return data.get("financial_metrics", None)
+
+    def get_financial_snapshots(
+        self,
+        ticker: str,
+    ) -> dict:
+        """
+        Get the financial snapshots for a stock `ticker`.
+
+        :param ticker: the stock ticker
+        """
+
+        url = (
+            f"{FINANCIAL_DATASETS_BASE_URL}/financial-metrics/snapshot"
+            f"?ticker={ticker}"
+        )
+
+        # Add the api key to the headers
+        headers = {"X-API-KEY": self._api_key}
+
+        # Execute the request
+        response = requests.get(url, headers=headers)
+        data = response.json()
+
+        return data.get("snapshot", None)
+
     def run(self, mode: str, ticker: str, **kwargs: Any) -> str:
         if mode == "get_income_statements":
             period = kwargs.get("period", "annual")
@@ -143,5 +199,11 @@ def run(self, mode: str, ticker: str, **kwargs: Any) -> str:
             period = kwargs.get("period", "annual")
             limit = kwargs.get("limit", 10)
             return json.dumps(self.get_cash_flow_statements(ticker, period, limit))
+        elif mode == "get_financial_metrics":
+            period = kwargs.get("period", "annual")
+            limit = kwargs.get("limit", 10)
+            return json.dumps(self.get_financial_metrics(ticker, period, limit))
+        elif mode == "get_financial_snapshots":
+            return json.dumps(self.get_financial_snapshots(ticker))
         else:
             raise ValueError(f"Invalid mode {mode} for financial datasets API.")

libs/community/tests/integration_tests/test_finance_dataset_integrations.py

@@ -0,0 +1,11 @@
+import os
+
+from langchain_community.agent_toolkits.financial_datasets.toolkit import (
+    FinancialDatasetsToolkit,
+)
+from langchain_community.utilities.financial_datasets import FinancialDatasetsAPIWrapper
+
+api_wrapper = FinancialDatasetsAPIWrapper(
+    financial_datasets_api_key=os.environ["FINANCIAL_DATASETS_API_KEY"]
+)
+toolkit = FinancialDatasetsToolkit(api_wrapper=api_wrapper)