finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/exchangecode.py

@@ -0,0 +1,90 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: b0dea2dc0cf6
+
+from __future__ import annotations
+from enum import Enum
+from finance_dev import utils
+
+
+class ExchangeCode(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Two-to-three-letter exchange code identifying a global stock exchange (e.g. `US` = U.S. exchanges, `L` = London, `HK` = Hong Kong, `T` = Tokyo, `PA` = Paris). Used as the `exchange` query parameter for market-status and market-holiday endpoints. Other endpoints may return a different exchange-code format depending on the upstream data source."""
+
+    AD = "AD"
+    AS = "AS"
+    AT = "AT"
+    AX = "AX"
+    BA = "BA"
+    BC = "BC"
+    BD = "BD"
+    BE = "BE"
+    BH = "BH"
+    BK = "BK"
+    BO = "BO"
+    BR = "BR"
+    CA = "CA"
+    CN = "CN"
+    CO = "CO"
+    CR = "CR"
+    CS = "CS"
+    DB = "DB"
+    DE = "DE"
+    DU = "DU"
+    F = "F"
+    HA = "HA"
+    HE = "HE"
+    HK = "HK"
+    HM = "HM"
+    IC = "IC"
+    IR = "IR"
+    IS = "IS"
+    JK = "JK"
+    JO = "JO"
+    KL = "KL"
+    KQ = "KQ"
+    KS = "KS"
+    KW = "KW"
+    L = "L"
+    LS = "LS"
+    MC = "MC"
+    ME = "ME"
+    MI = "MI"
+    MT = "MT"
+    MU = "MU"
+    MX = "MX"
+    NE = "NE"
+    NL = "NL"
+    NS = "NS"
+    NZ = "NZ"
+    OL = "OL"
+    OM = "OM"
+    PA = "PA"
+    PK = "PK"
+    PM = "PM"
+    PR = "PR"
+    QA = "QA"
+    RG = "RG"
+    RO = "RO"
+    SA = "SA"
+    SC = "SC"
+    SG = "SG"
+    SI = "SI"
+    SN = "SN"
+    SR = "SR"
+    SS = "SS"
+    ST = "ST"
+    SW = "SW"
+    SX = "SX"
+    SZ = "SZ"
+    T = "T"
+    TA = "TA"
+    TG = "TG"
+    TL = "TL"
+    TO = "TO"
+    TW = "TW"
+    TWO = "TWO"
+    US = "US"
+    V = "V"
+    VI = "VI"
+    VN = "VN"
+    VS = "VS"
+    WA = "WA"

finance_dev/models/fdaadvisorycommitteecalendarresponse.py

@@ -0,0 +1,88 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: eb838066ae7d
+
+from __future__ import annotations
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FdaAdvisoryCommitteeCalendarResponseDataTypedDict(TypedDict):
+    event_description: NotRequired[str]
+    r"""Description of the meeting."""
+    from_date: NotRequired[str]
+    r"""Start time of the event in EST, as returned by the provider."""
+    to_date: NotRequired[str]
+    r"""End time of the event in EST, as returned by the provider."""
+    url: NotRequired[str]
+    r"""URL with more details about the meeting."""
+
+
+class FdaAdvisoryCommitteeCalendarResponseData(BaseModel):
+    event_description: Annotated[
+        Optional[str], pydantic.Field(alias="eventDescription")
+    ] = None
+    r"""Description of the meeting."""
+
+    from_date: Annotated[Optional[str], pydantic.Field(alias="fromDate")] = None
+    r"""Start time of the event in EST, as returned by the provider."""
+
+    to_date: Annotated[Optional[str], pydantic.Field(alias="toDate")] = None
+    r"""End time of the event in EST, as returned by the provider."""
+
+    url: Optional[str] = None
+    r"""URL with more details about the meeting."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["eventDescription", "fromDate", "toDate", "url"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class FdaAdvisoryCommitteeCalendarResponseTypedDict(TypedDict):
+    r"""Upcoming FDA advisory committee meetings, as provided by Finnhub."""
+
+    data: NotRequired[List[FdaAdvisoryCommitteeCalendarResponseDataTypedDict]]
+    r"""FDA advisory committee meeting events."""
+
+
+class FdaAdvisoryCommitteeCalendarResponse(BaseModel):
+    r"""Upcoming FDA advisory committee meetings, as provided by Finnhub."""
+
+    data: Optional[List[FdaAdvisoryCommitteeCalendarResponseData]] = None
+    r"""FDA advisory committee meeting events."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["data"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+try:
+    FdaAdvisoryCommitteeCalendarResponseData.model_rebuild()
+except NameError:
+    pass

finance_dev/models/filingsimilarityrecord.py

@@ -0,0 +1,115 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 2f831b52a128
+
+from __future__ import annotations
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FilingSimilarityRecordTypedDict(TypedDict):
+    r"""Cosine similarity scores between a filing and the prior comparable filing, by 10-K section."""
+
+    accepted_date: NotRequired[str]
+    r"""Date when the SEC accepted the filing"""
+    access_number: NotRequired[str]
+    r"""SEC accession number"""
+    cik: NotRequired[str]
+    r"""Central Index Key"""
+    filed_date: NotRequired[str]
+    r"""Date when filed with SEC"""
+    filing_url: NotRequired[str]
+    r"""URL to the complete filing"""
+    form: NotRequired[str]
+    r"""Type of SEC form"""
+    item1: NotRequired[float]
+    r"""Cosine similarity score for Item 1 (Business) section"""
+    item1a: NotRequired[float]
+    r"""Cosine similarity score for Item 1A (Risk Factors) section"""
+    item2: NotRequired[float]
+    r"""Cosine similarity score for Item 2 (Properties) section"""
+    item7: NotRequired[float]
+    r"""Cosine similarity score for Item 7 (MD&A) section"""
+    item7a: NotRequired[float]
+    r"""Cosine similarity score for Item 7A (Market Risk) section"""
+    report_url: NotRequired[str]
+    r"""URL to the formatted report"""
+
+
+class FilingSimilarityRecord(BaseModel):
+    r"""Cosine similarity scores between a filing and the prior comparable filing, by 10-K section."""
+
+    accepted_date: Annotated[Optional[str], pydantic.Field(alias="acceptedDate")] = None
+    r"""Date when the SEC accepted the filing"""
+
+    access_number: Annotated[Optional[str], pydantic.Field(alias="accessNumber")] = None
+    r"""SEC accession number"""
+
+    cik: Optional[str] = None
+    r"""Central Index Key"""
+
+    filed_date: Annotated[Optional[str], pydantic.Field(alias="filedDate")] = None
+    r"""Date when filed with SEC"""
+
+    filing_url: Annotated[Optional[str], pydantic.Field(alias="filingUrl")] = None
+    r"""URL to the complete filing"""
+
+    form: Optional[str] = None
+    r"""Type of SEC form"""
+
+    item1: Optional[float] = None
+    r"""Cosine similarity score for Item 1 (Business) section"""
+
+    item1a: Optional[float] = None
+    r"""Cosine similarity score for Item 1A (Risk Factors) section"""
+
+    item2: Optional[float] = None
+    r"""Cosine similarity score for Item 2 (Properties) section"""
+
+    item7: Optional[float] = None
+    r"""Cosine similarity score for Item 7 (MD&A) section"""
+
+    item7a: Optional[float] = None
+    r"""Cosine similarity score for Item 7A (Market Risk) section"""
+
+    report_url: Annotated[Optional[str], pydantic.Field(alias="reportUrl")] = None
+    r"""URL to the formatted report"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "acceptedDate",
+                "accessNumber",
+                "cik",
+                "filedDate",
+                "filingUrl",
+                "form",
+                "item1",
+                "item1a",
+                "item2",
+                "item7",
+                "item7a",
+                "reportUrl",
+            ]
+        )
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+try:
+    FilingSimilarityRecord.model_rebuild()
+except NameError:
+    pass

