finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/indicesrealtimeindexvalue.py

@@ -0,0 +1,157 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: eddc3c09f44e
+
+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 IndicesRealtimeIndexValueTypedDict(TypedDict):
+    r"""Realtime OHLC and change fields for an index quote."""
+
+    change_from_open: NotRequired[float]
+    r"""Change in the index value from the session open."""
+    change_from_previous_close: NotRequired[float]
+    r"""Change in the index value from the previous close."""
+    close: NotRequired[float]
+    r"""Current / last close value"""
+    date_: NotRequired[str]
+    r"""Session date in source format (locale-specific)"""
+    high: NotRequired[float]
+    r"""Highest index value for the session."""
+    high52_weeks: NotRequired[float]
+    r"""52-week high"""
+    last: NotRequired[float]
+    r"""Last traded value"""
+    low: NotRequired[float]
+    r"""Lowest index value for the session."""
+    low52_weeks: NotRequired[float]
+    r"""52-week low"""
+    open: NotRequired[float]
+    r"""Opening value of the index for the session."""
+    percent_change_from_open: NotRequired[float]
+    r"""Percentage change in the index value from the session open."""
+    percent_change_from_previous_close: NotRequired[float]
+    r"""Percentage change in the index value from the previous close."""
+    previous_close: NotRequired[float]
+    r"""Closing value of the index on the previous trading day."""
+    previous_close_date: NotRequired[str]
+    r"""Prior close date in source format"""
+    time: NotRequired[str]
+    r"""Quote time in source format"""
+    utc_offset: NotRequired[int]
+    r"""UTC offset in hours"""
+    volume: NotRequired[int]
+    r"""Volume (may be 0 for some indices)"""
+
+
+class IndicesRealtimeIndexValue(BaseModel):
+    r"""Realtime OHLC and change fields for an index quote."""
+
+    change_from_open: Annotated[
+        Optional[float], pydantic.Field(alias="changeFromOpen")
+    ] = None
+    r"""Change in the index value from the session open."""
+
+    change_from_previous_close: Annotated[
+        Optional[float], pydantic.Field(alias="changeFromPreviousClose")
+    ] = None
+    r"""Change in the index value from the previous close."""
+
+    close: Optional[float] = None
+    r"""Current / last close value"""
+
+    date_: Annotated[Optional[str], pydantic.Field(alias="date")] = None
+    r"""Session date in source format (locale-specific)"""
+
+    high: Optional[float] = None
+    r"""Highest index value for the session."""
+
+    high52_weeks: Annotated[Optional[float], pydantic.Field(alias="high52Weeks")] = None
+    r"""52-week high"""
+
+    last: Optional[float] = None
+    r"""Last traded value"""
+
+    low: Optional[float] = None
+    r"""Lowest index value for the session."""
+
+    low52_weeks: Annotated[Optional[float], pydantic.Field(alias="low52Weeks")] = None
+    r"""52-week low"""
+
+    open: Optional[float] = None
+    r"""Opening value of the index for the session."""
+
+    percent_change_from_open: Annotated[
+        Optional[float], pydantic.Field(alias="percentChangeFromOpen")
+    ] = None
+    r"""Percentage change in the index value from the session open."""
+
+    percent_change_from_previous_close: Annotated[
+        Optional[float], pydantic.Field(alias="percentChangeFromPreviousClose")
+    ] = None
+    r"""Percentage change in the index value from the previous close."""
+
+    previous_close: Annotated[
+        Optional[float], pydantic.Field(alias="previousClose")
+    ] = None
+    r"""Closing value of the index on the previous trading day."""
+
+    previous_close_date: Annotated[
+        Optional[str], pydantic.Field(alias="previousCloseDate")
+    ] = None
+    r"""Prior close date in source format"""
+
+    time: Optional[str] = None
+    r"""Quote time in source format"""
+
+    utc_offset: Annotated[Optional[int], pydantic.Field(alias="utcOffset")] = None
+    r"""UTC offset in hours"""
+
+    volume: Optional[int] = None
+    r"""Volume (may be 0 for some indices)"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "changeFromOpen",
+                "changeFromPreviousClose",
+                "close",
+                "date",
+                "high",
+                "high52Weeks",
+                "last",
+                "low",
+                "low52Weeks",
+                "open",
+                "percentChangeFromOpen",
+                "percentChangeFromPreviousClose",
+                "previousClose",
+                "previousCloseDate",
+                "time",
+                "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
+
+
+try:
+    IndicesRealtimeIndexValue.model_rebuild()
+except NameError:
+    pass

finance_dev/models/indicesrealtimevaluesitem.py

@@ -0,0 +1,80 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: a5bdf4d21c69
+
+from __future__ import annotations
+from .indicesrealtimeindexinfo import (
+    IndicesRealtimeIndexInfo,
+    IndicesRealtimeIndexInfoTypedDict,
+)
+from .indicesrealtimeindexvalue import (
+    IndicesRealtimeIndexValue,
+    IndicesRealtimeIndexValueTypedDict,
+)
+from .tenderofferidentifiertype import TenderOfferIdentifierType
+from finance_dev import models
+from finance_dev.types import BaseModel
+import pydantic
+from pydantic import field_serializer
+from typing_extensions import Annotated, TypedDict
+
+
+class IndicesRealtimeValuesItemTypedDict(TypedDict):
+    r"""One index in the batch realtime values response."""
+
+    identifier: str
+    r"""Full index identifier (e.g. SPX.IND_CBOM)"""
+    identifier_type: TenderOfferIdentifierType
+    r"""Which kind of identifier you are filtering by. Provide the matching value in the identifier field:
+    - `Symbol` — exchange ticker (e.g. `AAPL`).
+    - `CUSIP` — 9-character U.S./Canadian security identifier.
+    - `ISIN` — 12-character international identifier.
+    - `SEDOL` — 7-character UK identifier.
+    - `Valoren` — Swiss identifier.
+    - `FIGI` — Bloomberg Financial Instrument Global Identifier.
+    - `CompositeFIGI` — country-level composite FIGI.
+    """
+    index: IndicesRealtimeIndexInfoTypedDict
+    r"""Index metadata for a realtime quote item."""
+    value: IndicesRealtimeIndexValueTypedDict
+    r"""Realtime OHLC and change fields for an index quote."""
+
+
+class IndicesRealtimeValuesItem(BaseModel):
+    r"""One index in the batch realtime values response."""
+
+    identifier: str
+    r"""Full index identifier (e.g. SPX.IND_CBOM)"""
+
+    identifier_type: Annotated[
+        TenderOfferIdentifierType, pydantic.Field(alias="identifierType")
+    ]
+    r"""Which kind of identifier you are filtering by. Provide the matching value in the identifier field:
+    - `Symbol` — exchange ticker (e.g. `AAPL`).
+    - `CUSIP` — 9-character U.S./Canadian security identifier.
+    - `ISIN` — 12-character international identifier.
+    - `SEDOL` — 7-character UK identifier.
+    - `Valoren` — Swiss identifier.
+    - `FIGI` — Bloomberg Financial Instrument Global Identifier.
+    - `CompositeFIGI` — country-level composite FIGI.
+    """
+
+    index: IndicesRealtimeIndexInfo
+    r"""Index metadata for a realtime quote item."""
+
+    value: IndicesRealtimeIndexValue
+    r"""Realtime OHLC and change fields for an index quote."""
+
+    @field_serializer("identifier_type")
+    def serialize_identifier_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.TenderOfferIdentifierType(value)
+            except ValueError:
+                return value
+        return value
+
+
+try:
+    IndicesRealtimeValuesItem.model_rebuild()
+except NameError:
+    pass

finance_dev/models/indicesrealtimevaluesresponse.py

@@ -0,0 +1,42 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 0fe715a6b05c
+
+from __future__ import annotations
+from .indicesrealtimevaluesitem import (
+    IndicesRealtimeValuesItem,
+    IndicesRealtimeValuesItemTypedDict,
+)
+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 IndicesRealtimeValuesResponseTypedDict(TypedDict):
+    r"""Batch realtime index quotes returned by GET /v1/indices/realtime/values."""
+
+    items: NotRequired[List[IndicesRealtimeValuesItemTypedDict]]
+    r"""One entry per requested identifier"""
+
+
+class IndicesRealtimeValuesResponse(BaseModel):
+    r"""Batch realtime index quotes returned by GET /v1/indices/realtime/values."""
+
+    items: Optional[List[IndicesRealtimeValuesItem]] = None
+    r"""One entry per requested identifier"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["items"])
+        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/inflationexpectationsresponse.py

