[Feature] Add the 13f data directly from the FMP

openbb_platform/providers/fmp/openbb_fmp/__init__.py

@@ -39,6 +39,7 @@
 from openbb_fmp.models.etf_sectors import FMPEtfSectorsFetcher
 from openbb_fmp.models.executive_compensation import FMPExecutiveCompensationFetcher
 from openbb_fmp.models.financial_ratios import FMPFinancialRatiosFetcher
+from openbb_fmp.models.form_13f import FMPForm13FHRFetcher
 from openbb_fmp.models.forward_ebitda_estimates import FMPForwardEbitdaEstimatesFetcher
 from openbb_fmp.models.forward_eps_estimates import FMPForwardEpsEstimatesFetcher
 from openbb_fmp.models.historical_dividends import FMPHistoricalDividendsFetcher
@@ -137,6 +138,7 @@
         "WorldNews": FMPWorldNewsFetcher,
         "EtfHistorical": FMPEquityHistoricalFetcher,
         "YieldCurve": FMPYieldCurveFetcher,
+        "Form13FHR": FMPForm13FHRFetcher,
     },
     repr_name="Financial Modeling Prep (FMP)",
     deprecated_credentials={"API_KEY_FINANCIALMODELINGPREP": "fmp_api_key"},

openbb_platform/providers/fmp/openbb_fmp/models/form_13f.py

@@ -0,0 +1,109 @@
+"""Form 13f Model."""
+
+import asyncio
+from datetime import date as dateType
+from typing import Any, Dict, List, Optional
+from warnings import warn
+
+from openbb_core.provider.abstract.fetcher import Fetcher
+from openbb_core.provider.standard_models.form_13FHR import (
+    Form13FHRData,
+    Form13FHRQueryParams,
+)
+from openbb_core.provider.utils.errors import EmptyDataError
+from openbb_core.provider.utils.helpers import amake_request
+from openbb_fmp.utils.helpers import create_url
+from pydantic import Field
+
+
+class FMPForm13FHRQueryParams(Form13FHRQueryParams):
+    """Form 13f Query Parameters.
+
+    Source: https://financialmodelingprep.com/api/v3/form-thirteen/0001388838?date=2021-09-30
+    """
+
+
+class FMPForm13FHRData(Form13FHRData):
+    """Form13 FHR Data Model."""
+
+    __alias_dict__ = {
+        "period_ending": "date",
+        "issuer": "nameOfIssuer",
+        "principal_amount": "shares",
+        "asset_class": "titleOfClass",
+        "filling_date": "fillingDate",
+        "accepted_date": "acceptedDate",
+        "ticker_cusip": "tickercusip",
+        "final_link": "finalLink",
+    }
+    filling_date: dateType = Field(
+        default=None, description="Date when the filing was submitted to the SEC."
+    )
+    accepted_date: dateType = Field(
+        default=None, description="Date when the filing was accepted by the SEC."
+    )
+    ticker_cusip: Optional[str] = Field(
+        default=None, description="Ticker symbol associated with the CUSIP."
+    )
+    link: Optional[str] = Field(
+        default=None, description="URL link to the SEC filing on the SEC website."
+    )
+    final_link: Optional[str] = Field(
+        default=None,
+        description="URL link to the XML information table of the SEC filing.",
+    )
+
+
+class FMPForm13FHRFetcher(
+    Fetcher[
+        FMPForm13FHRQueryParams,
+        List[FMPForm13FHRData],
+    ]
+):
+    """Fetches and transforms data from the Form 13f endpoints."""
+
+    @staticmethod
+    def transform_query(params: Dict[str, Any]) -> FMPForm13FHRQueryParams:
+        """Transform the query params."""
+        return FMPForm13FHRQueryParams(**params)
+
+    @staticmethod
+    async def aextract_data(
+        query: FMPForm13FHRQueryParams,
+        credentials: Optional[Dict[str, str]] = None,
+        **kwargs: Any,
+    ) -> List[Dict]:
+        """Return the raw data from the House Disclosure endpoint."""
+        symbols = query.symbol.split(",")
+        results: List[Dict] = []
+
+        async def get_one(symbol):
+            """Get data for the given symbol."""
+            api_key = credentials.get("fmp_api_key") if credentials else ""
+            url = create_url(
+                3,
+                f"form-thirteen/{symbol}",
+                api_key,
+                query,
+                exclude=["symbol", "limit"],
+            )
+            result = await amake_request(url, **kwargs)
+            if not result or len(result) == 0:
+                warn(f"Symbol Error: No data found for symbol {symbol}")
+            if result:
+                results.extend(result)
+
+        await asyncio.gather(*[get_one(symbol) for symbol in symbols])
+
+        results = [i for i in results if isinstance(i, dict)]
+        if not results:
+            raise EmptyDataError("No data returned for the given symbol.")
+
+        return results
+
+    @staticmethod
+    def transform_data(
+        query: FMPForm13FHRQueryParams, data: List[Dict], **kwargs: Any
+    ) -> List[FMPForm13FHRData]:
+        """Return the transformed data."""
+        return [FMPForm13FHRData(**d) for d in data]

openbb_platform/providers/fmp/tests/test_fmp_fetchers.py

@@ -5,6 +5,7 @@
 
 import pytest
 from openbb_core.app.service.user_service import UserService
+from openbb_fmp.models.form_13f import FMPForm13FHRFetcher
 from openbb_fmp.models.analyst_estimates import FMPAnalystEstimatesFetcher
 from openbb_fmp.models.available_indices import FMPAvailableIndicesFetcher
 from openbb_fmp.models.balance_sheet import FMPBalanceSheetFetcher
@@ -762,3 +763,16 @@ def test_fmp_historical_market_cap_fetcher(credentials=test_credentials):
     fetcher = FmpHistoricalMarketCapFetcher()
     result = fetcher.test(params, credentials)
     assert result is None
+
+
+@pytest.mark.record_http
+def test_fmp_form_13f_fetcher(credentials=test_credentials):
+    """Test FMP form 13f fetcher."""
+    params = {
+        "symbol": "0001388838",
+        "date": date(2021, 9, 30),
+        "limit": 1,
+    }
+    fetcher = FMPForm13FHRFetcher()
+    result = fetcher.test(params, credentials)
+    assert result is None