try to add fmp senate trading data api

openbb_platform/core/openbb_core/provider/standard_models/advanced_dcf.py

@@ -0,0 +1,133 @@
+"""Advanced Dcf Standard Model."""
+
+from typing import Optional
+
+from openbb_core.provider.abstract.data import Data
+from openbb_core.provider.abstract.query_params import QueryParams
+from openbb_core.provider.utils.descriptions import (
+    DATA_DESCRIPTIONS,
+    QUERY_DESCRIPTIONS,
+)
+from pydantic import Field, field_validator
+
+
+class AdvancedDcfQueryParams(QueryParams):
+    """Advanced Dcf Query."""
+
+    symbol: Optional[str] = Field(
+        default=None, description=QUERY_DESCRIPTIONS.get("symbol", "")
+    )
+    debt: bool = Field(
+        default=False, description="Take the debt level into account or not."
+    )
+
+    @field_validator("symbol", mode="before", check_fields=False)
+    @classmethod
+    def to_upper(cls, v: str) -> str:
+        """Convert field to uppercase."""
+        return v.upper()
+
+
+class AdvancedDcfData(Data):
+    """Advanced Dcf data."""
+
+    year: Optional[int] = Field(default=None, description="Year of the data.")
+    symbol: Optional[str] = Field(
+        default=None, description=DATA_DESCRIPTIONS.get("symbol", "")
+    )
+    revenue: Optional[float] = Field(
+        default=None, description="Annual revenue of the company, i.e., total sales."
+    )
+    revenue_percentage: Optional[float] = Field(
+        default=None,
+        description="Revenue percentage, typically relative to industry or overall financials.",
+    )
+    capital_expenditure: Optional[float] = Field(
+        default=None,
+        description="Capital expenditure, i.e., spending on fixed assets or asset expansion.",
+    )
+    capital_expenditure_percentage: Optional[float] = Field(
+        default=None,
+        description="Capital expenditure percentage, usually relative to revenue.",
+    )
+    price: Optional[float] = Field(default=None, description="Stock price.")
+    beta: Optional[float] = Field(
+        default=None,
+        description="Stock beta, indicating volatility relative to the market.",
+    )
+    diluted_shares_outstanding: Optional[float] = Field(
+        default=None,
+        description="Diluted shares outstanding, i.e., total shares after all potential issuances.",
+    )
+    cost_of_debt: Optional[float] = Field(
+        default=None,
+        description="Cost of debt, or the average interest rate on the company's borrowing.",
+    )
+    tax_rate: Optional[float] = Field(
+        default=None, description="Corporate income tax rate."
+    )
+    after_tax_cost_of_debt: Optional[float] = Field(
+        default=None,
+        description="After-tax cost of debt, actual debt cost after tax deductions.",
+    )
+    risk_free_rate: Optional[float] = Field(
+        default=None,
+        description="Risk-free rate, typically represented by government bond yields.",
+    )
+    market_risk_premium: Optional[float] = Field(
+        default=None,
+        description="Market risk premium, i.e., the difference between market returns and the risk-free rate.",
+    )
+    cost_of_equity: Optional[float] = Field(
+        default=None,
+        description="Cost of equity, or the expected return rate by investors.",
+    )
+    total_debt: Optional[float] = Field(
+        default=None, description="Total debt of the company."
+    )
+    total_equity: Optional[float] = Field(
+        default=None, description="Total equity or shareholder assets of the company."
+    )
+    total_capital: Optional[float] = Field(
+        default=None, description="Total capital, or the sum of debt and equity."
+    )
+    debt_weighting: Optional[float] = Field(
+        default=None, description="Debt weighting in capital structure, in percentage."
+    )
+    equity_weighting: Optional[float] = Field(
+        default=None,
+        description="Equity weighting in capital structure, in percentage.",
+    )
+    wacc: Optional[float] = Field(
+        default=None,
+        description="Weighted average cost of capital, or the company's overall financing cost.",
+    )
+    long_term_growth_rate: Optional[float] = Field(
+        default=None, description="Long-term growth rate forecast for the company."
+    )
+    terminal_value: Optional[float] = Field(
+        default=None,
+        description="Terminal value, an estimate of future cash flows in DCF models.",
+    )
+    present_terminal_value: Optional[float] = Field(
+        default=None,
+        description="Present terminal value, i.e., the discounted value of terminal value.",
+    )
+    enterprise_value: Optional[float] = Field(
+        default=None,
+        description="Enterprise value, or the total value of the company excluding cash and debt.",
+    )
+    net_debt: Optional[float] = Field(
+        default=None, description="Net debt, or total debt minus cash."
+    )
+    equity_value: Optional[float] = Field(
+        default=None,
+        description="Equity value of the company, or enterprise value minus net debt.",
+    )
+    equity_value_per_share: Optional[float] = Field(
+        default=None,
+        description="Equity value per share, calculated as equity value divided by shares outstanding.",
+    )
+    free_cash_flow_t1: Optional[float] = Field(
+        default=None, description="Projected free cash flow for the first year."
+    )

