finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/incomestatement.py

@@ -0,0 +1,296 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: eeeeece614bc
+
+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 IncomeStatementTypedDict(TypedDict):
+    r"""Single SEC income statement row."""
+
+    basic_earnings_per_share: NotRequired[float]
+    r"""Basic earnings per share."""
+    basic_shares_outstanding: NotRequired[float]
+    r"""Weighted average basic shares outstanding."""
+    cik: NotRequired[str]
+    r"""SEC Central Index Key of the company."""
+    consolidated_net_income_loss: NotRequired[float]
+    r"""Consolidated net income or loss, including noncontrolling interests."""
+    cost_of_revenue: NotRequired[float]
+    r"""Cost of revenue."""
+    depreciation_depletion_amortization: NotRequired[float]
+    r"""Depreciation, depletion and amortization expense."""
+    diluted_earnings_per_share: NotRequired[float]
+    r"""Diluted earnings per share."""
+    diluted_shares_outstanding: NotRequired[float]
+    r"""Weighted average diluted shares outstanding."""
+    discontinued_operations: NotRequired[float]
+    r"""Income or loss from discontinued operations."""
+    ebitda: NotRequired[float]
+    r"""Earnings before interest, taxes, depreciation and amortization."""
+    equity_in_affiliates: NotRequired[float]
+    r"""Income or loss from equity-method affiliates."""
+    extraordinary_items: NotRequired[float]
+    r"""Extraordinary items of income or loss."""
+    filing_date: NotRequired[str]
+    r"""Date the filing was submitted to the SEC."""
+    fiscal_quarter: NotRequired[float]
+    r"""Fiscal quarter of the reporting period."""
+    fiscal_year: NotRequired[float]
+    r"""Fiscal year of the reporting period."""
+    gross_profit: NotRequired[float]
+    r"""Revenue minus cost of revenue."""
+    income_before_income_taxes: NotRequired[float]
+    r"""Income before income taxes."""
+    income_taxes: NotRequired[float]
+    r"""Income tax expense."""
+    interest_expense: NotRequired[float]
+    r"""Interest expense."""
+    interest_income: NotRequired[float]
+    r"""Interest income."""
+    net_income_loss_attributable_common_shareholders: NotRequired[float]
+    r"""Net income or loss attributable to common shareholders."""
+    noncontrolling_interest: NotRequired[float]
+    r"""Net income attributable to noncontrolling interest."""
+    operating_income: NotRequired[float]
+    r"""Operating income."""
+    other_income_expense: NotRequired[float]
+    r"""Other income or expense."""
+    other_operating_expenses: NotRequired[float]
+    r"""Other operating expenses."""
+    period_end: NotRequired[str]
+    r"""End date of the reporting period."""
+    preferred_stock_dividends_declared: NotRequired[float]
+    r"""Preferred stock dividends declared."""
+    research_development: NotRequired[float]
+    r"""Research and development expense."""
+    revenue: NotRequired[float]
+    r"""Total revenue."""
+    selling_general_administrative: NotRequired[float]
+    r"""Selling, general and administrative expense."""
+    tickers: NotRequired[List[str]]
+    r"""Ticker symbols associated with the company."""
+    timeframe: NotRequired[str]
+    r"""Reporting timeframe of the statement, as supplied by the provider."""
+    total_operating_expenses: NotRequired[float]
+    r"""Total operating expenses."""
+    total_other_income_expense: NotRequired[float]
+    r"""Total other income or expense."""
+
+
+class IncomeStatement(BaseModel):
+    r"""Single SEC income statement row."""
+
+    basic_earnings_per_share: Annotated[
+        Optional[float], pydantic.Field(alias="basicEarningsPerShare")
+    ] = None
+    r"""Basic earnings per share."""
+
+    basic_shares_outstanding: Annotated[
+        Optional[float], pydantic.Field(alias="basicSharesOutstanding")
+    ] = None
+    r"""Weighted average basic shares outstanding."""
+
+    cik: Optional[str] = None
+    r"""SEC Central Index Key of the company."""
+
+    consolidated_net_income_loss: Annotated[
+        Optional[float], pydantic.Field(alias="consolidatedNetIncomeLoss")
+    ] = None
+    r"""Consolidated net income or loss, including noncontrolling interests."""
+
+    cost_of_revenue: Annotated[
+        Optional[float], pydantic.Field(alias="costOfRevenue")
+    ] = None
+    r"""Cost of revenue."""
+
+    depreciation_depletion_amortization: Annotated[
+        Optional[float], pydantic.Field(alias="depreciationDepletionAmortization")
+    ] = None
+    r"""Depreciation, depletion and amortization expense."""
+
+    diluted_earnings_per_share: Annotated[
+        Optional[float], pydantic.Field(alias="dilutedEarningsPerShare")
+    ] = None
+    r"""Diluted earnings per share."""
+
+    diluted_shares_outstanding: Annotated[
+        Optional[float], pydantic.Field(alias="dilutedSharesOutstanding")
+    ] = None
+    r"""Weighted average diluted shares outstanding."""
+
+    discontinued_operations: Annotated[
+        Optional[float], pydantic.Field(alias="discontinuedOperations")
+    ] = None
+    r"""Income or loss from discontinued operations."""
+
+    ebitda: Optional[float] = None
+    r"""Earnings before interest, taxes, depreciation and amortization."""
+
+    equity_in_affiliates: Annotated[
+        Optional[float], pydantic.Field(alias="equityInAffiliates")
+    ] = None
+    r"""Income or loss from equity-method affiliates."""
+
+    extraordinary_items: Annotated[
+        Optional[float], pydantic.Field(alias="extraordinaryItems")
+    ] = None
+    r"""Extraordinary items of income or loss."""
+
+    filing_date: Annotated[Optional[str], pydantic.Field(alias="filingDate")] = None
+    r"""Date the filing was submitted to the SEC."""
+
+    fiscal_quarter: Annotated[
+        Optional[float], pydantic.Field(alias="fiscalQuarter")
+    ] = None
+    r"""Fiscal quarter of the reporting period."""
+
+    fiscal_year: Annotated[Optional[float], pydantic.Field(alias="fiscalYear")] = None
+    r"""Fiscal year of the reporting period."""
+
+    gross_profit: Annotated[Optional[float], pydantic.Field(alias="grossProfit")] = None
+    r"""Revenue minus cost of revenue."""
+
+    income_before_income_taxes: Annotated[
+        Optional[float], pydantic.Field(alias="incomeBeforeIncomeTaxes")
+    ] = None
+    r"""Income before income taxes."""
+
+    income_taxes: Annotated[Optional[float], pydantic.Field(alias="incomeTaxes")] = None
+    r"""Income tax expense."""
+
+    interest_expense: Annotated[
+        Optional[float], pydantic.Field(alias="interestExpense")
+    ] = None
+    r"""Interest expense."""
+
+    interest_income: Annotated[
+        Optional[float], pydantic.Field(alias="interestIncome")
+    ] = None
+    r"""Interest income."""
+
+    net_income_loss_attributable_common_shareholders: Annotated[
+        Optional[float],
+        pydantic.Field(alias="netIncomeLossAttributableCommonShareholders"),
+    ] = None
+    r"""Net income or loss attributable to common shareholders."""
+
+    noncontrolling_interest: Annotated[
+        Optional[float], pydantic.Field(alias="noncontrollingInterest")
+    ] = None
+    r"""Net income attributable to noncontrolling interest."""
+
+    operating_income: Annotated[
+        Optional[float], pydantic.Field(alias="operatingIncome")
+    ] = None
+    r"""Operating income."""
+
+    other_income_expense: Annotated[
+        Optional[float], pydantic.Field(alias="otherIncomeExpense")
+    ] = None
+    r"""Other income or expense."""
+
+    other_operating_expenses: Annotated[
+        Optional[float], pydantic.Field(alias="otherOperatingExpenses")
+    ] = None
+    r"""Other operating expenses."""
+
+    period_end: Annotated[Optional[str], pydantic.Field(alias="periodEnd")] = None
+    r"""End date of the reporting period."""
+
+    preferred_stock_dividends_declared: Annotated[
+        Optional[float], pydantic.Field(alias="preferredStockDividendsDeclared")
+    ] = None
+    r"""Preferred stock dividends declared."""
+
+    research_development: Annotated[
+        Optional[float], pydantic.Field(alias="researchDevelopment")
+    ] = None
+    r"""Research and development expense."""
+
+    revenue: Optional[float] = None
+    r"""Total revenue."""
+
+    selling_general_administrative: Annotated[
+        Optional[float], pydantic.Field(alias="sellingGeneralAdministrative")
+    ] = None
+    r"""Selling, general and administrative expense."""
+
+    tickers: Optional[List[str]] = None
+    r"""Ticker symbols associated with the company."""
+
+    timeframe: Optional[str] = None
+    r"""Reporting timeframe of the statement, as supplied by the provider."""
+
+    total_operating_expenses: Annotated[
+        Optional[float], pydantic.Field(alias="totalOperatingExpenses")
+    ] = None
+    r"""Total operating expenses."""
+
+    total_other_income_expense: Annotated[
+        Optional[float], pydantic.Field(alias="totalOtherIncomeExpense")
+    ] = None
+    r"""Total other income or expense."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "basicEarningsPerShare",
+                "basicSharesOutstanding",
+                "cik",
+                "consolidatedNetIncomeLoss",
+                "costOfRevenue",
+                "depreciationDepletionAmortization",
+                "dilutedEarningsPerShare",
+                "dilutedSharesOutstanding",
+                "discontinuedOperations",
+                "ebitda",
+                "equityInAffiliates",
+                "extraordinaryItems",
+                "filingDate",
+                "fiscalQuarter",
+                "fiscalYear",
+                "grossProfit",
+                "incomeBeforeIncomeTaxes",
+                "incomeTaxes",
+                "interestExpense",
+                "interestIncome",
+                "netIncomeLossAttributableCommonShareholders",
+                "noncontrollingInterest",
+                "operatingIncome",
+                "otherIncomeExpense",
+                "otherOperatingExpenses",
+                "periodEnd",
+                "preferredStockDividendsDeclared",
+                "researchDevelopment",
+                "revenue",
+                "sellingGeneralAdministrative",
+                "tickers",
+                "timeframe",
+                "totalOperatingExpenses",
+                "totalOtherIncomeExpense",
+            ]
+        )
+        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:
+    IncomeStatement.model_rebuild()
+except NameError:
+    pass

finance_dev/models/incomestatementsresponse.py

@@ -0,0 +1,61 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 40616c771607
+
+from __future__ import annotations
+from .incomestatement import IncomeStatement, IncomeStatementTypedDict
+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 IncomeStatementsResponseTypedDict(TypedDict):
+    r"""Paginated SEC income statements (results, status, requestId, nextUrl)."""
+
+    next_url: NotRequired[str]
+    r"""URL for the next page when more results exist"""
+    request_id: NotRequired[str]
+    r"""Provider request identifier. Include this when reporting data issues to support."""
+    results: NotRequired[List[IncomeStatementTypedDict]]
+    r"""Income statement rows for the requested filters. Use these to analyze revenue, expenses, and profitability."""
+    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 IncomeStatementsResponse(BaseModel):
+    r"""Paginated SEC income statements (results, status, requestId, nextUrl)."""
+
+    next_url: Annotated[Optional[str], pydantic.Field(alias="nextUrl")] = None
+    r"""URL for the next page when more results exist"""
+
+    request_id: Annotated[Optional[str], pydantic.Field(alias="requestId")] = None
+    r"""Provider request identifier. Include this when reporting data issues to support."""
+
+    results: Optional[List[IncomeStatement]] = None
+    r"""Income statement rows for the requested filters. Use these to analyze revenue, expenses, and profitability."""
+
+    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:
+    IncomeStatementsResponse.model_rebuild()
+except NameError:
+    pass

finance_dev/models/indexbarresponse.py

@@ -0,0 +1,194 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: c4a6e4a72129
+
+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 IndexBarResponseBarTypedDict(TypedDict):
+    r"""OHLC bar data for the requested time period"""
+
+    close: NotRequired[float]
+    r"""Closing index value for the bar period"""
+    end_date: NotRequired[str]
+    r"""Bar end date in MM/DD/YYYY format"""
+    end_time: NotRequired[str]
+    r"""Bar end time in HH:MM AM/PM format"""
+    high: NotRequired[float]
+    r"""Highest index value during the bar period"""
+    low: NotRequired[float]
+    r"""Lowest index value during the bar period"""
+    open: NotRequired[float]
+    r"""Opening index value for the bar period"""
+    start_date: NotRequired[str]
+    r"""Bar start date in MM/DD/YYYY format"""
+    start_time: NotRequired[str]
+    r"""Bar start time in HH:MM AM/PM format"""
+    utc_offset: NotRequired[int]
+    r"""UTC time offset in hours (e.g., -5 for EST)"""
+    volume: NotRequired[int]
+    r"""Trading volume during the bar period (may be 0 for indices)"""
+
+
+class IndexBarResponseBar(BaseModel):
+    r"""OHLC bar data for the requested time period"""
+
+    close: Optional[float] = None
+    r"""Closing index value for the bar period"""
+
+    end_date: Annotated[Optional[str], pydantic.Field(alias="endDate")] = None
+    r"""Bar end date in MM/DD/YYYY format"""
+
+    end_time: Annotated[Optional[str], pydantic.Field(alias="endTime")] = None
+    r"""Bar end time in HH:MM AM/PM format"""
+
+    high: Optional[float] = None
+    r"""Highest index value during the bar period"""
+
+    low: Optional[float] = None
+    r"""Lowest index value during the bar period"""
+
+    open: Optional[float] = None
+    r"""Opening index value for the bar period"""
+
+    start_date: Annotated[Optional[str], pydantic.Field(alias="startDate")] = None
+    r"""Bar start date in MM/DD/YYYY format"""
+
+    start_time: Annotated[Optional[str], pydantic.Field(alias="startTime")] = None
+    r"""Bar start time in HH:MM AM/PM format"""
+
+    utc_offset: Annotated[Optional[int], pydantic.Field(alias="utcOffset")] = None
+    r"""UTC time offset in hours (e.g., -5 for EST)"""
+
+    volume: Optional[int] = None
+    r"""Trading volume during the bar period (may be 0 for indices)"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "close",
+                "endDate",
+                "endTime",
+                "high",
+                "low",
+                "open",
+                "startDate",
+                "startTime",
+                "utcOffset",
+                "volume",
+            ]
+        )
+        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 IndexBarResponseIndexTypedDict(TypedDict):
+    r"""Index metadata and identification"""
+
+    currency: NotRequired[str]
+    r"""Currency in which the index is quoted (e.g., USD, EUR)"""
+    index_group: NotRequired[str]
+    r"""Index group classification identifier"""
+    index_name: NotRequired[str]
+    r"""Full name of the index (e.g., S&P 500, Dow Jones)"""
+    symbol: NotRequired[str]
+    r"""Index ticker symbol (e.g., SPX, DJI)"""
+    valoren: NotRequired[str]
+    r"""Swiss securities identification number (Valoren)"""
+
+
+class IndexBarResponseIndex(BaseModel):
+    r"""Index metadata and identification"""
+
+    currency: Optional[str] = None
+    r"""Currency in which the index is quoted (e.g., USD, EUR)"""
+
+    index_group: Annotated[Optional[str], pydantic.Field(alias="indexGroup")] = None
+    r"""Index group classification identifier"""
+
+    index_name: Annotated[Optional[str], pydantic.Field(alias="indexName")] = None
+    r"""Full name of the index (e.g., S&P 500, Dow Jones)"""
+
+    symbol: Optional[str] = None
+    r"""Index ticker symbol (e.g., SPX, DJI)"""
+
+    valoren: Optional[str] = None
+    r"""Swiss securities identification number (Valoren)"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            ["currency", "indexGroup", "indexName", "symbol", "valoren"]
+        )
+        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 IndexBarResponseTypedDict(TypedDict):
+    r"""Response containing a single OHLC bar for an index along with the index metadata."""
+
+    bar: NotRequired[IndexBarResponseBarTypedDict]
+    r"""OHLC bar data for the requested time period"""
+    index: NotRequired[IndexBarResponseIndexTypedDict]
+    r"""Index metadata and identification"""
+
+
+class IndexBarResponse(BaseModel):
+    r"""Response containing a single OHLC bar for an index along with the index metadata."""
+
+    bar: Optional[IndexBarResponseBar] = None
+    r"""OHLC bar data for the requested time period"""
+
+    index: Optional[IndexBarResponseIndex] = None
+    r"""Index metadata and identification"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["bar", "index"])
+        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:
+    IndexBarResponseBar.model_rebuild()
+except NameError:
+    pass
+try:
+    IndexBarResponseIndex.model_rebuild()
+except NameError:
+    pass

