finance_dev 0.9.0__py3-none-any.whl

finance_dev/py.typed

@@ -0,0 +1 @@
+# Marker file for PEP 561. The package enables type hints.

finance_dev/sdk.py

@@ -0,0 +1,347 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 5fb27a93df8c
+
+from .basesdk import BaseSDK
+from .httpclient import AsyncHttpClient, ClientOwner, HttpClient, close_clients
+from .sdkconfiguration import SDKConfiguration
+from .utils.logger import Logger, get_default_logger
+from .utils.retries import RetryConfig
+from finance_dev import models, utils
+from finance_dev._hooks import SDKHooks
+from finance_dev.types import OptionalNullable, UNSET
+import httpx
+import importlib
+import sys
+from typing import Callable, Dict, Optional, TYPE_CHECKING, Union, cast
+import weakref
+
+if TYPE_CHECKING:
+    from finance_dev.accounts import Accounts
+    from finance_dev.alternativedata import AlternativeData
+    from finance_dev.analytics import Analytics
+    from finance_dev.calendar import Calendar
+    from finance_dev.chart import Chart
+    from finance_dev.company import Company
+    from finance_dev.corporateactions import CorporateActions
+    from finance_dev.economy import Economy
+    from finance_dev.estimates import Estimates
+    from finance_dev.etf import Etf
+    from finance_dev.filings import Filings
+    from finance_dev.financials import Financials
+    from finance_dev.indices import Indices
+    from finance_dev.logos import Logos
+    from finance_dev.market import Market
+    from finance_dev.news_sdk import NewsSDK
+    from finance_dev.options import Options
+    from finance_dev.orders import Orders
+    from finance_dev.ownership import Ownership
+    from finance_dev.predictions import Predictions
+    from finance_dev.signals import Signals
+    from finance_dev.stocks import Stocks
+    from finance_dev.technicalanalysis_sdk import TechnicalAnalysisSDK
+    from finance_dev.watchlist_sdk import WatchlistSDK
+
+
+class FinanceDev(BaseSDK):
+    r"""Aries API — OpenAPI Specification: OpenAPI Specification for the Aries trading platform API.
+
+    # Authentication
+
+    Learn how to authenticate with the Aries API using OAuth2 and manage access tokens in your SDK.
+
+    ## Overview
+
+    The Aries API uses **OAuth2 with Bearer tokens** (JWT format) for authentication. All API requests require a valid access token in the `Authorization` header:
+
+    ```
+    Authorization: Bearer <access_token>
+    ```
+
+    ## Providing Client ID and Client Secret (SDK)
+
+    When using the generated SDK, provide your **Client ID** and **Client Secret** when you create the API client (e.g. in the constructor or security options). The SDK will use these to obtain and refresh the access token internally; you do not need to manage tokens yourself.
+
+    Obtain your OAuth2 credentials from the Aries platform (e.g. Client Center / Manage Account at https://app.aries.com):
+
+    - **Client ID** – Your application identifier (pass to SDK client)
+    - **Client Secret** – Your application secret key (pass to SDK client; use PKCE for public clients where secret cannot be stored)
+
+    ## Authentication Flow
+
+    ### 1. Authorization Code Flow
+
+    For server-side or confidential clients:
+
+    1. **Redirect the user** to the authorization URL to sign in and consent:
+    - **URL:** `https://app.aries.com/oauth2/authorize`
+    - **Query params:** `response_type=code`, `client_id`, `redirect_uri`, `scope`, `state`
+
+    2. **Exchange the code for tokens** (after user is redirected back with `?code=.`):
+    - **POST** `https://api.aries.com/v1/oauth2/token`
+    - **Body:** `grant_type=authorization_code`, `code`, `redirect_uri`, `client_id`, `client_secret`
+    - Response includes `access_token` and `refresh_token`
+
+    3. **Call the API** with the access token: `Authorization: Bearer <access_token>`
+
+    ### 2. PKCE Flow
+
+    For SPAs and mobile apps (public clients that cannot store `client_secret`):
+
+    1. Generate a **code_verifier** (random string) and **code_challenge** = BASE64URL(SHA256(code_verifier)).
+    2. **Redirect the user** to `https://app.aries.com/oauth2/authorize` with `code_challenge`, `code_challenge_method=S256`, plus `client_id`, `redirect_uri`, `scope`, `state`.
+    3. **Exchange the code** at POST `https://api.aries.com/v1/oauth2/token` with `grant_type=authorization_code`, `code`, `redirect_uri`, `client_id`, `code_verifier` (no client_secret).
+    4. Use the returned `access_token` as Bearer.
+
+    ### 3. MFA Verification
+
+    If the user has MFA enabled, the authorize step may return `is_mfa: true` and a `next_step_auth_id`. Call **POST** `https://api.aries.com/v1/oauth2/authorize/mfa` with `next_step_auth_id` and `verification_code` (6-digit code). Then continue with **POST** `/v1/oauth2/authorize/confirm` to get the authorization code, and exchange it at `/v1/oauth2/token`.
+
+    ## Token Management
+
+    - **Refresh when expired:** POST `https://api.aries.com/v1/oauth2/token` with `grant_type=refresh_token`, `client_id`, `client_secret`, `refresh_token`.
+    - **Using a Bearer token directly:** If you already have an access token, set the header `Authorization: Bearer <access_token>` on every request. The SDK can accept a pre-obtained token and use it until it expires.
+
+    ## OAuth2 Scopes
+
+    Request only the scopes your application needs. Available scopes:
+
+    | Scope | Description |
+    |-------|-------------|
+    | `user:information` | View user profile and personal details |
+    | `watchlist:information` | View your watchlists and their symbols |
+    | `watchlist:management` | Create, update, replace, and delete your watchlists |
+    | `account:information` | View account balances, positions, and transaction history |
+    | `order:execution` | Place, modify, and cancel orders |
+    | `order:information` | View order history and status |
+    | `position:information` | View current positions and holdings |
+    | `market:information` | Access live and historical market data |
+    | `calendar:information` | Access earnings, economic, and market schedule data |
+    | `options:information` | Access options chains and expiration data |
+    | `analytics:information` | View analytics, ratings, and market insights |
+    | `market:supplemental` | News, company profiles, financials, filings, ETF data, technical analysis |
+
+    Specify multiple scopes as a space-separated string, e.g. `account:information order:execution market:information`.
+
+    ## Security Best Practices
+
+    - **Store credentials securely** – Use environment variables or a secrets manager for `client_id` and `client_secret`. Never hardcode them.
+    - **Handle token expiration** – Check for 401 responses and refresh the token using the refresh_token, then retry the request.
+    - **Use HTTPS** – All authorization and token endpoints must be called over HTTPS.
+    - **Validate state** – When using the authorization code flow, validate the `state` parameter on the callback to prevent CSRF.
+
+    ## Error Handling
+
+    - **400 Bad Request** – Invalid or missing parameters, validation failures, or malformed JSON. Response bodies follow the same patterns as other errors (flat `error` string, optional `codes`, nested `error` object, or rarely no body).
+
+    - **401 Unauthorized** – Invalid or expired access token; refresh the token or re-authenticate. JSON bodies are not identical on every route: you may see a flat `error` string (sometimes with `codes`), a nested `error` object (`type`, `code`, `message`), or rarely an empty body
+
+    - **403 Forbidden** – Insufficient scope or permissions for the requested resource. Error JSON may be flat or nested, like 400/401.
+
+    - **404 Not Found** – Resource does not exist or is not visible. Error JSON may be flat or nested.
+
+    - **500 / 5xx** – Server or upstream failure; retry with backoff. Do not depend on a single error JSON shape; some responses may have no body.
+
+
+    ---
+
+    Endpoints in this spec: health, OAuth2 (authorize, confirm, mfa, token), users, accounts, orders, market data, watchlist, chart, analytics, calendars, company, economy, financials, indices, options, news, and supplemental data.
+    """
+
+    accounts: "Accounts"
+    analytics: "Analytics"
+    calendar: "Calendar"
+    chart: "Chart"
+    company: "Company"
+    watchlist: "WatchlistSDK"
+    corporate_actions: "CorporateActions"
+    economy: "Economy"
+    market: "Market"
+    etf: "Etf"
+    filings: "Filings"
+    financials: "Financials"
+    technical_analysis: "TechnicalAnalysisSDK"
+    indices: "Indices"
+    ownership: "Ownership"
+    logos: "Logos"
+    news: "NewsSDK"
+    options: "Options"
+    orders: "Orders"
+    predictions: "Predictions"
+    signals: "Signals"
+    alternative_data: "AlternativeData"
+    estimates: "Estimates"
+    stocks: "Stocks"
+    _sub_sdk_map = {
+        "websocket": ("finance_dev.websocket.sdk", "WebSocketSDK"),
+        "accounts": ("finance_dev.accounts", "Accounts"),
+        "analytics": ("finance_dev.analytics", "Analytics"),
+        "calendar": ("finance_dev.calendar", "Calendar"),
+        "chart": ("finance_dev.chart", "Chart"),
+        "company": ("finance_dev.company", "Company"),
+        "watchlist": ("finance_dev.watchlist_sdk", "WatchlistSDK"),
+        "corporate_actions": ("finance_dev.corporateactions", "CorporateActions"),
+        "economy": ("finance_dev.economy", "Economy"),
+        "market": ("finance_dev.market", "Market"),
+        "etf": ("finance_dev.etf", "Etf"),
+        "filings": ("finance_dev.filings", "Filings"),
+        "financials": ("finance_dev.financials", "Financials"),
+        "technical_analysis": (
+            "finance_dev.technicalanalysis_sdk",
+            "TechnicalAnalysisSDK",
+        ),
+        "indices": ("finance_dev.indices", "Indices"),
+        "ownership": ("finance_dev.ownership", "Ownership"),
+        "logos": ("finance_dev.logos", "Logos"),
+        "news": ("finance_dev.news_sdk", "NewsSDK"),
+        "options": ("finance_dev.options", "Options"),
+        "orders": ("finance_dev.orders", "Orders"),
+        "predictions": ("finance_dev.predictions", "Predictions"),
+        "signals": ("finance_dev.signals", "Signals"),
+        "alternative_data": ("finance_dev.alternativedata", "AlternativeData"),
+        "estimates": ("finance_dev.estimates", "Estimates"),
+        "stocks": ("finance_dev.stocks", "Stocks"),
+    }
+
+    def __init__(
+        self,
+        security: Optional[
+            Union[models.Security, Callable[[], models.Security]]
+        ] = None,
+        server_idx: Optional[int] = None,
+        url_params: Optional[Dict[str, str]] = None,
+        server_url: Optional[str] = None,
+        client: Optional[HttpClient] = None,
+        async_client: Optional[AsyncHttpClient] = None,
+        retry_config: OptionalNullable[RetryConfig] = UNSET,
+        timeout_ms: Optional[int] = None,
+        debug_logger: Optional[Logger] = None,
+    ) -> None:
+        r"""Instantiates the SDK configuring it with the provided parameters.
+
+        :param security: The security details required for authentication
+        :param server_idx: The index of the server to use for all methods
+        :param server_url: The server URL to use for all methods
+        :param url_params: Parameters to optionally template the server URL with
+        :param client: The HTTP client to use for all synchronous methods
+        :param async_client: The Async HTTP client to use for all asynchronous methods
+        :param retry_config: The retry configuration to use for all supported methods
+        :param timeout_ms: Optional request timeout applied to each operation in milliseconds
+        """
+        client_supplied = True
+        if client is None:
+            client = httpx.Client(follow_redirects=True)
+            client_supplied = False
+
+        assert issubclass(
+            type(client), HttpClient
+        ), "The provided client must implement the HttpClient protocol."
+
+        async_client_supplied = True
+        if async_client is None:
+            async_client = httpx.AsyncClient(follow_redirects=True)
+            async_client_supplied = False
+
+        if debug_logger is None:
+            debug_logger = get_default_logger()
+
+        assert issubclass(
+            type(async_client), AsyncHttpClient
+        ), "The provided async_client must implement the AsyncHttpClient protocol."
+
+        if server_url is not None:
+            if url_params is not None:
+                server_url = utils.template_url(server_url, url_params)
+
+        BaseSDK.__init__(
+            self,
+            SDKConfiguration(
+                client=client,
+                client_supplied=client_supplied,
+                async_client=async_client,
+                async_client_supplied=async_client_supplied,
+                security=security,
+                server_url=server_url,
+                server_idx=server_idx,
+                retry_config=retry_config,
+                timeout_ms=timeout_ms,
+                debug_logger=debug_logger,
+            ),
+            parent_ref=self,
+        )
+
+        hooks = SDKHooks()
+
+        # pylint: disable=protected-access
+        self.sdk_configuration.__dict__["_hooks"] = hooks
+
+        self.sdk_configuration = hooks.sdk_init(self.sdk_configuration)
+
+        weakref.finalize(
+            self,
+            close_clients,
+            cast(ClientOwner, self.sdk_configuration),
+            self.sdk_configuration.client,
+            self.sdk_configuration.client_supplied,
+            self.sdk_configuration.async_client,
+            self.sdk_configuration.async_client_supplied,
+        )
+
+    def dynamic_import(self, modname, retries=3):
+        for attempt in range(retries):
+            try:
+                return importlib.import_module(modname)
+            except KeyError:
+                # Clear any half-initialized module and retry
+                sys.modules.pop(modname, None)
+                if attempt == retries - 1:
+                    break
+        raise KeyError(f"Failed to import module '{modname}' after {retries} attempts")
+
+    def __getattr__(self, name: str):
+        if name in self._sub_sdk_map:
+            module_path, class_name = self._sub_sdk_map[name]
+            try:
+                module = self.dynamic_import(module_path)
+                klass = getattr(module, class_name)
+                instance = klass(self.sdk_configuration, parent_ref=self)
+                setattr(self, name, instance)
+                return instance
+            except ImportError as e:
+                raise AttributeError(
+                    f"Failed to import module {module_path} for attribute {name}: {e}"
+                ) from e
+            except AttributeError as e:
+                raise AttributeError(
+                    f"Failed to find class {class_name} in module {module_path} for attribute {name}: {e}"
+                ) from e
+
+        raise AttributeError(
+            f"'{type(self).__name__}' object has no attribute '{name}'"
+        )
+
+    def __dir__(self):
+        default_attrs = list(super().__dir__())
+        lazy_attrs = list(self._sub_sdk_map.keys())
+        return sorted(list(set(default_attrs + lazy_attrs)))
+
+    def __enter__(self):
+        return self
+
+    async def __aenter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        if (
+            self.sdk_configuration.client is not None
+            and not self.sdk_configuration.client_supplied
+        ):
+            self.sdk_configuration.client.close()
+        self.sdk_configuration.client = None
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        if (
+            self.sdk_configuration.async_client is not None
+            and not self.sdk_configuration.async_client_supplied
+        ):
+            await self.sdk_configuration.async_client.aclose()
+        self.sdk_configuration.async_client = None