@@ -0,0 +1,140 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 96050407b34a
+
+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 InflationExpectationsResponseResultTypedDict(TypedDict):
+    date_: NotRequired[str]
+    r"""Reference date (YYYY-MM-DD)"""
+    forward_years5_to10: NotRequired[float]
+    r"""Forward inflation expectation covering years 5 to 10"""
+    market10_year: NotRequired[float]
+    r"""Market-implied 10-year inflation expectation"""
+    market5_year: NotRequired[float]
+    r"""Market-implied 5-year inflation expectation"""
+    model10_year: NotRequired[float]
+    r"""Model-based 10-year inflation expectation"""
+    model1_year: NotRequired[float]
+    r"""Model-based 1-year inflation expectation"""
+    model30_year: NotRequired[float]
+    r"""Model-based 30-year inflation expectation"""
+    model5_year: NotRequired[float]
+    r"""Model-based 5-year inflation expectation"""
+
+
+class InflationExpectationsResponseResult(BaseModel):
+    date_: Annotated[Optional[str], pydantic.Field(alias="date")] = None
+    r"""Reference date (YYYY-MM-DD)"""
+
+    forward_years5_to10: Annotated[
+        Optional[float], pydantic.Field(alias="forwardYears5To10")
+    ] = None
+    r"""Forward inflation expectation covering years 5 to 10"""
+
+    market10_year: Annotated[Optional[float], pydantic.Field(alias="market10Year")] = (
+        None
+    )
+    r"""Market-implied 10-year inflation expectation"""
+
+    market5_year: Annotated[Optional[float], pydantic.Field(alias="market5Year")] = None
+    r"""Market-implied 5-year inflation expectation"""
+
+    model10_year: Annotated[Optional[float], pydantic.Field(alias="model10Year")] = None
+    r"""Model-based 10-year inflation expectation"""
+
+    model1_year: Annotated[Optional[float], pydantic.Field(alias="model1Year")] = None
+    r"""Model-based 1-year inflation expectation"""
+
+    model30_year: Annotated[Optional[float], pydantic.Field(alias="model30Year")] = None
+    r"""Model-based 30-year inflation expectation"""
+
+    model5_year: Annotated[Optional[float], pydantic.Field(alias="model5Year")] = None
+    r"""Model-based 5-year inflation expectation"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "date",
+                "forwardYears5To10",
+                "market10Year",
+                "market5Year",
+                "model10Year",
+                "model1Year",
+                "model30Year",
+                "model5Year",
+            ]
+        )
+        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 InflationExpectationsResponseTypedDict(TypedDict):
+    r"""Paginated response containing inflation expectations data from the upstream data provider."""
+
+    next_url: NotRequired[str]
+    r"""URL for next page of results"""
+    request_id: NotRequired[str]
+    r"""Provider request identifier for tracing and support"""
+    results: NotRequired[List[InflationExpectationsResponseResultTypedDict]]
+    r"""Array of inflation expectation data points"""
+    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 InflationExpectationsResponse(BaseModel):
+    r"""Paginated response containing inflation expectations data from the upstream data provider."""
+
+    next_url: Annotated[Optional[str], pydantic.Field(alias="nextUrl")] = None
+    r"""URL for next page of results"""
+
+    request_id: Annotated[Optional[str], pydantic.Field(alias="requestId")] = None
+    r"""Provider request identifier for tracing and support"""
+
+    results: Optional[List[InflationExpectationsResponseResult]] = None
+    r"""Array of inflation expectation data points"""
+
+    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:
+    InflationExpectationsResponseResult.model_rebuild()
+except NameError:
+    pass
+try:
+    InflationExpectationsResponse.model_rebuild()
+except NameError:
+    pass

finance_dev/models/inflationresponse.py

@@ -0,0 +1,132 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 87f4e479ab26
+
+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 InflationResponseResultTypedDict(TypedDict):
+    cpi: NotRequired[float]
+    r"""Consumer Price Index"""
+    cpi_core: NotRequired[float]
+    r"""Core CPI (excluding food and energy)"""
+    cpi_year_over_year: NotRequired[float]
+    r"""CPI year-over-year change"""
+    date_: NotRequired[str]
+    r"""Reference date (YYYY-MM-DD)"""
+    pce: NotRequired[float]
+    r"""Personal Consumption Expenditures"""
+    pce_core: NotRequired[float]
+    r"""Core PCE"""
+    pce_spending: NotRequired[float]
+    r"""PCE spending"""
+
+
+class InflationResponseResult(BaseModel):
+    cpi: Optional[float] = None
+    r"""Consumer Price Index"""
+
+    cpi_core: Annotated[Optional[float], pydantic.Field(alias="cpiCore")] = None
+    r"""Core CPI (excluding food and energy)"""
+
+    cpi_year_over_year: Annotated[
+        Optional[float], pydantic.Field(alias="cpiYearOverYear")
+    ] = None
+    r"""CPI year-over-year change"""
+
+    date_: Annotated[Optional[str], pydantic.Field(alias="date")] = None
+    r"""Reference date (YYYY-MM-DD)"""
+
+    pce: Optional[float] = None
+    r"""Personal Consumption Expenditures"""
+
+    pce_core: Annotated[Optional[float], pydantic.Field(alias="pceCore")] = None
+    r"""Core PCE"""
+
+    pce_spending: Annotated[Optional[float], pydantic.Field(alias="pceSpending")] = None
+    r"""PCE spending"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "cpi",
+                "cpiCore",
+                "cpiYearOverYear",
+                "date",
+                "pce",
+                "pceCore",
+                "pceSpending",
+            ]
+        )
+        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 InflationResponseTypedDict(TypedDict):
+    r"""Paginated response containing inflation data (CPI and PCE) from the upstream data provider."""
+
+    next_url: NotRequired[str]
+    r"""URL for next page of results"""
+    request_id: NotRequired[str]
+    r"""Provider request identifier for tracing and support"""
+    results: NotRequired[List[InflationResponseResultTypedDict]]
+    r"""Array of inflation data points"""
+    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 InflationResponse(BaseModel):
+    r"""Paginated response containing inflation data (CPI and PCE) from the upstream data provider."""
+
+    next_url: Annotated[Optional[str], pydantic.Field(alias="nextUrl")] = None
+    r"""URL for next page of results"""
+
+    request_id: Annotated[Optional[str], pydantic.Field(alias="requestId")] = None
+    r"""Provider request identifier for tracing and support"""
+
+    results: Optional[List[InflationResponseResult]] = None
+    r"""Array of inflation data points"""
+
+    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:
+    InflationResponseResult.model_rebuild()
+except NameError:
+    pass
+try:
+    InflationResponse.model_rebuild()
+except NameError:
+    pass