finance_dev/models/filingssimilarityindexdatawrapper.py

@@ -0,0 +1,52 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 98dd9eec252c
+
+from __future__ import annotations
+from .filingsimilarityrecord import (
+    FilingSimilarityRecord,
+    FilingSimilarityRecordTypedDict,
+)
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class FilingsSimilarityIndexDataWrapperTypedDict(TypedDict):
+    r"""Similarity index data for a company, identified by CIK and symbol."""
+
+    cik: NotRequired[str]
+    r"""Central Index Key"""
+    similarity: NotRequired[List[FilingSimilarityRecordTypedDict]]
+    r"""Array of filing similarity records with cosine similarity scores"""
+    symbol: NotRequired[str]
+    r"""Stock ticker symbol"""
+
+
+class FilingsSimilarityIndexDataWrapper(BaseModel):
+    r"""Similarity index data for a company, identified by CIK and symbol."""
+
+    cik: Optional[str] = None
+    r"""Central Index Key"""
+
+    similarity: Optional[List[FilingSimilarityRecord]] = None
+    r"""Array of filing similarity records with cosine similarity scores"""
+
+    symbol: Optional[str] = None
+    r"""Stock ticker symbol"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["cik", "similarity", "symbol"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m

finance_dev/models/filingssimilarityindexresponse.py

@@ -0,0 +1,42 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 02b3775f9913
+
+from __future__ import annotations
+from .filingssimilarityindexdatawrapper import (
+    FilingsSimilarityIndexDataWrapper,
+    FilingsSimilarityIndexDataWrapperTypedDict,
+)
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class FilingsSimilarityIndexResponseTypedDict(TypedDict):
+    r"""Response containing the SEC filings similarity index for a company."""
+
+    data: NotRequired[FilingsSimilarityIndexDataWrapperTypedDict]
+    r"""Similarity index data for a company, identified by CIK and symbol."""
+
+
+class FilingsSimilarityIndexResponse(BaseModel):
+    r"""Response containing the SEC filings similarity index for a company."""
+
+    data: Optional[FilingsSimilarityIndexDataWrapper] = None
+    r"""Similarity index data for a company, identified by CIK and symbol."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["data"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m