finance_dev/models/indexbarsresponse.py

@@ -0,0 +1,123 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 35d9dcbf1826
+
+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 IndexBarsResponseBarTypedDict(TypedDict):
+    close: NotRequired[float]
+    r"""Closing index value for the bar period"""
+    end_date: NotRequired[str]
+    r"""Bar end date in MM/DD/YYYY format"""
+    end_time: NotRequired[str]
+    r"""Bar end time in HH:MM AM/PM format"""
+    high: NotRequired[float]
+    r"""Highest index value during the bar period"""
+    low: NotRequired[float]
+    r"""Lowest index value during the bar period"""
+    open: NotRequired[float]
+    r"""Opening index value for the bar period"""
+    start_date: NotRequired[str]
+    r"""Bar start date in MM/DD/YYYY format"""
+    start_time: NotRequired[str]
+    r"""Bar start time in HH:MM AM/PM format"""
+    volume: NotRequired[int]
+    r"""Trading volume during the bar period"""
+
+
+class IndexBarsResponseBar(BaseModel):
+    close: Optional[float] = None
+    r"""Closing index value for the bar period"""
+
+    end_date: Annotated[Optional[str], pydantic.Field(alias="endDate")] = None
+    r"""Bar end date in MM/DD/YYYY format"""
+
+    end_time: Annotated[Optional[str], pydantic.Field(alias="endTime")] = None
+    r"""Bar end time in HH:MM AM/PM format"""
+
+    high: Optional[float] = None
+    r"""Highest index value during the bar period"""
+
+    low: Optional[float] = None
+    r"""Lowest index value during the bar period"""
+
+    open: Optional[float] = None
+    r"""Opening index value for the bar period"""
+
+    start_date: Annotated[Optional[str], pydantic.Field(alias="startDate")] = None
+    r"""Bar start date in MM/DD/YYYY format"""
+
+    start_time: Annotated[Optional[str], pydantic.Field(alias="startTime")] = None
+    r"""Bar start time in HH:MM AM/PM format"""
+
+    volume: Optional[int] = None
+    r"""Trading volume during the bar period"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "close",
+                "endDate",
+                "endTime",
+                "high",
+                "low",
+                "open",
+                "startDate",
+                "startTime",
+                "volume",
+            ]
+        )
+        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 IndexBarsResponseTypedDict(TypedDict):
+    r"""Response containing OHLC bars for an index."""
+
+    bars: NotRequired[List[IndexBarsResponseBarTypedDict]]
+    r"""Array of index OHLC bars"""
+
+
+class IndexBarsResponse(BaseModel):
+    r"""Response containing OHLC bars for an index."""
+
+    bars: Optional[List[IndexBarsResponseBar]] = None
+    r"""Array of index OHLC bars"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["bars"])
+        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:
+    IndexBarsResponseBar.model_rebuild()
+except NameError:
+    pass