finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/listindicesop.py

@@ -0,0 +1,91 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 8a1cf91408e2
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .indexlistresponse import IndexListResponse, IndexListResponseTypedDict
+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 Callable, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ListIndicesRequestTypedDict(TypedDict):
+    index_group: str
+    r"""Index group whose members you want to list (paginated). Use [GET /v1/indices/groups](/api-reference/supplemental/indices-groups) to discover the live list of groups — see `IndexGroup` for the current published set with plain-English labels."""
+    page_size: NotRequired[int]
+    r"""Number of results per page. Use this to control pagination size in list views. (default: 100, max: 1000)"""
+    next_page: NotRequired[str]
+    r"""Pagination token for the next page. Omit it on the first request, then send the returned token to continue paging."""
+
+
+class ListIndicesRequest(BaseModel):
+    index_group: Annotated[
+        str,
+        pydantic.Field(alias="indexGroup"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""Index group whose members you want to list (paginated). Use [GET /v1/indices/groups](/api-reference/supplemental/indices-groups) to discover the live list of groups — see `IndexGroup` for the current published set with plain-English labels."""
+
+    page_size: Annotated[
+        Optional[int],
+        pydantic.Field(alias="pageSize"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Number of results per page. Use this to control pagination size in list views. (default: 100, max: 1000)"""
+
+    next_page: Annotated[
+        Optional[str],
+        pydantic.Field(alias="nextPage"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Pagination token for the next page. Omit it on the first request, then send the returned token to continue paging."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["pageSize", "nextPage"])
+        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 ListIndicesResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    index_list_response: NotRequired[IndexListResponseTypedDict]
+    r"""Successful response with list of indices"""
+
+
+class ListIndicesResponse(BaseModel):
+    next: Callable[[], Optional[ListIndicesResponse]]
+
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    index_list_response: Optional[IndexListResponse] = None
+    r"""Successful response with list of indices"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["IndexListResponse"])
+        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/listoptioncontractsop.py

@@ -0,0 +1,66 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 030f239a66ae
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .optioncontractsresponse import (
+    OptionContractsResponse,
+    OptionContractsResponseTypedDict,
+)
+from datetime import date
+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 ListOptionContractsRequestTypedDict(TypedDict):
+    symbol: str
+    r"""The underlying stock symbol (e.g., AAPL, TSLA, SPY)"""
+    expiry_date: date
+    r"""The expiration date in YYYY-MM-DD format"""
+
+
+class ListOptionContractsRequest(BaseModel):
+    symbol: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""The underlying stock symbol (e.g., AAPL, TSLA, SPY)"""
+
+    expiry_date: Annotated[
+        date,
+        pydantic.Field(alias="expiryDate"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The expiration date in YYYY-MM-DD format"""
+
+
+class ListOptionContractsResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    option_contracts_response: NotRequired[OptionContractsResponseTypedDict]
+    r"""Successful response. Returns symbol, expiryDate, and separate calls and puts arrays; each item has symbol (OCC ticker) and strikePrice."""
+
+
+class ListOptionContractsResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    option_contracts_response: Optional[OptionContractsResponse] = None
+    r"""Successful response. Returns symbol, expiryDate, and separate calls and puts arrays; each item has symbol (OCC ticker) and strikePrice."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OptionContractsResponse"])
+        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/listoptionexpirydatesop.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: c0f060f31145
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .optionexpirydatesresponse import (
+    OptionExpiryDatesResponse,
+    OptionExpiryDatesResponseTypedDict,
+)
+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 ListOptionExpiryDatesRequestTypedDict(TypedDict):
+    symbol: str
+    r"""The underlying stock symbol (e.g., AAPL, TSLA, SPY)"""
+
+
+class ListOptionExpiryDatesRequest(BaseModel):
+    symbol: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""The underlying stock symbol (e.g., AAPL, TSLA, SPY)"""
+
+
+class ListOptionExpiryDatesResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    option_expiry_dates_response: NotRequired[OptionExpiryDatesResponseTypedDict]
+    r"""Successful response. Returns symbol and list of expiry dates in YYYY-MM-DD format."""
+
+
+class ListOptionExpiryDatesResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    option_expiry_dates_response: Optional[OptionExpiryDatesResponse] = None
+    r"""Successful response. Returns symbol and list of expiry dates in YYYY-MM-DD format."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OptionExpiryDatesResponse"])
+        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/listorderhistoryop.py

@@ -0,0 +1,139 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: a97d55fa8217
+
+from __future__ import annotations
+from .getordersv2response import GetOrdersV2Response, GetOrdersV2ResponseTypedDict
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from datetime import datetime
+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 OrderBy(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Sort direction by `order_created_at`. Defaults to `desc` (newest first). Use `asc` for chronological exports."""
+
+    ASC = "asc"
+    DESC = "desc"
+
+
+class ListOrderHistoryRequestTypedDict(TypedDict):
+    id: str
+    r"""Account ID whose historical orders you want to read."""
+    from_: datetime
+    r"""Start of the history window, inclusive. Enter an RFC 3339 timestamp with timezone, for example `2026-04-01T00:00:00Z`."""
+    to: NotRequired[datetime]
+    r"""End of the history window, inclusive. Omit it to use the current time. The total range from `from` cannot exceed 90 days."""
+    order_by: NotRequired[OrderBy]
+    r"""Sort direction by `order_created_at`. Defaults to `desc` (newest first). Use `asc` for chronological exports."""
+    exclude_today: NotRequired[bool]
+    r"""Set to `true` when you want historical orders only and do not want today's activity duplicated with the active-orders endpoint."""
+    limit: NotRequired[int]
+    r"""Maximum number of historical orders to return in this page. Default is 50; maximum is 500."""
+    cursor: NotRequired[int]
+    r"""Opaque pagination cursor for the database history walk. Send `0` (or omit) for the first page; pass the previous `nextCursor` until it returns `0`."""
+
+
+class ListOrderHistoryRequest(BaseModel):
+    id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""Account ID whose historical orders you want to read."""
+
+    from_: Annotated[
+        datetime,
+        pydantic.Field(alias="from"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""Start of the history window, inclusive. Enter an RFC 3339 timestamp with timezone, for example `2026-04-01T00:00:00Z`."""
+
+    to: Annotated[
+        Optional[datetime],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""End of the history window, inclusive. Omit it to use the current time. The total range from `from` cannot exceed 90 days."""
+
+    order_by: Annotated[
+        Optional[OrderBy],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = OrderBy.DESC
+    r"""Sort direction by `order_created_at`. Defaults to `desc` (newest first). Use `asc` for chronological exports."""
+
+    exclude_today: Annotated[
+        Optional[bool],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = False
+    r"""Set to `true` when you want historical orders only and do not want today's activity duplicated with the active-orders endpoint."""
+
+    limit: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 50
+    r"""Maximum number of historical orders to return in this page. Default is 50; maximum is 500."""
+
+    cursor: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 0
+    r"""Opaque pagination cursor for the database history walk. Send `0` (or omit) for the first page; pass the previous `nextCursor` until it returns `0`."""
+
+    @field_serializer("order_by")
+    def serialize_order_by(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OrderBy(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["to", "order_by", "exclude_today", "limit", "cursor"])
+        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 ListOrderHistoryResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    get_orders_v2_response: NotRequired[GetOrdersV2ResponseTypedDict]
+    r"""Page of historical orders"""
+
+
+class ListOrderHistoryResponse(BaseModel):
+    next: Callable[[], Optional[ListOrderHistoryResponse]]
+
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    get_orders_v2_response: Optional[GetOrdersV2Response] = None
+    r"""Page of historical orders"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["GetOrdersV2Response"])
+        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/listpredictionordersop.py

@@ -0,0 +1,134 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 13a9dfb5e973
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .predordersorderpage import PredOrdersOrderPage, PredOrdersOrderPageTypedDict
+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 ListPredictionOrdersRequestTypedDict(TypedDict):
+    status: NotRequired[str]
+    r"""Comma-separated order states, or `open` for every state an order can still rest or execute in (`pending_new`, `new`, `partially_filled`, `unknown`). An unknown state returns `400`."""
+    account_id: NotRequired[str]
+    r"""Only orders on this account."""
+    symbol: NotRequired[str]
+    r"""Only orders on this contract symbol."""
+    limit: NotRequired[int]
+    r"""Orders per page. Values above 200 are clamped to 200. `0`, a negative value, or a non-integer returns `400`."""
+    cursor: NotRequired[str]
+    r"""`nextCursor` from the previous page."""
+
+
+class ListPredictionOrdersRequest(BaseModel):
+    status: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated order states, or `open` for every state an order can still rest or execute in (`pending_new`, `new`, `partially_filled`, `unknown`). An unknown state returns `400`."""
+
+    account_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="accountId"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Only orders on this account."""
+
+    symbol: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Only orders on this contract symbol."""
+
+    limit: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 50
+    r"""Orders per page. Values above 200 are clamped to 200. `0`, a negative value, or a non-integer returns `400`."""
+
+    cursor: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""`nextCursor` from the previous page."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["status", "accountId", "symbol", "limit", "cursor"])
+        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 ListPredictionOrdersResponseBodyTypedDict(TypedDict):
+    r"""Standard success envelope used by all success responses. `data` is endpoint-specific."""
+
+    success: bool
+    data: NotRequired[PredOrdersOrderPageTypedDict]
+
+
+class ListPredictionOrdersResponseBody(BaseModel):
+    r"""Standard success envelope used by all success responses. `data` is endpoint-specific."""
+
+    success: bool
+
+    data: Optional[PredOrdersOrderPage] = None
+
+    @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 ListPredictionOrdersResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    object: NotRequired[ListPredictionOrdersResponseBodyTypedDict]
+    r"""One page of orders."""
+
+
+class ListPredictionOrdersResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    object: Optional[ListPredictionOrdersResponseBody] = None
+    r"""One page of orders."""
+
+    @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/listtranscriptsop.py

@@ -0,0 +1,53 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 83b1e849f10f
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .transcriptsresponse import TranscriptsResponse, TranscriptsResponseTypedDict
+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 ListTranscriptsRequestTypedDict(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`."""
+
+
+class ListTranscriptsRequest(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`."""
+
+
+class ListTranscriptsResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    transcripts_response: NotRequired[TranscriptsResponseTypedDict]
+    r"""List of transcripts."""
+
+
+class ListTranscriptsResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    transcripts_response: Optional[TranscriptsResponse] = None
+    r"""List of transcripts."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["TranscriptsResponse"])
+        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