finance_dev/sdkconfiguration.py

@@ -0,0 +1,50 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 6dab16bc4f60
+
+from ._version import (
+    __gen_version__,
+    __openapi_doc_version__,
+    __user_agent__,
+    __version__,
+)
+from .httpclient import AsyncHttpClient, HttpClient
+from .utils import Logger, RetryConfig, remove_suffix
+from dataclasses import dataclass
+from finance_dev import models
+from finance_dev.types import OptionalNullable, UNSET
+from pydantic import Field
+from typing import Callable, Dict, Optional, Tuple, Union
+
+
+SERVERS = [
+    "https://api.aries.com",
+    # Production server
+]
+"""Contains the list of servers available to the SDK"""
+
+
+@dataclass
+class SDKConfiguration:
+    client: Union[HttpClient, None]
+    client_supplied: bool
+    async_client: Union[AsyncHttpClient, None]
+    async_client_supplied: bool
+    debug_logger: Logger
+    security: Optional[Union[models.Security, Callable[[], models.Security]]] = None
+    server_url: Optional[str] = ""
+    server_idx: Optional[int] = 0
+    language: str = "python"
+    openapi_doc_version: str = __openapi_doc_version__
+    sdk_version: str = __version__
+    gen_version: str = __gen_version__
+    user_agent: str = __user_agent__
+    retry_config: OptionalNullable[RetryConfig] = Field(default_factory=lambda: UNSET)
+    timeout_ms: Optional[int] = None
+
+    def get_server_details(self) -> Tuple[str, Dict[str, str]]:
+        if self.server_url is not None and self.server_url:
+            return remove_suffix(self.server_url, "/"), {}
+        if self.server_idx is None:
+            self.server_idx = 0
+
+        return SERVERS[self.server_idx], {}