finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/financialsreportedresponse.py

@@ -0,0 +1,42 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: af79bfab8b77
+
+from __future__ import annotations
+from .financialsreporteddatawrapper import (
+    FinancialsReportedDataWrapper,
+    FinancialsReportedDataWrapperTypedDict,
+)
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class FinancialsReportedResponseTypedDict(TypedDict):
+    r"""Response containing company financials as reported in SEC filings."""
+
+    data: NotRequired[FinancialsReportedDataWrapperTypedDict]
+    r"""Company identifiers and the list of reported SEC filings."""
+
+
+class FinancialsReportedResponse(BaseModel):
+    r"""Response containing company financials as reported in SEC filings."""
+
+    data: Optional[FinancialsReportedDataWrapper] = None
+    r"""Company identifiers and the list of reported SEC filings."""
+
+    @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/financialsrevenuebreakdowndatawrapper.py

@@ -0,0 +1,49 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: ce0134424625
+
+from __future__ import annotations
+from .revenuebreakdownentry import RevenueBreakdownEntry, RevenueBreakdownEntryTypedDict
+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 FinancialsRevenueBreakdownDataWrapperTypedDict(TypedDict):
+    r"""Company identifiers and revenue breakdown entries from SEC filings."""
+
+    cik: NotRequired[str]
+    r"""Central Index Key assigned by the SEC."""
+    data: NotRequired[List[RevenueBreakdownEntryTypedDict]]
+    r"""Revenue breakdown entries by filing."""
+    symbol: NotRequired[str]
+    r"""Stock ticker symbol."""
+
+
+class FinancialsRevenueBreakdownDataWrapper(BaseModel):
+    r"""Company identifiers and revenue breakdown entries from SEC filings."""
+
+    cik: Optional[str] = None
+    r"""Central Index Key assigned by the SEC."""
+
+    data: Optional[List[RevenueBreakdownEntry]] = None
+    r"""Revenue breakdown entries by filing."""
+
+    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

finance_dev/models/financialsrevenuebreakdownresponse.py

@@ -0,0 +1,42 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 49d2c6811694
+
+from __future__ import annotations
+from .financialsrevenuebreakdowndatawrapper import (
+    FinancialsRevenueBreakdownDataWrapper,
+    FinancialsRevenueBreakdownDataWrapperTypedDict,
+)
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class FinancialsRevenueBreakdownResponseTypedDict(TypedDict):
+    r"""Response containing revenue breakdown data."""
+
+    data: NotRequired[FinancialsRevenueBreakdownDataWrapperTypedDict]
+    r"""Company identifiers and revenue breakdown entries from SEC filings."""
+
+
+class FinancialsRevenueBreakdownResponse(BaseModel):
+    r"""Response containing revenue breakdown data."""
+
+    data: Optional[FinancialsRevenueBreakdownDataWrapper] = None
+    r"""Company identifiers and revenue breakdown entries from SEC filings."""
+
+    @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/financialsstatementsdatawrapper.py

