finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/getinflationexpectationsop.py

@@ -0,0 +1,157 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: f51044bc1fbd
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .inflationexpectationsresponse import (
+    InflationExpectationsResponse,
+    InflationExpectationsResponseTypedDict,
+)
+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 GetInflationExpectationsRequestTypedDict(TypedDict):
+    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_from: NotRequired[date]
+    r"""Start-date filter. Returns records on or after this date."""
+    date_to: NotRequired[date]
+    r"""End-date filter. Returns records on or before this date."""
+    date_after: NotRequired[date]
+    r"""After-date filter. Returns records after this date, excluding the date itself."""
+    date_before: NotRequired[date]
+    r"""Before-date filter. Returns records before this date, excluding the date itself."""
+    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 `date.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 GetInflationExpectationsRequest(BaseModel):
+    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_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_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."""
+
+    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_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."""
+
+    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 `date.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(
+            [
+                "date",
+                "dates",
+                "dateFrom",
+                "dateTo",
+                "dateAfter",
+                "dateBefore",
+                "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 GetInflationExpectationsResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    inflation_expectations_response: NotRequired[InflationExpectationsResponseTypedDict]
+    r"""Successful response"""
+
+
+class GetInflationExpectationsResponse(BaseModel):
+    next: Callable[[], Optional[GetInflationExpectationsResponse]]
+
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    inflation_expectations_response: Optional[InflationExpectationsResponse] = None
+    r"""Successful response"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["InflationExpectationsResponse"])
+        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/getinflationop.py

@@ -0,0 +1,154 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 67032bce2451
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .inflationresponse import InflationResponse, InflationResponseTypedDict
+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 GetInflationRequestTypedDict(TypedDict):
+    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_from: NotRequired[date]
+    r"""Start-date filter. Returns records on or after this date."""
+    date_to: NotRequired[date]
+    r"""End-date filter. Returns records on or before this date."""
+    date_after: NotRequired[date]
+    r"""After-date filter. Returns records after this date, excluding the date itself."""
+    date_before: NotRequired[date]
+    r"""Before-date filter. Returns records before this date, excluding the date itself."""
+    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 `date.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 GetInflationRequest(BaseModel):
+    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_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_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."""
+
+    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_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."""
+
+    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 `date.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(
+            [
+                "date",
+                "dates",
+                "dateFrom",
+                "dateTo",
+                "dateAfter",
+                "dateBefore",
+                "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 GetInflationResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    inflation_response: NotRequired[InflationResponseTypedDict]
+    r"""Successful response"""
+
+
+class GetInflationResponse(BaseModel):
+    next: Callable[[], Optional[GetInflationResponse]]
+
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    inflation_response: Optional[InflationResponse] = None
+    r"""Successful response"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["InflationResponse"])
+        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/getinsidertransactionsop.py

@@ -0,0 +1,90 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 594f80221f9a
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .insidertransactionsresponse import (
+    InsiderTransactionsResponse,
+    InsiderTransactionsResponseTypedDict,
+)
+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 GetInsiderTransactionsRequestTypedDict(TypedDict):
+    symbol: str
+    r"""Stock symbol, such as AAPL. Use it to narrow results to one company."""
+    from_: NotRequired[date]
+    r"""Optional start date in YYYY-MM-DD format. Use it to begin the research window."""
+    to: NotRequired[date]
+    r"""Optional end date in YYYY-MM-DD format. Use it to end the research window."""
+
+
+class GetInsiderTransactionsRequest(BaseModel):
+    symbol: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Stock symbol, such as AAPL. Use it to narrow results to one company."""
+
+    from_: Annotated[
+        Optional[date],
+        pydantic.Field(alias="from"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Optional start date in YYYY-MM-DD format. Use it to begin the research window."""
+
+    to: Annotated[
+        Optional[date],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Optional end date in YYYY-MM-DD format. Use it to end the research window."""
+
+    @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 GetInsiderTransactionsResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    insider_transactions_response: NotRequired[InsiderTransactionsResponseTypedDict]
+    r"""Insider transactions."""
+
+
+class GetInsiderTransactionsResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    insider_transactions_response: Optional[InsiderTransactionsResponse] = None
+    r"""Insider transactions."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["InsiderTransactionsResponse"])
+        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/getinstitutionalownershipop.py

@@ -0,0 +1,99 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: f0aecac29259
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .institutionalownershipresponse import (
+    InstitutionalOwnershipResponse,
+    InstitutionalOwnershipResponseTypedDict,
+)
+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 GetInstitutionalOwnershipRequestTypedDict(TypedDict):
+    cusip: str
+    r"""CUSIP security identifier for the security you want institutional ownership for."""
+    from_: date
+    r"""Start date in YYYY-MM-DD format. Enter the first date to include in the research window."""
+    to: date
+    r"""End date in YYYY-MM-DD format. Enter the last date to include in the research window."""
+    symbol: NotRequired[str]
+    r"""Optional stock ticker symbol filter, such as AAPL. Use it to narrow results to one company."""
+
+
+class GetInstitutionalOwnershipRequest(BaseModel):
+    cusip: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""CUSIP security identifier for the security you want institutional ownership for."""
+
+    from_: Annotated[
+        date,
+        pydantic.Field(alias="from"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""Start date in YYYY-MM-DD format. Enter the first date to include in the research window."""
+
+    to: Annotated[
+        date, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""End date in YYYY-MM-DD format. Enter the last date to include in the research window."""
+
+    symbol: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Optional stock ticker symbol filter, such as AAPL. Use it to narrow results to one company."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["symbol"])
+        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 GetInstitutionalOwnershipResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    institutional_ownership_response: NotRequired[
+        InstitutionalOwnershipResponseTypedDict
+    ]
+    r"""Institutional ownership data."""
+
+
+class GetInstitutionalOwnershipResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    institutional_ownership_response: Optional[InstitutionalOwnershipResponse] = None
+    r"""Institutional ownership data."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["InstitutionalOwnershipResponse"])
+        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/getinstitutionalportfolioop.py

@@ -0,0 +1,75 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 52c9324084d8
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .institutionalportfolioresponse import (
+    InstitutionalPortfolioResponse,
+    InstitutionalPortfolioResponseTypedDict,
+)
+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 GetInstitutionalPortfolioRequestTypedDict(TypedDict):
+    cik: str
+    r"""Central Index Key (CIK) of the institution."""
+    from_: date
+    r"""Start date in YYYY-MM-DD format. Enter the first date to include in the research window."""
+    to: date
+    r"""End date in YYYY-MM-DD format. Enter the last date to include in the research window."""
+
+
+class GetInstitutionalPortfolioRequest(BaseModel):
+    cik: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Central Index Key (CIK) of the institution."""
+
+    from_: Annotated[
+        date,
+        pydantic.Field(alias="from"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""Start date in YYYY-MM-DD format. Enter the first date to include in the research window."""
+
+    to: Annotated[
+        date, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""End date in YYYY-MM-DD format. Enter the last date to include in the research window."""
+
+
+class GetInstitutionalPortfolioResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    institutional_portfolio_response: NotRequired[
+        InstitutionalPortfolioResponseTypedDict
+    ]
+    r"""Institutional portfolio holdings."""
+
+
+class GetInstitutionalPortfolioResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    institutional_portfolio_response: Optional[InstitutionalPortfolioResponse] = None
+    r"""Institutional portfolio holdings."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["InstitutionalPortfolioResponse"])
+        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/getinvestmentthemeop.py

@@ -0,0 +1,68 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 18f8f6725dc2
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .investmentthemeid import InvestmentThemeID
+from .investmentthemeresponse import (
+    InvestmentThemeResponse,
+    InvestmentThemeResponseTypedDict,
+)
+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 GetInvestmentThemeRequestTypedDict(TypedDict):
+    theme: InvestmentThemeID
+    r"""investment theme identifier. Use the Try it dropdown or the supported values list on the reference page."""
+
+
+class GetInvestmentThemeRequest(BaseModel):
+    theme: Annotated[
+        InvestmentThemeID,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""investment theme identifier. Use the Try it dropdown or the supported values list on the reference page."""
+
+    @field_serializer("theme")
+    def serialize_theme(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InvestmentThemeID(value)
+            except ValueError:
+                return value
+        return value
+
+
+class GetInvestmentThemeResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    investment_theme_response: NotRequired[InvestmentThemeResponseTypedDict]
+    r"""Investment theme data."""
+
+
+class GetInvestmentThemeResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    investment_theme_response: Optional[InvestmentThemeResponse] = None
+    r"""Investment theme data."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["InvestmentThemeResponse"])
+        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