finance_dev/models/insidertransaction.py

@@ -0,0 +1,97 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 75f2f6ab27c9
+
+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 InsiderTransactionTypedDict(TypedDict):
+    r"""Single insider trading transaction reported on SEC Form 4."""
+
+    change: NotRequired[int]
+    r"""Net change in shares held after the transaction"""
+    filing_date: NotRequired[str]
+    r"""Date when the Form 4 was filed with the SEC in YYYY-MM-DD format"""
+    name: NotRequired[str]
+    r"""Name of the insider (executive, director, or beneficial owner)"""
+    share: NotRequired[int]
+    r"""Number of shares involved in the transaction"""
+    symbol: NotRequired[str]
+    r"""Stock ticker symbol"""
+    transaction_code: NotRequired[str]
+    r"""SEC transaction code (P=Purchase, S=Sale, A=Award, etc.)"""
+    transaction_date: NotRequired[str]
+    r"""Date when the transaction occurred in YYYY-MM-DD format"""
+    transaction_price: NotRequired[float]
+    r"""Price per share at which the transaction was executed"""
+
+
+class InsiderTransaction(BaseModel):
+    r"""Single insider trading transaction reported on SEC Form 4."""
+
+    change: Optional[int] = None
+    r"""Net change in shares held after the transaction"""
+
+    filing_date: Annotated[Optional[str], pydantic.Field(alias="filingDate")] = None
+    r"""Date when the Form 4 was filed with the SEC in YYYY-MM-DD format"""
+
+    name: Optional[str] = None
+    r"""Name of the insider (executive, director, or beneficial owner)"""
+
+    share: Optional[int] = None
+    r"""Number of shares involved in the transaction"""
+
+    symbol: Optional[str] = None
+    r"""Stock ticker symbol"""
+
+    transaction_code: Annotated[
+        Optional[str], pydantic.Field(alias="transactionCode")
+    ] = None
+    r"""SEC transaction code (P=Purchase, S=Sale, A=Award, etc.)"""
+
+    transaction_date: Annotated[
+        Optional[str], pydantic.Field(alias="transactionDate")
+    ] = None
+    r"""Date when the transaction occurred in YYYY-MM-DD format"""
+
+    transaction_price: Annotated[
+        Optional[float], pydantic.Field(alias="transactionPrice")
+    ] = None
+    r"""Price per share at which the transaction was executed"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "change",
+                "filingDate",
+                "name",
+                "share",
+                "symbol",
+                "transactionCode",
+                "transactionDate",
+                "transactionPrice",
+            ]
+        )
+        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:
+    InsiderTransaction.model_rebuild()
+except NameError:
+    pass

finance_dev/models/insidertransactionsresponse.py

@@ -0,0 +1,39 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 21a3e8656361
+
+from __future__ import annotations
+from .insidertransaction import InsiderTransaction, InsiderTransactionTypedDict
+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 InsiderTransactionsResponseTypedDict(TypedDict):
+    r"""Response containing insider trading transactions."""
+
+    transactions: NotRequired[List[InsiderTransactionTypedDict]]
+    r"""List of insider trading transactions"""
+
+
+class InsiderTransactionsResponse(BaseModel):
+    r"""Response containing insider trading transactions."""
+
+    transactions: Optional[List[InsiderTransaction]] = None
+    r"""List of insider trading transactions"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["transactions"])
+        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