finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/getoptiontradesop.py

@@ -0,0 +1,177 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 84a041e387f4
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .optiontradesresponse import OptionTradesResponse, OptionTradesResponseTypedDict
+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 Callable, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetOptionTradesOrder(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Sort order for returned records. Use asc for oldest first or desc for newest first when supported."""
+
+    ASC = "asc"
+    DESC = "desc"
+
+
+class GetOptionTradesRequestTypedDict(TypedDict):
+    ticker: str
+    r"""Options contract ticker symbol. Enter the exact option symbol returned by option search or chain endpoints."""
+    timestamp: NotRequired[str]
+    r"""Query by timestamp (YYYY-MM-DD or nanoseconds)"""
+    timestamp_from: NotRequired[str]
+    r"""Timestamp start filter. Returns records at or after this timestamp."""
+    timestamp_after: NotRequired[str]
+    r"""Timestamp lower-bound filter. Returns records after this timestamp, excluding the timestamp itself."""
+    timestamp_to: NotRequired[str]
+    r"""Timestamp end filter. Returns records at or before this timestamp."""
+    timestamp_before: NotRequired[str]
+    r"""Timestamp upper-bound filter. Returns records before this timestamp, excluding the timestamp itself."""
+    order: NotRequired[GetOptionTradesOrder]
+    r"""Sort order for returned records. Use asc for oldest first or desc for newest first when supported."""
+    limit: NotRequired[int]
+    r"""Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits."""
+    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, for example `timestamp`."""
+    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."""
+
+
+class GetOptionTradesRequest(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."""
+
+    timestamp: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Query by timestamp (YYYY-MM-DD or nanoseconds)"""
+
+    timestamp_from: Annotated[
+        Optional[str],
+        pydantic.Field(alias="timestampFrom"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Timestamp start filter. Returns records at or after this timestamp."""
+
+    timestamp_after: Annotated[
+        Optional[str],
+        pydantic.Field(alias="timestampAfter"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Timestamp lower-bound filter. Returns records after this timestamp, excluding the timestamp itself."""
+
+    timestamp_to: Annotated[
+        Optional[str],
+        pydantic.Field(alias="timestampTo"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Timestamp end filter. Returns records at or before this timestamp."""
+
+    timestamp_before: Annotated[
+        Optional[str],
+        pydantic.Field(alias="timestampBefore"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Timestamp upper-bound filter. Returns records before this timestamp, excluding the timestamp itself."""
+
+    order: Annotated[
+        Optional[GetOptionTradesOrder],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = GetOptionTradesOrder.DESC
+    r"""Sort order for returned records. Use asc for oldest first or desc for newest first when supported."""
+
+    limit: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits."""
+
+    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, for example `timestamp`."""
+
+    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."""
+
+    @field_serializer("order")
+    def serialize_order(self, value):
+        if isinstance(value, str):
+            try:
+                return models.GetOptionTradesOrder(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "timestamp",
+                "timestampFrom",
+                "timestampAfter",
+                "timestampTo",
+                "timestampBefore",
+                "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 GetOptionTradesResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    option_trades_response: NotRequired[OptionTradesResponseTypedDict]
+    r"""Successful response"""
+
+
+class GetOptionTradesResponse(BaseModel):
+    next: Callable[[], Optional[GetOptionTradesResponse]]
+
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    option_trades_response: Optional[OptionTradesResponse] = None
+    r"""Successful response"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OptionTradesResponse"])
+        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/getordersv2response.py

@@ -0,0 +1,66 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 614b8bb929c3
+
+from __future__ import annotations
+from .tradeorderv2 import TradeOrderV2, TradeOrderV2TypedDict
+from finance_dev.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+import pydantic
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetOrdersV2ResponseTypedDict(TypedDict):
+    r"""Paginated v2 orders response from **GET /v2/accounts/{id}/orders** and **GET /v2/accounts/{id}/orders/history**. Both fields are always present."""
+
+    next_cursor: NotRequired[int]
+    r"""Opaque pagination cursor. Pass as `cursor` on the next request. Value `0` means the walk is exhausted."""
+    orders: NotRequired[Nullable[List[TradeOrderV2TypedDict]]]
+    r"""Page of orders in v2 domain shape (`TradeOrderV2`). `null` from **GET /v2/accounts/{id}/orders** when the account has no active orders; an empty array from the history endpoint when there are no matches."""
+
+
+class GetOrdersV2Response(BaseModel):
+    r"""Paginated v2 orders response from **GET /v2/accounts/{id}/orders** and **GET /v2/accounts/{id}/orders/history**. Both fields are always present."""
+
+    next_cursor: Annotated[Optional[int], pydantic.Field(alias="nextCursor")] = None
+    r"""Opaque pagination cursor. Pass as `cursor` on the next request. Value `0` means the walk is exhausted."""
+
+    orders: OptionalNullable[List[TradeOrderV2]] = UNSET
+    r"""Page of orders in v2 domain shape (`TradeOrderV2`). `null` from **GET /v2/accounts/{id}/orders** when the account has no active orders; an empty array from the history endpoint when there are no matches."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["nextCursor", "orders"])
+        nullable_fields = set(["orders"])
+        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))
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m
+
+
+try:
+    GetOrdersV2Response.model_rebuild()
+except NameError:
+    pass

finance_dev/models/getownershipdataop.py

@@ -0,0 +1,77 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 301f62c130c7
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .ownershipdataresponse import OwnershipDataResponse, OwnershipDataResponseTypedDict
+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 GetOwnershipDataRequestTypedDict(TypedDict):
+    symbol: str
+    r"""Stock symbol, such as AAPL. Use it to narrow results to one company."""
+    limit: NotRequired[int]
+    r"""Optional maximum number of results to return. Use it to keep ownership lists small for UI views."""
+
+
+class GetOwnershipDataRequest(BaseModel):
+    symbol: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Stock symbol, such as AAPL. Use it to narrow results to one company."""
+
+    limit: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Optional maximum number of results to return. Use it to keep ownership lists small for UI views."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["limit"])
+        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 GetOwnershipDataResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    ownership_data_response: NotRequired[OwnershipDataResponseTypedDict]
+    r"""Ownership data."""
+
+
+class GetOwnershipDataResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    ownership_data_response: Optional[OwnershipDataResponse] = None
+    r"""Ownership data."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OwnershipDataResponse"])
+        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/getpositionsresponse.py

@@ -0,0 +1,39 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: b5f1e028ea4d
+
+from __future__ import annotations
+from .accountposition import AccountPosition, AccountPositionTypedDict
+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 GetPositionsResponseTypedDict(TypedDict):
+    r"""Response for GET /v1/accounts/{id}/positions. Cached positions for the account. Numeric amounts are returned as decimal strings."""
+
+    positions: NotRequired[List[AccountPositionTypedDict]]
+    r"""Open positions for the account"""
+
+
+class GetPositionsResponse(BaseModel):
+    r"""Response for GET /v1/accounts/{id}/positions. Cached positions for the account. Numeric amounts are returned as decimal strings."""
+
+    positions: Optional[List[AccountPosition]] = None
+    r"""Open positions for the account"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["positions"])
+        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/getpredictionorderop.py

@@ -0,0 +1,88 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: fad97694db27
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .predordersorderdetail import PredOrdersOrderDetail, PredOrdersOrderDetailTypedDict
+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 GetPredictionOrderRequestTypedDict(TypedDict):
+    order_id: str
+    r"""`orderId` returned by Place Prediction Order or List Prediction Orders."""
+
+
+class GetPredictionOrderRequest(BaseModel):
+    order_id: Annotated[
+        str,
+        pydantic.Field(alias="orderId"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""`orderId` returned by Place Prediction Order or List Prediction Orders."""
+
+
+class GetPredictionOrderResponseBodyTypedDict(TypedDict):
+    r"""Standard success envelope used by all success responses. `data` is endpoint-specific."""
+
+    success: bool
+    data: NotRequired[PredOrdersOrderDetailTypedDict]
+    r"""An order and every venue report against it, read from one snapshot."""
+
+
+class GetPredictionOrderResponseBody(BaseModel):
+    r"""Standard success envelope used by all success responses. `data` is endpoint-specific."""
+
+    success: bool
+
+    data: Optional[PredOrdersOrderDetail] = None
+    r"""An order and every venue report against it, read from one snapshot."""
+
+    @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
+
+
+class GetPredictionOrderResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    object: NotRequired[GetPredictionOrderResponseBodyTypedDict]
+    r"""The order and its reports."""
+
+
+class GetPredictionOrderResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    object: Optional[GetPredictionOrderResponseBody] = None
+    r"""The order and its reports."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["object"])
+        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/getpricetargetop.py

@@ -0,0 +1,53 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 4d907d562cff
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .pricetargetresponse import PriceTargetResponse, PriceTargetResponseTypedDict
+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 GetPriceTargetRequestTypedDict(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`."""
+
+
+class GetPriceTargetRequest(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`."""
+
+
+class GetPriceTargetResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    price_target_response: NotRequired[PriceTargetResponseTypedDict]
+    r"""Analyst price targets."""
+
+
+class GetPriceTargetResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    price_target_response: Optional[PriceTargetResponse] = None
+    r"""Analyst price targets."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["PriceTargetResponse"])
+        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/getquotesop.py

@@ -0,0 +1,53 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 96e67977078d
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .quotesresponse import QuotesResponse, QuotesResponseTypedDict
+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 GetQuotesRequestTypedDict(TypedDict):
+    symbols: str
+    r"""Comma-separated symbols to quote, such as `AAPL,MSFT`. Use one symbol for a quote tile or multiple symbols for watchlists and dashboards."""
+
+
+class GetQuotesRequest(BaseModel):
+    symbols: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Comma-separated symbols to quote, such as `AAPL,MSFT`. Use one symbol for a quote tile or multiple symbols for watchlists and dashboards."""
+
+
+class GetQuotesResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    quotes_response: NotRequired[QuotesResponseTypedDict]
+    r"""Quotes retrieved successfully"""
+
+
+class GetQuotesResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    quotes_response: Optional[QuotesResponse] = None
+    r"""Quotes retrieved successfully"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["QuotesResponse"])
+        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