openbb_platform/core/openbb_core/provider/standard_models/dcf.py

@@ -0,0 +1,38 @@
+"""Dcf Standard Model."""
+
+from datetime import date as dateType
+from typing import Optional
+
+from openbb_core.provider.abstract.data import Data
+from openbb_core.provider.abstract.query_params import QueryParams
+from openbb_core.provider.utils.descriptions import (
+    DATA_DESCRIPTIONS,
+    QUERY_DESCRIPTIONS,
+)
+from pydantic import Field, field_validator
+
+
+class DcfQueryParams(QueryParams):
+    """Dcf Query."""
+
+    symbol: Optional[str] = Field(
+        default=None, description=QUERY_DESCRIPTIONS.get("symbol", "")
+    )
+
+    @field_validator("symbol", mode="before", check_fields=False)
+    @classmethod
+    def to_upper(cls, v: str) -> str:
+        """Convert field to uppercase."""
+        return v.upper()
+
+
+class DcfData(Data):
+    """Dcf data."""
+
+    symbol: Optional[str] = Field(
+        default=None, description=DATA_DESCRIPTIONS.get("symbol", "")
+    )
+    date: dateType = Field(description=DATA_DESCRIPTIONS.get("date", ""))
+    dcf: Optional[float] = Field(
+        default=None, description="Discounted Cash Flow value."
+    )

openbb_platform/core/openbb_core/provider/standard_models/government_trades.py

@@ -0,0 +1,43 @@
+"""Government Trades Standard Model."""
+
+from datetime import date as dateType
+from typing import Literal, Optional
+
+from openbb_core.provider.abstract.data import Data
+from openbb_core.provider.abstract.query_params import QueryParams
+from openbb_core.provider.utils.descriptions import (
+    DATA_DESCRIPTIONS,
+    QUERY_DESCRIPTIONS,
+)
+from pydantic import Field, NonNegativeInt, field_validator
+
+
+class GovernmentTradesQueryParams(QueryParams):
+    """Government Trades Query."""
+
+    symbol: Optional[str] = Field(
+        default=None, description=QUERY_DESCRIPTIONS.get("symbol", "")
+    )
+    chamber: Literal["house", "senate", "all"] = Field(
+        description="Government Chamber."
+    )
+    limit: Optional[NonNegativeInt] = Field(
+        default=100, description=QUERY_DESCRIPTIONS.get("limit", "")
+    )
+
+    @field_validator("symbol", mode="before", check_fields=False)
+    @classmethod
+    def to_upper(cls, v: str) -> str:
+        """Convert field to uppercase."""
+        return v.upper()
+
+
+class GovernmentTradesData(Data):
+    """Government Trades data."""
+
+    symbol: str = Field(description=DATA_DESCRIPTIONS.get("symbol", ""))
+    date: dateType = Field(description=DATA_DESCRIPTIONS.get("date", ""))
+    transaction_date: dateType = Field(default=None, description="Date of Transaction.")
+    representative: Optional[str] = Field(
+        default=None, description="Name of Representative."
+    )

openbb_platform/core/openbb_core/provider/standard_models/house_disclosure.py

@@ -0,0 +1,39 @@
+"""House Disclosure Standard Model."""
+
+from datetime import date as dateType
+from typing import Optional
+
+from pydantic import Field, field_validator
+
+from openbb_core.provider.abstract.data import Data
+from openbb_core.provider.abstract.query_params import QueryParams
+from openbb_core.provider.utils.descriptions import QUERY_DESCRIPTIONS, DATA_DESCRIPTIONS
+
+
+class HouseDisclosureQueryParams(QueryParams):
+    """House Disclosure Query Parameters."""
+
+    symbol: str = Field(..., description=QUERY_DESCRIPTIONS.get("symbol", "The symbol of the company."))
+
+    @field_validator("symbol", mode="before", check_fields=False)
+    @classmethod
+    def to_upper(cls, v: str) -> str:
+        """Convert field to uppercase."""
+        return v.upper()
+
+
+class HouseDisclosureData(Data):
+    """House Disclosure Data Model."""
+
+    disclosure_year: str = Field(description="The year of the disclosure.")
+    disclosure_date: dateType = Field(description="The date of the disclosure.")
+    transaction_date: dateType = Field(description="The date of the transaction.")
+    owner: str = Field(description="The owner of the transaction.")
+    symbol: str = Field(description=DATA_DESCRIPTIONS.get("symbol", "The symbol of the company."))
+    asset_description: str = Field(description="The description of the asset.")
+    type: str = Field(description="The type of transaction.")
+    amount: str = Field(description="The amount of the transaction.")
+    representative: str = Field(description="The representative associated with the transaction.")
+    district: str = Field(description="The district of the representative.")
+    link: str = Field(description="The link to the disclosure document.")
+    capital_gains_over_200_usd: Optional[bool] = Field(default=None, description="Whether the capital gains exceed 200 USD.")