finance_dev/models/financialratiosresponse.py

@@ -0,0 +1,252 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 392acf5d65dd
+
+from __future__ import annotations
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FinancialRatiosResponseResultTypedDict(TypedDict):
+    average_volume: NotRequired[int]
+    r"""Average trading volume in shares"""
+    cash: NotRequired[float]
+    r"""Cash ratio"""
+    cik: NotRequired[str]
+    r"""SEC Central Index Key of the company"""
+    current: NotRequired[float]
+    r"""Current ratio (current assets to current liabilities)"""
+    date_: NotRequired[str]
+    r"""Date the ratios were calculated for (YYYY-MM-DD)"""
+    debt_to_equity: NotRequired[float]
+    r"""Debt-to-equity ratio"""
+    dividend_yield: NotRequired[float]
+    r"""Dividend yield"""
+    earnings_per_share: NotRequired[float]
+    r"""Earnings per share"""
+    enterprise_value: NotRequired[int]
+    r"""Enterprise value"""
+    ev_to_ebitda: NotRequired[float]
+    r"""Enterprise value to EBITDA ratio"""
+    ev_to_sales: NotRequired[float]
+    r"""Enterprise value to sales ratio"""
+    free_cash_flow: NotRequired[int]
+    r"""Free cash flow"""
+    market_cap: NotRequired[int]
+    r"""Market capitalization"""
+    price: NotRequired[float]
+    r"""Stock price used to compute the ratios"""
+    price_to_book: NotRequired[float]
+    r"""Price-to-book (P/B) ratio"""
+    price_to_cash_flow: NotRequired[float]
+    r"""Price-to-cash-flow ratio"""
+    price_to_earnings: NotRequired[float]
+    r"""Price-to-earnings (P/E) ratio"""
+    price_to_free_cash_flow: NotRequired[float]
+    r"""Price-to-free-cash-flow ratio"""
+    price_to_sales: NotRequired[float]
+    r"""Price-to-sales (P/S) ratio"""
+    quick: NotRequired[float]
+    r"""Quick ratio (liquid assets to current liabilities)"""
+    return_on_assets: NotRequired[float]
+    r"""Return on assets"""
+    return_on_equity: NotRequired[float]
+    r"""Return on equity"""
+    ticker: NotRequired[str]
+    r"""Stock ticker symbol"""
+
+
+class FinancialRatiosResponseResult(BaseModel):
+    average_volume: Annotated[Optional[int], pydantic.Field(alias="averageVolume")] = (
+        None
+    )
+    r"""Average trading volume in shares"""
+
+    cash: Optional[float] = None
+    r"""Cash ratio"""
+
+    cik: Optional[str] = None
+    r"""SEC Central Index Key of the company"""
+
+    current: Optional[float] = None
+    r"""Current ratio (current assets to current liabilities)"""
+
+    date_: Annotated[Optional[str], pydantic.Field(alias="date")] = None
+    r"""Date the ratios were calculated for (YYYY-MM-DD)"""
+
+    debt_to_equity: Annotated[Optional[float], pydantic.Field(alias="debtToEquity")] = (
+        None
+    )
+    r"""Debt-to-equity ratio"""
+
+    dividend_yield: Annotated[
+        Optional[float], pydantic.Field(alias="dividendYield")
+    ] = None
+    r"""Dividend yield"""
+
+    earnings_per_share: Annotated[
+        Optional[float], pydantic.Field(alias="earningsPerShare")
+    ] = None
+    r"""Earnings per share"""
+
+    enterprise_value: Annotated[
+        Optional[int], pydantic.Field(alias="enterpriseValue")
+    ] = None
+    r"""Enterprise value"""
+
+    ev_to_ebitda: Annotated[Optional[float], pydantic.Field(alias="evToEbitda")] = None
+    r"""Enterprise value to EBITDA ratio"""
+
+    ev_to_sales: Annotated[Optional[float], pydantic.Field(alias="evToSales")] = None
+    r"""Enterprise value to sales ratio"""
+
+    free_cash_flow: Annotated[Optional[int], pydantic.Field(alias="freeCashFlow")] = (
+        None
+    )
+    r"""Free cash flow"""
+
+    market_cap: Annotated[Optional[int], pydantic.Field(alias="marketCap")] = None
+    r"""Market capitalization"""
+
+    price: Optional[float] = None
+    r"""Stock price used to compute the ratios"""
+
+    price_to_book: Annotated[Optional[float], pydantic.Field(alias="priceToBook")] = (
+        None
+    )
+    r"""Price-to-book (P/B) ratio"""
+
+    price_to_cash_flow: Annotated[
+        Optional[float], pydantic.Field(alias="priceToCashFlow")
+    ] = None
+    r"""Price-to-cash-flow ratio"""
+
+    price_to_earnings: Annotated[
+        Optional[float], pydantic.Field(alias="priceToEarnings")
+    ] = None
+    r"""Price-to-earnings (P/E) ratio"""
+
+    price_to_free_cash_flow: Annotated[
+        Optional[float], pydantic.Field(alias="priceToFreeCashFlow")
+    ] = None
+    r"""Price-to-free-cash-flow ratio"""
+
+    price_to_sales: Annotated[Optional[float], pydantic.Field(alias="priceToSales")] = (
+        None
+    )
+    r"""Price-to-sales (P/S) ratio"""
+
+    quick: Optional[float] = None
+    r"""Quick ratio (liquid assets to current liabilities)"""
+
+    return_on_assets: Annotated[
+        Optional[float], pydantic.Field(alias="returnOnAssets")
+    ] = None
+    r"""Return on assets"""
+
+    return_on_equity: Annotated[
+        Optional[float], pydantic.Field(alias="returnOnEquity")
+    ] = None
+    r"""Return on equity"""
+
+    ticker: Optional[str] = None
+    r"""Stock ticker symbol"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "averageVolume",
+                "cash",
+                "cik",
+                "current",
+                "date",
+                "debtToEquity",
+                "dividendYield",
+                "earningsPerShare",
+                "enterpriseValue",
+                "evToEbitda",
+                "evToSales",
+                "freeCashFlow",
+                "marketCap",
+                "price",
+                "priceToBook",
+                "priceToCashFlow",
+                "priceToEarnings",
+                "priceToFreeCashFlow",
+                "priceToSales",
+                "quick",
+                "returnOnAssets",
+                "returnOnEquity",
+                "ticker",
+            ]
+        )
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class FinancialRatiosResponseTypedDict(TypedDict):
+    r"""Valuation, profitability, liquidity and leverage ratios for a company, sourced from Polygon."""
+
+    next_url: NotRequired[str]
+    r"""URL for the next page of results, omitted when there are no more pages"""
+    request_id: NotRequired[str]
+    r"""Request identifier returned by the upstream data provider"""
+    results: NotRequired[List[FinancialRatiosResponseResultTypedDict]]
+    r"""Financial ratio records, one per ticker and date"""
+    status: NotRequired[str]
+    r"""Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code."""
+
+
+class FinancialRatiosResponse(BaseModel):
+    r"""Valuation, profitability, liquidity and leverage ratios for a company, sourced from Polygon."""
+
+    next_url: Annotated[Optional[str], pydantic.Field(alias="nextUrl")] = None
+    r"""URL for the next page of results, omitted when there are no more pages"""
+
+    request_id: Annotated[Optional[str], pydantic.Field(alias="requestId")] = None
+    r"""Request identifier returned by the upstream data provider"""
+
+    results: Optional[List[FinancialRatiosResponseResult]] = None
+    r"""Financial ratio records, one per ticker and date"""
+
+    status: Optional[str] = None
+    r"""Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["nextUrl", "requestId", "results", "status"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+try:
+    FinancialRatiosResponseResult.model_rebuild()
+except NameError:
+    pass
+try:
+    FinancialRatiosResponse.model_rebuild()
+except NameError:
+    pass

finance_dev/models/financialsreporteddatawrapper.py

@@ -0,0 +1,49 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 70c4ddf2f400
+
+from __future__ import annotations
+from .reportedfiling import ReportedFiling, ReportedFilingTypedDict
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class FinancialsReportedDataWrapperTypedDict(TypedDict):
+    r"""Company identifiers and the list of reported SEC filings."""
+
+    cik: NotRequired[str]
+    r"""Central Index Key assigned by the SEC"""
+    data: NotRequired[List[ReportedFilingTypedDict]]
+    r"""Array of reported filings with financial data"""
+    symbol: NotRequired[str]
+    r"""Stock ticker symbol"""
+
+
+class FinancialsReportedDataWrapper(BaseModel):
+    r"""Company identifiers and the list of reported SEC filings."""
+
+    cik: Optional[str] = None
+    r"""Central Index Key assigned by the SEC"""
+
+    data: Optional[List[ReportedFiling]] = None
+    r"""Array of reported filings with financial data"""
+
+    symbol: Optional[str] = None
+    r"""Stock ticker symbol"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["cik", "data", "symbol"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m