finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/getoptionchainsnapshotop.py

@@ -0,0 +1,244 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: d8379f1eb73a
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .optionchainsnapshotresponse import (
+    OptionChainSnapshotResponse,
+    OptionChainSnapshotResponseTypedDict,
+)
+from datetime import date
+from enum import Enum
+from finance_dev import models, utils
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from finance_dev.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata
+import pydantic
+from pydantic import field_serializer, model_serializer
+from typing import Callable, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetOptionChainSnapshotOrder(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Sort order for returned records. Use asc for oldest first or desc for newest first when supported. for results."""
+
+    ASC = "asc"
+    DESC = "desc"
+
+
+class GetOptionChainSnapshotRequestTypedDict(TypedDict):
+    underlying_asset: str
+    r"""Underlying equity symbol (for example AAPL)."""
+    strike_price: NotRequired[str]
+    r"""Filter by exact strike price (numeric string)."""
+    expiration_date: NotRequired[date]
+    r"""Filter by expiration date (typically YYYY-MM-DD)."""
+    contract_type: NotRequired[str]
+    r"""Filter by contract type (for example call or put)."""
+    strike_price_gte: NotRequired[str]
+    r"""Strike price greater than or equal to this value."""
+    strike_price_gt: NotRequired[str]
+    r"""Strike price strictly greater than this value."""
+    strike_price_lte: NotRequired[str]
+    r"""Strike price less than or equal to this value."""
+    strike_price_lt: NotRequired[str]
+    r"""Strike price strictly less than this value."""
+    expiration_date_gte: NotRequired[str]
+    r"""Expiration date greater than or equal to this value."""
+    expiration_date_gt: NotRequired[str]
+    r"""Expiration date strictly greater than this value."""
+    expiration_date_lte: NotRequired[str]
+    r"""Expiration date less than or equal to this value."""
+    expiration_date_lt: NotRequired[str]
+    r"""Expiration date strictly less than this value."""
+    order: NotRequired[GetOptionChainSnapshotOrder]
+    r"""Sort order for returned records. Use asc for oldest first or desc for newest first when supported. for results."""
+    limit: NotRequired[int]
+    r"""Maximum number of contracts per page (1–250)."""
+    sort: NotRequired[str]
+    r"""Sort field used for ordering. Massive documents this separately from `order`, so enter the provider-supported field name in the text box."""
+    next: NotRequired[str]
+    r"""Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page. You can also follow the absolute `nextUrl` from the previous response."""
+
+
+class GetOptionChainSnapshotRequest(BaseModel):
+    underlying_asset: Annotated[
+        str,
+        pydantic.Field(alias="underlyingAsset"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Underlying equity symbol (for example AAPL)."""
+
+    strike_price: Annotated[
+        Optional[str],
+        pydantic.Field(alias="strikePrice"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Filter by exact strike price (numeric string)."""
+
+    expiration_date: Annotated[
+        Optional[date],
+        pydantic.Field(alias="expirationDate"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Filter by expiration date (typically YYYY-MM-DD)."""
+
+    contract_type: Annotated[
+        Optional[str],
+        pydantic.Field(alias="contractType"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Filter by contract type (for example call or put)."""
+
+    strike_price_gte: Annotated[
+        Optional[str],
+        pydantic.Field(alias="strikePriceGte"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Strike price greater than or equal to this value."""
+
+    strike_price_gt: Annotated[
+        Optional[str],
+        pydantic.Field(alias="strikePriceGt"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Strike price strictly greater than this value."""
+
+    strike_price_lte: Annotated[
+        Optional[str],
+        pydantic.Field(alias="strikePriceLte"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Strike price less than or equal to this value."""
+
+    strike_price_lt: Annotated[
+        Optional[str],
+        pydantic.Field(alias="strikePriceLt"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Strike price strictly less than this value."""
+
+    expiration_date_gte: Annotated[
+        Optional[str],
+        pydantic.Field(alias="expirationDateGte"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Expiration date greater than or equal to this value."""
+
+    expiration_date_gt: Annotated[
+        Optional[str],
+        pydantic.Field(alias="expirationDateGt"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Expiration date strictly greater than this value."""
+
+    expiration_date_lte: Annotated[
+        Optional[str],
+        pydantic.Field(alias="expirationDateLte"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Expiration date less than or equal to this value."""
+
+    expiration_date_lt: Annotated[
+        Optional[str],
+        pydantic.Field(alias="expirationDateLt"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Expiration date strictly less than this value."""
+
+    order: Annotated[
+        Optional[GetOptionChainSnapshotOrder],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = GetOptionChainSnapshotOrder.ASC
+    r"""Sort order for returned records. Use asc for oldest first or desc for newest first when supported. for results."""
+
+    limit: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Maximum number of contracts per page (1–250)."""
+
+    sort: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Sort field used for ordering. Massive documents this separately from `order`, so enter the provider-supported field name in the text box."""
+
+    next: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page. You can also follow the absolute `nextUrl` from the previous response."""
+
+    @field_serializer("order")
+    def serialize_order(self, value):
+        if isinstance(value, str):
+            try:
+                return models.GetOptionChainSnapshotOrder(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "strikePrice",
+                "expirationDate",
+                "contractType",
+                "strikePriceGte",
+                "strikePriceGt",
+                "strikePriceLte",
+                "strikePriceLt",
+                "expirationDateGte",
+                "expirationDateGt",
+                "expirationDateLte",
+                "expirationDateLt",
+                "order",
+                "limit",
+                "sort",
+                "next",
+            ]
+        )
+        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 GetOptionChainSnapshotResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    option_chain_snapshot_response: NotRequired[OptionChainSnapshotResponseTypedDict]
+    r"""Option chain snapshot returned successfully."""
+
+
+class GetOptionChainSnapshotResponse(BaseModel):
+    next: Callable[[], Optional[GetOptionChainSnapshotResponse]]
+
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    option_chain_snapshot_response: Optional[OptionChainSnapshotResponse] = None
+    r"""Option chain snapshot returned successfully."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OptionChainSnapshotResponse"])
+        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/getoptioncontractsnapshotop.py

@@ -0,0 +1,69 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 4112a7f453dd
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .optioncontractsnapshotresponse import (
+    OptionContractSnapshotResponse,
+    OptionContractSnapshotResponseTypedDict,
+)
+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 GetOptionContractSnapshotRequestTypedDict(TypedDict):
+    underlying_asset: str
+    r"""Underlying equity symbol (for example AAPL)."""
+    option_contract: str
+    r"""OCC-format options contract identifier (for example O:AAPL240119C00190000)."""
+
+
+class GetOptionContractSnapshotRequest(BaseModel):
+    underlying_asset: Annotated[
+        str,
+        pydantic.Field(alias="underlyingAsset"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Underlying equity symbol (for example AAPL)."""
+
+    option_contract: Annotated[
+        str,
+        pydantic.Field(alias="optionContract"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""OCC-format options contract identifier (for example O:AAPL240119C00190000)."""
+
+
+class GetOptionContractSnapshotResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    option_contract_snapshot_response: NotRequired[
+        OptionContractSnapshotResponseTypedDict
+    ]
+    r"""Option contract snapshot returned successfully."""
+
+
+class GetOptionContractSnapshotResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    option_contract_snapshot_response: Optional[OptionContractSnapshotResponse] = None
+    r"""Option contract snapshot returned successfully."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OptionContractSnapshotResponse"])
+        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/getoptiondetailsop.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: c61f967cb70d
+
+from __future__ import annotations
+from .getoptiondetailsresponse import (
+    GetOptionDetailsResponse,
+    GetOptionDetailsResponseTypedDict,
+)
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from finance_dev.utils import FieldMetadata, QueryParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetOptionDetailsRequestTypedDict(TypedDict):
+    symbols: str
+    r"""One or more OSI option symbols, separated by commas (e.g. `GOOG270115C00285000`). Send at least one. The response order matches the request order."""
+
+
+class GetOptionDetailsRequest(BaseModel):
+    symbols: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""One or more OSI option symbols, separated by commas (e.g. `GOOG270115C00285000`). Send at least one. The response order matches the request order."""
+
+
+class GetOptionDetailsResponseResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    get_option_details_response: NotRequired[GetOptionDetailsResponseTypedDict]
+    r"""`data` holds per-symbol option pricing objects matching `OptionDetailsDTO`. See schema for the `errors` array shape when a symbol cannot be returned."""
+
+
+class GetOptionDetailsResponseResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    get_option_details_response: Optional[GetOptionDetailsResponse] = None
+    r"""`data` holds per-symbol option pricing objects matching `OptionDetailsDTO`. See schema for the `errors` array shape when a symbol cannot be returned."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["GetOptionDetailsResponse"])
+        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/getoptiondetailsresponse.py

@@ -0,0 +1,45 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: cbb957c35f86
+
+from __future__ import annotations
+from .optiondetailsdto import OptionDetailsDTO, OptionDetailsDTOTypedDict
+from .symbolerror import SymbolError, SymbolErrorTypedDict
+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 GetOptionDetailsResponseTypedDict(TypedDict):
+    r"""Wrapper for GET /v1/marketdata/options/details: `data` for successful symbols, `errors` when applicable."""
+
+    data: NotRequired[List[OptionDetailsDTOTypedDict]]
+    r"""Option contracts that returned a pricing snapshot"""
+    errors: NotRequired[List[SymbolErrorTypedDict]]
+    r"""Per-symbol error entries when a requested symbol cannot be included in `data`"""
+
+
+class GetOptionDetailsResponse(BaseModel):
+    r"""Wrapper for GET /v1/marketdata/options/details: `data` for successful symbols, `errors` when applicable."""
+
+    data: Optional[List[OptionDetailsDTO]] = None
+    r"""Option contracts that returned a pricing snapshot"""
+
+    errors: Optional[List[SymbolError]] = None
+    r"""Per-symbol error entries when a requested symbol cannot be included in `data`"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["data", "errors"])
+        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/getoptionlasttradeop.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 5c2ffb6e8763
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .optionlasttraderesponse import (
+    OptionLastTradeResponse,
+    OptionLastTradeResponseTypedDict,
+)
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from finance_dev.utils import FieldMetadata, QueryParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetOptionLastTradeRequestTypedDict(TypedDict):
+    ticker: str
+    r"""Options contract ticker symbol. Enter the exact option symbol returned by option search or chain endpoints."""
+
+
+class GetOptionLastTradeRequest(BaseModel):
+    ticker: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Options contract ticker symbol. Enter the exact option symbol returned by option search or chain endpoints."""
+
+
+class GetOptionLastTradeResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    option_last_trade_response: NotRequired[OptionLastTradeResponseTypedDict]
+    r"""Successful response"""
+
+
+class GetOptionLastTradeResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    option_last_trade_response: Optional[OptionLastTradeResponse] = None
+    r"""Successful response"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OptionLastTradeResponse"])
+        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/getoptionopencloseop.py

@@ -0,0 +1,66 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 687ca8fa045e
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .optionopencloseresponse import (
+    OptionOpenCloseResponse,
+    OptionOpenCloseResponseTypedDict,
+)
+from datetime import date
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from finance_dev.utils import FieldMetadata, QueryParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetOptionOpenCloseRequestTypedDict(TypedDict):
+    ticker: str
+    r"""OCC option ticker symbol (e.g., O:AAPL251219C00150000)"""
+    date_: date
+    r"""Date in YYYY-MM-DD format. Enter the specific calendar date you want to query."""
+
+
+class GetOptionOpenCloseRequest(BaseModel):
+    ticker: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""OCC option ticker symbol (e.g., O:AAPL251219C00150000)"""
+
+    date_: Annotated[
+        date,
+        pydantic.Field(alias="date"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""Date in YYYY-MM-DD format. Enter the specific calendar date you want to query."""
+
+
+class GetOptionOpenCloseResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    option_open_close_response: NotRequired[OptionOpenCloseResponseTypedDict]
+    r"""Successful response"""
+
+
+class GetOptionOpenCloseResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    option_open_close_response: Optional[OptionOpenCloseResponse] = None
+    r"""Successful response"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OptionOpenCloseResponse"])
+        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/getoptionpreviousdayop.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: ffd8ea15e195
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .optionpreviousdayresponse import (
+    OptionPreviousDayResponse,
+    OptionPreviousDayResponseTypedDict,
+)
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from finance_dev.utils import FieldMetadata, QueryParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetOptionPreviousDayRequestTypedDict(TypedDict):
+    ticker: str
+    r"""Option contract identifier in OCC/OSI format. The 21-character form is `ROOT + YYMMDD + C/P + strike-in-cents` (e.g. `AAPL251219C00150000` = AAPL Dec-19-2025 $150 Call). The optional `O:` prefix is accepted and stripped (so `O:AAPL251219C00150000` works too)."""
+
+
+class GetOptionPreviousDayRequest(BaseModel):
+    ticker: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Option contract identifier in OCC/OSI format. The 21-character form is `ROOT + YYMMDD + C/P + strike-in-cents` (e.g. `AAPL251219C00150000` = AAPL Dec-19-2025 $150 Call). The optional `O:` prefix is accepted and stripped (so `O:AAPL251219C00150000` works too)."""
+
+
+class GetOptionPreviousDayResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    option_previous_day_response: NotRequired[OptionPreviousDayResponseTypedDict]
+    r"""Previous-day bar for the requested option contract."""
+
+
+class GetOptionPreviousDayResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    option_previous_day_response: Optional[OptionPreviousDayResponse] = None
+    r"""Previous-day bar for the requested option contract."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OptionPreviousDayResponse"])
+        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