openbb_platform/core/openbb_core/provider/standard_models/house_disclosure_rss_feed.py

@@ -0,0 +1,33 @@
+"""House Disclosure RSS Feed Standard Model."""
+
+from datetime import date as dateType
+from typing import Optional
+
+from pydantic import Field
+
+from openbb_core.provider.abstract.data import Data
+from openbb_core.provider.abstract.query_params import QueryParams
+
+
+
+class HouseDisclosureRSSFeedQueryParams(QueryParams):
+    """House Disclosure RSS Feed Query Parameters."""
+
+    page: Optional[int] = Field(None, description="The page number of the RSS feed.", ge=0)
+
+
+class HouseDisclosureRSSFeedData(Data):
+    """House Disclosure RSS Feed Data Model."""
+
+    disclosure_year: str = Field(description="The year of the disclosure.")
+    disclosure_date: dateType = Field(description="The date of the disclosure.")
+    transaction_date: dateType = Field(description="The date of the transaction.")
+    owner: str = Field(description="The owner of the transaction.")
+    ticker: str = Field(description="The ticker symbol of the asset.")
+    asset_description: str = Field(description="The description of the asset.")
+    type: str = Field(description="The type of transaction.")
+    amount: str = Field(description="The amount of the transaction.")
+    representative: str = Field(description="The representative associated with the transaction.")
+    district: str = Field(description="The district of the representative.")
+    link: str = Field(description="The link to the disclosure document.")
+    capital_gains_over_200_usd: Optional[str] = Field(None, description="Whether the capital gains exceed 200 USD.")

openbb_platform/core/openbb_core/provider/standard_models/rating.py

@@ -0,0 +1,81 @@
+"""Rating Standard Model."""
+
+from typing import Optional
+
+from openbb_core.provider.abstract.data import Data
+from openbb_core.provider.abstract.query_params import QueryParams
+from openbb_core.provider.utils.descriptions import (
+    DATA_DESCRIPTIONS,
+    QUERY_DESCRIPTIONS,
+)
+from pydantic import Field, field_validator
+
+
+class RatingQueryParams(QueryParams):
+    """Rating Query."""
+
+    symbol: Optional[str] = Field(
+        default=None, description=QUERY_DESCRIPTIONS.get("symbol", "")
+    )
+
+    @field_validator("symbol", mode="before", check_fields=False)
+    @classmethod
+    def to_upper(cls, v: str) -> str:
+        """Convert field to uppercase."""
+        return v.upper()
+
+
+class RatingData(Data):
+    """Rating data."""
+
+    symbol: Optional[str] = Field(
+        default=None, description=DATA_DESCRIPTIONS.get("symbol", "")
+    )
+    date: Optional[str] = Field(
+        default=None, description=DATA_DESCRIPTIONS.get("date", "")
+    )
+    rating: Optional[str] = Field(
+        default=None, description="Overall rating of the stock."
+    )
+    rating_score: Optional[int] = Field(
+        default=None, description="Overall rating score."
+    )
+    rating_recommendation: Optional[str] = Field(
+        default=None, description="Overall recommendation based on the rating."
+    )
+    rating_details_dcf_score: Optional[int] = Field(
+        default=None, description="Score based on DCF analysis."
+    )
+    rating_details_dcf_recommendation: Optional[str] = Field(
+        default=None, description="Recommendation based on DCF score."
+    )
+    rating_details_roe_score: Optional[int] = Field(
+        default=None, description="Score based on ROE analysis."
+    )
+    rating_details_roe_recommendation: Optional[str] = Field(
+        default=None, description="Recommendation based on ROE score."
+    )
+    rating_details_roa_score: Optional[int] = Field(
+        default=None, description="Score based on ROA analysis."
+    )
+    rating_details_roa_recommendation: Optional[str] = Field(
+        default=None, description="Recommendation based on ROA score."
+    )
+    rating_details_de_score: Optional[int] = Field(
+        default=None, description="Score based on DE (Debt to Equity) analysis."
+    )
+    rating_details_de_recommendation: Optional[str] = Field(
+        default=None, description="Recommendation based on DE score."
+    )
+    rating_details_pe_score: Optional[int] = Field(
+        default=None, description="Score based on PE (Price to Earnings) analysis."
+    )
+    rating_details_pe_recommendation: Optional[str] = Field(
+        default=None, description="Recommendation based on PE score."
+    )
+    rating_details_pb_score: Optional[int] = Field(
+        default=None, description="Score based on PB (Price to Book) analysis."
+    )
+    rating_details_pb_recommendation: Optional[str] = Field(
+        default=None, description="Recommendation based on PB score."
+    )