@@ -0,0 +1,44 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: e31053f3e45e
+
+from __future__ import annotations
+from .financialstatement import FinancialStatement, FinancialStatementTypedDict
+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 FinancialsStatementsDataWrapperTypedDict(TypedDict):
+    r"""Symbol and list of standardized financial statements by period."""
+
+    financials: NotRequired[List[FinancialStatementTypedDict]]
+    r"""Array of financial statements for different periods"""
+    symbol: NotRequired[str]
+    r"""Stock ticker symbol"""
+
+
+class FinancialsStatementsDataWrapper(BaseModel):
+    r"""Symbol and list of standardized financial statements by period."""
+
+    financials: Optional[List[FinancialStatement]] = None
+    r"""Array of financial statements for different periods"""
+
+    symbol: Optional[str] = None
+    r"""Stock ticker symbol"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["financials", "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/financialsstatementsresponse.py

@@ -0,0 +1,42 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: ea55f9975766
+
+from __future__ import annotations
+from .financialsstatementsdatawrapper import (
+    FinancialsStatementsDataWrapper,
+    FinancialsStatementsDataWrapperTypedDict,
+)
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class FinancialsStatementsResponseTypedDict(TypedDict):
+    r"""Response containing standardized financial statements."""
+
+    data: NotRequired[FinancialsStatementsDataWrapperTypedDict]
+    r"""Symbol and list of standardized financial statements by period."""
+
+
+class FinancialsStatementsResponse(BaseModel):
+    r"""Response containing standardized financial statements."""
+
+    data: Optional[FinancialsStatementsDataWrapper] = None
+    r"""Symbol and list of standardized financial statements by period."""
+
+    @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/financialstatement.py

@@ -0,0 +1,171 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 3a2ecccc9209
+
+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 FinancialStatementTypedDict(TypedDict):
+    r"""Standardized income statement figures for a single reporting period."""
+
+    cost_of_goods_sold: NotRequired[float]
+    r"""Direct costs attributable to production of goods sold"""
+    diluted_average_shares_outstanding: NotRequired[float]
+    r"""Average number of shares outstanding including dilutive securities"""
+    diluted_eps: NotRequired[float]
+    r"""Earnings per share assuming dilution from convertible securities"""
+    ebit: NotRequired[float]
+    r"""Earnings Before Interest and Taxes"""
+    gross_income: NotRequired[float]
+    r"""Revenue minus cost of goods sold"""
+    interest_income_expense: NotRequired[float]
+    r"""Net interest income or expense from debt and investments"""
+    net_income: NotRequired[float]
+    r"""Total profit after all expenses and taxes"""
+    net_income_after_taxes: NotRequired[float]
+    r"""Net income after deducting income taxes"""
+    non_recurring_items: NotRequired[float]
+    r"""One-time or unusual items affecting income"""
+    period: NotRequired[str]
+    r"""Reporting period in YYYY-MM-DD format"""
+    pretax_income: NotRequired[float]
+    r"""Income before provision for income taxes"""
+    provisionfor_income_taxes: NotRequired[float]
+    r"""Estimated income tax expense for the period"""
+    research_development: NotRequired[float]
+    r"""Expenses for research and development activities"""
+    revenue: NotRequired[float]
+    r"""Total revenue from operations"""
+    sga_expense: NotRequired[float]
+    r"""Selling, General, and Administrative expenses"""
+    total_operating_expense: NotRequired[float]
+    r"""Sum of all operating expenses"""
+    total_other_income_expense_net: NotRequired[float]
+    r"""Net of other income and expenses not related to operations"""
+    year: NotRequired[int]
+    r"""Fiscal year of the financial statement"""
+
+
+class FinancialStatement(BaseModel):
+    r"""Standardized income statement figures for a single reporting period."""
+
+    cost_of_goods_sold: Annotated[
+        Optional[float], pydantic.Field(alias="costOfGoodsSold")
+    ] = None
+    r"""Direct costs attributable to production of goods sold"""
+
+    diluted_average_shares_outstanding: Annotated[
+        Optional[float], pydantic.Field(alias="dilutedAverageSharesOutstanding")
+    ] = None
+    r"""Average number of shares outstanding including dilutive securities"""
+
+    diluted_eps: Annotated[Optional[float], pydantic.Field(alias="dilutedEPS")] = None
+    r"""Earnings per share assuming dilution from convertible securities"""
+
+    ebit: Optional[float] = None
+    r"""Earnings Before Interest and Taxes"""
+
+    gross_income: Annotated[Optional[float], pydantic.Field(alias="grossIncome")] = None
+    r"""Revenue minus cost of goods sold"""
+
+    interest_income_expense: Annotated[
+        Optional[float], pydantic.Field(alias="interestIncomeExpense")
+    ] = None
+    r"""Net interest income or expense from debt and investments"""
+
+    net_income: Annotated[Optional[float], pydantic.Field(alias="netIncome")] = None
+    r"""Total profit after all expenses and taxes"""
+
+    net_income_after_taxes: Annotated[
+        Optional[float], pydantic.Field(alias="netIncomeAfterTaxes")
+    ] = None
+    r"""Net income after deducting income taxes"""
+
+    non_recurring_items: Annotated[
+        Optional[float], pydantic.Field(alias="nonRecurringItems")
+    ] = None
+    r"""One-time or unusual items affecting income"""
+
+    period: Optional[str] = None
+    r"""Reporting period in YYYY-MM-DD format"""
+
+    pretax_income: Annotated[Optional[float], pydantic.Field(alias="pretaxIncome")] = (
+        None
+    )
+    r"""Income before provision for income taxes"""
+
+    provisionfor_income_taxes: Annotated[
+        Optional[float], pydantic.Field(alias="provisionforIncomeTaxes")
+    ] = None
+    r"""Estimated income tax expense for the period"""
+
+    research_development: Annotated[
+        Optional[float], pydantic.Field(alias="researchDevelopment")
+    ] = None
+    r"""Expenses for research and development activities"""
+
+    revenue: Optional[float] = None
+    r"""Total revenue from operations"""
+
+    sga_expense: Annotated[Optional[float], pydantic.Field(alias="sgaExpense")] = None
+    r"""Selling, General, and Administrative expenses"""
+
+    total_operating_expense: Annotated[
+        Optional[float], pydantic.Field(alias="totalOperatingExpense")
+    ] = None
+    r"""Sum of all operating expenses"""
+
+    total_other_income_expense_net: Annotated[
+        Optional[float], pydantic.Field(alias="totalOtherIncomeExpenseNet")
+    ] = None
+    r"""Net of other income and expenses not related to operations"""
+
+    year: Optional[int] = None
+    r"""Fiscal year of the financial statement"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "costOfGoodsSold",
+                "dilutedAverageSharesOutstanding",
+                "dilutedEPS",
+                "ebit",
+                "grossIncome",
+                "interestIncomeExpense",
+                "netIncome",
+                "netIncomeAfterTaxes",
+                "nonRecurringItems",
+                "period",
+                "pretaxIncome",
+                "provisionforIncomeTaxes",
+                "researchDevelopment",
+                "revenue",
+                "sgaExpense",
+                "totalOperatingExpense",
+                "totalOtherIncomeExpenseNet",
+                "year",
+            ]
+        )
+        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:
+    FinancialStatement.model_rebuild()
+except NameError:
+    pass

