finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/getsymbolinfoop.py

@@ -0,0 +1,53 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 5073b17c4720
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .symbolinfo import SymbolInfo, SymbolInfoTypedDict
+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 GetSymbolInfoRequestTypedDict(TypedDict):
+    symbol: str
+    r"""Symbol to resolve for charting. Use equities like `AAPL` or futures with a leading slash such as `/ES`. Prefer values returned by chart search."""
+
+
+class GetSymbolInfoRequest(BaseModel):
+    symbol: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Symbol to resolve for charting. Use equities like `AAPL` or futures with a leading slash such as `/ES`. Prefer values returned by chart search."""
+
+
+class GetSymbolInfoResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    symbol_info: NotRequired[SymbolInfoTypedDict]
+    r"""Symbol information retrieved successfully"""
+
+
+class GetSymbolInfoResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    symbol_info: Optional[SymbolInfo] = None
+    r"""Symbol information retrieved successfully"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["SymbolInfo"])
+        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/gettechnicalindicatorop.py

@@ -0,0 +1,172 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: cce3ec35a331
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .technicalindicatorresponse import (
+    TechnicalIndicatorResponse,
+    TechnicalIndicatorResponseTypedDict,
+)
+from .technicalindicatortype import TechnicalIndicatorType
+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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetTechnicalIndicatorResolution(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""How long each bar covers. Supported values are minutes (`1`, `5`, `15`, `30`, `60`) or daily/weekly/monthly (`D`, `W`, `M`). Other values return 400 Bad Request with error code `VALIDATION_ERROR`."""
+
+    ONE = "1"
+    FIVE = "5"
+    FIFTEEN = "15"
+    THIRTY = "30"
+    SIXTY = "60"
+    D = "D"
+    W = "W"
+    M = "M"
+
+
+class GetTechnicalIndicatorRequestTypedDict(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`."""
+    resolution: GetTechnicalIndicatorResolution
+    r"""How long each bar covers. Supported values are minutes (`1`, `5`, `15`, `30`, `60`) or daily/weekly/monthly (`D`, `W`, `M`). Other values return 400 Bad Request with error code `VALIDATION_ERROR`."""
+    indicator: TechnicalIndicatorType
+    r"""Which technical indicator to compute. Common picks: `sma` (simple moving average), `ema` (exponential moving average), `rsi` (relative strength index), `macd` (moving-average convergence-divergence), `bbands` (Bollinger Bands). See `TechnicalIndicatorType` for the full list of supported slugs."""
+    from_: int
+    r"""Start timestamp (Unix seconds)"""
+    to: int
+    r"""End timestamp (Unix seconds)"""
+    timeperiod: NotRequired[int]
+    r"""(Optional) Period for SMA/RSI/BBANDS"""
+    fast_period: NotRequired[int]
+    r"""MACD fast EMA length, in bars. The shorter of the two moving averages used to compute MACD. Standard value is 12. Only used when `indicator=macd`."""
+    slow_period: NotRequired[int]
+    r"""MACD slow EMA length, in bars. The longer of the two moving averages used to compute MACD. Standard value is 26. Only used when `indicator=macd`."""
+    signal_period: NotRequired[int]
+    r"""MACD signal EMA length, in bars. Used to smooth the MACD line into the signal line; crossovers between the two are the basic MACD trading cue. Standard value is 9. Only used when `indicator=macd`."""
+
+
+class GetTechnicalIndicatorRequest(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`."""
+
+    resolution: Annotated[
+        GetTechnicalIndicatorResolution,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""How long each bar covers. Supported values are minutes (`1`, `5`, `15`, `30`, `60`) or daily/weekly/monthly (`D`, `W`, `M`). Other values return 400 Bad Request with error code `VALIDATION_ERROR`."""
+
+    indicator: Annotated[
+        TechnicalIndicatorType,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""Which technical indicator to compute. Common picks: `sma` (simple moving average), `ema` (exponential moving average), `rsi` (relative strength index), `macd` (moving-average convergence-divergence), `bbands` (Bollinger Bands). See `TechnicalIndicatorType` for the full list of supported slugs."""
+
+    from_: Annotated[
+        int,
+        pydantic.Field(alias="from"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""Start timestamp (Unix seconds)"""
+
+    to: Annotated[
+        int, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""End timestamp (Unix seconds)"""
+
+    timeperiod: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""(Optional) Period for SMA/RSI/BBANDS"""
+
+    fast_period: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""MACD fast EMA length, in bars. The shorter of the two moving averages used to compute MACD. Standard value is 12. Only used when `indicator=macd`."""
+
+    slow_period: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""MACD slow EMA length, in bars. The longer of the two moving averages used to compute MACD. Standard value is 26. Only used when `indicator=macd`."""
+
+    signal_period: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""MACD signal EMA length, in bars. Used to smooth the MACD line into the signal line; crossovers between the two are the basic MACD trading cue. Standard value is 9. Only used when `indicator=macd`."""
+
+    @field_serializer("resolution")
+    def serialize_resolution(self, value):
+        if isinstance(value, str):
+            try:
+                return models.GetTechnicalIndicatorResolution(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("indicator")
+    def serialize_indicator(self, value):
+        if isinstance(value, str):
+            try:
+                return models.TechnicalIndicatorType(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            ["timeperiod", "fast_period", "slow_period", "signal_period"]
+        )
+        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 GetTechnicalIndicatorResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    technical_indicator_response: NotRequired[TechnicalIndicatorResponseTypedDict]
+    r"""Successful response"""
+
+
+class GetTechnicalIndicatorResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    technical_indicator_response: Optional[TechnicalIndicatorResponse] = None
+    r"""Successful response"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["TechnicalIndicatorResponse"])
+        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/gettechnicalpatternsop.py

@@ -0,0 +1,88 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 40a5227e7fa9
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .technicalpatternsresponse import (
+    TechnicalPatternsResponse,
+    TechnicalPatternsResponseTypedDict,
+)
+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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetTechnicalPatternsResolution(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""How long each bar covers. Supported values are minutes (`1`, `5`, `15`, `30`, `60`) or daily/weekly/monthly (`D`, `W`, `M`). Other values return 400 Bad Request with error code `VALIDATION_ERROR`."""
+
+    ONE = "1"
+    FIVE = "5"
+    FIFTEEN = "15"
+    THIRTY = "30"
+    SIXTY = "60"
+    D = "D"
+    W = "W"
+    M = "M"
+
+
+class GetTechnicalPatternsRequestTypedDict(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`."""
+    resolution: GetTechnicalPatternsResolution
+    r"""How long each bar covers. Supported values are minutes (`1`, `5`, `15`, `30`, `60`) or daily/weekly/monthly (`D`, `W`, `M`). Other values return 400 Bad Request with error code `VALIDATION_ERROR`."""
+
+
+class GetTechnicalPatternsRequest(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`."""
+
+    resolution: Annotated[
+        GetTechnicalPatternsResolution,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""How long each bar covers. Supported values are minutes (`1`, `5`, `15`, `30`, `60`) or daily/weekly/monthly (`D`, `W`, `M`). Other values return 400 Bad Request with error code `VALIDATION_ERROR`."""
+
+    @field_serializer("resolution")
+    def serialize_resolution(self, value):
+        if isinstance(value, str):
+            try:
+                return models.GetTechnicalPatternsResolution(value)
+            except ValueError:
+                return value
+        return value
+
+
+class GetTechnicalPatternsResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    technical_patterns_response: NotRequired[TechnicalPatternsResponseTypedDict]
+    r"""Successful response"""
+
+
+class GetTechnicalPatternsResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    technical_patterns_response: Optional[TechnicalPatternsResponse] = None
+    r"""Successful response"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["TechnicalPatternsResponse"])
+        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/gettenderoffersop.py

@@ -0,0 +1,112 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: e1503f43936d
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .tenderofferidentifiertype import TenderOfferIdentifierType
+from .tenderoffersresponse import TenderOffersResponse, TenderOffersResponseTypedDict
+from datetime import date
+from finance_dev import models
+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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetTenderOffersRequestTypedDict(TypedDict):
+    identifier: str
+    r"""Identifier value for the company you're querying. The format depends on `identifierType`:
+    - `Symbol` — exchange ticker (e.g. `AAPL`).
+    - `CUSIP` — 9-character U.S./Canadian identifier (e.g. `037833100`).
+    - `ISIN` — 12-character international identifier (e.g. `US0378331005`).
+    - `SEDOL` — 7-character UK identifier.
+    - `Valoren` — Swiss security identifier.
+    - `FIGI` — Bloomberg Financial Instrument Global Identifier.
+    - `CompositeFIGI` — country-level composite FIGI.
+
+    Must match the kind selected in `identifierType`.
+    """
+    identifier_type: TenderOfferIdentifierType
+    r"""Tells the API how to interpret `identifier`. See `TenderOfferIdentifierType` for the full set of supported values and what each one means."""
+    start_date: date
+    r"""Start of the tender-offer announcement window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-01-01`)."""
+    end_date: date
+    r"""End of the tender-offer announcement window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-12-31`)."""
+
+
+class GetTenderOffersRequest(BaseModel):
+    identifier: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Identifier value for the company you're querying. The format depends on `identifierType`:
+    - `Symbol` — exchange ticker (e.g. `AAPL`).
+    - `CUSIP` — 9-character U.S./Canadian identifier (e.g. `037833100`).
+    - `ISIN` — 12-character international identifier (e.g. `US0378331005`).
+    - `SEDOL` — 7-character UK identifier.
+    - `Valoren` — Swiss security identifier.
+    - `FIGI` — Bloomberg Financial Instrument Global Identifier.
+    - `CompositeFIGI` — country-level composite FIGI.
+
+    Must match the kind selected in `identifierType`.
+    """
+
+    identifier_type: Annotated[
+        TenderOfferIdentifierType,
+        pydantic.Field(alias="identifierType"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""Tells the API how to interpret `identifier`. See `TenderOfferIdentifierType` for the full set of supported values and what each one means."""
+
+    start_date: Annotated[
+        date,
+        pydantic.Field(alias="startDate"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""Start of the tender-offer announcement window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-01-01`)."""
+
+    end_date: Annotated[
+        date,
+        pydantic.Field(alias="endDate"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""End of the tender-offer announcement window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-12-31`)."""
+
+    @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
+
+
+class GetTenderOffersResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    tender_offers_response: NotRequired[TenderOffersResponseTypedDict]
+    r"""Tender offers data."""
+
+
+class GetTenderOffersResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    tender_offers_response: Optional[TenderOffersResponse] = None
+    r"""Tender offers data."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["TenderOffersResponse"])
+        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/gettickhistoryop.py

@@ -0,0 +1,104 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: bf0c140979e0
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .tickchartbars import TickChartBars, TickChartBarsTypedDict
+from .tickresolution import TickResolution
+from finance_dev import models
+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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetTickHistoryRequestTypedDict(TypedDict):
+    symbol: str
+    r"""Symbol to fetch tick bars for. Use the exact symbol returned by symbol search, such as `AAPL` for equities."""
+    resolution: TickResolution
+    r"""Tick bar size: the number of trades that make up one bar."""
+    countback: NotRequired[int]
+    r"""How many bars to return, counting back from the most recent bar (or from `cursor`, if provided). Defaults to 300 when omitted. The maximum depends on `resolution`: each call is bounded by a fixed per-request trade budget, so low-count ticks (e.g. `1T`) can return up to 5000 bars, while high-count ticks (e.g. `1000T`) may cap out around 50. Requests above the resolution's maximum are silently reduced to it — this is normal, not an error. Use the `cursor` field to keep loading further back until you have as much history as you need."""
+    cursor: NotRequired[str]
+    r"""Pagination token for loading OLDER bars, used when a user scrolls a chart backward in time. Omit this parameter for the initial chart load, which returns the most recent bars. To load the page before that, pass the `nextTo` value from the previous response as `cursor`. Treat this value as opaque — always pass it back exactly as received; do not attempt to construct, decode, or modify it."""
+
+
+class GetTickHistoryRequest(BaseModel):
+    symbol: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Symbol to fetch tick bars for. Use the exact symbol returned by symbol search, such as `AAPL` for equities."""
+
+    resolution: Annotated[
+        TickResolution,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""Tick bar size: the number of trades that make up one bar."""
+
+    countback: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 300
+    r"""How many bars to return, counting back from the most recent bar (or from `cursor`, if provided). Defaults to 300 when omitted. The maximum depends on `resolution`: each call is bounded by a fixed per-request trade budget, so low-count ticks (e.g. `1T`) can return up to 5000 bars, while high-count ticks (e.g. `1000T`) may cap out around 50. Requests above the resolution's maximum are silently reduced to it — this is normal, not an error. Use the `cursor` field to keep loading further back until you have as much history as you need."""
+
+    cursor: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Pagination token for loading OLDER bars, used when a user scrolls a chart backward in time. Omit this parameter for the initial chart load, which returns the most recent bars. To load the page before that, pass the `nextTo` value from the previous response as `cursor`. Treat this value as opaque — always pass it back exactly as received; do not attempt to construct, decode, or modify it."""
+
+    @field_serializer("resolution")
+    def serialize_resolution(self, value):
+        if isinstance(value, str):
+            try:
+                return models.TickResolution(value)
+            except ValueError:
+                return value
+        return value
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["countback", "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 GetTickHistoryResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    tick_chart_bars: NotRequired[TickChartBarsTypedDict]
+    r"""Tick bars in TradingView UDF format, extended with a pagination cursor. Always returns 200; check **s** (status): `ok` = data in t, o, h, l, c, v (and usually `nextTo`); `no_data` = no matching trade activity, and `nextTo` will be absent — stop requesting further history; `error` = errmsg contains reason (e.g. invalid resolution or malformed cursor)."""
+
+
+class GetTickHistoryResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    tick_chart_bars: Optional[TickChartBars] = None
+    r"""Tick bars in TradingView UDF format, extended with a pagination cursor. Always returns 200; check **s** (status): `ok` = data in t, o, h, l, c, v (and usually `nextTo`); `no_data` = no matching trade activity, and `nextTo` will be absent — stop requesting further history; `error` = errmsg contains reason (e.g. invalid resolution or malformed cursor)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["TickChartBars"])
+        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/gettopgainersop.py

@@ -0,0 +1,78 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 288a74785eef
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .symboldetails import SymbolDetails, SymbolDetailsTypedDict
+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 GetTopGainersRequestTypedDict(TypedDict):
+    limit: 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)"""
+    size: NotRequired[int]
+    r"""Alias for limit. Ignored when limit is supplied."""
+
+
+class GetTopGainersRequest(BaseModel):
+    limit: 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)"""
+
+    size: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 10
+    r"""Alias for limit. Ignored when limit is supplied."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["limit", "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 GetTopGainersResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    symbol_details: NotRequired[List[SymbolDetailsTypedDict]]
+    r"""Top gaining stocks retrieved successfully"""
+
+
+class GetTopGainersResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    symbol_details: Optional[List[SymbolDetails]] = None
+    r"""Top gaining stocks retrieved successfully"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["SymbolDetails"])
+        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