snaptrade-python-sdk 13.0.15__tar.gz → 13.0.16__tar.gz

snaptrade_python_sdk-13.0.16/PKG-INFO

@@ -0,0 +1,2530 @@
+Metadata-Version: 2.1
+Name: snaptrade-python-sdk
+Version: 13.0.16
+Summary: Client for SnapTrade
+License: MIT
+Author: SnapTrade
+Author-email: api@snaptrade.com
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: aiohttp (>=3.10.11,<4.0.0)
+Requires-Dist: certifi (>=2023.7.22)
+Requires-Dist: cryptography (>=43.0.3)
+Requires-Dist: frozendict (>=2.3.4,<3.0.0)
+Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
+Requires-Dist: typing_extensions (>=4.13.2,<5)
+Requires-Dist: urllib3 (>=1.26.18,<3.0.0)
+Description-Content-Type: text/markdown
+
+<div align="left">
+
+[![Visit SnapTrade](https://raw.githubusercontent.com/passiv/snaptrade-sdks/HEAD/sdks/python/header.png)](https://snaptrade.com)
+
+# SnapTrade<a id="snaptrade"></a>
+
+Connect brokerage accounts to your app for live positions and trading.
+
+## Rate limiting<a id="rate-limiting"></a>
+
+Two limits apply to requests signed with your `clientId`. The stricter one
+wins, and exceeding either returns `429 Too Many Requests`.
+
+- **Customer-level** — 250 requests/minute by default, scoped to your
+  `clientId` and applied across all endpoints. Reported in
+  `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`.
+- **Account-level** — 10 requests/minute per account, scoped to
+  (`clientId`, `accountId`). All covered operations for one account draw on
+  the same bucket — reading balances and reading positions share it — and
+  enforcement does not depend on the HTTP method, so updating an account
+  consumes the same bucket as reading it. Only enforced for Personal users,
+  and only for integrations it has been rolled out to — it is not yet in
+  force for every Personal integration. It also does not apply on every
+  operation that documents a 429 below. Where it applies it is reported in
+  `X-RateLimit-Account-Limit`, `X-RateLimit-Account-Remaining` and
+  `X-RateLimit-Account-Reset`. Do not read the absence of those headers as
+  proof the limit is off — some configurations omit the rate limit headers
+  while still enforcing the limit, so header absence tells you nothing
+  about your allowance.
+
+On a 429, `X-RateLimit-Remaining: 0` means you hit the customer-level limit
+and `X-RateLimit-Account-Remaining: 0` means the account-level one. Wait for
+the corresponding `*-Reset` value (seconds) before retrying, or fall back to
+exponential backoff with jitter.
+
+Not every 429 is explained by those headers. A separate
+per-authenticated-user limit, reported in no `X-RateLimit-*` header, covers
+OAuth-authenticated requests and signed requests in configurations where the
+customer-level limit is not in effect — on the operations that use the
+default throttles. A few operations override those and are governed by the
+customer-level limit alone. The two do not stack: a signed request
+governed by the customer-level limit above is not additionally subject to the
+per-user one. If a 429 arrives with no header at zero — or with no
+`X-RateLimit-*` headers at all — honour `Retry-After` and back off. Treat the
+remaining counts as a hint, not a guarantee that the next request will
+succeed.
+
+Because the customer-level limit applies everywhere, any signed request can
+return 429.
+
+**OAuth-authenticated requests are an exception.** They are not subject to
+the customer-level limit and do not receive `X-RateLimit-Limit`,
+`X-RateLimit-Remaining` or `X-RateLimit-Reset` — do not wait on those headers
+or design around a customer-level allowance on this path. The account-level
+limit still applies to them on the account-data endpoints above, reported in
+the `X-RateLimit-Account-*` headers. On operations using the default
+throttles the per-user limit above applies to them as well, so an OAuth
+request can be rejected while the account headers still show capacity; on
+the few operations that override those throttles, OAuth callers have no
+per-user ceiling at all. Drive retries from `Retry-After` and exponential
+backoff with jitter rather than from the headers.
+
+See https://docs.snaptrade.com/docs/ratelimiting.
+
+
+
+[![PyPI](https://img.shields.io/badge/PyPI-v13.0.16-blue)](https://pypi.org/project/snaptrade-python-sdk/13.0.16)
+[![README.md](https://img.shields.io/badge/README-Click%20Here-green)](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/python#readme)
+[![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
+
+</div>
+
+## Table of Contents<a id="table-of-contents"></a>
+
+<!-- toc -->
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Getting Started](#getting-started)
+- [Async](#async)
+- [Reference](#reference)
+  * [`snaptrade.account_information.get_account_activities`](#snaptradeaccount_informationget_account_activities)
+  * [`snaptrade.account_information.get_account_balance_history`](#snaptradeaccount_informationget_account_balance_history)
+  * [`snaptrade.account_information.get_all_account_positions`](#snaptradeaccount_informationget_all_account_positions)
+  * [`snaptrade.account_information.get_user_account_balance`](#snaptradeaccount_informationget_user_account_balance)
+  * [`snaptrade.account_information.get_user_account_details`](#snaptradeaccount_informationget_user_account_details)
+  * [`snaptrade.account_information.get_user_account_order_detail`](#snaptradeaccount_informationget_user_account_order_detail)
+  * [`snaptrade.account_information.get_user_account_orders`](#snaptradeaccount_informationget_user_account_orders)
+  * [`snaptrade.account_information.get_user_account_recent_orders`](#snaptradeaccount_informationget_user_account_recent_orders)
+  * [`snaptrade.account_information.get_user_account_return_rates`](#snaptradeaccount_informationget_user_account_return_rates)
+  * [`snaptrade.account_information.get_user_holdings`](#snaptradeaccount_informationget_user_holdings)
+  * [`snaptrade.account_information.list_user_accounts`](#snaptradeaccount_informationlist_user_accounts)
+  * [`snaptrade.account_information.update_user_account`](#snaptradeaccount_informationupdate_user_account)
+  * [`snaptrade.api_status.check`](#snaptradeapi_statuscheck)
+  * [`snaptrade.authentication.delete_snap_trade_user`](#snaptradeauthenticationdelete_snap_trade_user)
+  * [`snaptrade.authentication.list_snap_trade_users`](#snaptradeauthenticationlist_snap_trade_users)
+  * [`snaptrade.authentication.login_snap_trade_user`](#snaptradeauthenticationlogin_snap_trade_user)
+  * [`snaptrade.authentication.register_snap_trade_user`](#snaptradeauthenticationregister_snap_trade_user)
+  * [`snaptrade.authentication.reset_snap_trade_user_secret`](#snaptradeauthenticationreset_snap_trade_user_secret)
+  * [`snaptrade.connections.delete_connection`](#snaptradeconnectionsdelete_connection)
+  * [`snaptrade.connections.detail_brokerage_authorization`](#snaptradeconnectionsdetail_brokerage_authorization)
+  * [`snaptrade.connections.disable_brokerage_authorization`](#snaptradeconnectionsdisable_brokerage_authorization)
+  * [`snaptrade.connections.list_brokerage_authorization_accounts`](#snaptradeconnectionslist_brokerage_authorization_accounts)
+  * [`snaptrade.connections.list_brokerage_authorizations`](#snaptradeconnectionslist_brokerage_authorizations)
+  * [`snaptrade.connections.refresh_brokerage_authorization`](#snaptradeconnectionsrefresh_brokerage_authorization)
+  * [`snaptrade.connections.return_rates`](#snaptradeconnectionsreturn_rates)
+  * [`snaptrade.connections.sync_brokerage_authorization_transactions`](#snaptradeconnectionssync_brokerage_authorization_transactions)
+  * [`snaptrade.experimental_endpoints.add_subscription`](#snaptradeexperimental_endpointsadd_subscription)
+  * [`snaptrade.experimental_endpoints.cancel_subscription`](#snaptradeexperimental_endpointscancel_subscription)
+  * [`snaptrade.experimental_endpoints.get_user_account_order_detail_v2`](#snaptradeexperimental_endpointsget_user_account_order_detail_v2)
+  * [`snaptrade.experimental_endpoints.get_user_account_orders_v2`](#snaptradeexperimental_endpointsget_user_account_orders_v2)
+  * [`snaptrade.experimental_endpoints.get_user_account_recent_orders_v2`](#snaptradeexperimental_endpointsget_user_account_recent_orders_v2)
+  * [`snaptrade.experimental_endpoints.list_connection_accounts`](#snaptradeexperimental_endpointslist_connection_accounts)
+  * [`snaptrade.experimental_endpoints.list_subscriptions`](#snaptradeexperimental_endpointslist_subscriptions)
+  * [`snaptrade.reference_data.get_partner_info`](#snaptradereference_dataget_partner_info)
+  * [`snaptrade.reference_data.get_stock_exchanges`](#snaptradereference_dataget_stock_exchanges)
+  * [`snaptrade.reference_data.get_symbols`](#snaptradereference_dataget_symbols)
+  * [`snaptrade.reference_data.get_symbols_by_ticker`](#snaptradereference_dataget_symbols_by_ticker)
+  * [`snaptrade.reference_data.list_all_brokerage_authorization_type`](#snaptradereference_datalist_all_brokerage_authorization_type)
+  * [`snaptrade.reference_data.list_all_brokerage_instruments`](#snaptradereference_datalist_all_brokerage_instruments)
+  * [`snaptrade.reference_data.list_all_brokerages`](#snaptradereference_datalist_all_brokerages)
+  * [`snaptrade.reference_data.symbol_search_user_account`](#snaptradereference_datasymbol_search_user_account)
+  * [`snaptrade.trading.cancel_order`](#snaptradetradingcancel_order)
+  * [`snaptrade.trading.get_cryptocurrency_pair_quote`](#snaptradetradingget_cryptocurrency_pair_quote)
+  * [`snaptrade.trading.get_option_impact`](#snaptradetradingget_option_impact)
+  * [`snaptrade.trading.get_order_impact`](#snaptradetradingget_order_impact)
+  * [`snaptrade.trading.get_user_account_option_quotes`](#snaptradetradingget_user_account_option_quotes)
+  * [`snaptrade.trading.get_user_account_quotes`](#snaptradetradingget_user_account_quotes)
+  * [`snaptrade.trading.place_complex_order`](#snaptradetradingplace_complex_order)
+  * [`snaptrade.trading.place_crypto_order`](#snaptradetradingplace_crypto_order)
+  * [`snaptrade.trading.place_force_order`](#snaptradetradingplace_force_order)
+  * [`snaptrade.trading.place_mleg_order`](#snaptradetradingplace_mleg_order)
+  * [`snaptrade.trading.place_order`](#snaptradetradingplace_order)
+  * [`snaptrade.trading.preview_crypto_order`](#snaptradetradingpreview_crypto_order)
+  * [`snaptrade.trading.replace_order`](#snaptradetradingreplace_order)
+  * [`snaptrade.trading.search_cryptocurrency_pair_instruments`](#snaptradetradingsearch_cryptocurrency_pair_instruments)
+
+<!-- tocstop -->
+
+## Requirements<a id="requirements"></a>
+
+Python >=3.8
+
+## Installation<a id="installation"></a>
+
+```sh
+pip install snaptrade-python-sdk==13.0.16
+```
+
+## Getting Started<a id="getting-started"></a>
+
+```python
+# Commercial API key example: registers a SnapTrade user and uses userId/userSecret.
+import os
+import uuid
+from pprint import pprint
+from typing import List
+
+from snaptrade_client import SnapTrade, SnapTradeAuth
+
+# 1) Initialize a client with your clientID and consumerKey.
+snaptrade = SnapTrade(
+    auth=SnapTradeAuth.commercial_api_key(
+        consumer_key=os.environ["SNAPTRADE_CONSUMER_KEY"],
+        client_id=os.environ["SNAPTRADE_CLIENT_ID"],
+    )
+)
+
+# 2) Check that the client is able to make a request to the API server.
+api_response = snaptrade.api_status.check()
+pprint(api_response.body)
+
+# 3) Create a new user on SnapTrade
+user_id = str(uuid.uuid4())
+register_response = snaptrade.authentication.register_snap_trade_user(user_id=user_id)
+pprint(register_response.body)
+
+# Note: A user secret is only generated once. It's required to access
+# resources for certain endpoints.
+user_secret = register_response.body["userSecret"]
+
+# 4) Get a redirect URI. Users will need this to connect
+# their brokerage to the SnapTrade server.
+redirect_uri = snaptrade.authentication.login_snap_trade_user(
+    user_id=user_id,
+    user_secret=user_secret,
+)
+print(redirect_uri.body)
+
+input("Open the link in your browser. When done logging in, press Enter to continue...")
+
+# 5) Get a list of connections
+connections = snaptrade.connections.list(
+    user_id=user_id,
+    user_secret=user_secret,
+)
+pprint(connections.body)
+
+# 6) Get a list of accounts for the first connection, if available
+if not isinstance(connections.body, List) or len(connections.body) == 0:
+    print("No brokerage connections found for the user.")
+else:
+    accounts = snaptrade.connections.list_brokerage_authorization_accounts(
+        authorization_id=connections.body[0]["id"],
+        user_id=user_id,
+        user_secret=user_secret,
+    )
+    pprint(accounts.body)
+
+# 6) Deleting a user
+deleted_response = snaptrade.authentication.delete_snap_trade_user(user_id=user_id)
+pprint(deleted_response.body)
+```
+
+## Async<a id="async"></a>
+
+`async` support is available by prepending `a` to any method.
+
+```python
+import asyncio
+from pprint import pprint
+from snaptrade_client import SnapTrade, ApiException, SnapTradeAuth
+
+snaptrade = SnapTrade(
+    auth=SnapTradeAuth.commercial_api_key(
+        consumer_key="YOUR_CONSUMER_KEY",
+        client_id="YOUR_CLIENT_ID",
+    ),
+)
+
+
+async def main():
+    try:
+        # List account activities
+        get_account_activities_response = (
+            await snaptrade.account_information.aget_account_activities(
+                account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+                start_date="2022-01-24T00:00:00.000Z",
+                end_date="2022-01-24T00:00:00.000Z",
+                offset=0,
+                limit=1,
+                type="BUY,SELL,DIVIDEND",
+            )
+        )
+        pprint(get_account_activities_response.body)
+        pprint(get_account_activities_response.body["data"])
+        pprint(get_account_activities_response.body["pagination"])
+        pprint(get_account_activities_response.headers)
+        pprint(get_account_activities_response.status)
+        pprint(get_account_activities_response.round_trip_time)
+    except ApiException as e:
+        print(
+            "Exception when calling AccountInformationApi.get_account_activities: %s\n"
+            % e
+        )
+        pprint(e.body)
+        pprint(e.headers)
+        pprint(e.status)
+        pprint(e.reason)
+        pprint(e.round_trip_time)
+
+
+asyncio.run(main())
+```
+
+
+## Reference<a id="reference"></a>
+### `snaptrade.account_information.get_account_activities`<a id="snaptradeaccount_informationget_account_activities"></a>
+
+This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`.
+
+Returns all historical transactions for the specified account.
+
+This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options.
+
+Transaction are returned in reverse chronological order, using the `trade_date` field.
+
+This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
+
+If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_account_activities_response = snaptrade.account_information.get_account_activities(
+    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    start_date="2022-01-24T00:00:00.000Z",
+    end_date="2022-01-24T00:00:00.000Z",
+    offset=0,
+    limit=1,
+    type="BUY,SELL,DIVIDEND",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### start_date: `date`<a id="start_date-date"></a>
+
+The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
+
+##### end_date: `date`<a id="end_date-date"></a>
+
+The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
+
+##### offset: `int`<a id="offset-int"></a>
+
+An integer that specifies the starting point of the paginated results. Default is 0.
+
+##### limit: `int`<a id="limit-int"></a>
+
+An integer that specifies the maximum number of transactions to return. Default of 1000.
+
+##### type: `str`<a id="type-str"></a>
+
+Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `TAX` - A tax related fee.   - `OPTIONEXPIRATION` - Option expiration event.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.   - `TRANSFER` - Transfer of assets from one account to another.   - `SPLIT` - A stock share split. 
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`PaginatedUniversalActivity`](./snaptrade_client/type/paginated_universal_activity.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/activities` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.account_information.get_account_balance_history`<a id="snaptradeaccount_informationget_account_balance_history"></a>
+
+An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Enable this feature for free in the Add-on section of the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_account_balance_history_response = (
+    snaptrade.account_information.get_account_balance_history(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountValueHistoryResponse`](./snaptrade_client/type/account_value_history_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/balanceHistory` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.account_information.get_all_account_positions`<a id="snaptradeaccount_informationget_all_account_positions"></a>
+
+Returns a list of all positions in the specified account.
+
+The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, bonds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
+
+Positions counted in account cash balance or buying power include `cash_equivalent: true`. `stock`, `adr`, `etf`, `mutualfund`, and `crypto` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages).
+
+If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_all_account_positions_response = (
+    snaptrade.account_information.get_all_account_positions(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AllAccountPositionsResponse`](./snaptrade_client/type/all_account_positions_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/positions/all` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.account_information.get_user_account_balance`<a id="snaptradeaccount_informationget_user_account_balance"></a>
+
+Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).
+
+Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
+  - If you do, this endpoint returns real-time data.
+  - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
+
+If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_balance_response = (
+    snaptrade.account_information.get_user_account_balance(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`Balance`](./snaptrade_client/type/balance.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/balances` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.account_information.get_user_account_details`<a id="snaptradeaccount_informationget_user_account_details"></a>
+
+Returns account detail known to SnapTrade for the specified account.
+
+Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
+  - If you do, this endpoint returns real-time data.
+  - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
+
+If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_details_response = (
+    snaptrade.account_information.get_user_account_details(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`Account`](./snaptrade_client/type/account.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.account_information.get_user_account_order_detail`<a id="snaptradeaccount_informationget_user_account_order_detail"></a>
+
+Returns the detail of a single order using the external order ID provided in the request body.
+
+This endpoint only works for single-leg orders at this time. Support for multi-leg orders will be added in the future.
+
+This endpoint is always realtime and does not rely on cached data.
+
+This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_order_detail_response = (
+    snaptrade.account_information.get_user_account_order_detail(
+        brokerage_order_id="66a033fa-da74-4fcf-b527-feefdec9257e",
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### brokerage_order_id: `str`<a id="brokerage_order_id-str"></a>
+
+Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`Any`](./snaptrade_client/type/typing_any.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrderRecord`](./snaptrade_client/type/account_order_record.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/orders/details` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.account_information.get_user_account_orders`<a id="snaptradeaccount_informationget_user_account_orders"></a>
+
+Returns a list of recent orders in the specified account.
+
+Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
+  - If you do, this endpoint returns real-time data.
+  - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
+
+If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_orders_response = (
+    snaptrade.account_information.get_user_account_orders(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        state="all",
+        days=30,
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### state: `str`<a id="state-str"></a>
+
+defaults to \"all\"
+
+##### days: `int`<a id="days-int"></a>
+
+Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Values greater than 90 will be capped at 90.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrderRecord`](./snaptrade_client/type/account_order_record.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/orders` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.account_information.get_user_account_recent_orders`<a id="snaptradeaccount_informationget_user_account_recent_orders"></a>
+
+A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders.
+This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders
+Differs from /orders in that it is always realtime, and only checks the last 24 hours
+By default only returns executed orders, but that can be changed by setting *only_executed* to false
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_recent_orders_response = (
+    snaptrade.account_information.get_user_account_recent_orders(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        only_executed=True,
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### only_executed: `bool`<a id="only_executed-bool"></a>
+
+Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`RecentOrdersResponse`](./snaptrade_client/type/recent_orders_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/recentOrders` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.account_information.get_user_account_return_rates`<a id="snaptradeaccount_informationget_user_account_return_rates"></a>
+
+Returns a list of rate of return percents for a given account.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_return_rates_response = (
+    snaptrade.account_information.get_user_account_return_rates(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        timeframes="ALL,1Y",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### timeframes: `str`<a id="timeframes-str"></a>
+
+Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`RateOfReturnResponse`](./snaptrade_client/type/rate_of_return_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/returnRates` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.account_information.get_user_holdings`<a id="snaptradeaccount_informationget_user_holdings"></a>
+![Deprecated](https://img.shields.io/badge/deprecated-yellow)
+
+**Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders).
+
+This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026.
+
+Returns a list of balances, positions, and recent orders for the specified account.
+
+Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
+  - If you do, this endpoint returns real-time data.
+  - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
+
+If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_holdings_response = snaptrade.account_information.get_user_holdings(
+    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountHoldingsAccount`](./snaptrade_client/type/account_holdings_account.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/holdings` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.account_information.list_user_accounts`<a id="snaptradeaccount_informationlist_user_accounts"></a>
+
+Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
+
+This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+list_user_accounts_response = snaptrade.account_information.list_user_accounts()
+```
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`Account`](./snaptrade_client/type/account.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.account_information.update_user_account`<a id="snaptradeaccount_informationupdate_user_account"></a>
+
+Updates various properties of a specified account.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+update_user_account_response = snaptrade.account_information.update_user_account(
+    account_id="accountId_example",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+The ID of the account to update.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`Account`](./snaptrade_client/type/account.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}` `put`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.api_status.check`<a id="snaptradeapi_statuscheck"></a>
+
+Check whether the API is operational and verify timestamps.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+check_response = snaptrade.api_status.check()
+```
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`Status`](./snaptrade_client/type/status.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.authentication.delete_snap_trade_user`<a id="snaptradeauthenticationdelete_snap_trade_user"></a>
+
+Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+delete_snap_trade_user_response = snaptrade.authentication.delete_snap_trade_user()
+```
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`DeleteUserResponse`](./snaptrade_client/type/delete_user_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/snapTrade/deleteUser` `delete`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.authentication.list_snap_trade_users`<a id="snaptradeauthenticationlist_snap_trade_users"></a>
+
+Returns a list of all registered user IDs. Please note that the response is not currently paginated.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+list_snap_trade_users_response = snaptrade.authentication.list_snap_trade_users()
+```
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`UserList`](./snaptrade_client/type/user_list.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/snapTrade/listUsers` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.authentication.login_snap_trade_user`<a id="snaptradeauthenticationlogin_snap_trade_user"></a>
+
+Authenticates a SnapTrade user and returns the Connection Portal URL used for connecting brokerage accounts. Please check [this guide](/docs/implement-connection-portal) for how to integrate the Connection Portal into your app.
+
+Please note that the returned URL expires in 5 minutes.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+login_snap_trade_user_response = snaptrade.authentication.login_snap_trade_user(
+    broker="ALPACA",
+    immediate_redirect=True,
+    custom_redirect="https://snaptrade.com",
+    reconnect="8b5f262d-4bb9-365d-888a-202bd3b15fa1",
+    connection_type="read",
+    show_close_button=True,
+    dark_mode=True,
+    locale="pt-BR",
+    connection_portal_version="v4",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### broker: `str`<a id="broker-str"></a>
+
+Slug of the brokerage to connect the user to. See [the integrations page](https://support.snaptrade.com/brokerages) for a list of supported brokerages and their slugs.
+
+##### immediate_redirect: `bool`<a id="immediate_redirect-bool"></a>
+
+When set to `true`, user will be redirected back to the partner's site instead of the connection portal. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](/docs/implement-connection-portal) for more information.
+
+##### custom_redirect: `str`<a id="custom_redirect-str"></a>
+
+URL to redirect the user to after the user connects their brokerage account. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](/docs/implement-connection-portal) for more information.
+
+##### reconnect: `str`<a id="reconnect-str"></a>
+
+The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See the [guide on fixing broken connections](/docs/fix-broken-connections) for more information.
+
+##### connection_type: `str`<a id="connection_type-str"></a>
+
+Determines connection permissions (default: read) - `read`: Data access only. - `trade`: Data and trading access. - `trade-if-available`: Attempts to establish a trading connection if the brokerage supports it, otherwise falls back to read-only access automatically. 
+
+##### show_close_button: `bool`<a id="show_close_button-bool"></a>
+
+Controls whether the close (X) button is displayed in the connection portal. When false, you control closing behavior from your app. Defaults to true.
+
+##### dark_mode: `bool`<a id="dark_mode-bool"></a>
+
+Enable dark mode for the connection portal. Defaults to false.
+
+##### locale: `str`<a id="locale-str"></a>
+
+Language the connection portal renders in. `en` and `pt-BR` are the languages we ship; any other language is rejected with a 400. Matching is case- and separator-insensitive, so `pt-br`, `pt-BR` and `pt_BR` are equivalent, and a regional tag resolves to the language when we ship it, so `en-US` renders `en`. Deliberately not an enum: those equivalent spellings are all accepted by the API, and an enum would have generated SDKs reject them before the request is sent. Screens without translated copy fall back to English individually. Defaults to `en`. 
+
+##### connection_portal_version: `str`<a id="connection_portal_version-str"></a>
+
+Sets the connection portal version to render. Currently only `v4` is supported and is the default. All other versions are deprecated and will automatically be set to v4.
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`SnapTradeLoginUserRequestBody`](./snaptrade_client/type/snap_trade_login_user_request_body.py)
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/snapTrade/login` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.authentication.register_snap_trade_user`<a id="snaptradeauthenticationregister_snap_trade_user"></a>
+
+Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system.
+Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+register_snap_trade_user_response = snaptrade.authentication.register_snap_trade_user(
+    user_id="snaptrade-user-123",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### user_id: `str`<a id="user_id-str"></a>
+
+SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`SnapTradeRegisterUserRequestBody`](./snaptrade_client/type/snap_trade_register_user_request_body.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`UserIDandSecret`](./snaptrade_client/type/user_i_dand_secret.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/snapTrade/registerUser` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.authentication.reset_snap_trade_user_secret`<a id="snaptradeauthenticationreset_snap_trade_user_secret"></a>
+
+Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+reset_snap_trade_user_secret_response = (
+    snaptrade.authentication.reset_snap_trade_user_secret(
+        user_id="snaptrade-user-123",
+        user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### user_id: `str`<a id="user_id-str"></a>
+
+SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
+
+##### user_secret: `str`<a id="user_secret-str"></a>
+
+SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`UserIDandSecret`](./snaptrade_client/type/user_i_dand_secret.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`UserIDandSecret`](./snaptrade_client/type/user_i_dand_secret.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/snapTrade/resetUserSecret` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.connections.delete_connection`<a id="snaptradeconnectionsdelete_connection"></a>
+
+Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+delete_connection_response = snaptrade.connections.delete_connection(
+    connection_id="87b24961-b51e-4db8-9226-f198f6518a89",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### connection_id: `str`<a id="connection_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`DeleteConnectionConfirmation`](./snaptrade_client/type/delete_connection_confirmation.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/connection/{connectionId}` `delete`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.connections.detail_brokerage_authorization`<a id="snaptradeconnectionsdetail_brokerage_authorization"></a>
+
+Returns a single connection for the specified ID.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+detail_brokerage_authorization_response = (
+    snaptrade.connections.detail_brokerage_authorization(
+        authorization_id="87b24961-b51e-4db8-9226-f198f6518a89",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### authorization_id: `str`<a id="authorization_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`BrokerageAuthorization`](./snaptrade_client/type/brokerage_authorization.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/authorizations/{authorizationId}` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.connections.disable_brokerage_authorization`<a id="snaptradeconnectionsdisable_brokerage_authorization"></a>
+
+Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections.
+Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection.
+
+This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support as it is disabled by default.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+disable_brokerage_authorization_response = (
+    snaptrade.connections.disable_brokerage_authorization(
+        authorization_id="87b24961-b51e-4db8-9226-f198f6518a89",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### authorization_id: `str`<a id="authorization_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`BrokerageAuthorizationDisabledConfirmation`](./snaptrade_client/type/brokerage_authorization_disabled_confirmation.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/authorizations/{authorizationId}/disable` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.connections.list_brokerage_authorization_accounts`<a id="snaptradeconnectionslist_brokerage_authorization_accounts"></a>
+
+Returns all brokerage accounts that belong to the specified connection for the authenticated user.
+
+On Pay as you Go / Real-time, this endpoint refreshes each account's opening date, funding date, and total value live from the brokerage on each call.
+
+On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
+
+Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+list_brokerage_authorization_accounts_response = (
+    snaptrade.connections.list_brokerage_authorization_accounts(
+        authorization_id="87b24961-b51e-4db8-9226-f198f6518a89",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### authorization_id: `str`<a id="authorization_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`Account`](./snaptrade_client/type/account.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/authorizations/{authorizationId}/accounts` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.connections.list_brokerage_authorizations`<a id="snaptradeconnectionslist_brokerage_authorizations"></a>
+
+Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.
+
+A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.
+
+SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+list_brokerage_authorizations_response = (
+    snaptrade.connections.list_brokerage_authorizations()
+)
+```
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`BrokerageAuthorization`](./snaptrade_client/type/brokerage_authorization.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/authorizations` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.connections.refresh_brokerage_authorization`<a id="snaptradeconnectionsrefresh_brokerage_authorization"></a>
+
+Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.
+This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
+
+**Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
+**Please note this endpoint is disabled for Real-time plans (Personal and Pay as you go) unless SnapTrade uses delayed data for the connection. Real-time connections do not benefit from this feature since data is refreshed when calls are made. Refer to `data_freshness_mode.snaptrade` on a connection to determine this.**
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+refresh_brokerage_authorization_response = (
+    snaptrade.connections.refresh_brokerage_authorization(
+        authorization_id="87b24961-b51e-4db8-9226-f198f6518a89",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### authorization_id: `str`<a id="authorization_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`BrokerageAuthorizationRefreshConfirmation`](./snaptrade_client/type/brokerage_authorization_refresh_confirmation.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/authorizations/{authorizationId}/refresh` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.connections.return_rates`<a id="snaptradeconnectionsreturn_rates"></a>
+
+Returns a list of rate of return percents for a given connection.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+return_rates_response = snaptrade.connections.return_rates(
+    authorization_id="87b24961-b51e-4db8-9226-f198f6518a89",
+    timeframes="ALL,1Y",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### authorization_id: `str`<a id="authorization_id-str"></a>
+
+##### timeframes: `str`<a id="timeframes-str"></a>
+
+Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`RateOfReturnResponse`](./snaptrade_client/type/rate_of_return_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/authorizations/{authorizationId}/returnRates` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.connections.sync_brokerage_authorization_transactions`<a id="snaptradeconnectionssync_brokerage_authorization_transactions"></a>
+
+Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day's transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+sync_brokerage_authorization_transactions_response = (
+    snaptrade.connections.sync_brokerage_authorization_transactions(
+        authorization_id="87b24961-b51e-4db8-9226-f198f6518a89",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### authorization_id: `str`<a id="authorization_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`BrokerageAuthorizationTransactionsSyncConfirmation`](./snaptrade_client/type/brokerage_authorization_transactions_sync_confirmation.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/authorizations/{authorizationId}/transactions/sync` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.experimental_endpoints.add_subscription`<a id="snaptradeexperimental_endpointsadd_subscription"></a>
+
+Adds or restores a Trade Detection subscription for a connected brokerage account.
+This endpoint requires `userId` and `userSecret` in addition to the partner signature.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+add_subscription_response = snaptrade.experimental_endpoints.add_subscription(
+    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    check_interval_seconds=300,
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
+
+##### check_interval_seconds: `int`<a id="check_interval_seconds-int"></a>
+
+How often the subscribed account should be checked for new trades. Must match an active Trade Detection plan.
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`Any`](./snaptrade_client/type/typing_any.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`TradeDetectionSubscription`](./snaptrade_client/type/trade_detection_subscription.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/snapTrade/tradeDetection/subscriptions` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.experimental_endpoints.cancel_subscription`<a id="snaptradeexperimental_endpointscancel_subscription"></a>
+
+Cancels a Trade Detection subscription for a connected brokerage account.
+This endpoint requires partner signature authentication only and does not require `userId` or `userSecret`.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+cancel_subscription_response = snaptrade.experimental_endpoints.cancel_subscription(
+    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`Any`](./snaptrade_client/type/typing_any.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`TradeDetectionCancelSubscriptionResponse`](./snaptrade_client/type/trade_detection_cancel_subscription_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/snapTrade/tradeDetection/subscriptions/cancel` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.experimental_endpoints.get_user_account_order_detail_v2`<a id="snaptradeexperimental_endpointsget_user_account_order_detail_v2"></a>
+
+Returns the detail of a single order using the brokerage order ID provided as a path parameter.
+
+The V2 order response format includes all legs of the order in the `legs` list field.
+If the order is single legged, `legs` will be a list of one leg.
+
+This endpoint is always realtime and does not rely on cached data.
+
+This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_order_detail_v2_response = (
+    snaptrade.experimental_endpoints.get_user_account_order_detail_v2(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        brokerage_order_id="66a033fa-da74-4fcf-b527-feefdec9257e",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### brokerage_order_id: `str`<a id="brokerage_order_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrderRecordV2`](./snaptrade_client/type/account_order_record_v2.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/orders/details/v2/{brokerageOrderId}` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.experimental_endpoints.get_user_account_orders_v2`<a id="snaptradeexperimental_endpointsget_user_account_orders_v2"></a>
+
+Returns a list of recent orders in the specified account.
+
+The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.
+
+If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_orders_v2_response = (
+    snaptrade.experimental_endpoints.get_user_account_orders_v2(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        state="all",
+        days=30,
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### state: `str`<a id="state-str"></a>
+
+defaults to \"all\"
+
+##### days: `int`<a id="days-int"></a>
+
+Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Values greater than 90 will be capped at 90.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrdersV2Response`](./snaptrade_client/type/account_orders_v2_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/orders/v2` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.experimental_endpoints.get_user_account_recent_orders_v2`<a id="snaptradeexperimental_endpointsget_user_account_recent_orders_v2"></a>
+
+A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format.
+This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders.
+Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days.
+By default only returns executed orders, but that can be changed by setting *only_executed* to false.
+**Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_recent_orders_v2_response = (
+    snaptrade.experimental_endpoints.get_user_account_recent_orders_v2(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        only_executed=True,
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### only_executed: `bool`<a id="only_executed-bool"></a>
+
+Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrdersV2Response`](./snaptrade_client/type/account_orders_v2_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/recentOrders/v2` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.experimental_endpoints.list_connection_accounts`<a id="snaptradeexperimental_endpointslist_connection_accounts"></a>
+
+Experimental and subject to change without notice.
+
+Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape.
+
+Each item in the response carries a `kind` field (`investment`, `deposit`, and `line_of_credit` are implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema.
+
+On Pay as you Go / Real-time, this endpoint refreshes each account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
+
+On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
+
+Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+list_connection_accounts_response = (
+    snaptrade.experimental_endpoints.list_connection_accounts(
+        connection_id="87b24961-b51e-4db8-9226-f198f6518a89",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### connection_id: `str`<a id="connection_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`ConnectionAccount`](./snaptrade_client/type/connection_account.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/connections/{connectionId}/accounts` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.experimental_endpoints.list_subscriptions`<a id="snaptradeexperimental_endpointslist_subscriptions"></a>
+
+Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+list_subscriptions_response = snaptrade.experimental_endpoints.list_subscriptions()
+```
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`TradeDetectionSubscription`](./snaptrade_client/type/trade_detection_subscription.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/snapTrade/tradeDetection/subscriptions` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.reference_data.get_partner_info`<a id="snaptradereference_dataget_partner_info"></a>
+
+Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_partner_info_response = snaptrade.reference_data.get_partner_info()
+```
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`PartnerData`](./snaptrade_client/type/partner_data.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/snapTrade/partners` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.reference_data.get_stock_exchanges`<a id="snaptradereference_dataget_stock_exchanges"></a>
+
+Returns a list of all supported Exchanges.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_stock_exchanges_response = snaptrade.reference_data.get_stock_exchanges()
+```
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`Exchange`](./snaptrade_client/type/exchange.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/exchanges` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.reference_data.get_symbols`<a id="snaptradereference_dataget_symbols"></a>
+
+Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_symbols_response = snaptrade.reference_data.get_symbols(
+    substring="AAPL",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### substring: `str`<a id="substring-str"></a>
+
+The search query for symbols.
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`SymbolQuery`](./snaptrade_client/type/symbol_query.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`UniversalSymbol`](./snaptrade_client/type/universal_symbol.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/symbols` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.reference_data.get_symbols_by_ticker`<a id="snaptradereference_dataget_symbols_by_ticker"></a>
+
+Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_symbols_by_ticker_response = snaptrade.reference_data.get_symbols_by_ticker(
+    query="query_example",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### query: `str`<a id="query-str"></a>
+
+The ticker or Universal Symbol ID to look up the symbol with.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`UniversalSymbol`](./snaptrade_client/type/universal_symbol.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/symbols/{query}` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.reference_data.list_all_brokerage_authorization_type`<a id="snaptradereference_datalist_all_brokerage_authorization_type"></a>
+
+Returns a list of all defined Brokerage authorization Type objects.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+list_all_brokerage_authorization_type_response = (
+    snaptrade.reference_data.list_all_brokerage_authorization_type(
+        brokerage="QUESTRADE,ALPACA",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### brokerage: `str`<a id="brokerage-str"></a>
+
+Comma separated value of brokerage slugs
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`BrokerageAuthorizationTypeReadOnly`](./snaptrade_client/type/brokerage_authorization_type_read_only.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/brokerageAuthorizationTypes` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.reference_data.list_all_brokerage_instruments`<a id="snaptradereference_datalist_all_brokerage_instruments"></a>
+
+Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+list_all_brokerage_instruments_response = (
+    snaptrade.reference_data.list_all_brokerage_instruments(
+        slug="QUESTRADE",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### slug: `str`<a id="slug-str"></a>
+
+A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`BrokerageInstrumentsResponse`](./snaptrade_client/type/brokerage_instruments_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/brokerages/{slug}/instruments` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.reference_data.list_all_brokerages`<a id="snaptradereference_datalist_all_brokerages"></a>
+
+Returns a list of all defined Brokerage objects.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+list_all_brokerages_response = snaptrade.reference_data.list_all_brokerages()
+```
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`Brokerage`](./snaptrade_client/type/brokerage.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/brokerages` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.reference_data.symbol_search_user_account`<a id="snaptradereference_datasymbol_search_user_account"></a>
+
+Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
+
+The search results are further limited to the symbols supported by the brokerage for which the account is under.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+symbol_search_user_account_response = (
+    snaptrade.reference_data.symbol_search_user_account(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        substring="AAPL",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### substring: `str`<a id="substring-str"></a>
+
+The search query for symbols.
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`SymbolQuery`](./snaptrade_client/type/symbol_query.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`UniversalSymbol`](./snaptrade_client/type/universal_symbol.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/symbols` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.trading.cancel_order`<a id="snaptradetradingcancel_order"></a>
+
+Cancels an order in the specified account. Accepts order IDs for all asset types.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+cancel_order_response = snaptrade.trading.cancel_order(
+    brokerage_order_id="66a033fa-da74-4fcf-b527-feefdec9257e",
+    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### brokerage_order_id: `str`<a id="brokerage_order_id-str"></a>
+
+Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`Any`](./snaptrade_client/type/typing_any.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`CancelOrderResponse`](./snaptrade_client/type/cancel_order_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/trading/cancel` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.trading.get_cryptocurrency_pair_quote`<a id="snaptradetradingget_cryptocurrency_pair_quote"></a>
+
+Gets a quote for the specified account.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_cryptocurrency_pair_quote_response = (
+    snaptrade.trading.get_cryptocurrency_pair_quote(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        instrument_symbol="BTC-USD",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### instrument_symbol: `str`<a id="instrument_symbol-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`CryptocurrencyPairQuote`](./snaptrade_client/type/cryptocurrency_pair_quote.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/trading/instruments/cryptocurrencyPairs/{instrumentSymbol}/quote` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.trading.get_option_impact`<a id="snaptradetradingget_option_impact"></a>
+
+Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it.
+Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_option_impact_response = snaptrade.trading.get_option_impact(
+    order_type="MARKET",
+    time_in_force="Day",
+    legs=[
+        {
+            "instrument": {
+                "symbol": "PBI   250718C00006000",
+                "instrument_type": "OPTION",
+            },
+            "action": "BUY_TO_OPEN",
+            "units": 1,
+        }
+    ],
+    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    limit_price="",
+    stop_price="",
+    price_effect="DEBIT",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### order_type: [`MlegOrderTypeStrict`](./snaptrade_client/type/mleg_order_type_strict.py)<a id="order_type-mlegordertypestrictsnaptrade_clienttypemleg_order_type_strictpy"></a>
+
+##### time_in_force: [`TimeInForceStrict`](./snaptrade_client/type/time_in_force_strict.py)<a id="time_in_force-timeinforcestrictsnaptrade_clienttypetime_in_force_strictpy"></a>
+
+##### legs: List[`MlegLeg`]<a id="legs-listmlegleg"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### limit_price: `Optional[str]`<a id="limit_price-optionalstr"></a>
+
+The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT`, unless `price_effect` is `EVEN` - a net-even order is implicitly priced at 0, so the field may be omitted and must be `0` if sent.
+
+##### stop_price: `Optional[str]`<a id="stop_price-optionalstr"></a>
+
+The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`.
+
+##### price_effect: [`MlegPriceEffectStrictNullable`](./snaptrade_client/type/mleg_price_effect_strict_nullable.py)<a id="price_effect-mlegpriceeffectstrictnullablesnaptrade_clienttypemleg_price_effect_strict_nullablepy"></a>
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`MlegTradeForm`](./snaptrade_client/type/mleg_trade_form.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`OptionImpact`](./snaptrade_client/type/option_impact.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/trading/options/impact` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.trading.get_order_impact`<a id="snaptradetradingget_order_impact"></a>
+
+Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_order_impact_response = snaptrade.trading.get_order_impact(
+    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    action="BUY",
+    universal_symbol_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
+    order_type="Market",
+    time_in_force="Day",
+    price=31.33,
+    stop=31.33,
+    units=10.5,
+    notional_value=None,
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
+
+##### action: [`ActionStrict`](./snaptrade_client/type/action_strict.py)<a id="action-actionstrictsnaptrade_clienttypeaction_strictpy"></a>
+
+##### universal_symbol_id: `str`<a id="universal_symbol_id-str"></a>
+
+Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+
+##### order_type: [`OrderTypeStrict`](./snaptrade_client/type/order_type_strict.py)<a id="order_type-ordertypestrictsnaptrade_clienttypeorder_type_strictpy"></a>
+
+##### time_in_force: [`TimeInForceStrict`](./snaptrade_client/type/time_in_force_strict.py)<a id="time_in_force-timeinforcestrictsnaptrade_clienttypetime_in_force_strictpy"></a>
+
+##### price: `Optional[Union[int, float]]`<a id="price-optionalunionint-float"></a>
+
+The limit price for `Limit` and `StopLimit` orders.
+
+##### stop: `Optional[Union[int, float]]`<a id="stop-optionalunionint-float"></a>
+
+The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
+
+##### units: [`UnitsNullable`](./snaptrade_client/type/units_nullable.py)<a id="units-unitsnullablesnaptrade_clienttypeunits_nullablepy"></a>
+
+##### notional_value: `NotionalValueNullable`<a id="notional_value-notionalvaluenullable"></a>
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`ManualTradeForm`](./snaptrade_client/type/manual_trade_form.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`ManualTradeAndImpact`](./snaptrade_client/type/manual_trade_and_impact.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/trade/impact` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.trading.get_user_account_option_quotes`<a id="snaptradetradingget_user_account_option_quotes"></a>
+![Deprecated](https://img.shields.io/badge/deprecated-yellow)
+
+Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format)
+**Note:** These are derived values and are not suitable for trading purposes.
+
+**This Endpoint is deprecated and will cease to return data as of October 1, 2026**
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_option_quotes_response = (
+    snaptrade.trading.get_user_account_option_quotes(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        symbol="AAPL  251219C00150000",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### symbol: `str`<a id="symbol-str"></a>
+
+The OCC-formatted option symbol.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`OptionQuote`](./snaptrade_client/type/option_quote.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/quotes/options` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.trading.get_user_account_quotes`<a id="snaptradetradingget_user_account_quotes"></a>
+
+Returns a maximum of 10 quotes from the brokerage for the specified symbols and account.
+
+The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.
+
+**This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys**
+
+This endpoint does not work for options quotes.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_quotes_response = snaptrade.trading.get_user_account_quotes(
+    symbols="symbols_example",
+    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    use_ticker=True,
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### symbols: `str`<a id="symbols-str"></a>
+
+List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### use_ticker: `bool`<a id="use_ticker-bool"></a>
+
+Should be set to `True` if `symbols` are comprised of tickers. Defaults to `False` if not provided.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`SymbolsQuotes`](./snaptrade_client/type/symbols_quotes.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/quotes` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.trading.place_complex_order`<a id="snaptradetradingplace_complex_order"></a>
+
+Places a complex conditional order (OCO, OTO, or OTOCO).
+Only supported on certain brokerages.
+Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for details on which brokerages support complex orders and which types they support.
+
+- **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled.
+- **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order.
+- **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+place_complex_order_response = snaptrade.trading.place_complex_order(
+    type="OTO",
+    orders=[
+        {
+            "order_role": "TRIGGER",
+            "action": "BUY",
+            "instrument": {
+                "symbol": "AAPL",
+                "type": "EQUITY",
+            },
+            "order_type": "Market",
+            "units": 10.5,
+            "time_in_force": "Day",
+            "price": 31.33,
+            "stop": 29.5,
+        }
+    ],
+    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    client_order_id="550e8400-e29b-41d4-a716-446655440000",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### type: `str`<a id="type-str"></a>
+
+The complex order type. - `OCO`: One Cancels the Other — two peer orders. - `OTO`: One Triggers the Other — a trigger order and a conditional order. - `OTOCO`: One Triggers a One Cancels the Other — a trigger order and two peer orders. 
+
+##### orders: List[`ComplexOrderLeg`]<a id="orders-listcomplexorderleg"></a>
+
+The orders that make up the complex order. Required counts and roles per type: - `OCO`: exactly 2 orders, both `PEER` - `OTO`: exactly 2 orders, one `TRIGGER` and one `CONDITIONAL` - `OTOCO`: exactly 3 orders, one `TRIGGER` and two `PEER` 
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+The ID of the account to execute the trade on.
+
+##### client_order_id: [`ClientOrderIDNullable`](./snaptrade_client/type/client_order_id_nullable.py)<a id="client_order_id-clientorderidnullablesnaptrade_clienttypeclient_order_id_nullablepy"></a>
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`ManualTradeFormComplex`](./snaptrade_client/type/manual_trade_form_complex.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`ComplexOrderResponse`](./snaptrade_client/type/complex_order_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/trading/complex` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.trading.place_crypto_order`<a id="snaptradetradingplace_crypto_order"></a>
+
+Places an order in the specified account.
+This endpoint does not compute the impact to the account balance from the order before submitting the order.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+place_crypto_order_response = snaptrade.trading.place_crypto_order(
+    instrument={
+        "symbol": "BTC",
+        "type": "CRYPTOCURRENCY",
+    },
+    side="BUY",
+    type="MARKET",
+    time_in_force="GTC",
+    amount="123.45",
+    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    limit_price="123.45",
+    stop_price="123.45",
+    post_only=False,
+    expiration_date="2024-01-01T00:00:00.000Z",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### instrument: [`CryptoTradingInstrument`](./snaptrade_client/type/crypto_trading_instrument.py)<a id="instrument-cryptotradinginstrumentsnaptrade_clienttypecrypto_trading_instrumentpy"></a>
+
+
+##### side: [`ActionStrict`](./snaptrade_client/type/action_strict.py)<a id="side-actionstrictsnaptrade_clienttypeaction_strictpy"></a>
+
+##### type: `str`<a id="type-str"></a>
+
+The type of order to place.
+
+##### time_in_force: `str`<a id="time_in_force-str"></a>
+
+The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.   - `GTD` - Good Til Date. The order is valid until the specified date. 
+
+##### amount: `str`<a id="amount-str"></a>
+
+The amount of the base currency to buy or sell.
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### limit_price: `str`<a id="limit_price-str"></a>
+
+The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
+
+##### stop_price: `str`<a id="stop_price-str"></a>
+
+The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_MARKET` or `TAKE_PROFIT_LIMIT`.
+
+##### post_only: `bool`<a id="post_only-bool"></a>
+
+Valid and required only for order type `LIMIT`. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
+
+##### expiration_date: `datetime`<a id="expiration_date-datetime"></a>
+
+The expiration date of the order. Required if the time_in_force is `GTD`.
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`CryptoOrderForm`](./snaptrade_client/type/crypto_order_form.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`OrderUpdatedResponse`](./snaptrade_client/type/order_updated_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/trading/crypto` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.trading.place_force_order`<a id="snaptradetradingplace_force_order"></a>
+
+Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.
+
+This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).
+
+It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+place_force_order_response = snaptrade.trading.place_force_order(
+    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    action="BUY",
+    order_type="Market",
+    time_in_force="Day",
+    universal_symbol_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
+    symbol="AAPL",
+    trading_session="REGULAR",
+    expiry_date="2026-08-21T23:27:55.027Z",
+    price=31.33,
+    stop=31.33,
+    units=10.5,
+    notional_value=None,
+    client_order_id="550e8400-e29b-41d4-a716-446655440000",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
+
+##### action: [`ActionStrictWithOptions`](./snaptrade_client/type/action_strict_with_options.py)<a id="action-actionstrictwithoptionssnaptrade_clienttypeaction_strict_with_optionspy"></a>
+
+##### order_type: [`OrderTypeStrict`](./snaptrade_client/type/order_type_strict.py)<a id="order_type-ordertypestrictsnaptrade_clienttypeorder_type_strictpy"></a>
+
+##### time_in_force: [`ManualTradePlaceTimeInForceStrict`](./snaptrade_client/type/manual_trade_place_time_in_force_strict.py)<a id="time_in_force-manualtradeplacetimeinforcestrictsnaptrade_clienttypemanual_trade_place_time_in_force_strictpy"></a>
+
+##### universal_symbol_id: [`UniversalSymbolIDNullable`](./snaptrade_client/type/universal_symbol_id_nullable.py)<a id="universal_symbol_id-universalsymbolidnullablesnaptrade_clienttypeuniversal_symbol_id_nullablepy"></a>
+
+The universal symbol ID of the security to trade. Must be 'null' if `symbol` is provided, otherwise must be provided.
+
+##### symbol: `Optional[str]`<a id="symbol-optionalstr"></a>
+
+The security's trading ticker symbol. If 'symbol' is provided, then 'universal_symbol_id' must be 'null'.
+
+##### trading_session: [`TradingSession`](./snaptrade_client/type/trading_session.py)<a id="trading_session-tradingsessionsnaptrade_clienttypetrading_sessionpy"></a>
+
+##### expiry_date: `Optional[datetime]`<a id="expiry_date-optionaldatetime"></a>
+
+Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the order expires. Required when `time_in_force` is `GTD`. Include a timezone offset or `Z` for UTC; if no timezone is provided, UTC is assumed. GTD orders are only available on certain brokerages. Visit https://support.snaptrade.com/brokerages for brokerage support.
+
+##### price: `Optional[Union[int, float]]`<a id="price-optionalunionint-float"></a>
+
+The limit price for `Limit` and `StopLimit` orders.
+
+##### stop: `Optional[Union[int, float]]`<a id="stop-optionalunionint-float"></a>
+
+The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
+
+##### units: [`UnitsNullable`](./snaptrade_client/type/units_nullable.py)<a id="units-unitsnullablesnaptrade_clienttypeunits_nullablepy"></a>
+
+For Equity orders, this represents the number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided. If placing an Option order, this field represents the number of contracts to buy or sell. (e.g., 1 contract = 100 shares).
+
+##### notional_value: `NotionalValueNullable`<a id="notional_value-notionalvaluenullable"></a>
+
+##### client_order_id: [`ClientOrderIDNullable`](./snaptrade_client/type/client_order_id_nullable.py)<a id="client_order_id-clientorderidnullablesnaptrade_clienttypeclient_order_id_nullablepy"></a>
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`ManualTradeFormWithOptions`](./snaptrade_client/type/manual_trade_form_with_options.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrderRecord`](./snaptrade_client/type/account_order_record.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/trade/place` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.trading.place_mleg_order`<a id="snaptradetradingplace_mleg_order"></a>
+
+Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+place_mleg_order_response = snaptrade.trading.place_mleg_order(
+    order_type="MARKET",
+    time_in_force="Day",
+    legs=[
+        {
+            "instrument": {
+                "symbol": "PBI   250718C00006000",
+                "instrument_type": "OPTION",
+            },
+            "action": "BUY_TO_OPEN",
+            "units": 1,
+        }
+    ],
+    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    limit_price="",
+    stop_price="",
+    price_effect="DEBIT",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### order_type: [`MlegOrderTypeStrict`](./snaptrade_client/type/mleg_order_type_strict.py)<a id="order_type-mlegordertypestrictsnaptrade_clienttypemleg_order_type_strictpy"></a>
+
+##### time_in_force: [`TimeInForceStrict`](./snaptrade_client/type/time_in_force_strict.py)<a id="time_in_force-timeinforcestrictsnaptrade_clienttypetime_in_force_strictpy"></a>
+
+##### legs: List[`MlegLeg`]<a id="legs-listmlegleg"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### limit_price: `Optional[str]`<a id="limit_price-optionalstr"></a>
+
+The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT`, unless `price_effect` is `EVEN` - a net-even order is implicitly priced at 0, so the field may be omitted and must be `0` if sent.
+
+##### stop_price: `Optional[str]`<a id="stop_price-optionalstr"></a>
+
+The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`.
+
+##### price_effect: [`MlegPriceEffectStrictNullable`](./snaptrade_client/type/mleg_price_effect_strict_nullable.py)<a id="price_effect-mlegpriceeffectstrictnullablesnaptrade_clienttypemleg_price_effect_strict_nullablepy"></a>
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`MlegTradeForm`](./snaptrade_client/type/mleg_trade_form.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`MlegOrderResponse`](./snaptrade_client/type/mleg_order_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/trading/options` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.trading.place_order`<a id="snaptradetradingplace_order"></a>
+
+Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder).
+
+It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+place_order_response = snaptrade.trading.place_order(
+    trade_id="139e307a-82f7-4402-b39e-4da7baa87758",
+    wait_to_confirm=True,
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### trade_id: `str`<a id="trade_id-str"></a>
+
+Obtained from calling the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact)
+
+##### wait_to_confirm: `Optional[bool]`<a id="wait_to_confirm-optionalbool"></a>
+
+Optional, defaults to true. Determines if a wait is performed to check on order status. If false, latency will be reduced but orders returned will be more likely to be of status `PENDING` as we will not wait to check on the status before responding to the request.
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`ValidatedTradeBody`](./snaptrade_client/type/validated_trade_body.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrderRecord`](./snaptrade_client/type/account_order_record.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/trade/{tradeId}` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.trading.preview_crypto_order`<a id="snaptradetradingpreview_crypto_order"></a>
+
+Previews an order using the specified account.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+preview_crypto_order_response = snaptrade.trading.preview_crypto_order(
+    instrument={
+        "symbol": "BTC",
+        "type": "CRYPTOCURRENCY",
+    },
+    side="BUY",
+    type="MARKET",
+    time_in_force="GTC",
+    amount="123.45",
+    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    limit_price="123.45",
+    stop_price="123.45",
+    post_only=False,
+    expiration_date="2024-01-01T00:00:00.000Z",
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### instrument: [`CryptoTradingInstrument`](./snaptrade_client/type/crypto_trading_instrument.py)<a id="instrument-cryptotradinginstrumentsnaptrade_clienttypecrypto_trading_instrumentpy"></a>
+
+
+##### side: [`ActionStrict`](./snaptrade_client/type/action_strict.py)<a id="side-actionstrictsnaptrade_clienttypeaction_strictpy"></a>
+
+##### type: `str`<a id="type-str"></a>
+
+The type of order to place.
+
+##### time_in_force: `str`<a id="time_in_force-str"></a>
+
+The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.   - `GTD` - Good Til Date. The order is valid until the specified date. 
+
+##### amount: `str`<a id="amount-str"></a>
+
+The amount of the base currency to buy or sell.
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### limit_price: `str`<a id="limit_price-str"></a>
+
+The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
+
+##### stop_price: `str`<a id="stop_price-str"></a>
+
+The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_MARKET` or `TAKE_PROFIT_LIMIT`.
+
+##### post_only: `bool`<a id="post_only-bool"></a>
+
+Valid and required only for order type `LIMIT`. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
+
+##### expiration_date: `datetime`<a id="expiration_date-datetime"></a>
+
+The expiration date of the order. Required if the time_in_force is `GTD`.
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`CryptoOrderForm`](./snaptrade_client/type/crypto_order_form.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`CryptoOrderPreview`](./snaptrade_client/type/crypto_order_preview.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/trading/crypto/preview` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.trading.replace_order`<a id="snaptradetradingreplace_order"></a>
+
+Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling
+the existing order and placing a new one. The order's brokerage_order_id may or may not change, be sure to use the one
+returned in the response going forward. Only supported on some brokerages
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+replace_order_response = snaptrade.trading.replace_order(
+    brokerage_order_id="66a033fa-da74-4fcf-b527-feefdec9257e",
+    action="BUY",
+    order_type="Market",
+    time_in_force="Day",
+    account_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
+    price=31.33,
+    symbol="AAPL",
+    stop=31.33,
+    units=10.5,
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### brokerage_order_id: `str`<a id="brokerage_order_id-str"></a>
+
+Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+
+##### action: [`ActionStrictWithOptions`](./snaptrade_client/type/action_strict_with_options.py)<a id="action-actionstrictwithoptionssnaptrade_clienttypeaction_strict_with_optionspy"></a>
+
+##### order_type: [`OrderTypeStrict`](./snaptrade_client/type/order_type_strict.py)<a id="order_type-ordertypestrictsnaptrade_clienttypeorder_type_strictpy"></a>
+
+##### time_in_force: [`TimeInForceStrict`](./snaptrade_client/type/time_in_force_strict.py)<a id="time_in_force-timeinforcestrictsnaptrade_clienttypetime_in_force_strictpy"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+The ID of the account to execute the trade on.
+
+##### price: `Optional[Union[int, float]]`<a id="price-optionalunionint-float"></a>
+
+The limit price for `Limit` and `StopLimit` orders.
+
+##### symbol: `str`<a id="symbol-str"></a>
+
+The security's trading ticker symbol. Use the OCC symbol to replace an option order.
+
+##### stop: `Optional[Union[int, float]]`<a id="stop-optionalunionint-float"></a>
+
+The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
+
+##### units: [`UnitsNullable`](./snaptrade_client/type/units_nullable.py)<a id="units-unitsnullablesnaptrade_clienttypeunits_nullablepy"></a>
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`ManualTradeReplaceForm`](./snaptrade_client/type/manual_trade_replace_form.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrderRecord`](./snaptrade_client/type/account_order_record.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/trading/replace` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.trading.search_cryptocurrency_pair_instruments`<a id="snaptradetradingsearch_cryptocurrency_pair_instruments"></a>
+
+Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+search_cryptocurrency_pair_instruments_response = (
+    snaptrade.trading.search_cryptocurrency_pair_instruments(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        base="BTC",
+        quote="USD",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### base: `str`<a id="base-str"></a>
+
+##### quote: `str`<a id="quote-str"></a>
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/trading/instruments/cryptocurrencyPairs` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
+## Author<a id="author"></a>
+This Python package is automatically generated by [Konfig](https://konfigthis.com)
+