finance_dev/models/financialstatementtype.py

@@ -0,0 +1,14 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: aa03517a0224
+
+from __future__ import annotations
+from enum import Enum
+from finance_dev import utils
+
+
+class FinancialStatementType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Statement: bs (balance sheet), ic (income), cf (cash flow)."""
+
+    BS = "bs"
+    IC = "ic"
+    CF = "cf"

finance_dev/models/getaccountbalanceop.py

@@ -0,0 +1,53 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 550ebfcc960d
+
+from __future__ import annotations
+from .accountbalancev2 import AccountBalanceV2, AccountBalanceV2TypedDict
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from finance_dev.utils import FieldMetadata, PathParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetAccountBalanceRequestTypedDict(TypedDict):
+    id: str
+    r"""Account whose balance you want to read. Enter the account ID from `GET /v1/users/me/accounts`."""
+
+
+class GetAccountBalanceRequest(BaseModel):
+    id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""Account whose balance you want to read. Enter the account ID from `GET /v1/users/me/accounts`."""
+
+
+class GetAccountBalanceResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    account_balance_v2: NotRequired[AccountBalanceV2TypedDict]
+    r"""Account balance retrieved successfully"""
+
+
+class GetAccountBalanceResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    account_balance_v2: Optional[AccountBalanceV2] = None
+    r"""Account balance retrieved successfully"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["AccountBalanceV2"])
+        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/getaccountpositionsop.py

@@ -0,0 +1,53 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: c57fa9cd8235
+
+from __future__ import annotations
+from .getpositionsresponse import GetPositionsResponse, GetPositionsResponseTypedDict
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from finance_dev.utils import FieldMetadata, PathParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetAccountPositionsRequestTypedDict(TypedDict):
+    id: str
+    r"""Account whose positions you want to read. Enter the account ID from [User Accounts](/api-reference/accounts/user-accounts)."""
+
+
+class GetAccountPositionsRequest(BaseModel):
+    id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""Account whose positions you want to read. Enter the account ID from [User Accounts](/api-reference/accounts/user-accounts)."""
+
+
+class GetAccountPositionsResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    get_positions_response: NotRequired[GetPositionsResponseTypedDict]
+    r"""Account positions retrieved successfully"""
+
+
+class GetAccountPositionsResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    get_positions_response: Optional[GetPositionsResponse] = None
+    r"""Account positions retrieved successfully"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["GetPositionsResponse"])
+        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/getaccountsresponse.py

@@ -0,0 +1,22 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 05035fa3859d
+
+from __future__ import annotations
+from .accountitem import AccountItem, AccountItemTypedDict
+from finance_dev.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class GetAccountsResponseTypedDict(TypedDict):
+    r"""Response for GET /v2/users/me/accounts"""
+
+    accounts: List[AccountItemTypedDict]
+    r"""Trading accounts linked to the authenticated user"""
+
+
+class GetAccountsResponse(BaseModel):
+    r"""Response for GET /v2/users/me/accounts"""
+
+    accounts: List[AccountItem]
+    r"""Trading accounts linked to the authenticated user"""

finance_dev/models/getaggregatetechnicalindicatorsop.py

@@ -0,0 +1,94 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 21ba2fab1797
+
+from __future__ import annotations
+from .aggregatetechnicalindicatorsresponse import (
+    AggregateTechnicalIndicatorsResponse,
+    AggregateTechnicalIndicatorsResponseTypedDict,
+)
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from enum import Enum
+from finance_dev import models, utils
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from finance_dev.utils import FieldMetadata, QueryParamMetadata
+import pydantic
+from pydantic import field_serializer, model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetAggregateTechnicalIndicatorsResolution(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
+    r"""How long each bar covers. Supported values are minutes (`1`, `5`, `15`, `30`, `60`) or daily/weekly/monthly (`D`, `W`, `M`). Other values return 400 Bad Request with error code `VALIDATION_ERROR`."""
+
+    ONE = "1"
+    FIVE = "5"
+    FIFTEEN = "15"
+    THIRTY = "30"
+    SIXTY = "60"
+    D = "D"
+    W = "W"
+    M = "M"
+
+
+class GetAggregateTechnicalIndicatorsRequestTypedDict(TypedDict):
+    symbol: str
+    r"""Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`, `TSLA`."""
+    resolution: GetAggregateTechnicalIndicatorsResolution
+    r"""How long each bar covers. Supported values are minutes (`1`, `5`, `15`, `30`, `60`) or daily/weekly/monthly (`D`, `W`, `M`). Other values return 400 Bad Request with error code `VALIDATION_ERROR`."""
+
+
+class GetAggregateTechnicalIndicatorsRequest(BaseModel):
+    symbol: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`, `TSLA`."""
+
+    resolution: Annotated[
+        GetAggregateTechnicalIndicatorsResolution,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""How long each bar covers. Supported values are minutes (`1`, `5`, `15`, `30`, `60`) or daily/weekly/monthly (`D`, `W`, `M`). Other values return 400 Bad Request with error code `VALIDATION_ERROR`."""
+
+    @field_serializer("resolution")
+    def serialize_resolution(self, value):
+        if isinstance(value, str):
+            try:
+                return models.GetAggregateTechnicalIndicatorsResolution(value)
+            except ValueError:
+                return value
+        return value
+
+
+class GetAggregateTechnicalIndicatorsResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    aggregate_technical_indicators_response: NotRequired[
+        AggregateTechnicalIndicatorsResponseTypedDict
+    ]
+    r"""Successful response"""
+
+
+class GetAggregateTechnicalIndicatorsResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    aggregate_technical_indicators_response: Optional[
+        AggregateTechnicalIndicatorsResponse
+    ] = None
+    r"""Successful response"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["AggregateTechnicalIndicatorsResponse"])
+        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