finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/getoptionquotesop.py

@@ -0,0 +1,177 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 116de7212277
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .optionquotesresponse import OptionQuotesResponse, OptionQuotesResponseTypedDict
+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 GetOptionQuotesOrder(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 GetOptionQuotesRequestTypedDict(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[GetOptionQuotesOrder]
+    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 GetOptionQuotesRequest(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[GetOptionQuotesOrder],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = GetOptionQuotesOrder.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.GetOptionQuotesOrder(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 GetOptionQuotesResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    option_quotes_response: NotRequired[OptionQuotesResponseTypedDict]
+    r"""Successful response"""
+
+
+class GetOptionQuotesResponse(BaseModel):
+    next: Callable[[], Optional[GetOptionQuotesResponse]]
+
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    option_quotes_response: Optional[OptionQuotesResponse] = None
+    r"""Successful response"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OptionQuotesResponse"])
+        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/getoptionsactivityop.py

@@ -0,0 +1,111 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 183e251a791b
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .optionsactivityresponse import (
+    OptionsActivityResponse,
+    OptionsActivityResponseTypedDict,
+)
+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 Callable, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetOptionsActivityRequestTypedDict(TypedDict):
+    date_from: NotRequired[date]
+    r"""Start date for filtering options activity in YYYY-MM-DD format"""
+    date_to: NotRequired[date]
+    r"""End date for filtering options activity in YYYY-MM-DD format"""
+    tickers: NotRequired[str]
+    r"""Comma-separated list of ticker symbols to filter results"""
+    page: NotRequired[int]
+    r"""Page number for pagination (zero-based)"""
+    page_size: NotRequired[int]
+    r"""Number of results per page. Use this to control pagination size in list views. (default: 100, max: 1000)"""
+
+
+class GetOptionsActivityRequest(BaseModel):
+    date_from: Annotated[
+        Optional[date],
+        pydantic.Field(alias="dateFrom"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Start date for filtering options activity in YYYY-MM-DD format"""
+
+    date_to: Annotated[
+        Optional[date],
+        pydantic.Field(alias="dateTo"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""End date for filtering options activity in YYYY-MM-DD format"""
+
+    tickers: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated list of ticker symbols to filter results"""
+
+    page: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Page number for pagination (zero-based)"""
+
+    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)"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["dateFrom", "dateTo", "tickers", "page", "pageSize"])
+        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 GetOptionsActivityResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    options_activity_response: NotRequired[OptionsActivityResponseTypedDict]
+    r"""Successful response"""
+
+
+class GetOptionsActivityResponse(BaseModel):
+    next: Callable[[], Optional[GetOptionsActivityResponse]]
+
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    options_activity_response: Optional[OptionsActivityResponse] = None
+    r"""Successful response"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OptionsActivityResponse"])
+        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/getoptionsetfstopvolumeop.py

@@ -0,0 +1,70 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 81543fb41a93
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .optionsscreeneritem import OptionsScreenerItem, OptionsScreenerItemTypedDict
+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 List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetOptionsETFsTopVolumeRequestTypedDict(TypedDict):
+    size: NotRequired[int]
+    r"""Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits. (optional, default 10)"""
+
+
+class GetOptionsETFsTopVolumeRequest(BaseModel):
+    size: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 10
+    r"""Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits. (optional, default 10)"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["size"])
+        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 GetOptionsETFsTopVolumeResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    options_screener_items: NotRequired[List[OptionsScreenerItemTypedDict]]
+    r"""Array of option contract details (symbol, underlyingSymbol, type, strike, expiry, volume, openInterest, lastPrice, change, changePercent, bid, ask, impliedVolatility, logoUrl)."""
+
+
+class GetOptionsETFsTopVolumeResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    options_screener_items: Optional[List[OptionsScreenerItem]] = None
+    r"""Array of option contract details (symbol, underlyingSymbol, type, strike, expiry, volume, openInterest, lastPrice, change, changePercent, bid, ask, impliedVolatility, logoUrl)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OptionsScreenerItems"])
+        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/getoptionsstockstopgainersop.py

@@ -0,0 +1,70 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 0b884e563562
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .optionsscreeneritem import OptionsScreenerItem, OptionsScreenerItemTypedDict
+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 List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetOptionsStocksTopGainersRequestTypedDict(TypedDict):
+    size: NotRequired[int]
+    r"""Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits. (optional, default 10)"""
+
+
+class GetOptionsStocksTopGainersRequest(BaseModel):
+    size: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 10
+    r"""Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits. (optional, default 10)"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["size"])
+        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 GetOptionsStocksTopGainersResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    options_screener_items: NotRequired[List[OptionsScreenerItemTypedDict]]
+    r"""Array of option contract details (symbol, underlyingSymbol, type, strike, expiry, volume, openInterest, lastPrice, change, changePercent, bid, ask, impliedVolatility, logoUrl)."""
+
+
+class GetOptionsStocksTopGainersResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    options_screener_items: Optional[List[OptionsScreenerItem]] = None
+    r"""Array of option contract details (symbol, underlyingSymbol, type, strike, expiry, volume, openInterest, lastPrice, change, changePercent, bid, ask, impliedVolatility, logoUrl)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OptionsScreenerItems"])
+        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/getoptionsstockstopvolumeop.py

@@ -0,0 +1,70 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 576cf5729029
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .optionsscreeneritem import OptionsScreenerItem, OptionsScreenerItemTypedDict
+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 List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetOptionsStocksTopVolumeRequestTypedDict(TypedDict):
+    size: NotRequired[int]
+    r"""Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits. (optional, default 10)"""
+
+
+class GetOptionsStocksTopVolumeRequest(BaseModel):
+    size: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 10
+    r"""Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits. (optional, default 10)"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["size"])
+        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 GetOptionsStocksTopVolumeResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    options_screener_items: NotRequired[List[OptionsScreenerItemTypedDict]]
+    r"""Array of option contract details (symbol, underlyingSymbol, type, strike, expiry, volume, openInterest, lastPrice, change, changePercent, bid, ask, impliedVolatility, logoUrl)."""
+
+
+class GetOptionsStocksTopVolumeResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    options_screener_items: Optional[List[OptionsScreenerItem]] = None
+    r"""Array of option contract details (symbol, underlyingSymbol, type, strike, expiry, volume, openInterest, lastPrice, change, changePercent, bid, ask, impliedVolatility, logoUrl)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OptionsScreenerItems"])
+        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/getoptionsunusualactivityop.py

@@ -0,0 +1,100 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: f6466f8c9dd1
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .optionsunusualactivityresponse import (
+    OptionsUnusualActivityResponse,
+    OptionsUnusualActivityResponseTypedDict,
+)
+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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class Source(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Data source. Values are case-insensitive."""
+
+    REALTIME = "realtime"
+    DELAYED = "delayed"
+
+
+class GetOptionsUnusualActivityRequestTypedDict(TypedDict):
+    symbol: str
+    r"""Underlying stock symbol (e.g. AAPL, TSLA)."""
+    source: NotRequired[Source]
+    r"""Data source. Values are case-insensitive."""
+
+
+class GetOptionsUnusualActivityRequest(BaseModel):
+    symbol: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""Underlying stock symbol (e.g. AAPL, TSLA)."""
+
+    source: Annotated[
+        Optional[Source],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = Source.DELAYED
+    r"""Data source. Values are case-insensitive."""
+
+    @field_serializer("source")
+    def serialize_source(self, value):
+        if isinstance(value, str):
+            try:
+                return models.Source(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["source"])
+        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 GetOptionsUnusualActivityResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    options_unusual_activity_response: NotRequired[
+        OptionsUnusualActivityResponseTypedDict
+    ]
+    r"""Options unusual activity: object with trades array. Each trade has symbol, timestamp, type (e.g. block), total_value, total_size, average_price, contract, ask_at_execution, bid_at_execution, sentiment, underlying_price_at_execution."""
+
+
+class GetOptionsUnusualActivityResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    options_unusual_activity_response: Optional[OptionsUnusualActivityResponse] = None
+    r"""Options unusual activity: object with trades array. Each trade has symbol, timestamp, type (e.g. block), total_value, total_size, average_price, contract, ask_at_execution, bid_at_execution, sentiment, underlying_price_at_execution."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["OptionsUnusualActivityResponse"])
+        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