finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/getsectortickersop.py

@@ -0,0 +1,124 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: e90372b13cfc
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .symboldetails import SymbolDetails, SymbolDetailsTypedDict
+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 List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class Sector(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Which industry sector to list tickers for. Use the exact uppercase value (including spaces) — these match the values returned by [GET /v1/equity/sector-wise-change](/api-reference/analytics/equity-sector-wise-change).
+    - `TECHNOLOGY` — software, hardware, semiconductors
+    - `HEALTHCARE` — pharma, biotech, medical devices, providers
+    - `FINANCIAL SERVICES` — banks, insurance, asset managers
+    - `CONSUMER CYCLICAL` — discretionary spending (autos, retail, travel)
+    - `CONSUMER DEFENSIVE` — staples (food, household goods, drugstores)
+    - `INDUSTRIALS` — manufacturing, transport, defense, machinery
+    - `ENERGY` — oil & gas, renewable energy
+    - `UTILITIES` — power, water, gas distribution
+    - `BASIC MATERIALS` — mining, chemicals, paper, metals
+    - `COMMUNICATION SERVICES` — telecom, media, internet platforms
+    - `REAL ESTATE` — REITs and real-estate operators
+    - `OTHER` — uncategorized
+    - `NONE` — no sector classification
+    """
+
+    HEALTHCARE = "HEALTHCARE"
+    UTILITIES = "UTILITIES"
+    CONSUMER_CYCLICAL = "CONSUMER CYCLICAL"
+    INDUSTRIALS = "INDUSTRIALS"
+    CONSUMER_DEFENSIVE = "CONSUMER DEFENSIVE"
+    BASIC_MATERIALS = "BASIC MATERIALS"
+    COMMUNICATION_SERVICES = "COMMUNICATION SERVICES"
+    FINANCIAL_SERVICES = "FINANCIAL SERVICES"
+    TECHNOLOGY = "TECHNOLOGY"
+    REAL_ESTATE = "REAL ESTATE"
+    NONE = "NONE"
+    OTHER = "OTHER"
+    ENERGY = "ENERGY"
+
+
+class GetSectorTickersRequestTypedDict(TypedDict):
+    sector: Sector
+    r"""Which industry sector to list tickers for. Use the exact uppercase value (including spaces) — these match the values returned by [GET /v1/equity/sector-wise-change](/api-reference/analytics/equity-sector-wise-change).
+    - `TECHNOLOGY` — software, hardware, semiconductors
+    - `HEALTHCARE` — pharma, biotech, medical devices, providers
+    - `FINANCIAL SERVICES` — banks, insurance, asset managers
+    - `CONSUMER CYCLICAL` — discretionary spending (autos, retail, travel)
+    - `CONSUMER DEFENSIVE` — staples (food, household goods, drugstores)
+    - `INDUSTRIALS` — manufacturing, transport, defense, machinery
+    - `ENERGY` — oil & gas, renewable energy
+    - `UTILITIES` — power, water, gas distribution
+    - `BASIC MATERIALS` — mining, chemicals, paper, metals
+    - `COMMUNICATION SERVICES` — telecom, media, internet platforms
+    - `REAL ESTATE` — REITs and real-estate operators
+    - `OTHER` — uncategorized
+    - `NONE` — no sector classification
+    """
+
+
+class GetSectorTickersRequest(BaseModel):
+    sector: Annotated[
+        Sector, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Which industry sector to list tickers for. Use the exact uppercase value (including spaces) — these match the values returned by [GET /v1/equity/sector-wise-change](/api-reference/analytics/equity-sector-wise-change).
+    - `TECHNOLOGY` — software, hardware, semiconductors
+    - `HEALTHCARE` — pharma, biotech, medical devices, providers
+    - `FINANCIAL SERVICES` — banks, insurance, asset managers
+    - `CONSUMER CYCLICAL` — discretionary spending (autos, retail, travel)
+    - `CONSUMER DEFENSIVE` — staples (food, household goods, drugstores)
+    - `INDUSTRIALS` — manufacturing, transport, defense, machinery
+    - `ENERGY` — oil & gas, renewable energy
+    - `UTILITIES` — power, water, gas distribution
+    - `BASIC MATERIALS` — mining, chemicals, paper, metals
+    - `COMMUNICATION SERVICES` — telecom, media, internet platforms
+    - `REAL ESTATE` — REITs and real-estate operators
+    - `OTHER` — uncategorized
+    - `NONE` — no sector classification
+    """
+
+    @field_serializer("sector")
+    def serialize_sector(self, value):
+        if isinstance(value, str):
+            try:
+                return models.Sector(value)
+            except ValueError:
+                return value
+        return value
+
+
+class GetSectorTickersResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    symbol_details: NotRequired[List[SymbolDetailsTypedDict]]
+    r"""Sector tickers retrieved successfully"""
+
+
+class GetSectorTickersResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    symbol_details: Optional[List[SymbolDetails]] = None
+    r"""Sector tickers 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

finance_dev/models/getsectorwisechangeop.py

@@ -0,0 +1,84 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: bff276b123b2
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .sectoravgchange import SectorAvgChange, SectorAvgChangeTypedDict
+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 GetSectorWiseChangeRequestTypedDict(TypedDict):
+    limit: NotRequired[str]
+    r"""Maximum number of sectors to return. Two formats are accepted:
+    - An integer like `5`, `10`, `15` to cap the list (default `15`).
+    - The literal string `all` to return every sector with no cap.
+    """
+    size: NotRequired[str]
+    r"""Alias for limit. Ignored when limit is supplied."""
+
+
+class GetSectorWiseChangeRequest(BaseModel):
+    limit: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Maximum number of sectors to return. Two formats are accepted:
+    - An integer like `5`, `10`, `15` to cap the list (default `15`).
+    - The literal string `all` to return every sector with no cap.
+    """
+
+    size: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    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 GetSectorWiseChangeResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    sector_avg_changes: NotRequired[List[SectorAvgChangeTypedDict]]
+    r"""Sector-wise changes retrieved successfully"""
+
+
+class GetSectorWiseChangeResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    sector_avg_changes: Optional[List[SectorAvgChange]] = None
+    r"""Sector-wise changes retrieved successfully"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["SectorAvgChanges"])
+        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/getshortinterestop.py

@@ -0,0 +1,334 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 4f4180ea4f37
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .shortinterestresponse import ShortInterestResponse, ShortInterestResponseTypedDict
+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 GetShortInterestRequestTypedDict(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)"""
+    days_to_cover: NotRequired[float]
+    r"""Exact days-to-cover filter for short interest. Use it when screening for one short-squeeze risk value."""
+    days_to_cover_list: NotRequired[str]
+    r"""Comma-separated list of days to cover"""
+    days_to_cover_above: NotRequired[float]
+    r"""Days to cover greater than (exclusive)"""
+    days_to_cover_min: NotRequired[float]
+    r"""Days to cover greater than or equal (inclusive)"""
+    days_to_cover_below: NotRequired[float]
+    r"""Days to cover less than (exclusive)"""
+    days_to_cover_max: NotRequired[float]
+    r"""Days to cover less than or equal (inclusive)"""
+    settlement_date: NotRequired[date]
+    r"""Settlement date in YYYY-MM-DD format. Use it to filter short-interest records by reporting settlement date."""
+    settlement_dates: NotRequired[str]
+    r"""Comma-separated list of settlement dates"""
+    settlement_date_after: NotRequired[date]
+    r"""Settlement-date lower-bound filter. Returns records after this date, excluding the date itself."""
+    settlement_date_from: NotRequired[date]
+    r"""Settlement-date start filter. Returns records on or after this date."""
+    settlement_date_before: NotRequired[date]
+    r"""Settlement-date upper-bound filter. Returns records before this date, excluding the date itself."""
+    settlement_date_to: NotRequired[date]
+    r"""Settlement-date end filter. Returns records on or before this date."""
+    avg_daily_volume: NotRequired[int]
+    r"""Exact average-daily-volume filter. Use it when screening for one specific liquidity value."""
+    avg_daily_volume_list: NotRequired[str]
+    r"""Comma-separated list of average daily volumes"""
+    avg_daily_volume_above: NotRequired[int]
+    r"""Average daily volume greater than (exclusive)"""
+    avg_daily_volume_min: NotRequired[int]
+    r"""Average daily volume greater than or equal (inclusive)"""
+    avg_daily_volume_below: NotRequired[int]
+    r"""Average daily volume less than (exclusive)"""
+    avg_daily_volume_max: NotRequired[int]
+    r"""Average daily 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 GetShortInterestRequest(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)"""
+
+    days_to_cover: Annotated[
+        Optional[float],
+        pydantic.Field(alias="daysToCover"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact days-to-cover filter for short interest. Use it when screening for one short-squeeze risk value."""
+
+    days_to_cover_list: Annotated[
+        Optional[str],
+        pydantic.Field(alias="daysToCoverList"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated list of days to cover"""
+
+    days_to_cover_above: Annotated[
+        Optional[float],
+        pydantic.Field(alias="daysToCoverAbove"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Days to cover greater than (exclusive)"""
+
+    days_to_cover_min: Annotated[
+        Optional[float],
+        pydantic.Field(alias="daysToCoverMin"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Days to cover greater than or equal (inclusive)"""
+
+    days_to_cover_below: Annotated[
+        Optional[float],
+        pydantic.Field(alias="daysToCoverBelow"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Days to cover less than (exclusive)"""
+
+    days_to_cover_max: Annotated[
+        Optional[float],
+        pydantic.Field(alias="daysToCoverMax"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Days to cover less than or equal (inclusive)"""
+
+    settlement_date: Annotated[
+        Optional[date],
+        pydantic.Field(alias="settlementDate"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Settlement date in YYYY-MM-DD format. Use it to filter short-interest records by reporting settlement date."""
+
+    settlement_dates: Annotated[
+        Optional[str],
+        pydantic.Field(alias="settlementDates"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated list of settlement dates"""
+
+    settlement_date_after: Annotated[
+        Optional[date],
+        pydantic.Field(alias="settlementDateAfter"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Settlement-date lower-bound filter. Returns records after this date, excluding the date itself."""
+
+    settlement_date_from: Annotated[
+        Optional[date],
+        pydantic.Field(alias="settlementDateFrom"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Settlement-date start filter. Returns records on or after this date."""
+
+    settlement_date_before: Annotated[
+        Optional[date],
+        pydantic.Field(alias="settlementDateBefore"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Settlement-date upper-bound filter. Returns records before this date, excluding the date itself."""
+
+    settlement_date_to: Annotated[
+        Optional[date],
+        pydantic.Field(alias="settlementDateTo"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Settlement-date end filter. Returns records on or before this date."""
+
+    avg_daily_volume: Annotated[
+        Optional[int],
+        pydantic.Field(alias="avgDailyVolume"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Exact average-daily-volume filter. Use it when screening for one specific liquidity value."""
+
+    avg_daily_volume_list: Annotated[
+        Optional[str],
+        pydantic.Field(alias="avgDailyVolumeList"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated list of average daily volumes"""
+
+    avg_daily_volume_above: Annotated[
+        Optional[int],
+        pydantic.Field(alias="avgDailyVolumeAbove"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Average daily volume greater than (exclusive)"""
+
+    avg_daily_volume_min: Annotated[
+        Optional[int],
+        pydantic.Field(alias="avgDailyVolumeMin"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Average daily volume greater than or equal (inclusive)"""
+
+    avg_daily_volume_below: Annotated[
+        Optional[int],
+        pydantic.Field(alias="avgDailyVolumeBelow"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Average daily volume less than (exclusive)"""
+
+    avg_daily_volume_max: Annotated[
+        Optional[int],
+        pydantic.Field(alias="avgDailyVolumeMax"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Average daily 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",
+                "daysToCover",
+                "daysToCoverList",
+                "daysToCoverAbove",
+                "daysToCoverMin",
+                "daysToCoverBelow",
+                "daysToCoverMax",
+                "settlementDate",
+                "settlementDates",
+                "settlementDateAfter",
+                "settlementDateFrom",
+                "settlementDateBefore",
+                "settlementDateTo",
+                "avgDailyVolume",
+                "avgDailyVolumeList",
+                "avgDailyVolumeAbove",
+                "avgDailyVolumeMin",
+                "avgDailyVolumeBelow",
+                "avgDailyVolumeMax",
+                "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 GetShortInterestResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    short_interest_response: NotRequired[ShortInterestResponseTypedDict]
+    r"""Successful response"""
+
+
+class GetShortInterestResponse(BaseModel):
+    next: Callable[[], Optional[GetShortInterestResponse]]
+
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    short_interest_response: Optional[ShortInterestResponse] = None
+    r"""Successful response"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["ShortInterestResponse"])
+        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