finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/getshortvolumeop.py

@@ -0,0 +1,333 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: ac15990e23d0
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .shortvolumeresponse import ShortVolumeResponse, ShortVolumeResponseTypedDict
+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 GetShortVolumeRequestTypedDict(TypedDict):
+    ticker: NotRequired[str]
+    r"""Single ticker symbol filter. Enter one ticker such as AAPL to narrow results to one company."""
+    tickers_any_of: NotRequired[str]
+    r"""Comma-separated list of ticker symbols."""
+    ticker_after: NotRequired[str]
+    r"""Ticker pagination lower bound. Returns symbols alphabetically after this ticker, excluding the ticker itself."""
+    ticker_from: NotRequired[str]
+    r"""Ticker greater than or equal (inclusive)"""
+    ticker_before: NotRequired[str]
+    r"""Ticker pagination upper bound. Returns symbols alphabetically before this ticker, excluding the ticker itself."""
+    ticker_to: NotRequired[str]
+    r"""Ticker less than or equal (inclusive)"""
+    date_: NotRequired[date]
+    r"""Exact date in YYYY-MM-DD format. Use this when you want one specific calendar day."""
+    dates: NotRequired[str]
+    r"""Comma-separated list of dates in YYYY-MM-DD format. Use this when you want several specific dates in one request."""
+    date_after: NotRequired[date]
+    r"""After-date filter. Returns records after this date, excluding the date itself."""
+    date_from: NotRequired[date]
+    r"""Start-date filter. Returns records on or after this date."""
+    date_before: NotRequired[date]
+    r"""Before-date filter. Returns records before this date, excluding the date itself."""
+    date_to: NotRequired[date]
+    r"""End-date filter. Returns records on or before this date."""
+    short_volume_ratio: NotRequired[float]
+    r"""Exact short-volume ratio filter. Use it when you need records matching one specific ratio value."""
+    short_volume_ratio_list: NotRequired[str]
+    r"""Comma-separated list of short volume ratios"""
+    short_volume_ratio_above: NotRequired[float]
+    r"""Short volume ratio greater than (exclusive)"""
+    short_volume_ratio_min: NotRequired[float]
+    r"""Short volume ratio greater than or equal (inclusive)"""
+    short_volume_ratio_below: NotRequired[float]
+    r"""Short volume ratio less than (exclusive)"""
+    short_volume_ratio_max: NotRequired[float]
+    r"""Short volume ratio less than or equal (inclusive)"""
+    total_volume: NotRequired[int]
+    r"""Exact total-volume filter. Use it when you need records matching one specific volume value."""
+    total_volume_list: NotRequired[str]
+    r"""Comma-separated list of total volumes"""
+    total_volume_above: NotRequired[int]
+    r"""Total volume greater than (exclusive)"""
+    total_volume_min: NotRequired[int]
+    r"""Total volume greater than or equal (inclusive)"""
+    total_volume_below: NotRequired[int]
+    r"""Total-volume upper-bound filter. Returns records below this value, excluding the value itself."""
+    total_volume_max: NotRequired[int]
+    r"""Total volume less than or equal (inclusive)"""
+    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"""A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Defaults to `ticker.asc` when not specified."""
+    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 GetShortVolumeRequest(BaseModel):
+    ticker: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Single ticker symbol filter. Enter one ticker such as AAPL to narrow results to one company."""
+
+    tickers_any_of: Annotated[
+        Optional[str],
+        pydantic.Field(alias="tickersAnyOf"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated list of ticker symbols."""
+
+    ticker_after: Annotated[
+        Optional[str],
+        pydantic.Field(alias="tickerAfter"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Ticker pagination lower bound. Returns symbols alphabetically after this ticker, excluding the ticker itself."""
+
+    ticker_from: Annotated[
+        Optional[str],
+        pydantic.Field(alias="tickerFrom"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Ticker greater than or equal (inclusive)"""
+
+    ticker_before: Annotated[
+        Optional[str],
+        pydantic.Field(alias="tickerBefore"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Ticker pagination upper bound. Returns symbols alphabetically before this ticker, excluding the ticker itself."""
+
+    ticker_to: Annotated[
+        Optional[str],
+        pydantic.Field(alias="tickerTo"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Ticker less than or equal (inclusive)"""
+
+    date_: Annotated[
+        Optional[date],
+        pydantic.Field(alias="date"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact date in YYYY-MM-DD format. Use this when you want one specific calendar day."""
+
+    dates: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated list of dates in YYYY-MM-DD format. Use this when you want several specific dates in one request."""
+
+    date_after: Annotated[
+        Optional[date],
+        pydantic.Field(alias="dateAfter"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""After-date filter. Returns records after this date, excluding the date itself."""
+
+    date_from: Annotated[
+        Optional[date],
+        pydantic.Field(alias="dateFrom"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Start-date filter. Returns records on or after this date."""
+
+    date_before: Annotated[
+        Optional[date],
+        pydantic.Field(alias="dateBefore"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Before-date filter. Returns records before this date, excluding the date itself."""
+
+    date_to: Annotated[
+        Optional[date],
+        pydantic.Field(alias="dateTo"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""End-date filter. Returns records on or before this date."""
+
+    short_volume_ratio: Annotated[
+        Optional[float],
+        pydantic.Field(alias="shortVolumeRatio"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact short-volume ratio filter. Use it when you need records matching one specific ratio value."""
+
+    short_volume_ratio_list: Annotated[
+        Optional[str],
+        pydantic.Field(alias="shortVolumeRatioList"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated list of short volume ratios"""
+
+    short_volume_ratio_above: Annotated[
+        Optional[float],
+        pydantic.Field(alias="shortVolumeRatioAbove"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Short volume ratio greater than (exclusive)"""
+
+    short_volume_ratio_min: Annotated[
+        Optional[float],
+        pydantic.Field(alias="shortVolumeRatioMin"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Short volume ratio greater than or equal (inclusive)"""
+
+    short_volume_ratio_below: Annotated[
+        Optional[float],
+        pydantic.Field(alias="shortVolumeRatioBelow"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Short volume ratio less than (exclusive)"""
+
+    short_volume_ratio_max: Annotated[
+        Optional[float],
+        pydantic.Field(alias="shortVolumeRatioMax"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Short volume ratio less than or equal (inclusive)"""
+
+    total_volume: Annotated[
+        Optional[int],
+        pydantic.Field(alias="totalVolume"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact total-volume filter. Use it when you need records matching one specific volume value."""
+
+    total_volume_list: Annotated[
+        Optional[str],
+        pydantic.Field(alias="totalVolumeList"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated list of total volumes"""
+
+    total_volume_above: Annotated[
+        Optional[int],
+        pydantic.Field(alias="totalVolumeAbove"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Total volume greater than (exclusive)"""
+
+    total_volume_min: Annotated[
+        Optional[int],
+        pydantic.Field(alias="totalVolumeMin"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Total volume greater than or equal (inclusive)"""
+
+    total_volume_below: Annotated[
+        Optional[int],
+        pydantic.Field(alias="totalVolumeBelow"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Total-volume upper-bound filter. Returns records below this value, excluding the value itself."""
+
+    total_volume_max: Annotated[
+        Optional[int],
+        pydantic.Field(alias="totalVolumeMax"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Total volume less than or equal (inclusive)"""
+
+    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"""A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Defaults to `ticker.asc` when not specified."""
+
+    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."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "ticker",
+                "tickersAnyOf",
+                "tickerAfter",
+                "tickerFrom",
+                "tickerBefore",
+                "tickerTo",
+                "date",
+                "dates",
+                "dateAfter",
+                "dateFrom",
+                "dateBefore",
+                "dateTo",
+                "shortVolumeRatio",
+                "shortVolumeRatioList",
+                "shortVolumeRatioAbove",
+                "shortVolumeRatioMin",
+                "shortVolumeRatioBelow",
+                "shortVolumeRatioMax",
+                "totalVolume",
+                "totalVolumeList",
+                "totalVolumeAbove",
+                "totalVolumeMin",
+                "totalVolumeBelow",
+                "totalVolumeMax",
+                "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 GetShortVolumeResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    short_volume_response: NotRequired[ShortVolumeResponseTypedDict]
+    r"""Successful response"""
+
+
+class GetShortVolumeResponse(BaseModel):
+    next: Callable[[], Optional[GetShortVolumeResponse]]
+
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    short_volume_response: Optional[ShortVolumeResponse] = None
+    r"""Successful response"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["ShortVolumeResponse"])
+        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/getsocialsentimentop.py

@@ -0,0 +1,90 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: bc1c52b3a1a3
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .socialsentimentresponse import (
+    SocialSentimentResponse,
+    SocialSentimentResponseTypedDict,
+)
+from datetime import date
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from finance_dev.utils import FieldMetadata, QueryParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetSocialSentimentRequestTypedDict(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`."""
+    from_: NotRequired[date]
+    r"""Start of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-01-01`)."""
+    to: NotRequired[date]
+    r"""End of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-12-31`)."""
+
+
+class GetSocialSentimentRequest(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`."""
+
+    from_: Annotated[
+        Optional[date],
+        pydantic.Field(alias="from"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Start of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-01-01`)."""
+
+    to: Annotated[
+        Optional[date],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""End of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-12-31`)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["from", "to"])
+        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 GetSocialSentimentResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    social_sentiment_response: NotRequired[SocialSentimentResponseTypedDict]
+    r"""Social sentiment data."""
+
+
+class GetSocialSentimentResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    social_sentiment_response: Optional[SocialSentimentResponse] = None
+    r"""Social sentiment data."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["SocialSentimentResponse"])
+        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/getspinoffsop.py

@@ -0,0 +1,112 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 0e84dd9e77a9
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .spinoffsresponse import SpinoffsResponse, SpinoffsResponseTypedDict
+from .tenderofferidentifiertype import TenderOfferIdentifierType
+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 GetSpinoffsRequestTypedDict(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 spin-off announcement window, inclusive. Format: `YYYY-MM-DD` (e.g. `2020-01-01`)."""
+    end_date: date
+    r"""End of the spin-off announcement window, inclusive. Format: `YYYY-MM-DD` (e.g. `2020-12-31`)."""
+
+
+class GetSpinoffsRequest(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 spin-off announcement window, inclusive. Format: `YYYY-MM-DD` (e.g. `2020-01-01`)."""
+
+    end_date: Annotated[
+        date,
+        pydantic.Field(alias="endDate"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""End of the spin-off announcement window, inclusive. Format: `YYYY-MM-DD` (e.g. `2020-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 GetSpinoffsResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    spinoffs_response: NotRequired[SpinoffsResponseTypedDict]
+    r"""Successful response with spinoffs data"""
+
+
+class GetSpinoffsResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    spinoffs_response: Optional[SpinoffsResponse] = None
+    r"""Successful response with spinoffs data"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["SpinoffsResponse"])
+        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