snaptrade-typescript-sdk 12.2.3 → 12.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1377 -166
- package/dist/browser.umd.js +1 -1
- package/dist/index.cjs +295 -246
- package/dist/index.d.cts +246 -148
- package/dist/index.d.mts +246 -148
- package/dist/index.d.ts +246 -148
- package/dist/index.mjs +295 -246
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -7716,7 +7716,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7716
7716
|
* @param {*} [options] Override http request option.
|
|
7717
7717
|
* @throws {RequiredError}
|
|
7718
7718
|
*/
|
|
7719
|
-
getAccountActivities(
|
|
7719
|
+
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedUniversalActivity>>;
|
|
7720
7720
|
/**
|
|
7721
7721
|
* 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)
|
|
7722
7722
|
* @summary List historical account total value
|
|
@@ -7724,7 +7724,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7724
7724
|
* @param {*} [options] Override http request option.
|
|
7725
7725
|
* @throws {RequiredError}
|
|
7726
7726
|
*/
|
|
7727
|
-
getAccountBalanceHistory(
|
|
7727
|
+
getAccountBalanceHistory(...args: AccountInformationApiGetAccountBalanceHistoryArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountValueHistoryResponse>>;
|
|
7728
7728
|
/**
|
|
7729
7729
|
* 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.
|
|
7730
7730
|
* @summary List all account positions
|
|
@@ -7732,7 +7732,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7732
7732
|
* @param {*} [options] Override http request option.
|
|
7733
7733
|
* @throws {RequiredError}
|
|
7734
7734
|
*/
|
|
7735
|
-
getAllAccountPositions(
|
|
7735
|
+
getAllAccountPositions(...args: AccountInformationApiGetAllAccountPositionsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AllAccountPositionsResponse>>;
|
|
7736
7736
|
/**
|
|
7737
7737
|
* 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.
|
|
7738
7738
|
* @summary List account balances
|
|
@@ -7740,7 +7740,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7740
7740
|
* @param {*} [options] Override http request option.
|
|
7741
7741
|
* @throws {RequiredError}
|
|
7742
7742
|
*/
|
|
7743
|
-
getUserAccountBalance(
|
|
7743
|
+
getUserAccountBalance(...args: AccountInformationApiGetUserAccountBalanceArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Balance>>>;
|
|
7744
7744
|
/**
|
|
7745
7745
|
* 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.
|
|
7746
7746
|
* @summary Get account detail
|
|
@@ -7748,7 +7748,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7748
7748
|
* @param {*} [options] Override http request option.
|
|
7749
7749
|
* @throws {RequiredError}
|
|
7750
7750
|
*/
|
|
7751
|
-
getUserAccountDetails(
|
|
7751
|
+
getUserAccountDetails(...args: AccountInformationApiGetUserAccountDetailsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Account>>;
|
|
7752
7752
|
/**
|
|
7753
7753
|
* 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.
|
|
7754
7754
|
* @summary Get account order detail
|
|
@@ -7756,7 +7756,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7756
7756
|
* @param {*} [options] Override http request option.
|
|
7757
7757
|
* @throws {RequiredError}
|
|
7758
7758
|
*/
|
|
7759
|
-
getUserAccountOrderDetail(
|
|
7759
|
+
getUserAccountOrderDetail(...args: AccountInformationApiGetUserAccountOrderDetailArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
7760
7760
|
/**
|
|
7761
7761
|
* 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.
|
|
7762
7762
|
* @summary List account orders
|
|
@@ -7764,7 +7764,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7764
7764
|
* @param {*} [options] Override http request option.
|
|
7765
7765
|
* @throws {RequiredError}
|
|
7766
7766
|
*/
|
|
7767
|
-
getUserAccountOrders(
|
|
7767
|
+
getUserAccountOrders(...args: AccountInformationApiGetUserAccountOrdersArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountOrderRecord>>>;
|
|
7768
7768
|
/**
|
|
7769
7769
|
* 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
|
|
7770
7770
|
* @summary List account recent orders (last 24 hours only)
|
|
@@ -7772,7 +7772,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7772
7772
|
* @param {*} [options] Override http request option.
|
|
7773
7773
|
* @throws {RequiredError}
|
|
7774
7774
|
*/
|
|
7775
|
-
getUserAccountRecentOrders(
|
|
7775
|
+
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecentOrdersResponse>>;
|
|
7776
7776
|
/**
|
|
7777
7777
|
* Returns a list of rate of return percents for a given account.
|
|
7778
7778
|
* @summary List account rate of returns
|
|
@@ -7780,7 +7780,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7780
7780
|
* @param {*} [options] Override http request option.
|
|
7781
7781
|
* @throws {RequiredError}
|
|
7782
7782
|
*/
|
|
7783
|
-
getUserAccountReturnRates(
|
|
7783
|
+
getUserAccountReturnRates(...args: AccountInformationApiGetUserAccountReturnRatesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RateOfReturnResponse>>;
|
|
7784
7784
|
/**
|
|
7785
7785
|
* **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.
|
|
7786
7786
|
* @summary List account holdings
|
|
@@ -7789,7 +7789,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7789
7789
|
* @deprecated
|
|
7790
7790
|
* @throws {RequiredError}
|
|
7791
7791
|
*/
|
|
7792
|
-
getUserHoldings(
|
|
7792
|
+
getUserHoldings(...args: AccountInformationApiGetUserHoldingsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountHoldingsAccount>>;
|
|
7793
7793
|
/**
|
|
7794
7794
|
* 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).
|
|
7795
7795
|
* @summary List accounts
|
|
@@ -7797,7 +7797,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7797
7797
|
* @param {*} [options] Override http request option.
|
|
7798
7798
|
* @throws {RequiredError}
|
|
7799
7799
|
*/
|
|
7800
|
-
listUserAccounts(
|
|
7800
|
+
listUserAccounts(...args: AccountInformationApiListUserAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Account>>>;
|
|
7801
7801
|
/**
|
|
7802
7802
|
* Updates various properties of a specified account.
|
|
7803
7803
|
* @summary Update details of an investment account
|
|
@@ -7805,7 +7805,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7805
7805
|
* @param {*} [options] Override http request option.
|
|
7806
7806
|
* @throws {RequiredError}
|
|
7807
7807
|
*/
|
|
7808
|
-
updateUserAccount(
|
|
7808
|
+
updateUserAccount(...args: AccountInformationApiUpdateUserAccountArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Account>>>;
|
|
7809
7809
|
};
|
|
7810
7810
|
/**
|
|
7811
7811
|
* AccountInformationApi - factory interface
|
|
@@ -7819,7 +7819,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7819
7819
|
* @param {*} [options] Override http request option.
|
|
7820
7820
|
* @throws {RequiredError}
|
|
7821
7821
|
*/
|
|
7822
|
-
getAccountActivities(
|
|
7822
|
+
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): AxiosPromise<PaginatedUniversalActivity>;
|
|
7823
7823
|
/**
|
|
7824
7824
|
* 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)
|
|
7825
7825
|
* @summary List historical account total value
|
|
@@ -7827,7 +7827,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7827
7827
|
* @param {*} [options] Override http request option.
|
|
7828
7828
|
* @throws {RequiredError}
|
|
7829
7829
|
*/
|
|
7830
|
-
getAccountBalanceHistory(
|
|
7830
|
+
getAccountBalanceHistory(...args: AccountInformationApiGetAccountBalanceHistoryArgs<TAuth>): AxiosPromise<AccountValueHistoryResponse>;
|
|
7831
7831
|
/**
|
|
7832
7832
|
* 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.
|
|
7833
7833
|
* @summary List all account positions
|
|
@@ -7835,7 +7835,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7835
7835
|
* @param {*} [options] Override http request option.
|
|
7836
7836
|
* @throws {RequiredError}
|
|
7837
7837
|
*/
|
|
7838
|
-
getAllAccountPositions(
|
|
7838
|
+
getAllAccountPositions(...args: AccountInformationApiGetAllAccountPositionsArgs<TAuth>): AxiosPromise<AllAccountPositionsResponse>;
|
|
7839
7839
|
/**
|
|
7840
7840
|
* 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.
|
|
7841
7841
|
* @summary List account balances
|
|
@@ -7843,7 +7843,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7843
7843
|
* @param {*} [options] Override http request option.
|
|
7844
7844
|
* @throws {RequiredError}
|
|
7845
7845
|
*/
|
|
7846
|
-
getUserAccountBalance(
|
|
7846
|
+
getUserAccountBalance(...args: AccountInformationApiGetUserAccountBalanceArgs<TAuth>): AxiosPromise<Array<Balance>>;
|
|
7847
7847
|
/**
|
|
7848
7848
|
* 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.
|
|
7849
7849
|
* @summary Get account detail
|
|
@@ -7851,7 +7851,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7851
7851
|
* @param {*} [options] Override http request option.
|
|
7852
7852
|
* @throws {RequiredError}
|
|
7853
7853
|
*/
|
|
7854
|
-
getUserAccountDetails(
|
|
7854
|
+
getUserAccountDetails(...args: AccountInformationApiGetUserAccountDetailsArgs<TAuth>): AxiosPromise<Account>;
|
|
7855
7855
|
/**
|
|
7856
7856
|
* 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.
|
|
7857
7857
|
* @summary Get account order detail
|
|
@@ -7859,7 +7859,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7859
7859
|
* @param {*} [options] Override http request option.
|
|
7860
7860
|
* @throws {RequiredError}
|
|
7861
7861
|
*/
|
|
7862
|
-
getUserAccountOrderDetail(
|
|
7862
|
+
getUserAccountOrderDetail(...args: AccountInformationApiGetUserAccountOrderDetailArgs<TAuth>): AxiosPromise<AccountOrderRecord>;
|
|
7863
7863
|
/**
|
|
7864
7864
|
* 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.
|
|
7865
7865
|
* @summary List account orders
|
|
@@ -7867,7 +7867,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7867
7867
|
* @param {*} [options] Override http request option.
|
|
7868
7868
|
* @throws {RequiredError}
|
|
7869
7869
|
*/
|
|
7870
|
-
getUserAccountOrders(
|
|
7870
|
+
getUserAccountOrders(...args: AccountInformationApiGetUserAccountOrdersArgs<TAuth>): AxiosPromise<Array<AccountOrderRecord>>;
|
|
7871
7871
|
/**
|
|
7872
7872
|
* 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
|
|
7873
7873
|
* @summary List account recent orders (last 24 hours only)
|
|
@@ -7875,7 +7875,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7875
7875
|
* @param {*} [options] Override http request option.
|
|
7876
7876
|
* @throws {RequiredError}
|
|
7877
7877
|
*/
|
|
7878
|
-
getUserAccountRecentOrders(
|
|
7878
|
+
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): AxiosPromise<RecentOrdersResponse>;
|
|
7879
7879
|
/**
|
|
7880
7880
|
* Returns a list of rate of return percents for a given account.
|
|
7881
7881
|
* @summary List account rate of returns
|
|
@@ -7883,7 +7883,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7883
7883
|
* @param {*} [options] Override http request option.
|
|
7884
7884
|
* @throws {RequiredError}
|
|
7885
7885
|
*/
|
|
7886
|
-
getUserAccountReturnRates(
|
|
7886
|
+
getUserAccountReturnRates(...args: AccountInformationApiGetUserAccountReturnRatesArgs<TAuth>): AxiosPromise<RateOfReturnResponse>;
|
|
7887
7887
|
/**
|
|
7888
7888
|
* **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.
|
|
7889
7889
|
* @summary List account holdings
|
|
@@ -7892,7 +7892,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7892
7892
|
* @deprecated
|
|
7893
7893
|
* @throws {RequiredError}
|
|
7894
7894
|
*/
|
|
7895
|
-
getUserHoldings(
|
|
7895
|
+
getUserHoldings(...args: AccountInformationApiGetUserHoldingsArgs<TAuth>): AxiosPromise<AccountHoldingsAccount>;
|
|
7896
7896
|
/**
|
|
7897
7897
|
* 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).
|
|
7898
7898
|
* @summary List accounts
|
|
@@ -7900,7 +7900,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7900
7900
|
* @param {*} [options] Override http request option.
|
|
7901
7901
|
* @throws {RequiredError}
|
|
7902
7902
|
*/
|
|
7903
|
-
listUserAccounts(
|
|
7903
|
+
listUserAccounts(...args: AccountInformationApiListUserAccountsArgs<TAuth>): AxiosPromise<Array<Account>>;
|
|
7904
7904
|
/**
|
|
7905
7905
|
* Updates various properties of a specified account.
|
|
7906
7906
|
* @summary Update details of an investment account
|
|
@@ -7908,7 +7908,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7908
7908
|
* @param {*} [options] Override http request option.
|
|
7909
7909
|
* @throws {RequiredError}
|
|
7910
7910
|
*/
|
|
7911
|
-
updateUserAccount(
|
|
7911
|
+
updateUserAccount(...args: AccountInformationApiUpdateUserAccountArgs<TAuth>): AxiosPromise<Array<Account>>;
|
|
7912
7912
|
};
|
|
7913
7913
|
/**
|
|
7914
7914
|
* Request parameters for getAccountActivities operation in AccountInformationApi.
|
|
@@ -7965,6 +7965,8 @@ type AccountInformationApiGetAccountActivitiesRequestByAuthMode = {
|
|
|
7965
7965
|
"personalApiKey": AccountInformationApiGetAccountActivitiespersonalApiKeyRequest;
|
|
7966
7966
|
};
|
|
7967
7967
|
type AccountInformationApiGetAccountActivitiesRequest<TAuth extends AuthMode> = AccountInformationApiGetAccountActivitiesRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiGetAccountActivitiesRequestByAuthMode];
|
|
7968
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
7969
|
+
type AccountInformationApiGetAccountActivitiesArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: AccountInformationApiGetAccountActivitiesRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AccountInformationApiGetAccountActivitiesRequest<TAuth>, options?: AxiosRequestConfig];
|
|
7968
7970
|
/**
|
|
7969
7971
|
* Request parameters for getAccountBalanceHistory operation in AccountInformationApi.
|
|
7970
7972
|
* @export
|
|
@@ -7990,6 +7992,8 @@ type AccountInformationApiGetAccountBalanceHistoryRequestByAuthMode = {
|
|
|
7990
7992
|
"personalApiKey": AccountInformationApiGetAccountBalanceHistorypersonalApiKeyRequest;
|
|
7991
7993
|
};
|
|
7992
7994
|
type AccountInformationApiGetAccountBalanceHistoryRequest<TAuth extends AuthMode> = AccountInformationApiGetAccountBalanceHistoryRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiGetAccountBalanceHistoryRequestByAuthMode];
|
|
7995
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
7996
|
+
type AccountInformationApiGetAccountBalanceHistoryArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>, options?: AxiosRequestConfig];
|
|
7993
7997
|
/**
|
|
7994
7998
|
* Request parameters for getAllAccountPositions operation in AccountInformationApi.
|
|
7995
7999
|
* @export
|
|
@@ -8015,6 +8019,8 @@ type AccountInformationApiGetAllAccountPositionsRequestByAuthMode = {
|
|
|
8015
8019
|
"personalApiKey": AccountInformationApiGetAllAccountPositionspersonalApiKeyRequest;
|
|
8016
8020
|
};
|
|
8017
8021
|
type AccountInformationApiGetAllAccountPositionsRequest<TAuth extends AuthMode> = AccountInformationApiGetAllAccountPositionsRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiGetAllAccountPositionsRequestByAuthMode];
|
|
8022
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8023
|
+
type AccountInformationApiGetAllAccountPositionsArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: AccountInformationApiGetAllAccountPositionsRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AccountInformationApiGetAllAccountPositionsRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8018
8024
|
/**
|
|
8019
8025
|
* Request parameters for getUserAccountBalance operation in AccountInformationApi.
|
|
8020
8026
|
* @export
|
|
@@ -8040,6 +8046,8 @@ type AccountInformationApiGetUserAccountBalanceRequestByAuthMode = {
|
|
|
8040
8046
|
"personalApiKey": AccountInformationApiGetUserAccountBalancepersonalApiKeyRequest;
|
|
8041
8047
|
};
|
|
8042
8048
|
type AccountInformationApiGetUserAccountBalanceRequest<TAuth extends AuthMode> = AccountInformationApiGetUserAccountBalanceRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiGetUserAccountBalanceRequestByAuthMode];
|
|
8049
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8050
|
+
type AccountInformationApiGetUserAccountBalanceArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: AccountInformationApiGetUserAccountBalanceRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AccountInformationApiGetUserAccountBalanceRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8043
8051
|
/**
|
|
8044
8052
|
* Request parameters for getUserAccountDetails operation in AccountInformationApi.
|
|
8045
8053
|
* @export
|
|
@@ -8065,6 +8073,8 @@ type AccountInformationApiGetUserAccountDetailsRequestByAuthMode = {
|
|
|
8065
8073
|
"personalApiKey": AccountInformationApiGetUserAccountDetailspersonalApiKeyRequest;
|
|
8066
8074
|
};
|
|
8067
8075
|
type AccountInformationApiGetUserAccountDetailsRequest<TAuth extends AuthMode> = AccountInformationApiGetUserAccountDetailsRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiGetUserAccountDetailsRequestByAuthMode];
|
|
8076
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8077
|
+
type AccountInformationApiGetUserAccountDetailsArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: AccountInformationApiGetUserAccountDetailsRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AccountInformationApiGetUserAccountDetailsRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8068
8078
|
/**
|
|
8069
8079
|
* Request parameters for getUserAccountOrderDetail operation in AccountInformationApi.
|
|
8070
8080
|
* @export
|
|
@@ -8090,6 +8100,8 @@ type AccountInformationApiGetUserAccountOrderDetailRequestByAuthMode = {
|
|
|
8090
8100
|
"personalApiKey": AccountInformationApiGetUserAccountOrderDetailpersonalApiKeyRequest;
|
|
8091
8101
|
};
|
|
8092
8102
|
type AccountInformationApiGetUserAccountOrderDetailRequest<TAuth extends AuthMode> = AccountInformationApiGetUserAccountOrderDetailRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiGetUserAccountOrderDetailRequestByAuthMode];
|
|
8103
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8104
|
+
type AccountInformationApiGetUserAccountOrderDetailArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: AccountInformationApiGetUserAccountOrderDetailRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AccountInformationApiGetUserAccountOrderDetailRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8093
8105
|
/**
|
|
8094
8106
|
* Request parameters for getUserAccountOrders operation in AccountInformationApi.
|
|
8095
8107
|
* @export
|
|
@@ -8127,6 +8139,8 @@ type AccountInformationApiGetUserAccountOrdersRequestByAuthMode = {
|
|
|
8127
8139
|
"personalApiKey": AccountInformationApiGetUserAccountOrderspersonalApiKeyRequest;
|
|
8128
8140
|
};
|
|
8129
8141
|
type AccountInformationApiGetUserAccountOrdersRequest<TAuth extends AuthMode> = AccountInformationApiGetUserAccountOrdersRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiGetUserAccountOrdersRequestByAuthMode];
|
|
8142
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8143
|
+
type AccountInformationApiGetUserAccountOrdersArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: AccountInformationApiGetUserAccountOrdersRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AccountInformationApiGetUserAccountOrdersRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8130
8144
|
/**
|
|
8131
8145
|
* Request parameters for getUserAccountRecentOrders operation in AccountInformationApi.
|
|
8132
8146
|
* @export
|
|
@@ -8158,6 +8172,8 @@ type AccountInformationApiGetUserAccountRecentOrdersRequestByAuthMode = {
|
|
|
8158
8172
|
"personalApiKey": AccountInformationApiGetUserAccountRecentOrderspersonalApiKeyRequest;
|
|
8159
8173
|
};
|
|
8160
8174
|
type AccountInformationApiGetUserAccountRecentOrdersRequest<TAuth extends AuthMode> = AccountInformationApiGetUserAccountRecentOrdersRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiGetUserAccountRecentOrdersRequestByAuthMode];
|
|
8175
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8176
|
+
type AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: AccountInformationApiGetUserAccountRecentOrdersRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AccountInformationApiGetUserAccountRecentOrdersRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8161
8177
|
/**
|
|
8162
8178
|
* Request parameters for getUserAccountReturnRates operation in AccountInformationApi.
|
|
8163
8179
|
* @export
|
|
@@ -8189,6 +8205,8 @@ type AccountInformationApiGetUserAccountReturnRatesRequestByAuthMode = {
|
|
|
8189
8205
|
"personalApiKey": AccountInformationApiGetUserAccountReturnRatespersonalApiKeyRequest;
|
|
8190
8206
|
};
|
|
8191
8207
|
type AccountInformationApiGetUserAccountReturnRatesRequest<TAuth extends AuthMode> = AccountInformationApiGetUserAccountReturnRatesRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiGetUserAccountReturnRatesRequestByAuthMode];
|
|
8208
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8209
|
+
type AccountInformationApiGetUserAccountReturnRatesArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: AccountInformationApiGetUserAccountReturnRatesRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8192
8210
|
/**
|
|
8193
8211
|
* Request parameters for getUserHoldings operation in AccountInformationApi.
|
|
8194
8212
|
* @export
|
|
@@ -8214,6 +8232,8 @@ type AccountInformationApiGetUserHoldingsRequestByAuthMode = {
|
|
|
8214
8232
|
"personalApiKey": AccountInformationApiGetUserHoldingspersonalApiKeyRequest;
|
|
8215
8233
|
};
|
|
8216
8234
|
type AccountInformationApiGetUserHoldingsRequest<TAuth extends AuthMode> = AccountInformationApiGetUserHoldingsRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiGetUserHoldingsRequestByAuthMode];
|
|
8235
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8236
|
+
type AccountInformationApiGetUserHoldingsArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: AccountInformationApiGetUserHoldingsRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AccountInformationApiGetUserHoldingsRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8217
8237
|
/**
|
|
8218
8238
|
* Request parameters for listUserAccounts operation in AccountInformationApi.
|
|
8219
8239
|
* @export
|
|
@@ -8232,6 +8252,8 @@ type AccountInformationApiListUserAccountsRequestByAuthMode = {
|
|
|
8232
8252
|
"personalApiKey": AccountInformationApiListUserAccountspersonalApiKeyRequest;
|
|
8233
8253
|
};
|
|
8234
8254
|
type AccountInformationApiListUserAccountsRequest<TAuth extends AuthMode> = AccountInformationApiListUserAccountsRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiListUserAccountsRequestByAuthMode];
|
|
8255
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8256
|
+
type AccountInformationApiListUserAccountsArgs<TAuth extends AuthMode> = TAuth["mode"] extends "personalApiKey" ? [requestParameters?: AccountInformationApiListUserAccountsRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AccountInformationApiListUserAccountsRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8235
8257
|
/**
|
|
8236
8258
|
* Request parameters for updateUserAccount operation in AccountInformationApi.
|
|
8237
8259
|
* @export
|
|
@@ -8257,6 +8279,8 @@ type AccountInformationApiUpdateUserAccountRequestByAuthMode = {
|
|
|
8257
8279
|
"personalApiKey": AccountInformationApiUpdateUserAccountpersonalApiKeyRequest;
|
|
8258
8280
|
};
|
|
8259
8281
|
type AccountInformationApiUpdateUserAccountRequest<TAuth extends AuthMode> = AccountInformationApiUpdateUserAccountRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiUpdateUserAccountRequestByAuthMode];
|
|
8282
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8283
|
+
type AccountInformationApiUpdateUserAccountArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: AccountInformationApiUpdateUserAccountRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AccountInformationApiUpdateUserAccountRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8260
8284
|
/**
|
|
8261
8285
|
* AccountInformationApiGenerated - object-oriented interface
|
|
8262
8286
|
* @export
|
|
@@ -8272,7 +8296,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8272
8296
|
* @throws {RequiredError}
|
|
8273
8297
|
* @memberof AccountInformationApiGenerated
|
|
8274
8298
|
*/
|
|
8275
|
-
getAccountActivities(
|
|
8299
|
+
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): Promise<_$axios.AxiosResponse<PaginatedUniversalActivity, any, {}>>;
|
|
8276
8300
|
/**
|
|
8277
8301
|
* 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)
|
|
8278
8302
|
* @summary List historical account total value
|
|
@@ -8281,7 +8305,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8281
8305
|
* @throws {RequiredError}
|
|
8282
8306
|
* @memberof AccountInformationApiGenerated
|
|
8283
8307
|
*/
|
|
8284
|
-
getAccountBalanceHistory(
|
|
8308
|
+
getAccountBalanceHistory(...args: AccountInformationApiGetAccountBalanceHistoryArgs<TAuth>): Promise<_$axios.AxiosResponse<AccountValueHistoryResponse, any, {}>>;
|
|
8285
8309
|
/**
|
|
8286
8310
|
* 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.
|
|
8287
8311
|
* @summary List all account positions
|
|
@@ -8290,7 +8314,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8290
8314
|
* @throws {RequiredError}
|
|
8291
8315
|
* @memberof AccountInformationApiGenerated
|
|
8292
8316
|
*/
|
|
8293
|
-
getAllAccountPositions(
|
|
8317
|
+
getAllAccountPositions(...args: AccountInformationApiGetAllAccountPositionsArgs<TAuth>): Promise<_$axios.AxiosResponse<AllAccountPositionsResponse, any, {}>>;
|
|
8294
8318
|
/**
|
|
8295
8319
|
* 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.
|
|
8296
8320
|
* @summary List account balances
|
|
@@ -8299,7 +8323,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8299
8323
|
* @throws {RequiredError}
|
|
8300
8324
|
* @memberof AccountInformationApiGenerated
|
|
8301
8325
|
*/
|
|
8302
|
-
getUserAccountBalance(
|
|
8326
|
+
getUserAccountBalance(...args: AccountInformationApiGetUserAccountBalanceArgs<TAuth>): Promise<_$axios.AxiosResponse<Balance[], any, {}>>;
|
|
8303
8327
|
/**
|
|
8304
8328
|
* 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.
|
|
8305
8329
|
* @summary Get account detail
|
|
@@ -8308,7 +8332,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8308
8332
|
* @throws {RequiredError}
|
|
8309
8333
|
* @memberof AccountInformationApiGenerated
|
|
8310
8334
|
*/
|
|
8311
|
-
getUserAccountDetails(
|
|
8335
|
+
getUserAccountDetails(...args: AccountInformationApiGetUserAccountDetailsArgs<TAuth>): Promise<_$axios.AxiosResponse<Account, any, {}>>;
|
|
8312
8336
|
/**
|
|
8313
8337
|
* 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.
|
|
8314
8338
|
* @summary Get account order detail
|
|
@@ -8317,7 +8341,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8317
8341
|
* @throws {RequiredError}
|
|
8318
8342
|
* @memberof AccountInformationApiGenerated
|
|
8319
8343
|
*/
|
|
8320
|
-
getUserAccountOrderDetail(
|
|
8344
|
+
getUserAccountOrderDetail(...args: AccountInformationApiGetUserAccountOrderDetailArgs<TAuth>): Promise<_$axios.AxiosResponse<AccountOrderRecord, any, {}>>;
|
|
8321
8345
|
/**
|
|
8322
8346
|
* 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.
|
|
8323
8347
|
* @summary List account orders
|
|
@@ -8326,7 +8350,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8326
8350
|
* @throws {RequiredError}
|
|
8327
8351
|
* @memberof AccountInformationApiGenerated
|
|
8328
8352
|
*/
|
|
8329
|
-
getUserAccountOrders(
|
|
8353
|
+
getUserAccountOrders(...args: AccountInformationApiGetUserAccountOrdersArgs<TAuth>): Promise<_$axios.AxiosResponse<AccountOrderRecord[], any, {}>>;
|
|
8330
8354
|
/**
|
|
8331
8355
|
* 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
|
|
8332
8356
|
* @summary List account recent orders (last 24 hours only)
|
|
@@ -8335,7 +8359,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8335
8359
|
* @throws {RequiredError}
|
|
8336
8360
|
* @memberof AccountInformationApiGenerated
|
|
8337
8361
|
*/
|
|
8338
|
-
getUserAccountRecentOrders(
|
|
8362
|
+
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): Promise<_$axios.AxiosResponse<RecentOrdersResponse, any, {}>>;
|
|
8339
8363
|
/**
|
|
8340
8364
|
* Returns a list of rate of return percents for a given account.
|
|
8341
8365
|
* @summary List account rate of returns
|
|
@@ -8344,7 +8368,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8344
8368
|
* @throws {RequiredError}
|
|
8345
8369
|
* @memberof AccountInformationApiGenerated
|
|
8346
8370
|
*/
|
|
8347
|
-
getUserAccountReturnRates(
|
|
8371
|
+
getUserAccountReturnRates(...args: AccountInformationApiGetUserAccountReturnRatesArgs<TAuth>): Promise<_$axios.AxiosResponse<RateOfReturnResponse, any, {}>>;
|
|
8348
8372
|
/**
|
|
8349
8373
|
* **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.
|
|
8350
8374
|
* @summary List account holdings
|
|
@@ -8354,7 +8378,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8354
8378
|
* @throws {RequiredError}
|
|
8355
8379
|
* @memberof AccountInformationApiGenerated
|
|
8356
8380
|
*/
|
|
8357
|
-
getUserHoldings(
|
|
8381
|
+
getUserHoldings(...args: AccountInformationApiGetUserHoldingsArgs<TAuth>): Promise<_$axios.AxiosResponse<AccountHoldingsAccount, any, {}>>;
|
|
8358
8382
|
/**
|
|
8359
8383
|
* 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).
|
|
8360
8384
|
* @summary List accounts
|
|
@@ -8363,7 +8387,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8363
8387
|
* @throws {RequiredError}
|
|
8364
8388
|
* @memberof AccountInformationApiGenerated
|
|
8365
8389
|
*/
|
|
8366
|
-
listUserAccounts(
|
|
8390
|
+
listUserAccounts(...args: AccountInformationApiListUserAccountsArgs<TAuth>): Promise<_$axios.AxiosResponse<Account[], any, {}>>;
|
|
8367
8391
|
/**
|
|
8368
8392
|
* Updates various properties of a specified account.
|
|
8369
8393
|
* @summary Update details of an investment account
|
|
@@ -8372,7 +8396,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8372
8396
|
* @throws {RequiredError}
|
|
8373
8397
|
* @memberof AccountInformationApiGenerated
|
|
8374
8398
|
*/
|
|
8375
|
-
updateUserAccount(
|
|
8399
|
+
updateUserAccount(...args: AccountInformationApiUpdateUserAccountArgs<TAuth>): Promise<_$axios.AxiosResponse<Account[], any, {}>>;
|
|
8376
8400
|
}
|
|
8377
8401
|
//#endregion
|
|
8378
8402
|
//#region api/account-information-api.d.ts
|
|
@@ -8498,7 +8522,7 @@ declare const AuthenticationApiFp: <TAuth extends AuthMode>(configuration?: Conf
|
|
|
8498
8522
|
* @param {*} [options] Override http request option.
|
|
8499
8523
|
* @throws {RequiredError}
|
|
8500
8524
|
*/
|
|
8501
|
-
deleteSnapTradeUser(
|
|
8525
|
+
deleteSnapTradeUser(...args: AuthenticationApiDeleteSnapTradeUserArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteUserResponse>>;
|
|
8502
8526
|
/**
|
|
8503
8527
|
* Returns a list of all registered user IDs. Please note that the response is not currently paginated.
|
|
8504
8528
|
* @summary List all users
|
|
@@ -8513,7 +8537,7 @@ declare const AuthenticationApiFp: <TAuth extends AuthMode>(configuration?: Conf
|
|
|
8513
8537
|
* @param {*} [options] Override http request option.
|
|
8514
8538
|
* @throws {RequiredError}
|
|
8515
8539
|
*/
|
|
8516
|
-
loginSnapTradeUser(
|
|
8540
|
+
loginSnapTradeUser(...args: AuthenticationApiLoginSnapTradeUserArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationLoginSnapTradeUser200Response>>;
|
|
8517
8541
|
/**
|
|
8518
8542
|
* 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.
|
|
8519
8543
|
* @summary Register user
|
|
@@ -8521,7 +8545,7 @@ declare const AuthenticationApiFp: <TAuth extends AuthMode>(configuration?: Conf
|
|
|
8521
8545
|
* @param {*} [options] Override http request option.
|
|
8522
8546
|
* @throws {RequiredError}
|
|
8523
8547
|
*/
|
|
8524
|
-
registerSnapTradeUser(
|
|
8548
|
+
registerSnapTradeUser(...args: AuthenticationApiRegisterSnapTradeUserArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserIDandSecret>>;
|
|
8525
8549
|
/**
|
|
8526
8550
|
* 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.
|
|
8527
8551
|
* @summary Rotate user secret
|
|
@@ -8529,7 +8553,7 @@ declare const AuthenticationApiFp: <TAuth extends AuthMode>(configuration?: Conf
|
|
|
8529
8553
|
* @param {*} [options] Override http request option.
|
|
8530
8554
|
* @throws {RequiredError}
|
|
8531
8555
|
*/
|
|
8532
|
-
resetSnapTradeUserSecret(
|
|
8556
|
+
resetSnapTradeUserSecret(...args: AuthenticationApiResetSnapTradeUserSecretArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserIDandSecret>>;
|
|
8533
8557
|
};
|
|
8534
8558
|
/**
|
|
8535
8559
|
* AuthenticationApi - factory interface
|
|
@@ -8543,7 +8567,7 @@ declare const AuthenticationApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
8543
8567
|
* @param {*} [options] Override http request option.
|
|
8544
8568
|
* @throws {RequiredError}
|
|
8545
8569
|
*/
|
|
8546
|
-
deleteSnapTradeUser(
|
|
8570
|
+
deleteSnapTradeUser(...args: AuthenticationApiDeleteSnapTradeUserArgs<TAuth>): AxiosPromise<DeleteUserResponse>;
|
|
8547
8571
|
/**
|
|
8548
8572
|
* Returns a list of all registered user IDs. Please note that the response is not currently paginated.
|
|
8549
8573
|
* @summary List all users
|
|
@@ -8558,7 +8582,7 @@ declare const AuthenticationApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
8558
8582
|
* @param {*} [options] Override http request option.
|
|
8559
8583
|
* @throws {RequiredError}
|
|
8560
8584
|
*/
|
|
8561
|
-
loginSnapTradeUser(
|
|
8585
|
+
loginSnapTradeUser(...args: AuthenticationApiLoginSnapTradeUserArgs<TAuth>): AxiosPromise<AuthenticationLoginSnapTradeUser200Response>;
|
|
8562
8586
|
/**
|
|
8563
8587
|
* 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.
|
|
8564
8588
|
* @summary Register user
|
|
@@ -8566,7 +8590,7 @@ declare const AuthenticationApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
8566
8590
|
* @param {*} [options] Override http request option.
|
|
8567
8591
|
* @throws {RequiredError}
|
|
8568
8592
|
*/
|
|
8569
|
-
registerSnapTradeUser(
|
|
8593
|
+
registerSnapTradeUser(...args: AuthenticationApiRegisterSnapTradeUserArgs<TAuth>): AxiosPromise<UserIDandSecret>;
|
|
8570
8594
|
/**
|
|
8571
8595
|
* 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.
|
|
8572
8596
|
* @summary Rotate user secret
|
|
@@ -8574,7 +8598,7 @@ declare const AuthenticationApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
8574
8598
|
* @param {*} [options] Override http request option.
|
|
8575
8599
|
* @throws {RequiredError}
|
|
8576
8600
|
*/
|
|
8577
|
-
resetSnapTradeUserSecret(
|
|
8601
|
+
resetSnapTradeUserSecret(...args: AuthenticationApiResetSnapTradeUserSecretArgs<TAuth>): AxiosPromise<UserIDandSecret>;
|
|
8578
8602
|
};
|
|
8579
8603
|
/**
|
|
8580
8604
|
* Request parameters for deleteSnapTradeUser operation in AuthenticationApi.
|
|
@@ -8588,6 +8612,8 @@ type AuthenticationApiDeleteSnapTradeUserRequestByAuthMode = {
|
|
|
8588
8612
|
"commercialApiKey": AuthenticationApiDeleteSnapTradeUsercommercialApiKeyRequest;
|
|
8589
8613
|
};
|
|
8590
8614
|
type AuthenticationApiDeleteSnapTradeUserRequest<TAuth extends AuthMode> = AuthenticationApiDeleteSnapTradeUserRequestByAuthMode[TAuth["mode"] & keyof AuthenticationApiDeleteSnapTradeUserRequestByAuthMode];
|
|
8615
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8616
|
+
type AuthenticationApiDeleteSnapTradeUserArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: AuthenticationApiDeleteSnapTradeUserRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AuthenticationApiDeleteSnapTradeUserRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8591
8617
|
/**
|
|
8592
8618
|
* Request parameters for loginSnapTradeUser operation in AuthenticationApi.
|
|
8593
8619
|
* @export
|
|
@@ -8606,6 +8632,8 @@ type AuthenticationApiLoginSnapTradeUserRequestByAuthMode = {
|
|
|
8606
8632
|
"personalApiKey": AuthenticationApiLoginSnapTradeUserpersonalApiKeyRequest;
|
|
8607
8633
|
};
|
|
8608
8634
|
type AuthenticationApiLoginSnapTradeUserRequest<TAuth extends AuthMode> = AuthenticationApiLoginSnapTradeUserRequestByAuthMode[TAuth["mode"] & keyof AuthenticationApiLoginSnapTradeUserRequestByAuthMode];
|
|
8635
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8636
|
+
type AuthenticationApiLoginSnapTradeUserArgs<TAuth extends AuthMode> = TAuth["mode"] extends "personalApiKey" ? [requestParameters?: AuthenticationApiLoginSnapTradeUserRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AuthenticationApiLoginSnapTradeUserRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8609
8637
|
/**
|
|
8610
8638
|
* Request parameters for registerSnapTradeUser operation in AuthenticationApi.
|
|
8611
8639
|
* @export
|
|
@@ -8616,6 +8644,8 @@ type AuthenticationApiRegisterSnapTradeUserRequestByAuthMode = {
|
|
|
8616
8644
|
"commercialApiKey": AuthenticationApiRegisterSnapTradeUsercommercialApiKeyRequest;
|
|
8617
8645
|
};
|
|
8618
8646
|
type AuthenticationApiRegisterSnapTradeUserRequest<TAuth extends AuthMode> = AuthenticationApiRegisterSnapTradeUserRequestByAuthMode[TAuth["mode"] & keyof AuthenticationApiRegisterSnapTradeUserRequestByAuthMode];
|
|
8647
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8648
|
+
type AuthenticationApiRegisterSnapTradeUserArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: AuthenticationApiRegisterSnapTradeUserRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AuthenticationApiRegisterSnapTradeUserRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8619
8649
|
/**
|
|
8620
8650
|
* Request parameters for resetSnapTradeUserSecret operation in AuthenticationApi.
|
|
8621
8651
|
* @export
|
|
@@ -8626,6 +8656,8 @@ type AuthenticationApiResetSnapTradeUserSecretRequestByAuthMode = {
|
|
|
8626
8656
|
"commercialApiKey": AuthenticationApiResetSnapTradeUserSecretcommercialApiKeyRequest;
|
|
8627
8657
|
};
|
|
8628
8658
|
type AuthenticationApiResetSnapTradeUserSecretRequest<TAuth extends AuthMode> = AuthenticationApiResetSnapTradeUserSecretRequestByAuthMode[TAuth["mode"] & keyof AuthenticationApiResetSnapTradeUserSecretRequestByAuthMode];
|
|
8659
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8660
|
+
type AuthenticationApiResetSnapTradeUserSecretArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: AuthenticationApiResetSnapTradeUserSecretRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: AuthenticationApiResetSnapTradeUserSecretRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8629
8661
|
/**
|
|
8630
8662
|
* AuthenticationApiGenerated - object-oriented interface
|
|
8631
8663
|
* @export
|
|
@@ -8641,7 +8673,7 @@ declare class AuthenticationApiGenerated<TAuth extends AuthMode> extends BaseAPI
|
|
|
8641
8673
|
* @throws {RequiredError}
|
|
8642
8674
|
* @memberof AuthenticationApiGenerated
|
|
8643
8675
|
*/
|
|
8644
|
-
deleteSnapTradeUser(
|
|
8676
|
+
deleteSnapTradeUser(...args: AuthenticationApiDeleteSnapTradeUserArgs<TAuth>): Promise<_$axios.AxiosResponse<DeleteUserResponse, any, {}>>;
|
|
8645
8677
|
/**
|
|
8646
8678
|
* Returns a list of all registered user IDs. Please note that the response is not currently paginated.
|
|
8647
8679
|
* @summary List all users
|
|
@@ -8658,7 +8690,7 @@ declare class AuthenticationApiGenerated<TAuth extends AuthMode> extends BaseAPI
|
|
|
8658
8690
|
* @throws {RequiredError}
|
|
8659
8691
|
* @memberof AuthenticationApiGenerated
|
|
8660
8692
|
*/
|
|
8661
|
-
loginSnapTradeUser(
|
|
8693
|
+
loginSnapTradeUser(...args: AuthenticationApiLoginSnapTradeUserArgs<TAuth>): Promise<_$axios.AxiosResponse<AuthenticationLoginSnapTradeUser200Response, any, {}>>;
|
|
8662
8694
|
/**
|
|
8663
8695
|
* 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.
|
|
8664
8696
|
* @summary Register user
|
|
@@ -8667,7 +8699,7 @@ declare class AuthenticationApiGenerated<TAuth extends AuthMode> extends BaseAPI
|
|
|
8667
8699
|
* @throws {RequiredError}
|
|
8668
8700
|
* @memberof AuthenticationApiGenerated
|
|
8669
8701
|
*/
|
|
8670
|
-
registerSnapTradeUser(
|
|
8702
|
+
registerSnapTradeUser(...args: AuthenticationApiRegisterSnapTradeUserArgs<TAuth>): Promise<_$axios.AxiosResponse<UserIDandSecret, any, {}>>;
|
|
8671
8703
|
/**
|
|
8672
8704
|
* 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.
|
|
8673
8705
|
* @summary Rotate user secret
|
|
@@ -8676,7 +8708,7 @@ declare class AuthenticationApiGenerated<TAuth extends AuthMode> extends BaseAPI
|
|
|
8676
8708
|
* @throws {RequiredError}
|
|
8677
8709
|
* @memberof AuthenticationApiGenerated
|
|
8678
8710
|
*/
|
|
8679
|
-
resetSnapTradeUserSecret(
|
|
8711
|
+
resetSnapTradeUserSecret(...args: AuthenticationApiResetSnapTradeUserSecretArgs<TAuth>): Promise<_$axios.AxiosResponse<UserIDandSecret, any, {}>>;
|
|
8680
8712
|
}
|
|
8681
8713
|
//#endregion
|
|
8682
8714
|
//#region api/authentication-api.d.ts
|
|
@@ -8781,7 +8813,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
8781
8813
|
* @param {*} [options] Override http request option.
|
|
8782
8814
|
* @throws {RequiredError}
|
|
8783
8815
|
*/
|
|
8784
|
-
deleteConnection(
|
|
8816
|
+
deleteConnection(...args: ConnectionsApiDeleteConnectionArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteConnectionConfirmation>>;
|
|
8785
8817
|
/**
|
|
8786
8818
|
* Returns a single connection for the specified ID.
|
|
8787
8819
|
* @summary Get connection detail
|
|
@@ -8789,7 +8821,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
8789
8821
|
* @param {*} [options] Override http request option.
|
|
8790
8822
|
* @throws {RequiredError}
|
|
8791
8823
|
*/
|
|
8792
|
-
detailBrokerageAuthorization(
|
|
8824
|
+
detailBrokerageAuthorization(...args: ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorization>>;
|
|
8793
8825
|
/**
|
|
8794
8826
|
* 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.
|
|
8795
8827
|
* @summary Force disable connection
|
|
@@ -8797,7 +8829,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
8797
8829
|
* @param {*} [options] Override http request option.
|
|
8798
8830
|
* @throws {RequiredError}
|
|
8799
8831
|
*/
|
|
8800
|
-
disableBrokerageAuthorization(
|
|
8832
|
+
disableBrokerageAuthorization(...args: ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorizationDisabledConfirmation>>;
|
|
8801
8833
|
/**
|
|
8802
8834
|
* 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.
|
|
8803
8835
|
* @summary List accounts for a connection
|
|
@@ -8805,7 +8837,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
8805
8837
|
* @param {*} [options] Override http request option.
|
|
8806
8838
|
* @throws {RequiredError}
|
|
8807
8839
|
*/
|
|
8808
|
-
listBrokerageAuthorizationAccounts(
|
|
8840
|
+
listBrokerageAuthorizationAccounts(...args: ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Account>>>;
|
|
8809
8841
|
/**
|
|
8810
8842
|
* 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.
|
|
8811
8843
|
* @summary List all connections
|
|
@@ -8813,7 +8845,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
8813
8845
|
* @param {*} [options] Override http request option.
|
|
8814
8846
|
* @throws {RequiredError}
|
|
8815
8847
|
*/
|
|
8816
|
-
listBrokerageAuthorizations(
|
|
8848
|
+
listBrokerageAuthorizations(...args: ConnectionsApiListBrokerageAuthorizationsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorization>>>;
|
|
8817
8849
|
/**
|
|
8818
8850
|
* 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.**
|
|
8819
8851
|
* @summary Refresh holdings for a connection
|
|
@@ -8821,7 +8853,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
8821
8853
|
* @param {*} [options] Override http request option.
|
|
8822
8854
|
* @throws {RequiredError}
|
|
8823
8855
|
*/
|
|
8824
|
-
refreshBrokerageAuthorization(
|
|
8856
|
+
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorizationRefreshConfirmation>>;
|
|
8825
8857
|
/**
|
|
8826
8858
|
* Returns a list of rate of return percents for a given connection.
|
|
8827
8859
|
* @summary List connection rate of returns
|
|
@@ -8829,7 +8861,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
8829
8861
|
* @param {*} [options] Override http request option.
|
|
8830
8862
|
* @throws {RequiredError}
|
|
8831
8863
|
*/
|
|
8832
|
-
returnRates(
|
|
8864
|
+
returnRates(...args: ConnectionsApiReturnRatesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RateOfReturnResponse>>;
|
|
8833
8865
|
/**
|
|
8834
8866
|
* 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
|
|
8835
8867
|
* @summary Sync transactions for a connection
|
|
@@ -8837,7 +8869,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
8837
8869
|
* @param {*} [options] Override http request option.
|
|
8838
8870
|
* @throws {RequiredError}
|
|
8839
8871
|
*/
|
|
8840
|
-
syncBrokerageAuthorizationTransactions(
|
|
8872
|
+
syncBrokerageAuthorizationTransactions(...args: ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorizationTransactionsSyncConfirmation>>;
|
|
8841
8873
|
};
|
|
8842
8874
|
/**
|
|
8843
8875
|
* ConnectionsApi - factory interface
|
|
@@ -8851,7 +8883,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
8851
8883
|
* @param {*} [options] Override http request option.
|
|
8852
8884
|
* @throws {RequiredError}
|
|
8853
8885
|
*/
|
|
8854
|
-
deleteConnection(
|
|
8886
|
+
deleteConnection(...args: ConnectionsApiDeleteConnectionArgs<TAuth>): AxiosPromise<DeleteConnectionConfirmation>;
|
|
8855
8887
|
/**
|
|
8856
8888
|
* Returns a single connection for the specified ID.
|
|
8857
8889
|
* @summary Get connection detail
|
|
@@ -8859,7 +8891,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
8859
8891
|
* @param {*} [options] Override http request option.
|
|
8860
8892
|
* @throws {RequiredError}
|
|
8861
8893
|
*/
|
|
8862
|
-
detailBrokerageAuthorization(
|
|
8894
|
+
detailBrokerageAuthorization(...args: ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth>): AxiosPromise<BrokerageAuthorization>;
|
|
8863
8895
|
/**
|
|
8864
8896
|
* 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.
|
|
8865
8897
|
* @summary Force disable connection
|
|
@@ -8867,7 +8899,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
8867
8899
|
* @param {*} [options] Override http request option.
|
|
8868
8900
|
* @throws {RequiredError}
|
|
8869
8901
|
*/
|
|
8870
|
-
disableBrokerageAuthorization(
|
|
8902
|
+
disableBrokerageAuthorization(...args: ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth>): AxiosPromise<BrokerageAuthorizationDisabledConfirmation>;
|
|
8871
8903
|
/**
|
|
8872
8904
|
* 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.
|
|
8873
8905
|
* @summary List accounts for a connection
|
|
@@ -8875,7 +8907,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
8875
8907
|
* @param {*} [options] Override http request option.
|
|
8876
8908
|
* @throws {RequiredError}
|
|
8877
8909
|
*/
|
|
8878
|
-
listBrokerageAuthorizationAccounts(
|
|
8910
|
+
listBrokerageAuthorizationAccounts(...args: ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth>): AxiosPromise<Array<Account>>;
|
|
8879
8911
|
/**
|
|
8880
8912
|
* 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.
|
|
8881
8913
|
* @summary List all connections
|
|
@@ -8883,7 +8915,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
8883
8915
|
* @param {*} [options] Override http request option.
|
|
8884
8916
|
* @throws {RequiredError}
|
|
8885
8917
|
*/
|
|
8886
|
-
listBrokerageAuthorizations(
|
|
8918
|
+
listBrokerageAuthorizations(...args: ConnectionsApiListBrokerageAuthorizationsArgs<TAuth>): AxiosPromise<Array<BrokerageAuthorization>>;
|
|
8887
8919
|
/**
|
|
8888
8920
|
* 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.**
|
|
8889
8921
|
* @summary Refresh holdings for a connection
|
|
@@ -8891,7 +8923,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
8891
8923
|
* @param {*} [options] Override http request option.
|
|
8892
8924
|
* @throws {RequiredError}
|
|
8893
8925
|
*/
|
|
8894
|
-
refreshBrokerageAuthorization(
|
|
8926
|
+
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): AxiosPromise<BrokerageAuthorizationRefreshConfirmation>;
|
|
8895
8927
|
/**
|
|
8896
8928
|
* Returns a list of rate of return percents for a given connection.
|
|
8897
8929
|
* @summary List connection rate of returns
|
|
@@ -8899,7 +8931,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
8899
8931
|
* @param {*} [options] Override http request option.
|
|
8900
8932
|
* @throws {RequiredError}
|
|
8901
8933
|
*/
|
|
8902
|
-
returnRates(
|
|
8934
|
+
returnRates(...args: ConnectionsApiReturnRatesArgs<TAuth>): AxiosPromise<RateOfReturnResponse>;
|
|
8903
8935
|
/**
|
|
8904
8936
|
* 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
|
|
8905
8937
|
* @summary Sync transactions for a connection
|
|
@@ -8907,7 +8939,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
8907
8939
|
* @param {*} [options] Override http request option.
|
|
8908
8940
|
* @throws {RequiredError}
|
|
8909
8941
|
*/
|
|
8910
|
-
syncBrokerageAuthorizationTransactions(
|
|
8942
|
+
syncBrokerageAuthorizationTransactions(...args: ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth>): AxiosPromise<BrokerageAuthorizationTransactionsSyncConfirmation>;
|
|
8911
8943
|
};
|
|
8912
8944
|
/**
|
|
8913
8945
|
* Request parameters for deleteConnection operation in ConnectionsApi.
|
|
@@ -8934,6 +8966,8 @@ type ConnectionsApiDeleteConnectionRequestByAuthMode = {
|
|
|
8934
8966
|
"personalApiKey": ConnectionsApiDeleteConnectionpersonalApiKeyRequest;
|
|
8935
8967
|
};
|
|
8936
8968
|
type ConnectionsApiDeleteConnectionRequest<TAuth extends AuthMode> = ConnectionsApiDeleteConnectionRequestByAuthMode[TAuth["mode"] & keyof ConnectionsApiDeleteConnectionRequestByAuthMode];
|
|
8969
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8970
|
+
type ConnectionsApiDeleteConnectionArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ConnectionsApiDeleteConnectionRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ConnectionsApiDeleteConnectionRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8937
8971
|
/**
|
|
8938
8972
|
* Request parameters for detailBrokerageAuthorization operation in ConnectionsApi.
|
|
8939
8973
|
* @export
|
|
@@ -8959,6 +8993,8 @@ type ConnectionsApiDetailBrokerageAuthorizationRequestByAuthMode = {
|
|
|
8959
8993
|
"personalApiKey": ConnectionsApiDetailBrokerageAuthorizationpersonalApiKeyRequest;
|
|
8960
8994
|
};
|
|
8961
8995
|
type ConnectionsApiDetailBrokerageAuthorizationRequest<TAuth extends AuthMode> = ConnectionsApiDetailBrokerageAuthorizationRequestByAuthMode[TAuth["mode"] & keyof ConnectionsApiDetailBrokerageAuthorizationRequestByAuthMode];
|
|
8996
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
8997
|
+
type ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ConnectionsApiDetailBrokerageAuthorizationRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8962
8998
|
/**
|
|
8963
8999
|
* Request parameters for disableBrokerageAuthorization operation in ConnectionsApi.
|
|
8964
9000
|
* @export
|
|
@@ -8984,6 +9020,8 @@ type ConnectionsApiDisableBrokerageAuthorizationRequestByAuthMode = {
|
|
|
8984
9020
|
"personalApiKey": ConnectionsApiDisableBrokerageAuthorizationpersonalApiKeyRequest;
|
|
8985
9021
|
};
|
|
8986
9022
|
type ConnectionsApiDisableBrokerageAuthorizationRequest<TAuth extends AuthMode> = ConnectionsApiDisableBrokerageAuthorizationRequestByAuthMode[TAuth["mode"] & keyof ConnectionsApiDisableBrokerageAuthorizationRequestByAuthMode];
|
|
9023
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9024
|
+
type ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ConnectionsApiDisableBrokerageAuthorizationRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ConnectionsApiDisableBrokerageAuthorizationRequest<TAuth>, options?: AxiosRequestConfig];
|
|
8987
9025
|
/**
|
|
8988
9026
|
* Request parameters for listBrokerageAuthorizationAccounts operation in ConnectionsApi.
|
|
8989
9027
|
* @export
|
|
@@ -9009,6 +9047,8 @@ type ConnectionsApiListBrokerageAuthorizationAccountsRequestByAuthMode = {
|
|
|
9009
9047
|
"personalApiKey": ConnectionsApiListBrokerageAuthorizationAccountspersonalApiKeyRequest;
|
|
9010
9048
|
};
|
|
9011
9049
|
type ConnectionsApiListBrokerageAuthorizationAccountsRequest<TAuth extends AuthMode> = ConnectionsApiListBrokerageAuthorizationAccountsRequestByAuthMode[TAuth["mode"] & keyof ConnectionsApiListBrokerageAuthorizationAccountsRequestByAuthMode];
|
|
9050
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9051
|
+
type ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ConnectionsApiListBrokerageAuthorizationAccountsRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ConnectionsApiListBrokerageAuthorizationAccountsRequest<TAuth>, options?: AxiosRequestConfig];
|
|
9012
9052
|
/**
|
|
9013
9053
|
* Request parameters for listBrokerageAuthorizations operation in ConnectionsApi.
|
|
9014
9054
|
* @export
|
|
@@ -9027,6 +9067,8 @@ type ConnectionsApiListBrokerageAuthorizationsRequestByAuthMode = {
|
|
|
9027
9067
|
"personalApiKey": ConnectionsApiListBrokerageAuthorizationspersonalApiKeyRequest;
|
|
9028
9068
|
};
|
|
9029
9069
|
type ConnectionsApiListBrokerageAuthorizationsRequest<TAuth extends AuthMode> = ConnectionsApiListBrokerageAuthorizationsRequestByAuthMode[TAuth["mode"] & keyof ConnectionsApiListBrokerageAuthorizationsRequestByAuthMode];
|
|
9070
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9071
|
+
type ConnectionsApiListBrokerageAuthorizationsArgs<TAuth extends AuthMode> = TAuth["mode"] extends "personalApiKey" ? [requestParameters?: ConnectionsApiListBrokerageAuthorizationsRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest<TAuth>, options?: AxiosRequestConfig];
|
|
9030
9072
|
/**
|
|
9031
9073
|
* Request parameters for refreshBrokerageAuthorization operation in ConnectionsApi.
|
|
9032
9074
|
* @export
|
|
@@ -9052,6 +9094,8 @@ type ConnectionsApiRefreshBrokerageAuthorizationRequestByAuthMode = {
|
|
|
9052
9094
|
"personalApiKey": ConnectionsApiRefreshBrokerageAuthorizationpersonalApiKeyRequest;
|
|
9053
9095
|
};
|
|
9054
9096
|
type ConnectionsApiRefreshBrokerageAuthorizationRequest<TAuth extends AuthMode> = ConnectionsApiRefreshBrokerageAuthorizationRequestByAuthMode[TAuth["mode"] & keyof ConnectionsApiRefreshBrokerageAuthorizationRequestByAuthMode];
|
|
9097
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9098
|
+
type ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ConnectionsApiRefreshBrokerageAuthorizationRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ConnectionsApiRefreshBrokerageAuthorizationRequest<TAuth>, options?: AxiosRequestConfig];
|
|
9055
9099
|
/**
|
|
9056
9100
|
* Request parameters for returnRates operation in ConnectionsApi.
|
|
9057
9101
|
* @export
|
|
@@ -9083,6 +9127,8 @@ type ConnectionsApiReturnRatesRequestByAuthMode = {
|
|
|
9083
9127
|
"personalApiKey": ConnectionsApiReturnRatespersonalApiKeyRequest;
|
|
9084
9128
|
};
|
|
9085
9129
|
type ConnectionsApiReturnRatesRequest<TAuth extends AuthMode> = ConnectionsApiReturnRatesRequestByAuthMode[TAuth["mode"] & keyof ConnectionsApiReturnRatesRequestByAuthMode];
|
|
9130
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9131
|
+
type ConnectionsApiReturnRatesArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ConnectionsApiReturnRatesRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ConnectionsApiReturnRatesRequest<TAuth>, options?: AxiosRequestConfig];
|
|
9086
9132
|
/**
|
|
9087
9133
|
* Request parameters for syncBrokerageAuthorizationTransactions operation in ConnectionsApi.
|
|
9088
9134
|
* @export
|
|
@@ -9108,6 +9154,8 @@ type ConnectionsApiSyncBrokerageAuthorizationTransactionsRequestByAuthMode = {
|
|
|
9108
9154
|
"personalApiKey": ConnectionsApiSyncBrokerageAuthorizationTransactionspersonalApiKeyRequest;
|
|
9109
9155
|
};
|
|
9110
9156
|
type ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest<TAuth extends AuthMode> = ConnectionsApiSyncBrokerageAuthorizationTransactionsRequestByAuthMode[TAuth["mode"] & keyof ConnectionsApiSyncBrokerageAuthorizationTransactionsRequestByAuthMode];
|
|
9157
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9158
|
+
type ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest<TAuth>, options?: AxiosRequestConfig];
|
|
9111
9159
|
/**
|
|
9112
9160
|
* ConnectionsApiGenerated - object-oriented interface
|
|
9113
9161
|
* @export
|
|
@@ -9123,7 +9171,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9123
9171
|
* @throws {RequiredError}
|
|
9124
9172
|
* @memberof ConnectionsApiGenerated
|
|
9125
9173
|
*/
|
|
9126
|
-
deleteConnection(
|
|
9174
|
+
deleteConnection(...args: ConnectionsApiDeleteConnectionArgs<TAuth>): Promise<_$axios.AxiosResponse<DeleteConnectionConfirmation, any, {}>>;
|
|
9127
9175
|
/**
|
|
9128
9176
|
* Returns a single connection for the specified ID.
|
|
9129
9177
|
* @summary Get connection detail
|
|
@@ -9132,7 +9180,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9132
9180
|
* @throws {RequiredError}
|
|
9133
9181
|
* @memberof ConnectionsApiGenerated
|
|
9134
9182
|
*/
|
|
9135
|
-
detailBrokerageAuthorization(
|
|
9183
|
+
detailBrokerageAuthorization(...args: ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth>): Promise<_$axios.AxiosResponse<BrokerageAuthorization, any, {}>>;
|
|
9136
9184
|
/**
|
|
9137
9185
|
* 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.
|
|
9138
9186
|
* @summary Force disable connection
|
|
@@ -9141,7 +9189,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9141
9189
|
* @throws {RequiredError}
|
|
9142
9190
|
* @memberof ConnectionsApiGenerated
|
|
9143
9191
|
*/
|
|
9144
|
-
disableBrokerageAuthorization(
|
|
9192
|
+
disableBrokerageAuthorization(...args: ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth>): Promise<_$axios.AxiosResponse<BrokerageAuthorizationDisabledConfirmation, any, {}>>;
|
|
9145
9193
|
/**
|
|
9146
9194
|
* 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.
|
|
9147
9195
|
* @summary List accounts for a connection
|
|
@@ -9150,7 +9198,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9150
9198
|
* @throws {RequiredError}
|
|
9151
9199
|
* @memberof ConnectionsApiGenerated
|
|
9152
9200
|
*/
|
|
9153
|
-
listBrokerageAuthorizationAccounts(
|
|
9201
|
+
listBrokerageAuthorizationAccounts(...args: ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth>): Promise<_$axios.AxiosResponse<Account[], any, {}>>;
|
|
9154
9202
|
/**
|
|
9155
9203
|
* 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.
|
|
9156
9204
|
* @summary List all connections
|
|
@@ -9159,7 +9207,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9159
9207
|
* @throws {RequiredError}
|
|
9160
9208
|
* @memberof ConnectionsApiGenerated
|
|
9161
9209
|
*/
|
|
9162
|
-
listBrokerageAuthorizations(
|
|
9210
|
+
listBrokerageAuthorizations(...args: ConnectionsApiListBrokerageAuthorizationsArgs<TAuth>): Promise<_$axios.AxiosResponse<BrokerageAuthorization[], any, {}>>;
|
|
9163
9211
|
/**
|
|
9164
9212
|
* 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.**
|
|
9165
9213
|
* @summary Refresh holdings for a connection
|
|
@@ -9168,7 +9216,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9168
9216
|
* @throws {RequiredError}
|
|
9169
9217
|
* @memberof ConnectionsApiGenerated
|
|
9170
9218
|
*/
|
|
9171
|
-
refreshBrokerageAuthorization(
|
|
9219
|
+
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): Promise<_$axios.AxiosResponse<BrokerageAuthorizationRefreshConfirmation, any, {}>>;
|
|
9172
9220
|
/**
|
|
9173
9221
|
* Returns a list of rate of return percents for a given connection.
|
|
9174
9222
|
* @summary List connection rate of returns
|
|
@@ -9177,7 +9225,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9177
9225
|
* @throws {RequiredError}
|
|
9178
9226
|
* @memberof ConnectionsApiGenerated
|
|
9179
9227
|
*/
|
|
9180
|
-
returnRates(
|
|
9228
|
+
returnRates(...args: ConnectionsApiReturnRatesArgs<TAuth>): Promise<_$axios.AxiosResponse<RateOfReturnResponse, any, {}>>;
|
|
9181
9229
|
/**
|
|
9182
9230
|
* 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
|
|
9183
9231
|
* @summary Sync transactions for a connection
|
|
@@ -9186,7 +9234,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9186
9234
|
* @throws {RequiredError}
|
|
9187
9235
|
* @memberof ConnectionsApiGenerated
|
|
9188
9236
|
*/
|
|
9189
|
-
syncBrokerageAuthorizationTransactions(
|
|
9237
|
+
syncBrokerageAuthorizationTransactions(...args: ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth>): Promise<_$axios.AxiosResponse<BrokerageAuthorizationTransactionsSyncConfirmation, any, {}>>;
|
|
9190
9238
|
}
|
|
9191
9239
|
//#endregion
|
|
9192
9240
|
//#region api/connections-api.d.ts
|
|
@@ -9280,7 +9328,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9280
9328
|
* @param {*} [options] Override http request option.
|
|
9281
9329
|
* @throws {RequiredError}
|
|
9282
9330
|
*/
|
|
9283
|
-
addSubscription(
|
|
9331
|
+
addSubscription(...args: ExperimentalEndpointsApiAddSubscriptionArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TradeDetectionSubscription>>;
|
|
9284
9332
|
/**
|
|
9285
9333
|
* Cancels a Trade Detection subscription for a connected brokerage account. This endpoint requires partner signature authentication only and does not require `userId` or `userSecret`.
|
|
9286
9334
|
* @summary Cancel a Trade Detection subscription
|
|
@@ -9288,7 +9336,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9288
9336
|
* @param {*} [options] Override http request option.
|
|
9289
9337
|
* @throws {RequiredError}
|
|
9290
9338
|
*/
|
|
9291
|
-
cancelSubscription(
|
|
9339
|
+
cancelSubscription(...args: ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TradeDetectionCancelSubscriptionResponse>>;
|
|
9292
9340
|
/**
|
|
9293
9341
|
* 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.
|
|
9294
9342
|
* @summary Get account order detail (V2)
|
|
@@ -9296,7 +9344,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9296
9344
|
* @param {*} [options] Override http request option.
|
|
9297
9345
|
* @throws {RequiredError}
|
|
9298
9346
|
*/
|
|
9299
|
-
getUserAccountOrderDetailV2(
|
|
9347
|
+
getUserAccountOrderDetailV2(...args: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecordV2>>;
|
|
9300
9348
|
/**
|
|
9301
9349
|
* 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.
|
|
9302
9350
|
* @summary List account orders v2
|
|
@@ -9304,7 +9352,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9304
9352
|
* @param {*} [options] Override http request option.
|
|
9305
9353
|
* @throws {RequiredError}
|
|
9306
9354
|
*/
|
|
9307
|
-
getUserAccountOrdersV2(
|
|
9355
|
+
getUserAccountOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrdersV2Response>>;
|
|
9308
9356
|
/**
|
|
9309
9357
|
* 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)**
|
|
9310
9358
|
* @summary List account recent orders (V2, last 24 hours only)
|
|
@@ -9312,7 +9360,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9312
9360
|
* @param {*} [options] Override http request option.
|
|
9313
9361
|
* @throws {RequiredError}
|
|
9314
9362
|
*/
|
|
9315
|
-
getUserAccountRecentOrdersV2(
|
|
9363
|
+
getUserAccountRecentOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrdersV2Response>>;
|
|
9316
9364
|
/**
|
|
9317
9365
|
* 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.
|
|
9318
9366
|
* @summary List accounts for a connection (discriminated union)
|
|
@@ -9320,7 +9368,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9320
9368
|
* @param {*} [options] Override http request option.
|
|
9321
9369
|
* @throws {RequiredError}
|
|
9322
9370
|
*/
|
|
9323
|
-
listConnectionAccounts(
|
|
9371
|
+
listConnectionAccounts(...args: ExperimentalEndpointsApiListConnectionAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ConnectionAccount>>>;
|
|
9324
9372
|
/**
|
|
9325
9373
|
* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
|
|
9326
9374
|
* @summary List active Trade Detection subscriptions
|
|
@@ -9341,7 +9389,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9341
9389
|
* @param {*} [options] Override http request option.
|
|
9342
9390
|
* @throws {RequiredError}
|
|
9343
9391
|
*/
|
|
9344
|
-
addSubscription(
|
|
9392
|
+
addSubscription(...args: ExperimentalEndpointsApiAddSubscriptionArgs<TAuth>): AxiosPromise<TradeDetectionSubscription>;
|
|
9345
9393
|
/**
|
|
9346
9394
|
* Cancels a Trade Detection subscription for a connected brokerage account. This endpoint requires partner signature authentication only and does not require `userId` or `userSecret`.
|
|
9347
9395
|
* @summary Cancel a Trade Detection subscription
|
|
@@ -9349,7 +9397,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9349
9397
|
* @param {*} [options] Override http request option.
|
|
9350
9398
|
* @throws {RequiredError}
|
|
9351
9399
|
*/
|
|
9352
|
-
cancelSubscription(
|
|
9400
|
+
cancelSubscription(...args: ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth>): AxiosPromise<TradeDetectionCancelSubscriptionResponse>;
|
|
9353
9401
|
/**
|
|
9354
9402
|
* 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.
|
|
9355
9403
|
* @summary Get account order detail (V2)
|
|
@@ -9357,7 +9405,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9357
9405
|
* @param {*} [options] Override http request option.
|
|
9358
9406
|
* @throws {RequiredError}
|
|
9359
9407
|
*/
|
|
9360
|
-
getUserAccountOrderDetailV2(
|
|
9408
|
+
getUserAccountOrderDetailV2(...args: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth>): AxiosPromise<AccountOrderRecordV2>;
|
|
9361
9409
|
/**
|
|
9362
9410
|
* 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.
|
|
9363
9411
|
* @summary List account orders v2
|
|
@@ -9365,7 +9413,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9365
9413
|
* @param {*} [options] Override http request option.
|
|
9366
9414
|
* @throws {RequiredError}
|
|
9367
9415
|
*/
|
|
9368
|
-
getUserAccountOrdersV2(
|
|
9416
|
+
getUserAccountOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth>): AxiosPromise<AccountOrdersV2Response>;
|
|
9369
9417
|
/**
|
|
9370
9418
|
* 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)**
|
|
9371
9419
|
* @summary List account recent orders (V2, last 24 hours only)
|
|
@@ -9373,7 +9421,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9373
9421
|
* @param {*} [options] Override http request option.
|
|
9374
9422
|
* @throws {RequiredError}
|
|
9375
9423
|
*/
|
|
9376
|
-
getUserAccountRecentOrdersV2(
|
|
9424
|
+
getUserAccountRecentOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth>): AxiosPromise<AccountOrdersV2Response>;
|
|
9377
9425
|
/**
|
|
9378
9426
|
* 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.
|
|
9379
9427
|
* @summary List accounts for a connection (discriminated union)
|
|
@@ -9381,7 +9429,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9381
9429
|
* @param {*} [options] Override http request option.
|
|
9382
9430
|
* @throws {RequiredError}
|
|
9383
9431
|
*/
|
|
9384
|
-
listConnectionAccounts(
|
|
9432
|
+
listConnectionAccounts(...args: ExperimentalEndpointsApiListConnectionAccountsArgs<TAuth>): AxiosPromise<Array<ConnectionAccount>>;
|
|
9385
9433
|
/**
|
|
9386
9434
|
* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
|
|
9387
9435
|
* @summary List active Trade Detection subscriptions
|
|
@@ -9408,6 +9456,8 @@ type ExperimentalEndpointsApiAddSubscriptionRequestByAuthMode = {
|
|
|
9408
9456
|
"personalApiKey": ExperimentalEndpointsApiAddSubscriptionpersonalApiKeyRequest;
|
|
9409
9457
|
};
|
|
9410
9458
|
type ExperimentalEndpointsApiAddSubscriptionRequest<TAuth extends AuthMode> = ExperimentalEndpointsApiAddSubscriptionRequestByAuthMode[TAuth["mode"] & keyof ExperimentalEndpointsApiAddSubscriptionRequestByAuthMode];
|
|
9459
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9460
|
+
type ExperimentalEndpointsApiAddSubscriptionArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ExperimentalEndpointsApiAddSubscriptionRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ExperimentalEndpointsApiAddSubscriptionRequest<TAuth>, options?: AxiosRequestConfig];
|
|
9411
9461
|
/**
|
|
9412
9462
|
* Request parameters for cancelSubscription operation in ExperimentalEndpointsApi.
|
|
9413
9463
|
* @export
|
|
@@ -9420,6 +9470,8 @@ type ExperimentalEndpointsApiCancelSubscriptionRequestByAuthMode = {
|
|
|
9420
9470
|
"personalApiKey": ExperimentalEndpointsApiCancelSubscriptionpersonalApiKeyRequest;
|
|
9421
9471
|
};
|
|
9422
9472
|
type ExperimentalEndpointsApiCancelSubscriptionRequest<TAuth extends AuthMode> = ExperimentalEndpointsApiCancelSubscriptionRequestByAuthMode[TAuth["mode"] & keyof ExperimentalEndpointsApiCancelSubscriptionRequestByAuthMode];
|
|
9473
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9474
|
+
type ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ExperimentalEndpointsApiCancelSubscriptionRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ExperimentalEndpointsApiCancelSubscriptionRequest<TAuth>, options?: AxiosRequestConfig];
|
|
9423
9475
|
/**
|
|
9424
9476
|
* Request parameters for getUserAccountOrderDetailV2 operation in ExperimentalEndpointsApi.
|
|
9425
9477
|
* @export
|
|
@@ -9451,6 +9503,8 @@ type ExperimentalEndpointsApiGetUserAccountOrderDetailV2RequestByAuthMode = {
|
|
|
9451
9503
|
"personalApiKey": ExperimentalEndpointsApiGetUserAccountOrderDetailV2personalApiKeyRequest;
|
|
9452
9504
|
};
|
|
9453
9505
|
type ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request<TAuth extends AuthMode> = ExperimentalEndpointsApiGetUserAccountOrderDetailV2RequestByAuthMode[TAuth["mode"] & keyof ExperimentalEndpointsApiGetUserAccountOrderDetailV2RequestByAuthMode];
|
|
9506
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9507
|
+
type ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request<TAuth>, options?: AxiosRequestConfig];
|
|
9454
9508
|
/**
|
|
9455
9509
|
* Request parameters for getUserAccountOrdersV2 operation in ExperimentalEndpointsApi.
|
|
9456
9510
|
* @export
|
|
@@ -9488,6 +9542,8 @@ type ExperimentalEndpointsApiGetUserAccountOrdersV2RequestByAuthMode = {
|
|
|
9488
9542
|
"personalApiKey": ExperimentalEndpointsApiGetUserAccountOrdersV2personalApiKeyRequest;
|
|
9489
9543
|
};
|
|
9490
9544
|
type ExperimentalEndpointsApiGetUserAccountOrdersV2Request<TAuth extends AuthMode> = ExperimentalEndpointsApiGetUserAccountOrdersV2RequestByAuthMode[TAuth["mode"] & keyof ExperimentalEndpointsApiGetUserAccountOrdersV2RequestByAuthMode];
|
|
9545
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9546
|
+
type ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ExperimentalEndpointsApiGetUserAccountOrdersV2Request<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ExperimentalEndpointsApiGetUserAccountOrdersV2Request<TAuth>, options?: AxiosRequestConfig];
|
|
9491
9547
|
/**
|
|
9492
9548
|
* Request parameters for getUserAccountRecentOrdersV2 operation in ExperimentalEndpointsApi.
|
|
9493
9549
|
* @export
|
|
@@ -9519,6 +9575,8 @@ type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2RequestByAuthMode = {
|
|
|
9519
9575
|
"personalApiKey": ExperimentalEndpointsApiGetUserAccountRecentOrdersV2personalApiKeyRequest;
|
|
9520
9576
|
};
|
|
9521
9577
|
type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request<TAuth extends AuthMode> = ExperimentalEndpointsApiGetUserAccountRecentOrdersV2RequestByAuthMode[TAuth["mode"] & keyof ExperimentalEndpointsApiGetUserAccountRecentOrdersV2RequestByAuthMode];
|
|
9578
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9579
|
+
type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request<TAuth>, options?: AxiosRequestConfig];
|
|
9522
9580
|
/**
|
|
9523
9581
|
* Request parameters for listConnectionAccounts operation in ExperimentalEndpointsApi.
|
|
9524
9582
|
* @export
|
|
@@ -9544,6 +9602,8 @@ type ExperimentalEndpointsApiListConnectionAccountsRequestByAuthMode = {
|
|
|
9544
9602
|
"personalApiKey": ExperimentalEndpointsApiListConnectionAccountspersonalApiKeyRequest;
|
|
9545
9603
|
};
|
|
9546
9604
|
type ExperimentalEndpointsApiListConnectionAccountsRequest<TAuth extends AuthMode> = ExperimentalEndpointsApiListConnectionAccountsRequestByAuthMode[TAuth["mode"] & keyof ExperimentalEndpointsApiListConnectionAccountsRequestByAuthMode];
|
|
9605
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9606
|
+
type ExperimentalEndpointsApiListConnectionAccountsArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ExperimentalEndpointsApiListConnectionAccountsRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ExperimentalEndpointsApiListConnectionAccountsRequest<TAuth>, options?: AxiosRequestConfig];
|
|
9547
9607
|
/**
|
|
9548
9608
|
* ExperimentalEndpointsApiGenerated - object-oriented interface
|
|
9549
9609
|
* @export
|
|
@@ -9559,7 +9619,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
9559
9619
|
* @throws {RequiredError}
|
|
9560
9620
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
9561
9621
|
*/
|
|
9562
|
-
addSubscription(
|
|
9622
|
+
addSubscription(...args: ExperimentalEndpointsApiAddSubscriptionArgs<TAuth>): Promise<_$axios.AxiosResponse<TradeDetectionSubscription, any, {}>>;
|
|
9563
9623
|
/**
|
|
9564
9624
|
* Cancels a Trade Detection subscription for a connected brokerage account. This endpoint requires partner signature authentication only and does not require `userId` or `userSecret`.
|
|
9565
9625
|
* @summary Cancel a Trade Detection subscription
|
|
@@ -9568,7 +9628,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
9568
9628
|
* @throws {RequiredError}
|
|
9569
9629
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
9570
9630
|
*/
|
|
9571
|
-
cancelSubscription(
|
|
9631
|
+
cancelSubscription(...args: ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth>): Promise<_$axios.AxiosResponse<TradeDetectionCancelSubscriptionResponse, any, {}>>;
|
|
9572
9632
|
/**
|
|
9573
9633
|
* 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.
|
|
9574
9634
|
* @summary Get account order detail (V2)
|
|
@@ -9577,7 +9637,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
9577
9637
|
* @throws {RequiredError}
|
|
9578
9638
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
9579
9639
|
*/
|
|
9580
|
-
getUserAccountOrderDetailV2(
|
|
9640
|
+
getUserAccountOrderDetailV2(...args: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth>): Promise<_$axios.AxiosResponse<AccountOrderRecordV2, any, {}>>;
|
|
9581
9641
|
/**
|
|
9582
9642
|
* 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.
|
|
9583
9643
|
* @summary List account orders v2
|
|
@@ -9586,7 +9646,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
9586
9646
|
* @throws {RequiredError}
|
|
9587
9647
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
9588
9648
|
*/
|
|
9589
|
-
getUserAccountOrdersV2(
|
|
9649
|
+
getUserAccountOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth>): Promise<_$axios.AxiosResponse<AccountOrdersV2Response, any, {}>>;
|
|
9590
9650
|
/**
|
|
9591
9651
|
* 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)**
|
|
9592
9652
|
* @summary List account recent orders (V2, last 24 hours only)
|
|
@@ -9595,7 +9655,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
9595
9655
|
* @throws {RequiredError}
|
|
9596
9656
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
9597
9657
|
*/
|
|
9598
|
-
getUserAccountRecentOrdersV2(
|
|
9658
|
+
getUserAccountRecentOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth>): Promise<_$axios.AxiosResponse<AccountOrdersV2Response, any, {}>>;
|
|
9599
9659
|
/**
|
|
9600
9660
|
* 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.
|
|
9601
9661
|
* @summary List accounts for a connection (discriminated union)
|
|
@@ -9604,7 +9664,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
9604
9664
|
* @throws {RequiredError}
|
|
9605
9665
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
9606
9666
|
*/
|
|
9607
|
-
listConnectionAccounts(
|
|
9667
|
+
listConnectionAccounts(...args: ExperimentalEndpointsApiListConnectionAccountsArgs<TAuth>): Promise<_$axios.AxiosResponse<ConnectionAccount[], any, {}>>;
|
|
9608
9668
|
/**
|
|
9609
9669
|
* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
|
|
9610
9670
|
* @summary List active Trade Detection subscriptions
|
|
@@ -9715,7 +9775,7 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
9715
9775
|
* @param {*} [options] Override http request option.
|
|
9716
9776
|
* @throws {RequiredError}
|
|
9717
9777
|
*/
|
|
9718
|
-
getSymbols(
|
|
9778
|
+
getSymbols(...args: ReferenceDataApiGetSymbolsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalSymbol>>>;
|
|
9719
9779
|
/**
|
|
9720
9780
|
* 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.
|
|
9721
9781
|
* @summary Get symbol detail
|
|
@@ -9723,7 +9783,7 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
9723
9783
|
* @param {*} [options] Override http request option.
|
|
9724
9784
|
* @throws {RequiredError}
|
|
9725
9785
|
*/
|
|
9726
|
-
getSymbolsByTicker(
|
|
9786
|
+
getSymbolsByTicker(...args: ReferenceDataApiGetSymbolsByTickerArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UniversalSymbol>>;
|
|
9727
9787
|
/**
|
|
9728
9788
|
* Returns a list of all defined Brokerage authorization Type objects.
|
|
9729
9789
|
* @summary Get all brokerage authorization types
|
|
@@ -9731,7 +9791,7 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
9731
9791
|
* @param {*} [options] Override http request option.
|
|
9732
9792
|
* @throws {RequiredError}
|
|
9733
9793
|
*/
|
|
9734
|
-
listAllBrokerageAuthorizationType(
|
|
9794
|
+
listAllBrokerageAuthorizationType(...args: ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>>;
|
|
9735
9795
|
/**
|
|
9736
9796
|
* 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.
|
|
9737
9797
|
* @summary Get brokerage instruments
|
|
@@ -9739,7 +9799,7 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
9739
9799
|
* @param {*} [options] Override http request option.
|
|
9740
9800
|
* @throws {RequiredError}
|
|
9741
9801
|
*/
|
|
9742
|
-
listAllBrokerageInstruments(
|
|
9802
|
+
listAllBrokerageInstruments(...args: ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageInstrumentsResponse>>;
|
|
9743
9803
|
/**
|
|
9744
9804
|
* Returns a list of all defined Brokerage objects.
|
|
9745
9805
|
* @summary Get brokerages
|
|
@@ -9754,7 +9814,7 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
9754
9814
|
* @param {*} [options] Override http request option.
|
|
9755
9815
|
* @throws {RequiredError}
|
|
9756
9816
|
*/
|
|
9757
|
-
symbolSearchUserAccount(
|
|
9817
|
+
symbolSearchUserAccount(...args: ReferenceDataApiSymbolSearchUserAccountArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalSymbol>>>;
|
|
9758
9818
|
};
|
|
9759
9819
|
/**
|
|
9760
9820
|
* ReferenceDataApi - factory interface
|
|
@@ -9782,7 +9842,7 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
9782
9842
|
* @param {*} [options] Override http request option.
|
|
9783
9843
|
* @throws {RequiredError}
|
|
9784
9844
|
*/
|
|
9785
|
-
getSymbols(
|
|
9845
|
+
getSymbols(...args: ReferenceDataApiGetSymbolsArgs<TAuth>): AxiosPromise<Array<UniversalSymbol>>;
|
|
9786
9846
|
/**
|
|
9787
9847
|
* 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.
|
|
9788
9848
|
* @summary Get symbol detail
|
|
@@ -9790,7 +9850,7 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
9790
9850
|
* @param {*} [options] Override http request option.
|
|
9791
9851
|
* @throws {RequiredError}
|
|
9792
9852
|
*/
|
|
9793
|
-
getSymbolsByTicker(
|
|
9853
|
+
getSymbolsByTicker(...args: ReferenceDataApiGetSymbolsByTickerArgs<TAuth>): AxiosPromise<UniversalSymbol>;
|
|
9794
9854
|
/**
|
|
9795
9855
|
* Returns a list of all defined Brokerage authorization Type objects.
|
|
9796
9856
|
* @summary Get all brokerage authorization types
|
|
@@ -9798,7 +9858,7 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
9798
9858
|
* @param {*} [options] Override http request option.
|
|
9799
9859
|
* @throws {RequiredError}
|
|
9800
9860
|
*/
|
|
9801
|
-
listAllBrokerageAuthorizationType(
|
|
9861
|
+
listAllBrokerageAuthorizationType(...args: ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth>): AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>;
|
|
9802
9862
|
/**
|
|
9803
9863
|
* 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.
|
|
9804
9864
|
* @summary Get brokerage instruments
|
|
@@ -9806,7 +9866,7 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
9806
9866
|
* @param {*} [options] Override http request option.
|
|
9807
9867
|
* @throws {RequiredError}
|
|
9808
9868
|
*/
|
|
9809
|
-
listAllBrokerageInstruments(
|
|
9869
|
+
listAllBrokerageInstruments(...args: ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth>): AxiosPromise<BrokerageInstrumentsResponse>;
|
|
9810
9870
|
/**
|
|
9811
9871
|
* Returns a list of all defined Brokerage objects.
|
|
9812
9872
|
* @summary Get brokerages
|
|
@@ -9821,7 +9881,7 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
9821
9881
|
* @param {*} [options] Override http request option.
|
|
9822
9882
|
* @throws {RequiredError}
|
|
9823
9883
|
*/
|
|
9824
|
-
symbolSearchUserAccount(
|
|
9884
|
+
symbolSearchUserAccount(...args: ReferenceDataApiSymbolSearchUserAccountArgs<TAuth>): AxiosPromise<Array<UniversalSymbol>>;
|
|
9825
9885
|
};
|
|
9826
9886
|
/**
|
|
9827
9887
|
* Request parameters for getSymbols operation in ReferenceDataApi.
|
|
@@ -9835,6 +9895,8 @@ type ReferenceDataApiGetSymbolsRequestByAuthMode = {
|
|
|
9835
9895
|
"personalApiKey": ReferenceDataApiGetSymbolspersonalApiKeyRequest;
|
|
9836
9896
|
};
|
|
9837
9897
|
type ReferenceDataApiGetSymbolsRequest<TAuth extends AuthMode> = ReferenceDataApiGetSymbolsRequestByAuthMode[TAuth["mode"] & keyof ReferenceDataApiGetSymbolsRequestByAuthMode];
|
|
9898
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9899
|
+
type ReferenceDataApiGetSymbolsArgs<TAuth extends AuthMode> = TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [requestParameters?: ReferenceDataApiGetSymbolsRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ReferenceDataApiGetSymbolsRequest<TAuth>, options?: AxiosRequestConfig];
|
|
9838
9900
|
/**
|
|
9839
9901
|
* Request parameters for getSymbolsByTicker operation in ReferenceDataApi.
|
|
9840
9902
|
* @export
|
|
@@ -9854,6 +9916,8 @@ type ReferenceDataApiGetSymbolsByTickerRequestByAuthMode = {
|
|
|
9854
9916
|
"personalApiKey": ReferenceDataApiGetSymbolsByTickerpersonalApiKeyRequest;
|
|
9855
9917
|
};
|
|
9856
9918
|
type ReferenceDataApiGetSymbolsByTickerRequest<TAuth extends AuthMode> = ReferenceDataApiGetSymbolsByTickerRequestByAuthMode[TAuth["mode"] & keyof ReferenceDataApiGetSymbolsByTickerRequestByAuthMode];
|
|
9919
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9920
|
+
type ReferenceDataApiGetSymbolsByTickerArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ReferenceDataApiGetSymbolsByTickerRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ReferenceDataApiGetSymbolsByTickerRequest<TAuth>, options?: AxiosRequestConfig];
|
|
9857
9921
|
/**
|
|
9858
9922
|
* Request parameters for listAllBrokerageAuthorizationType operation in ReferenceDataApi.
|
|
9859
9923
|
* @export
|
|
@@ -9873,6 +9937,8 @@ type ReferenceDataApiListAllBrokerageAuthorizationTypeRequestByAuthMode = {
|
|
|
9873
9937
|
"personalApiKey": ReferenceDataApiListAllBrokerageAuthorizationTypepersonalApiKeyRequest;
|
|
9874
9938
|
};
|
|
9875
9939
|
type ReferenceDataApiListAllBrokerageAuthorizationTypeRequest<TAuth extends AuthMode> = ReferenceDataApiListAllBrokerageAuthorizationTypeRequestByAuthMode[TAuth["mode"] & keyof ReferenceDataApiListAllBrokerageAuthorizationTypeRequestByAuthMode];
|
|
9940
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9941
|
+
type ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth extends AuthMode> = TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest<TAuth>, options?: AxiosRequestConfig];
|
|
9876
9942
|
/**
|
|
9877
9943
|
* Request parameters for listAllBrokerageInstruments operation in ReferenceDataApi.
|
|
9878
9944
|
* @export
|
|
@@ -9892,6 +9958,8 @@ type ReferenceDataApiListAllBrokerageInstrumentsRequestByAuthMode = {
|
|
|
9892
9958
|
"personalApiKey": ReferenceDataApiListAllBrokerageInstrumentspersonalApiKeyRequest;
|
|
9893
9959
|
};
|
|
9894
9960
|
type ReferenceDataApiListAllBrokerageInstrumentsRequest<TAuth extends AuthMode> = ReferenceDataApiListAllBrokerageInstrumentsRequestByAuthMode[TAuth["mode"] & keyof ReferenceDataApiListAllBrokerageInstrumentsRequestByAuthMode];
|
|
9961
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9962
|
+
type ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ReferenceDataApiListAllBrokerageInstrumentsRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ReferenceDataApiListAllBrokerageInstrumentsRequest<TAuth>, options?: AxiosRequestConfig];
|
|
9895
9963
|
/**
|
|
9896
9964
|
* Request parameters for symbolSearchUserAccount operation in ReferenceDataApi.
|
|
9897
9965
|
* @export
|
|
@@ -9917,6 +9985,8 @@ type ReferenceDataApiSymbolSearchUserAccountRequestByAuthMode = {
|
|
|
9917
9985
|
"personalApiKey": ReferenceDataApiSymbolSearchUserAccountpersonalApiKeyRequest;
|
|
9918
9986
|
};
|
|
9919
9987
|
type ReferenceDataApiSymbolSearchUserAccountRequest<TAuth extends AuthMode> = ReferenceDataApiSymbolSearchUserAccountRequestByAuthMode[TAuth["mode"] & keyof ReferenceDataApiSymbolSearchUserAccountRequestByAuthMode];
|
|
9988
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
9989
|
+
type ReferenceDataApiSymbolSearchUserAccountArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: ReferenceDataApiSymbolSearchUserAccountRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest<TAuth>, options?: AxiosRequestConfig];
|
|
9920
9990
|
/**
|
|
9921
9991
|
* ReferenceDataApiGenerated - object-oriented interface
|
|
9922
9992
|
* @export
|
|
@@ -9948,7 +10018,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
9948
10018
|
* @throws {RequiredError}
|
|
9949
10019
|
* @memberof ReferenceDataApiGenerated
|
|
9950
10020
|
*/
|
|
9951
|
-
getSymbols(
|
|
10021
|
+
getSymbols(...args: ReferenceDataApiGetSymbolsArgs<TAuth>): Promise<_$axios.AxiosResponse<UniversalSymbol[], any, {}>>;
|
|
9952
10022
|
/**
|
|
9953
10023
|
* 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.
|
|
9954
10024
|
* @summary Get symbol detail
|
|
@@ -9957,7 +10027,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
9957
10027
|
* @throws {RequiredError}
|
|
9958
10028
|
* @memberof ReferenceDataApiGenerated
|
|
9959
10029
|
*/
|
|
9960
|
-
getSymbolsByTicker(
|
|
10030
|
+
getSymbolsByTicker(...args: ReferenceDataApiGetSymbolsByTickerArgs<TAuth>): Promise<_$axios.AxiosResponse<UniversalSymbol, any, {}>>;
|
|
9961
10031
|
/**
|
|
9962
10032
|
* Returns a list of all defined Brokerage authorization Type objects.
|
|
9963
10033
|
* @summary Get all brokerage authorization types
|
|
@@ -9966,7 +10036,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
9966
10036
|
* @throws {RequiredError}
|
|
9967
10037
|
* @memberof ReferenceDataApiGenerated
|
|
9968
10038
|
*/
|
|
9969
|
-
listAllBrokerageAuthorizationType(
|
|
10039
|
+
listAllBrokerageAuthorizationType(...args: ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth>): Promise<_$axios.AxiosResponse<BrokerageAuthorizationTypeReadOnly[], any, {}>>;
|
|
9970
10040
|
/**
|
|
9971
10041
|
* 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.
|
|
9972
10042
|
* @summary Get brokerage instruments
|
|
@@ -9975,7 +10045,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
9975
10045
|
* @throws {RequiredError}
|
|
9976
10046
|
* @memberof ReferenceDataApiGenerated
|
|
9977
10047
|
*/
|
|
9978
|
-
listAllBrokerageInstruments(
|
|
10048
|
+
listAllBrokerageInstruments(...args: ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth>): Promise<_$axios.AxiosResponse<BrokerageInstrumentsResponse, any, {}>>;
|
|
9979
10049
|
/**
|
|
9980
10050
|
* Returns a list of all defined Brokerage objects.
|
|
9981
10051
|
* @summary Get brokerages
|
|
@@ -9992,7 +10062,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
9992
10062
|
* @throws {RequiredError}
|
|
9993
10063
|
* @memberof ReferenceDataApiGenerated
|
|
9994
10064
|
*/
|
|
9995
|
-
symbolSearchUserAccount(
|
|
10065
|
+
symbolSearchUserAccount(...args: ReferenceDataApiSymbolSearchUserAccountArgs<TAuth>): Promise<_$axios.AxiosResponse<UniversalSymbol[], any, {}>>;
|
|
9996
10066
|
}
|
|
9997
10067
|
//#endregion
|
|
9998
10068
|
//#region api/reference-data-api.d.ts
|
|
@@ -10172,7 +10242,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10172
10242
|
* @param {*} [options] Override http request option.
|
|
10173
10243
|
* @throws {RequiredError}
|
|
10174
10244
|
*/
|
|
10175
|
-
cancelOrder(
|
|
10245
|
+
cancelOrder(...args: TradingApiCancelOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelOrderResponse>>;
|
|
10176
10246
|
/**
|
|
10177
10247
|
* Gets a quote for the specified account.
|
|
10178
10248
|
* @summary Get crypto pair quote
|
|
@@ -10180,7 +10250,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10180
10250
|
* @param {*} [options] Override http request option.
|
|
10181
10251
|
* @throws {RequiredError}
|
|
10182
10252
|
*/
|
|
10183
|
-
getCryptocurrencyPairQuote(
|
|
10253
|
+
getCryptocurrencyPairQuote(...args: TradingApiGetCryptocurrencyPairQuoteArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CryptocurrencyPairQuote>>;
|
|
10184
10254
|
/**
|
|
10185
10255
|
* 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.
|
|
10186
10256
|
* @summary Get option order impact
|
|
@@ -10188,7 +10258,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10188
10258
|
* @param {*} [options] Override http request option.
|
|
10189
10259
|
* @throws {RequiredError}
|
|
10190
10260
|
*/
|
|
10191
|
-
getOptionImpact(
|
|
10261
|
+
getOptionImpact(...args: TradingApiGetOptionImpactArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionImpact>>;
|
|
10192
10262
|
/**
|
|
10193
10263
|
* 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.
|
|
10194
10264
|
* @summary Check equity order impact
|
|
@@ -10196,7 +10266,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10196
10266
|
* @param {*} [options] Override http request option.
|
|
10197
10267
|
* @throws {RequiredError}
|
|
10198
10268
|
*/
|
|
10199
|
-
getOrderImpact(
|
|
10269
|
+
getOrderImpact(...args: TradingApiGetOrderImpactArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualTradeAndImpact>>;
|
|
10200
10270
|
/**
|
|
10201
10271
|
* 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**
|
|
10202
10272
|
* @summary Get option quote
|
|
@@ -10205,7 +10275,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10205
10275
|
* @deprecated
|
|
10206
10276
|
* @throws {RequiredError}
|
|
10207
10277
|
*/
|
|
10208
|
-
getUserAccountOptionQuotes(
|
|
10278
|
+
getUserAccountOptionQuotes(...args: TradingApiGetUserAccountOptionQuotesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionQuote>>;
|
|
10209
10279
|
/**
|
|
10210
10280
|
* 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.
|
|
10211
10281
|
* @summary Get equity symbol quotes
|
|
@@ -10213,7 +10283,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10213
10283
|
* @param {*} [options] Override http request option.
|
|
10214
10284
|
* @throws {RequiredError}
|
|
10215
10285
|
*/
|
|
10216
|
-
getUserAccountQuotes(
|
|
10286
|
+
getUserAccountQuotes(...args: TradingApiGetUserAccountQuotesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SymbolsQuotesInner>>>;
|
|
10217
10287
|
/**
|
|
10218
10288
|
* 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.
|
|
10219
10289
|
* @summary Place complex order
|
|
@@ -10221,7 +10291,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10221
10291
|
* @param {*} [options] Override http request option.
|
|
10222
10292
|
* @throws {RequiredError}
|
|
10223
10293
|
*/
|
|
10224
|
-
placeComplexOrder(
|
|
10294
|
+
placeComplexOrder(...args: TradingApiPlaceComplexOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ComplexOrderResponse>>;
|
|
10225
10295
|
/**
|
|
10226
10296
|
* 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.
|
|
10227
10297
|
* @summary Place crypto order
|
|
@@ -10229,7 +10299,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10229
10299
|
* @param {*} [options] Override http request option.
|
|
10230
10300
|
* @throws {RequiredError}
|
|
10231
10301
|
*/
|
|
10232
|
-
placeCryptoOrder(
|
|
10302
|
+
placeCryptoOrder(...args: TradingApiPlaceCryptoOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderUpdatedResponse>>;
|
|
10233
10303
|
/**
|
|
10234
10304
|
* 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.
|
|
10235
10305
|
* @summary Place equity order
|
|
@@ -10237,7 +10307,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10237
10307
|
* @param {*} [options] Override http request option.
|
|
10238
10308
|
* @throws {RequiredError}
|
|
10239
10309
|
*/
|
|
10240
|
-
placeForceOrder(
|
|
10310
|
+
placeForceOrder(...args: TradingApiPlaceForceOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
10241
10311
|
/**
|
|
10242
10312
|
* Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
|
|
10243
10313
|
* @summary Place option order
|
|
@@ -10245,7 +10315,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10245
10315
|
* @param {*} [options] Override http request option.
|
|
10246
10316
|
* @throws {RequiredError}
|
|
10247
10317
|
*/
|
|
10248
|
-
placeMlegOrder(
|
|
10318
|
+
placeMlegOrder(...args: TradingApiPlaceMlegOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MlegOrderResponse>>;
|
|
10249
10319
|
/**
|
|
10250
10320
|
* 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.
|
|
10251
10321
|
* @summary Place checked equity order
|
|
@@ -10253,7 +10323,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10253
10323
|
* @param {*} [options] Override http request option.
|
|
10254
10324
|
* @throws {RequiredError}
|
|
10255
10325
|
*/
|
|
10256
|
-
placeOrder(
|
|
10326
|
+
placeOrder(...args: TradingApiPlaceOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
10257
10327
|
/**
|
|
10258
10328
|
* Previews an order using the specified account.
|
|
10259
10329
|
* @summary Preview crypto order
|
|
@@ -10261,7 +10331,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10261
10331
|
* @param {*} [options] Override http request option.
|
|
10262
10332
|
* @throws {RequiredError}
|
|
10263
10333
|
*/
|
|
10264
|
-
previewCryptoOrder(
|
|
10334
|
+
previewCryptoOrder(...args: TradingApiPreviewCryptoOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CryptoOrderPreview>>;
|
|
10265
10335
|
/**
|
|
10266
10336
|
* 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
|
|
10267
10337
|
* @summary Replace order
|
|
@@ -10269,7 +10339,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10269
10339
|
* @param {*} [options] Override http request option.
|
|
10270
10340
|
* @throws {RequiredError}
|
|
10271
10341
|
*/
|
|
10272
|
-
replaceOrder(
|
|
10342
|
+
replaceOrder(...args: TradingApiReplaceOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
10273
10343
|
/**
|
|
10274
10344
|
* Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
|
|
10275
10345
|
* @summary Get crypto pairs
|
|
@@ -10277,7 +10347,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10277
10347
|
* @param {*} [options] Override http request option.
|
|
10278
10348
|
* @throws {RequiredError}
|
|
10279
10349
|
*/
|
|
10280
|
-
searchCryptocurrencyPairInstruments(
|
|
10350
|
+
searchCryptocurrencyPairInstruments(...args: TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TradingSearchCryptocurrencyPairInstruments200Response>>;
|
|
10281
10351
|
};
|
|
10282
10352
|
/**
|
|
10283
10353
|
* TradingApi - factory interface
|
|
@@ -10291,7 +10361,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10291
10361
|
* @param {*} [options] Override http request option.
|
|
10292
10362
|
* @throws {RequiredError}
|
|
10293
10363
|
*/
|
|
10294
|
-
cancelOrder(
|
|
10364
|
+
cancelOrder(...args: TradingApiCancelOrderArgs<TAuth>): AxiosPromise<CancelOrderResponse>;
|
|
10295
10365
|
/**
|
|
10296
10366
|
* Gets a quote for the specified account.
|
|
10297
10367
|
* @summary Get crypto pair quote
|
|
@@ -10299,7 +10369,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10299
10369
|
* @param {*} [options] Override http request option.
|
|
10300
10370
|
* @throws {RequiredError}
|
|
10301
10371
|
*/
|
|
10302
|
-
getCryptocurrencyPairQuote(
|
|
10372
|
+
getCryptocurrencyPairQuote(...args: TradingApiGetCryptocurrencyPairQuoteArgs<TAuth>): AxiosPromise<CryptocurrencyPairQuote>;
|
|
10303
10373
|
/**
|
|
10304
10374
|
* 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.
|
|
10305
10375
|
* @summary Get option order impact
|
|
@@ -10307,7 +10377,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10307
10377
|
* @param {*} [options] Override http request option.
|
|
10308
10378
|
* @throws {RequiredError}
|
|
10309
10379
|
*/
|
|
10310
|
-
getOptionImpact(
|
|
10380
|
+
getOptionImpact(...args: TradingApiGetOptionImpactArgs<TAuth>): AxiosPromise<OptionImpact>;
|
|
10311
10381
|
/**
|
|
10312
10382
|
* 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.
|
|
10313
10383
|
* @summary Check equity order impact
|
|
@@ -10315,7 +10385,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10315
10385
|
* @param {*} [options] Override http request option.
|
|
10316
10386
|
* @throws {RequiredError}
|
|
10317
10387
|
*/
|
|
10318
|
-
getOrderImpact(
|
|
10388
|
+
getOrderImpact(...args: TradingApiGetOrderImpactArgs<TAuth>): AxiosPromise<ManualTradeAndImpact>;
|
|
10319
10389
|
/**
|
|
10320
10390
|
* 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**
|
|
10321
10391
|
* @summary Get option quote
|
|
@@ -10324,7 +10394,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10324
10394
|
* @deprecated
|
|
10325
10395
|
* @throws {RequiredError}
|
|
10326
10396
|
*/
|
|
10327
|
-
getUserAccountOptionQuotes(
|
|
10397
|
+
getUserAccountOptionQuotes(...args: TradingApiGetUserAccountOptionQuotesArgs<TAuth>): AxiosPromise<OptionQuote>;
|
|
10328
10398
|
/**
|
|
10329
10399
|
* 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.
|
|
10330
10400
|
* @summary Get equity symbol quotes
|
|
@@ -10332,7 +10402,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10332
10402
|
* @param {*} [options] Override http request option.
|
|
10333
10403
|
* @throws {RequiredError}
|
|
10334
10404
|
*/
|
|
10335
|
-
getUserAccountQuotes(
|
|
10405
|
+
getUserAccountQuotes(...args: TradingApiGetUserAccountQuotesArgs<TAuth>): AxiosPromise<Array<SymbolsQuotesInner>>;
|
|
10336
10406
|
/**
|
|
10337
10407
|
* 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.
|
|
10338
10408
|
* @summary Place complex order
|
|
@@ -10340,7 +10410,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10340
10410
|
* @param {*} [options] Override http request option.
|
|
10341
10411
|
* @throws {RequiredError}
|
|
10342
10412
|
*/
|
|
10343
|
-
placeComplexOrder(
|
|
10413
|
+
placeComplexOrder(...args: TradingApiPlaceComplexOrderArgs<TAuth>): AxiosPromise<ComplexOrderResponse>;
|
|
10344
10414
|
/**
|
|
10345
10415
|
* 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.
|
|
10346
10416
|
* @summary Place crypto order
|
|
@@ -10348,7 +10418,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10348
10418
|
* @param {*} [options] Override http request option.
|
|
10349
10419
|
* @throws {RequiredError}
|
|
10350
10420
|
*/
|
|
10351
|
-
placeCryptoOrder(
|
|
10421
|
+
placeCryptoOrder(...args: TradingApiPlaceCryptoOrderArgs<TAuth>): AxiosPromise<OrderUpdatedResponse>;
|
|
10352
10422
|
/**
|
|
10353
10423
|
* 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.
|
|
10354
10424
|
* @summary Place equity order
|
|
@@ -10356,7 +10426,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10356
10426
|
* @param {*} [options] Override http request option.
|
|
10357
10427
|
* @throws {RequiredError}
|
|
10358
10428
|
*/
|
|
10359
|
-
placeForceOrder(
|
|
10429
|
+
placeForceOrder(...args: TradingApiPlaceForceOrderArgs<TAuth>): AxiosPromise<AccountOrderRecord>;
|
|
10360
10430
|
/**
|
|
10361
10431
|
* Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
|
|
10362
10432
|
* @summary Place option order
|
|
@@ -10364,7 +10434,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10364
10434
|
* @param {*} [options] Override http request option.
|
|
10365
10435
|
* @throws {RequiredError}
|
|
10366
10436
|
*/
|
|
10367
|
-
placeMlegOrder(
|
|
10437
|
+
placeMlegOrder(...args: TradingApiPlaceMlegOrderArgs<TAuth>): AxiosPromise<MlegOrderResponse>;
|
|
10368
10438
|
/**
|
|
10369
10439
|
* 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.
|
|
10370
10440
|
* @summary Place checked equity order
|
|
@@ -10372,7 +10442,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10372
10442
|
* @param {*} [options] Override http request option.
|
|
10373
10443
|
* @throws {RequiredError}
|
|
10374
10444
|
*/
|
|
10375
|
-
placeOrder(
|
|
10445
|
+
placeOrder(...args: TradingApiPlaceOrderArgs<TAuth>): AxiosPromise<AccountOrderRecord>;
|
|
10376
10446
|
/**
|
|
10377
10447
|
* Previews an order using the specified account.
|
|
10378
10448
|
* @summary Preview crypto order
|
|
@@ -10380,7 +10450,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10380
10450
|
* @param {*} [options] Override http request option.
|
|
10381
10451
|
* @throws {RequiredError}
|
|
10382
10452
|
*/
|
|
10383
|
-
previewCryptoOrder(
|
|
10453
|
+
previewCryptoOrder(...args: TradingApiPreviewCryptoOrderArgs<TAuth>): AxiosPromise<CryptoOrderPreview>;
|
|
10384
10454
|
/**
|
|
10385
10455
|
* 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
|
|
10386
10456
|
* @summary Replace order
|
|
@@ -10388,7 +10458,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10388
10458
|
* @param {*} [options] Override http request option.
|
|
10389
10459
|
* @throws {RequiredError}
|
|
10390
10460
|
*/
|
|
10391
|
-
replaceOrder(
|
|
10461
|
+
replaceOrder(...args: TradingApiReplaceOrderArgs<TAuth>): AxiosPromise<AccountOrderRecord>;
|
|
10392
10462
|
/**
|
|
10393
10463
|
* Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
|
|
10394
10464
|
* @summary Get crypto pairs
|
|
@@ -10396,7 +10466,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10396
10466
|
* @param {*} [options] Override http request option.
|
|
10397
10467
|
* @throws {RequiredError}
|
|
10398
10468
|
*/
|
|
10399
|
-
searchCryptocurrencyPairInstruments(
|
|
10469
|
+
searchCryptocurrencyPairInstruments(...args: TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth>): AxiosPromise<TradingSearchCryptocurrencyPairInstruments200Response>;
|
|
10400
10470
|
};
|
|
10401
10471
|
/**
|
|
10402
10472
|
* Request parameters for cancelOrder operation in TradingApi.
|
|
@@ -10423,6 +10493,8 @@ type TradingApiCancelOrderRequestByAuthMode = {
|
|
|
10423
10493
|
"personalApiKey": TradingApiCancelOrderpersonalApiKeyRequest;
|
|
10424
10494
|
};
|
|
10425
10495
|
type TradingApiCancelOrderRequest<TAuth extends AuthMode> = TradingApiCancelOrderRequestByAuthMode[TAuth["mode"] & keyof TradingApiCancelOrderRequestByAuthMode];
|
|
10496
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
10497
|
+
type TradingApiCancelOrderArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: TradingApiCancelOrderRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: TradingApiCancelOrderRequest<TAuth>, options?: AxiosRequestConfig];
|
|
10426
10498
|
/**
|
|
10427
10499
|
* Request parameters for getCryptocurrencyPairQuote operation in TradingApi.
|
|
10428
10500
|
* @export
|
|
@@ -10454,6 +10526,8 @@ type TradingApiGetCryptocurrencyPairQuoteRequestByAuthMode = {
|
|
|
10454
10526
|
"personalApiKey": TradingApiGetCryptocurrencyPairQuotepersonalApiKeyRequest;
|
|
10455
10527
|
};
|
|
10456
10528
|
type TradingApiGetCryptocurrencyPairQuoteRequest<TAuth extends AuthMode> = TradingApiGetCryptocurrencyPairQuoteRequestByAuthMode[TAuth["mode"] & keyof TradingApiGetCryptocurrencyPairQuoteRequestByAuthMode];
|
|
10529
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
10530
|
+
type TradingApiGetCryptocurrencyPairQuoteArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: TradingApiGetCryptocurrencyPairQuoteRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest<TAuth>, options?: AxiosRequestConfig];
|
|
10457
10531
|
/**
|
|
10458
10532
|
* Request parameters for getOptionImpact operation in TradingApi.
|
|
10459
10533
|
* @export
|
|
@@ -10479,6 +10553,8 @@ type TradingApiGetOptionImpactRequestByAuthMode = {
|
|
|
10479
10553
|
"personalApiKey": TradingApiGetOptionImpactpersonalApiKeyRequest;
|
|
10480
10554
|
};
|
|
10481
10555
|
type TradingApiGetOptionImpactRequest<TAuth extends AuthMode> = TradingApiGetOptionImpactRequestByAuthMode[TAuth["mode"] & keyof TradingApiGetOptionImpactRequestByAuthMode];
|
|
10556
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
10557
|
+
type TradingApiGetOptionImpactArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: TradingApiGetOptionImpactRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: TradingApiGetOptionImpactRequest<TAuth>, options?: AxiosRequestConfig];
|
|
10482
10558
|
/**
|
|
10483
10559
|
* Request parameters for getOrderImpact operation in TradingApi.
|
|
10484
10560
|
* @export
|
|
@@ -10497,6 +10573,8 @@ type TradingApiGetOrderImpactRequestByAuthMode = {
|
|
|
10497
10573
|
"personalApiKey": TradingApiGetOrderImpactpersonalApiKeyRequest;
|
|
10498
10574
|
};
|
|
10499
10575
|
type TradingApiGetOrderImpactRequest<TAuth extends AuthMode> = TradingApiGetOrderImpactRequestByAuthMode[TAuth["mode"] & keyof TradingApiGetOrderImpactRequestByAuthMode];
|
|
10576
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
10577
|
+
type TradingApiGetOrderImpactArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: TradingApiGetOrderImpactRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: TradingApiGetOrderImpactRequest<TAuth>, options?: AxiosRequestConfig];
|
|
10500
10578
|
/**
|
|
10501
10579
|
* Request parameters for getUserAccountOptionQuotes operation in TradingApi.
|
|
10502
10580
|
* @export
|
|
@@ -10528,6 +10606,8 @@ type TradingApiGetUserAccountOptionQuotesRequestByAuthMode = {
|
|
|
10528
10606
|
"personalApiKey": TradingApiGetUserAccountOptionQuotespersonalApiKeyRequest;
|
|
10529
10607
|
};
|
|
10530
10608
|
type TradingApiGetUserAccountOptionQuotesRequest<TAuth extends AuthMode> = TradingApiGetUserAccountOptionQuotesRequestByAuthMode[TAuth["mode"] & keyof TradingApiGetUserAccountOptionQuotesRequestByAuthMode];
|
|
10609
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
10610
|
+
type TradingApiGetUserAccountOptionQuotesArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: TradingApiGetUserAccountOptionQuotesRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: TradingApiGetUserAccountOptionQuotesRequest<TAuth>, options?: AxiosRequestConfig];
|
|
10531
10611
|
/**
|
|
10532
10612
|
* Request parameters for getUserAccountQuotes operation in TradingApi.
|
|
10533
10613
|
* @export
|
|
@@ -10565,6 +10645,8 @@ type TradingApiGetUserAccountQuotesRequestByAuthMode = {
|
|
|
10565
10645
|
"personalApiKey": TradingApiGetUserAccountQuotespersonalApiKeyRequest;
|
|
10566
10646
|
};
|
|
10567
10647
|
type TradingApiGetUserAccountQuotesRequest<TAuth extends AuthMode> = TradingApiGetUserAccountQuotesRequestByAuthMode[TAuth["mode"] & keyof TradingApiGetUserAccountQuotesRequestByAuthMode];
|
|
10648
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
10649
|
+
type TradingApiGetUserAccountQuotesArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: TradingApiGetUserAccountQuotesRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: TradingApiGetUserAccountQuotesRequest<TAuth>, options?: AxiosRequestConfig];
|
|
10568
10650
|
/**
|
|
10569
10651
|
* Request parameters for placeComplexOrder operation in TradingApi.
|
|
10570
10652
|
* @export
|
|
@@ -10590,6 +10672,8 @@ type TradingApiPlaceComplexOrderRequestByAuthMode = {
|
|
|
10590
10672
|
"personalApiKey": TradingApiPlaceComplexOrderpersonalApiKeyRequest;
|
|
10591
10673
|
};
|
|
10592
10674
|
type TradingApiPlaceComplexOrderRequest<TAuth extends AuthMode> = TradingApiPlaceComplexOrderRequestByAuthMode[TAuth["mode"] & keyof TradingApiPlaceComplexOrderRequestByAuthMode];
|
|
10675
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
10676
|
+
type TradingApiPlaceComplexOrderArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: TradingApiPlaceComplexOrderRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: TradingApiPlaceComplexOrderRequest<TAuth>, options?: AxiosRequestConfig];
|
|
10593
10677
|
/**
|
|
10594
10678
|
* Request parameters for placeCryptoOrder operation in TradingApi.
|
|
10595
10679
|
* @export
|
|
@@ -10615,6 +10699,8 @@ type TradingApiPlaceCryptoOrderRequestByAuthMode = {
|
|
|
10615
10699
|
"personalApiKey": TradingApiPlaceCryptoOrderpersonalApiKeyRequest;
|
|
10616
10700
|
};
|
|
10617
10701
|
type TradingApiPlaceCryptoOrderRequest<TAuth extends AuthMode> = TradingApiPlaceCryptoOrderRequestByAuthMode[TAuth["mode"] & keyof TradingApiPlaceCryptoOrderRequestByAuthMode];
|
|
10702
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
10703
|
+
type TradingApiPlaceCryptoOrderArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: TradingApiPlaceCryptoOrderRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: TradingApiPlaceCryptoOrderRequest<TAuth>, options?: AxiosRequestConfig];
|
|
10618
10704
|
/**
|
|
10619
10705
|
* Request parameters for placeForceOrder operation in TradingApi.
|
|
10620
10706
|
* @export
|
|
@@ -10633,6 +10719,8 @@ type TradingApiPlaceForceOrderRequestByAuthMode = {
|
|
|
10633
10719
|
"personalApiKey": TradingApiPlaceForceOrderpersonalApiKeyRequest;
|
|
10634
10720
|
};
|
|
10635
10721
|
type TradingApiPlaceForceOrderRequest<TAuth extends AuthMode> = TradingApiPlaceForceOrderRequestByAuthMode[TAuth["mode"] & keyof TradingApiPlaceForceOrderRequestByAuthMode];
|
|
10722
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
10723
|
+
type TradingApiPlaceForceOrderArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: TradingApiPlaceForceOrderRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: TradingApiPlaceForceOrderRequest<TAuth>, options?: AxiosRequestConfig];
|
|
10636
10724
|
/**
|
|
10637
10725
|
* Request parameters for placeMlegOrder operation in TradingApi.
|
|
10638
10726
|
* @export
|
|
@@ -10658,6 +10746,8 @@ type TradingApiPlaceMlegOrderRequestByAuthMode = {
|
|
|
10658
10746
|
"personalApiKey": TradingApiPlaceMlegOrderpersonalApiKeyRequest;
|
|
10659
10747
|
};
|
|
10660
10748
|
type TradingApiPlaceMlegOrderRequest<TAuth extends AuthMode> = TradingApiPlaceMlegOrderRequestByAuthMode[TAuth["mode"] & keyof TradingApiPlaceMlegOrderRequestByAuthMode];
|
|
10749
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
10750
|
+
type TradingApiPlaceMlegOrderArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: TradingApiPlaceMlegOrderRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: TradingApiPlaceMlegOrderRequest<TAuth>, options?: AxiosRequestConfig];
|
|
10661
10751
|
/**
|
|
10662
10752
|
* Request parameters for placeOrder operation in TradingApi.
|
|
10663
10753
|
* @export
|
|
@@ -10683,6 +10773,8 @@ type TradingApiPlaceOrderRequestByAuthMode = {
|
|
|
10683
10773
|
"personalApiKey": TradingApiPlaceOrderpersonalApiKeyRequest;
|
|
10684
10774
|
};
|
|
10685
10775
|
type TradingApiPlaceOrderRequest<TAuth extends AuthMode> = TradingApiPlaceOrderRequestByAuthMode[TAuth["mode"] & keyof TradingApiPlaceOrderRequestByAuthMode];
|
|
10776
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
10777
|
+
type TradingApiPlaceOrderArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: TradingApiPlaceOrderRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: TradingApiPlaceOrderRequest<TAuth>, options?: AxiosRequestConfig];
|
|
10686
10778
|
/**
|
|
10687
10779
|
* Request parameters for previewCryptoOrder operation in TradingApi.
|
|
10688
10780
|
* @export
|
|
@@ -10708,6 +10800,8 @@ type TradingApiPreviewCryptoOrderRequestByAuthMode = {
|
|
|
10708
10800
|
"personalApiKey": TradingApiPreviewCryptoOrderpersonalApiKeyRequest;
|
|
10709
10801
|
};
|
|
10710
10802
|
type TradingApiPreviewCryptoOrderRequest<TAuth extends AuthMode> = TradingApiPreviewCryptoOrderRequestByAuthMode[TAuth["mode"] & keyof TradingApiPreviewCryptoOrderRequestByAuthMode];
|
|
10803
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
10804
|
+
type TradingApiPreviewCryptoOrderArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: TradingApiPreviewCryptoOrderRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: TradingApiPreviewCryptoOrderRequest<TAuth>, options?: AxiosRequestConfig];
|
|
10711
10805
|
/**
|
|
10712
10806
|
* Request parameters for replaceOrder operation in TradingApi.
|
|
10713
10807
|
* @export
|
|
@@ -10733,6 +10827,8 @@ type TradingApiReplaceOrderRequestByAuthMode = {
|
|
|
10733
10827
|
"personalApiKey": TradingApiReplaceOrderpersonalApiKeyRequest;
|
|
10734
10828
|
};
|
|
10735
10829
|
type TradingApiReplaceOrderRequest<TAuth extends AuthMode> = TradingApiReplaceOrderRequestByAuthMode[TAuth["mode"] & keyof TradingApiReplaceOrderRequestByAuthMode];
|
|
10830
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
10831
|
+
type TradingApiReplaceOrderArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: TradingApiReplaceOrderRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: TradingApiReplaceOrderRequest<TAuth>, options?: AxiosRequestConfig];
|
|
10736
10832
|
/**
|
|
10737
10833
|
* Request parameters for searchCryptocurrencyPairInstruments operation in TradingApi.
|
|
10738
10834
|
* @export
|
|
@@ -10770,6 +10866,8 @@ type TradingApiSearchCryptocurrencyPairInstrumentsRequestByAuthMode = {
|
|
|
10770
10866
|
"personalApiKey": TradingApiSearchCryptocurrencyPairInstrumentspersonalApiKeyRequest;
|
|
10771
10867
|
};
|
|
10772
10868
|
type TradingApiSearchCryptocurrencyPairInstrumentsRequest<TAuth extends AuthMode> = TradingApiSearchCryptocurrencyPairInstrumentsRequestByAuthMode[TAuth["mode"] & keyof TradingApiSearchCryptocurrencyPairInstrumentsRequestByAuthMode];
|
|
10869
|
+
/** Request argument optionality depends on the selected authentication mode. */
|
|
10870
|
+
type TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth extends AuthMode> = TAuth["mode"] extends never ? [requestParameters?: TradingApiSearchCryptocurrencyPairInstrumentsRequest<TAuth>, options?: AxiosRequestConfig] : [requestParameters: TradingApiSearchCryptocurrencyPairInstrumentsRequest<TAuth>, options?: AxiosRequestConfig];
|
|
10773
10871
|
/**
|
|
10774
10872
|
* TradingApiGenerated - object-oriented interface
|
|
10775
10873
|
* @export
|
|
@@ -10785,7 +10883,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10785
10883
|
* @throws {RequiredError}
|
|
10786
10884
|
* @memberof TradingApiGenerated
|
|
10787
10885
|
*/
|
|
10788
|
-
cancelOrder(
|
|
10886
|
+
cancelOrder(...args: TradingApiCancelOrderArgs<TAuth>): Promise<_$axios.AxiosResponse<CancelOrderResponse, any, {}>>;
|
|
10789
10887
|
/**
|
|
10790
10888
|
* Gets a quote for the specified account.
|
|
10791
10889
|
* @summary Get crypto pair quote
|
|
@@ -10794,7 +10892,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10794
10892
|
* @throws {RequiredError}
|
|
10795
10893
|
* @memberof TradingApiGenerated
|
|
10796
10894
|
*/
|
|
10797
|
-
getCryptocurrencyPairQuote(
|
|
10895
|
+
getCryptocurrencyPairQuote(...args: TradingApiGetCryptocurrencyPairQuoteArgs<TAuth>): Promise<_$axios.AxiosResponse<CryptocurrencyPairQuote, any, {}>>;
|
|
10798
10896
|
/**
|
|
10799
10897
|
* 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.
|
|
10800
10898
|
* @summary Get option order impact
|
|
@@ -10803,7 +10901,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10803
10901
|
* @throws {RequiredError}
|
|
10804
10902
|
* @memberof TradingApiGenerated
|
|
10805
10903
|
*/
|
|
10806
|
-
getOptionImpact(
|
|
10904
|
+
getOptionImpact(...args: TradingApiGetOptionImpactArgs<TAuth>): Promise<_$axios.AxiosResponse<OptionImpact, any, {}>>;
|
|
10807
10905
|
/**
|
|
10808
10906
|
* 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.
|
|
10809
10907
|
* @summary Check equity order impact
|
|
@@ -10812,7 +10910,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10812
10910
|
* @throws {RequiredError}
|
|
10813
10911
|
* @memberof TradingApiGenerated
|
|
10814
10912
|
*/
|
|
10815
|
-
getOrderImpact(
|
|
10913
|
+
getOrderImpact(...args: TradingApiGetOrderImpactArgs<TAuth>): Promise<_$axios.AxiosResponse<ManualTradeAndImpact, any, {}>>;
|
|
10816
10914
|
/**
|
|
10817
10915
|
* 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**
|
|
10818
10916
|
* @summary Get option quote
|
|
@@ -10822,7 +10920,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10822
10920
|
* @throws {RequiredError}
|
|
10823
10921
|
* @memberof TradingApiGenerated
|
|
10824
10922
|
*/
|
|
10825
|
-
getUserAccountOptionQuotes(
|
|
10923
|
+
getUserAccountOptionQuotes(...args: TradingApiGetUserAccountOptionQuotesArgs<TAuth>): Promise<_$axios.AxiosResponse<OptionQuote, any, {}>>;
|
|
10826
10924
|
/**
|
|
10827
10925
|
* 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.
|
|
10828
10926
|
* @summary Get equity symbol quotes
|
|
@@ -10831,7 +10929,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10831
10929
|
* @throws {RequiredError}
|
|
10832
10930
|
* @memberof TradingApiGenerated
|
|
10833
10931
|
*/
|
|
10834
|
-
getUserAccountQuotes(
|
|
10932
|
+
getUserAccountQuotes(...args: TradingApiGetUserAccountQuotesArgs<TAuth>): Promise<_$axios.AxiosResponse<SymbolsQuotesInner[], any, {}>>;
|
|
10835
10933
|
/**
|
|
10836
10934
|
* 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.
|
|
10837
10935
|
* @summary Place complex order
|
|
@@ -10840,7 +10938,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10840
10938
|
* @throws {RequiredError}
|
|
10841
10939
|
* @memberof TradingApiGenerated
|
|
10842
10940
|
*/
|
|
10843
|
-
placeComplexOrder(
|
|
10941
|
+
placeComplexOrder(...args: TradingApiPlaceComplexOrderArgs<TAuth>): Promise<_$axios.AxiosResponse<ComplexOrderResponse, any, {}>>;
|
|
10844
10942
|
/**
|
|
10845
10943
|
* 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.
|
|
10846
10944
|
* @summary Place crypto order
|
|
@@ -10849,7 +10947,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10849
10947
|
* @throws {RequiredError}
|
|
10850
10948
|
* @memberof TradingApiGenerated
|
|
10851
10949
|
*/
|
|
10852
|
-
placeCryptoOrder(
|
|
10950
|
+
placeCryptoOrder(...args: TradingApiPlaceCryptoOrderArgs<TAuth>): Promise<_$axios.AxiosResponse<OrderUpdatedResponse, any, {}>>;
|
|
10853
10951
|
/**
|
|
10854
10952
|
* 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.
|
|
10855
10953
|
* @summary Place equity order
|
|
@@ -10858,7 +10956,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10858
10956
|
* @throws {RequiredError}
|
|
10859
10957
|
* @memberof TradingApiGenerated
|
|
10860
10958
|
*/
|
|
10861
|
-
placeForceOrder(
|
|
10959
|
+
placeForceOrder(...args: TradingApiPlaceForceOrderArgs<TAuth>): Promise<_$axios.AxiosResponse<AccountOrderRecord, any, {}>>;
|
|
10862
10960
|
/**
|
|
10863
10961
|
* Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
|
|
10864
10962
|
* @summary Place option order
|
|
@@ -10867,7 +10965,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10867
10965
|
* @throws {RequiredError}
|
|
10868
10966
|
* @memberof TradingApiGenerated
|
|
10869
10967
|
*/
|
|
10870
|
-
placeMlegOrder(
|
|
10968
|
+
placeMlegOrder(...args: TradingApiPlaceMlegOrderArgs<TAuth>): Promise<_$axios.AxiosResponse<MlegOrderResponse, any, {}>>;
|
|
10871
10969
|
/**
|
|
10872
10970
|
* 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.
|
|
10873
10971
|
* @summary Place checked equity order
|
|
@@ -10876,7 +10974,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10876
10974
|
* @throws {RequiredError}
|
|
10877
10975
|
* @memberof TradingApiGenerated
|
|
10878
10976
|
*/
|
|
10879
|
-
placeOrder(
|
|
10977
|
+
placeOrder(...args: TradingApiPlaceOrderArgs<TAuth>): Promise<_$axios.AxiosResponse<AccountOrderRecord, any, {}>>;
|
|
10880
10978
|
/**
|
|
10881
10979
|
* Previews an order using the specified account.
|
|
10882
10980
|
* @summary Preview crypto order
|
|
@@ -10885,7 +10983,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10885
10983
|
* @throws {RequiredError}
|
|
10886
10984
|
* @memberof TradingApiGenerated
|
|
10887
10985
|
*/
|
|
10888
|
-
previewCryptoOrder(
|
|
10986
|
+
previewCryptoOrder(...args: TradingApiPreviewCryptoOrderArgs<TAuth>): Promise<_$axios.AxiosResponse<CryptoOrderPreview, any, {}>>;
|
|
10889
10987
|
/**
|
|
10890
10988
|
* 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
|
|
10891
10989
|
* @summary Replace order
|
|
@@ -10894,7 +10992,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10894
10992
|
* @throws {RequiredError}
|
|
10895
10993
|
* @memberof TradingApiGenerated
|
|
10896
10994
|
*/
|
|
10897
|
-
replaceOrder(
|
|
10995
|
+
replaceOrder(...args: TradingApiReplaceOrderArgs<TAuth>): Promise<_$axios.AxiosResponse<AccountOrderRecord, any, {}>>;
|
|
10898
10996
|
/**
|
|
10899
10997
|
* Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
|
|
10900
10998
|
* @summary Get crypto pairs
|
|
@@ -10903,7 +11001,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10903
11001
|
* @throws {RequiredError}
|
|
10904
11002
|
* @memberof TradingApiGenerated
|
|
10905
11003
|
*/
|
|
10906
|
-
searchCryptocurrencyPairInstruments(
|
|
11004
|
+
searchCryptocurrencyPairInstruments(...args: TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth>): Promise<_$axios.AxiosResponse<TradingSearchCryptocurrencyPairInstruments200Response, any, {}>>;
|
|
10907
11005
|
}
|
|
10908
11006
|
//#endregion
|
|
10909
11007
|
//#region api/trading-api.d.ts
|
|
@@ -10973,4 +11071,4 @@ declare class SnaptradeError extends Error {
|
|
|
10973
11071
|
declare function readableStreamToString(stream: ReadableStream): Promise<string>;
|
|
10974
11072
|
declare function parseIfJson(input: unknown): object | unknown;
|
|
10975
11073
|
//#endregion
|
|
10976
|
-
export { Account, AccountBalance, AccountBalanceTotal, AccountHoldings, AccountHoldingsAccount, AccountInformationApi, AccountInformationApiAxiosParamCreator, AccountInformationApiFactory, AccountInformationApiFp, AccountInformationApiGenerated, AccountInformationApiGetAccountActivitiesBaseRequest, AccountInformationApiGetAccountActivitiesRequest, AccountInformationApiGetAccountActivitiesRequestByAuthMode, AccountInformationApiGetAccountActivitiescommercialApiKeyRequest, AccountInformationApiGetAccountActivitiespersonalApiKeyRequest, AccountInformationApiGetAccountBalanceHistoryBaseRequest, AccountInformationApiGetAccountBalanceHistoryRequest, AccountInformationApiGetAccountBalanceHistoryRequestByAuthMode, AccountInformationApiGetAccountBalanceHistorycommercialApiKeyRequest, AccountInformationApiGetAccountBalanceHistorypersonalApiKeyRequest, AccountInformationApiGetAllAccountPositionsBaseRequest, AccountInformationApiGetAllAccountPositionsRequest, AccountInformationApiGetAllAccountPositionsRequestByAuthMode, AccountInformationApiGetAllAccountPositionscommercialApiKeyRequest, AccountInformationApiGetAllAccountPositionspersonalApiKeyRequest, AccountInformationApiGetUserAccountBalanceBaseRequest, AccountInformationApiGetUserAccountBalanceRequest, AccountInformationApiGetUserAccountBalanceRequestByAuthMode, AccountInformationApiGetUserAccountBalancecommercialApiKeyRequest, AccountInformationApiGetUserAccountBalancepersonalApiKeyRequest, AccountInformationApiGetUserAccountDetailsBaseRequest, AccountInformationApiGetUserAccountDetailsRequest, AccountInformationApiGetUserAccountDetailsRequestByAuthMode, AccountInformationApiGetUserAccountDetailscommercialApiKeyRequest, AccountInformationApiGetUserAccountDetailspersonalApiKeyRequest, AccountInformationApiGetUserAccountOrderDetailBaseRequest, AccountInformationApiGetUserAccountOrderDetailRequest, AccountInformationApiGetUserAccountOrderDetailRequestByAuthMode, AccountInformationApiGetUserAccountOrderDetailcommercialApiKeyRequest, AccountInformationApiGetUserAccountOrderDetailpersonalApiKeyRequest, AccountInformationApiGetUserAccountOrdersBaseRequest, AccountInformationApiGetUserAccountOrdersRequest, AccountInformationApiGetUserAccountOrdersRequestByAuthMode, AccountInformationApiGetUserAccountOrderscommercialApiKeyRequest, AccountInformationApiGetUserAccountOrderspersonalApiKeyRequest, AccountInformationApiGetUserAccountRecentOrdersBaseRequest, AccountInformationApiGetUserAccountRecentOrdersRequest, AccountInformationApiGetUserAccountRecentOrdersRequestByAuthMode, AccountInformationApiGetUserAccountRecentOrderscommercialApiKeyRequest, AccountInformationApiGetUserAccountRecentOrderspersonalApiKeyRequest, AccountInformationApiGetUserAccountReturnRatesBaseRequest, AccountInformationApiGetUserAccountReturnRatesRequest, AccountInformationApiGetUserAccountReturnRatesRequestByAuthMode, AccountInformationApiGetUserAccountReturnRatescommercialApiKeyRequest, AccountInformationApiGetUserAccountReturnRatespersonalApiKeyRequest, AccountInformationApiGetUserHoldingsBaseRequest, AccountInformationApiGetUserHoldingsRequest, AccountInformationApiGetUserHoldingsRequestByAuthMode, AccountInformationApiGetUserHoldingscommercialApiKeyRequest, AccountInformationApiGetUserHoldingspersonalApiKeyRequest, AccountInformationApiListUserAccountsBaseRequest, AccountInformationApiListUserAccountsRequest, AccountInformationApiListUserAccountsRequestByAuthMode, AccountInformationApiListUserAccountscommercialApiKeyRequest, AccountInformationApiListUserAccountspersonalApiKeyRequest, AccountInformationApiUpdateUserAccountBaseRequest, AccountInformationApiUpdateUserAccountRequest, AccountInformationApiUpdateUserAccountRequestByAuthMode, AccountInformationApiUpdateUserAccountcommercialApiKeyRequest, AccountInformationApiUpdateUserAccountpersonalApiKeyRequest, AccountInformationGetUserAccountOrderDetailRequest, AccountOrderRecord, AccountOrderRecordChildBrokerageOrderIds, AccountOrderRecordLeg, AccountOrderRecordLegInstrument, AccountOrderRecordOptionSymbol, AccountOrderRecordQuoteCurrency, AccountOrderRecordQuoteUniversalSymbol, AccountOrderRecordStatus, AccountOrderRecordStatusV2, AccountOrderRecordTrailingStop, AccountOrderRecordUniversalSymbol, AccountOrderRecordV2, AccountOrderRecordV2OrderRole, AccountOrdersV2Response, AccountPosition, AccountSimple, AccountSyncStatus, AccountUniversalActivity, AccountUniversalActivityCurrency, AccountUniversalActivityCurrencyUniversalSymbol, AccountUniversalActivityOptionSymbol, AccountUniversalActivitySymbol, AccountValueHistoryItem, AccountValueHistoryResponse, ActionStrict, ActionStrictWithOptions, AdrInstrument, AllAccountPositionsResponse, AllAccountPositionsResponseDataFreshness, ApiKey, ApiStatusApi, ApiStatusApiAxiosParamCreator, ApiStatusApiFactory, ApiStatusApiFp, ApiStatusApiGenerated, type AuthMode, AuthenticationApi, AuthenticationApiAxiosParamCreator, AuthenticationApiDeleteSnapTradeUserBaseRequest, AuthenticationApiDeleteSnapTradeUserRequest, AuthenticationApiDeleteSnapTradeUserRequestByAuthMode, AuthenticationApiDeleteSnapTradeUsercommercialApiKeyRequest, AuthenticationApiFactory, AuthenticationApiFp, AuthenticationApiGenerated, AuthenticationApiLoginSnapTradeUserBaseRequest, AuthenticationApiLoginSnapTradeUserRequest, AuthenticationApiLoginSnapTradeUserRequestByAuthMode, AuthenticationApiLoginSnapTradeUsercommercialApiKeyRequest, AuthenticationApiLoginSnapTradeUserpersonalApiKeyRequest, AuthenticationApiRegisterSnapTradeUserBaseRequest, AuthenticationApiRegisterSnapTradeUserRequest, AuthenticationApiRegisterSnapTradeUserRequestByAuthMode, AuthenticationApiRegisterSnapTradeUsercommercialApiKeyRequest, AuthenticationApiResetSnapTradeUserSecretBaseRequest, AuthenticationApiResetSnapTradeUserSecretRequest, AuthenticationApiResetSnapTradeUserSecretRequestByAuthMode, AuthenticationApiResetSnapTradeUserSecretcommercialApiKeyRequest, AuthenticationLoginSnapTradeUser200Response, Balance, BalanceCurrency, Brokerage, BrokerageAuthorization, BrokerageAuthorizationDataFreshnessMode, BrokerageAuthorizationDisabledConfirmation, BrokerageAuthorizationRefreshConfirmation, BrokerageAuthorizationTransactionsSyncConfirmation, BrokerageAuthorizationTypeReadOnly, BrokerageAuthorizationTypeReadOnlyBrokerage, BrokerageInstrument, BrokerageInstrumentsResponse, BrokerageType, CancelOrderResponse, CefInstrument, CfdInstrument, ChildBrokerageOrderIDs, CommercialApiKeyAuth, ComplexOrderLeg, ComplexOrderResponse, Configuration, ConfigurationParameters, ConfigurationParametersShared, ConnectionAccount, ConnectionAccountSyncStatus, ConnectionsApi, ConnectionsApiAxiosParamCreator, ConnectionsApiDeleteConnectionBaseRequest, ConnectionsApiDeleteConnectionRequest, ConnectionsApiDeleteConnectionRequestByAuthMode, ConnectionsApiDeleteConnectioncommercialApiKeyRequest, ConnectionsApiDeleteConnectionpersonalApiKeyRequest, ConnectionsApiDetailBrokerageAuthorizationBaseRequest, ConnectionsApiDetailBrokerageAuthorizationRequest, ConnectionsApiDetailBrokerageAuthorizationRequestByAuthMode, ConnectionsApiDetailBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiDetailBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiDisableBrokerageAuthorizationBaseRequest, ConnectionsApiDisableBrokerageAuthorizationRequest, ConnectionsApiDisableBrokerageAuthorizationRequestByAuthMode, ConnectionsApiDisableBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiDisableBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiFactory, ConnectionsApiFp, ConnectionsApiGenerated, ConnectionsApiListBrokerageAuthorizationAccountsBaseRequest, ConnectionsApiListBrokerageAuthorizationAccountsRequest, ConnectionsApiListBrokerageAuthorizationAccountsRequestByAuthMode, ConnectionsApiListBrokerageAuthorizationAccountscommercialApiKeyRequest, ConnectionsApiListBrokerageAuthorizationAccountspersonalApiKeyRequest, ConnectionsApiListBrokerageAuthorizationsBaseRequest, ConnectionsApiListBrokerageAuthorizationsRequest, ConnectionsApiListBrokerageAuthorizationsRequestByAuthMode, ConnectionsApiListBrokerageAuthorizationscommercialApiKeyRequest, ConnectionsApiListBrokerageAuthorizationspersonalApiKeyRequest, ConnectionsApiRefreshBrokerageAuthorizationBaseRequest, ConnectionsApiRefreshBrokerageAuthorizationRequest, ConnectionsApiRefreshBrokerageAuthorizationRequestByAuthMode, ConnectionsApiRefreshBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiRefreshBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiReturnRatesBaseRequest, ConnectionsApiReturnRatesRequest, ConnectionsApiReturnRatesRequestByAuthMode, ConnectionsApiReturnRatescommercialApiKeyRequest, ConnectionsApiReturnRatespersonalApiKeyRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsBaseRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsRequestByAuthMode, ConnectionsApiSyncBrokerageAuthorizationTransactionscommercialApiKeyRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionspersonalApiKeyRequest, CryptoInstrument, CryptoOrderForm, CryptoOrderPreview, CryptoOrderPreviewEstimatedFee, CryptoTradingInstrument, CryptocurrencyPair, CryptocurrencyPairQuote, Currency, DeleteConnectionConfirmation, DeleteUserResponse, DepositAccount, DepositAccountNetValue, DepositAccountSyncStatus, DividendAtDate, EncryptedResponse, EncryptedResponseEncryptedMessageData, EtfInstrument, Exchange, ExchangeRatePairs, ExperimentalEndpointsApi, ExperimentalEndpointsApiAddSubscriptionBaseRequest, ExperimentalEndpointsApiAddSubscriptionRequest, ExperimentalEndpointsApiAddSubscriptionRequestByAuthMode, ExperimentalEndpointsApiAddSubscriptioncommercialApiKeyRequest, ExperimentalEndpointsApiAddSubscriptionpersonalApiKeyRequest, ExperimentalEndpointsApiAxiosParamCreator, ExperimentalEndpointsApiCancelSubscriptionBaseRequest, ExperimentalEndpointsApiCancelSubscriptionRequest, ExperimentalEndpointsApiCancelSubscriptionRequestByAuthMode, ExperimentalEndpointsApiCancelSubscriptioncommercialApiKeyRequest, ExperimentalEndpointsApiCancelSubscriptionpersonalApiKeyRequest, ExperimentalEndpointsApiFactory, ExperimentalEndpointsApiFp, ExperimentalEndpointsApiGenerated, ExperimentalEndpointsApiGetUserAccountOrderDetailV2BaseRequest, ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request, ExperimentalEndpointsApiGetUserAccountOrderDetailV2RequestByAuthMode, ExperimentalEndpointsApiGetUserAccountOrderDetailV2commercialApiKeyRequest, ExperimentalEndpointsApiGetUserAccountOrderDetailV2personalApiKeyRequest, ExperimentalEndpointsApiGetUserAccountOrdersV2BaseRequest, ExperimentalEndpointsApiGetUserAccountOrdersV2Request, ExperimentalEndpointsApiGetUserAccountOrdersV2RequestByAuthMode, ExperimentalEndpointsApiGetUserAccountOrdersV2commercialApiKeyRequest, ExperimentalEndpointsApiGetUserAccountOrdersV2personalApiKeyRequest, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2BaseRequest, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2RequestByAuthMode, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2commercialApiKeyRequest, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2personalApiKeyRequest, ExperimentalEndpointsApiListConnectionAccountsBaseRequest, ExperimentalEndpointsApiListConnectionAccountsRequest, ExperimentalEndpointsApiListConnectionAccountsRequestByAuthMode, ExperimentalEndpointsApiListConnectionAccountscommercialApiKeyRequest, ExperimentalEndpointsApiListConnectionAccountspersonalApiKeyRequest, FigiInstrument, FutureInstrument, HoldingsStatus, Instrument, InvestmentAccount, InvestmentAccountNetValue, LineOfCreditAccount, LineOfCreditAccountAvailableCredit, LineOfCreditAccountMinimumPaymentAmount, LineOfCreditAccountNetValue, LineOfCreditAccountSyncStatus, LoginRedirectURI, ManualTrade, ManualTradeAndImpact, ManualTradeBalance, ManualTradeForm, ManualTradeFormBracket, ManualTradeFormComplex, ManualTradeFormNotionalValue, ManualTradeFormWithOptions, ManualTradeImpact, ManualTradePlaceTimeInForceStrict, ManualTradeReplaceForm, ManualTradeSymbol, MlegActionStrict, MlegInstrumentType, MlegLeg, MlegOrderResponse, MlegOrderTypeStrict, MlegPriceEffectStrict, MlegTradeForm, MlegTradingInstrument, Model400FailedRequestResponse, Model401FailedRequestResponse, Model402BrokerageAuthAlreadyDisabledException, Model402BrokerageAuthDisabledResponse, Model403FailedRequestResponse, Model403FeatureNotEnabledResponse, Model404FailedRequestResponse, Model425FailedRequestResponse, Model429TooManyRequestsResponse, Model500UnexpectedExceptionResponse, Model501NotImplementedResponse, Model503BrokerageRequestResponse, MonthlyDividends, MutualFundInstrument, NetContributions, NetDividend, NotionalValue, OAuthWebhookBase, OptionBrokerageSymbol, OptionChainInner, OptionChainInnerChainPerRootInner, OptionChainInnerChainPerRootInnerChainPerStrikePriceInner, OptionImpact, OptionInstrument, OptionLeg, OptionQuote, OptionQuoteGreeks, OptionStrategy, OptionStrategyLegsInner, OptionsPosition, OptionsPositionCurrency, OptionsSymbol, OrderTypeStrict, OrderUpdatedResponse, OrderUpdatedResponseOrder, OtherInstrument, PaginatedUniversalActivity, PaginationDetails, PartnerData, PastValue, PerformanceCustom, PersonalApiKeyAuth, Position, PositionCurrency, PositionSymbol, RateOfReturnObject, RateOfReturnResponse, RecentOrdersResponse, ReferenceDataApi, ReferenceDataApiAxiosParamCreator, ReferenceDataApiFactory, ReferenceDataApiFp, ReferenceDataApiGenerated, ReferenceDataApiGetSymbolsBaseRequest, ReferenceDataApiGetSymbolsByTickerBaseRequest, ReferenceDataApiGetSymbolsByTickerRequest, ReferenceDataApiGetSymbolsByTickerRequestByAuthMode, ReferenceDataApiGetSymbolsByTickercommercialApiKeyRequest, ReferenceDataApiGetSymbolsByTickerpersonalApiKeyRequest, ReferenceDataApiGetSymbolsRequest, ReferenceDataApiGetSymbolsRequestByAuthMode, ReferenceDataApiGetSymbolscommercialApiKeyRequest, ReferenceDataApiGetSymbolspersonalApiKeyRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeBaseRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeRequestByAuthMode, ReferenceDataApiListAllBrokerageAuthorizationTypecommercialApiKeyRequest, ReferenceDataApiListAllBrokerageAuthorizationTypepersonalApiKeyRequest, ReferenceDataApiListAllBrokerageInstrumentsBaseRequest, ReferenceDataApiListAllBrokerageInstrumentsRequest, ReferenceDataApiListAllBrokerageInstrumentsRequestByAuthMode, ReferenceDataApiListAllBrokerageInstrumentscommercialApiKeyRequest, ReferenceDataApiListAllBrokerageInstrumentspersonalApiKeyRequest, ReferenceDataApiSymbolSearchUserAccountBaseRequest, ReferenceDataApiSymbolSearchUserAccountRequest, ReferenceDataApiSymbolSearchUserAccountRequestByAuthMode, ReferenceDataApiSymbolSearchUserAccountcommercialApiKeyRequest, ReferenceDataApiSymbolSearchUserAccountpersonalApiKeyRequest, SecurityType, SessionEvent, SimpleOrderForm, SnapTradeHoldingsAccount, SnapTradeHoldingsTotalValue, SnapTradeLoginUserRequestBody, SnapTradeRegisterUserRequestBody, Snaptrade, SnaptradeAuth, SnaptradeError, Status, StockInstrument, StockInstrumentFigiInstrument, StopLoss, StrategyOrderRecord, StrategyQuotes, StrategyQuotesGreek, SubPeriodReturnRate, Symbol, SymbolCurrency, SymbolExchange, SymbolQuery, SymbolsQuotesInner, TakeProfit, TaxLot, TimeInForceStrict, TradeDetectionAddSubscriptionRequest, TradeDetectionCancelSubscriptionRequest, TradeDetectionCancelSubscriptionResponse, TradeDetectionSubscription, TradingApi, TradingApiAxiosParamCreator, TradingApiCancelOrderBaseRequest, TradingApiCancelOrderRequest, TradingApiCancelOrderRequestByAuthMode, TradingApiCancelOrdercommercialApiKeyRequest, TradingApiCancelOrderpersonalApiKeyRequest, TradingApiFactory, TradingApiFp, TradingApiGenerated, TradingApiGetCryptocurrencyPairQuoteBaseRequest, TradingApiGetCryptocurrencyPairQuoteRequest, TradingApiGetCryptocurrencyPairQuoteRequestByAuthMode, TradingApiGetCryptocurrencyPairQuotecommercialApiKeyRequest, TradingApiGetCryptocurrencyPairQuotepersonalApiKeyRequest, TradingApiGetOptionImpactBaseRequest, TradingApiGetOptionImpactRequest, TradingApiGetOptionImpactRequestByAuthMode, TradingApiGetOptionImpactcommercialApiKeyRequest, TradingApiGetOptionImpactpersonalApiKeyRequest, TradingApiGetOrderImpactBaseRequest, TradingApiGetOrderImpactRequest, TradingApiGetOrderImpactRequestByAuthMode, TradingApiGetOrderImpactcommercialApiKeyRequest, TradingApiGetOrderImpactpersonalApiKeyRequest, TradingApiGetUserAccountOptionQuotesBaseRequest, TradingApiGetUserAccountOptionQuotesRequest, TradingApiGetUserAccountOptionQuotesRequestByAuthMode, TradingApiGetUserAccountOptionQuotescommercialApiKeyRequest, TradingApiGetUserAccountOptionQuotespersonalApiKeyRequest, TradingApiGetUserAccountQuotesBaseRequest, TradingApiGetUserAccountQuotesRequest, TradingApiGetUserAccountQuotesRequestByAuthMode, TradingApiGetUserAccountQuotescommercialApiKeyRequest, TradingApiGetUserAccountQuotespersonalApiKeyRequest, TradingApiPlaceComplexOrderBaseRequest, TradingApiPlaceComplexOrderRequest, TradingApiPlaceComplexOrderRequestByAuthMode, TradingApiPlaceComplexOrdercommercialApiKeyRequest, TradingApiPlaceComplexOrderpersonalApiKeyRequest, TradingApiPlaceCryptoOrderBaseRequest, TradingApiPlaceCryptoOrderRequest, TradingApiPlaceCryptoOrderRequestByAuthMode, TradingApiPlaceCryptoOrdercommercialApiKeyRequest, TradingApiPlaceCryptoOrderpersonalApiKeyRequest, TradingApiPlaceForceOrderBaseRequest, TradingApiPlaceForceOrderRequest, TradingApiPlaceForceOrderRequestByAuthMode, TradingApiPlaceForceOrdercommercialApiKeyRequest, TradingApiPlaceForceOrderpersonalApiKeyRequest, TradingApiPlaceMlegOrderBaseRequest, TradingApiPlaceMlegOrderRequest, TradingApiPlaceMlegOrderRequestByAuthMode, TradingApiPlaceMlegOrdercommercialApiKeyRequest, TradingApiPlaceMlegOrderpersonalApiKeyRequest, TradingApiPlaceOrderBaseRequest, TradingApiPlaceOrderRequest, TradingApiPlaceOrderRequestByAuthMode, TradingApiPlaceOrdercommercialApiKeyRequest, TradingApiPlaceOrderpersonalApiKeyRequest, TradingApiPreviewCryptoOrderBaseRequest, TradingApiPreviewCryptoOrderRequest, TradingApiPreviewCryptoOrderRequestByAuthMode, TradingApiPreviewCryptoOrdercommercialApiKeyRequest, TradingApiPreviewCryptoOrderpersonalApiKeyRequest, TradingApiReplaceOrderBaseRequest, TradingApiReplaceOrderRequest, TradingApiReplaceOrderRequestByAuthMode, TradingApiReplaceOrdercommercialApiKeyRequest, TradingApiReplaceOrderpersonalApiKeyRequest, TradingApiSearchCryptocurrencyPairInstrumentsBaseRequest, TradingApiSearchCryptocurrencyPairInstrumentsRequest, TradingApiSearchCryptocurrencyPairInstrumentsRequestByAuthMode, TradingApiSearchCryptocurrencyPairInstrumentscommercialApiKeyRequest, TradingApiSearchCryptocurrencyPairInstrumentspersonalApiKeyRequest, TradingInstrument, TradingSearchCryptocurrencyPairInstruments200Response, TradingSession, TrailingStop, TransactionsStatus, USExchange, UnderlyingCfdInstrument, UnderlyingOptionInstrument, UnderlyingSymbol, UnderlyingSymbolExchange, UnderlyingSymbolType, UniversalActivity, UniversalSymbol, UserIDandSecret, ValidatedTradeBody, parseIfJson, readableStreamToString };
|
|
11074
|
+
export { Account, AccountBalance, AccountBalanceTotal, AccountHoldings, AccountHoldingsAccount, AccountInformationApi, AccountInformationApiAxiosParamCreator, AccountInformationApiFactory, AccountInformationApiFp, AccountInformationApiGenerated, AccountInformationApiGetAccountActivitiesArgs, AccountInformationApiGetAccountActivitiesBaseRequest, AccountInformationApiGetAccountActivitiesRequest, AccountInformationApiGetAccountActivitiesRequestByAuthMode, AccountInformationApiGetAccountActivitiescommercialApiKeyRequest, AccountInformationApiGetAccountActivitiespersonalApiKeyRequest, AccountInformationApiGetAccountBalanceHistoryArgs, AccountInformationApiGetAccountBalanceHistoryBaseRequest, AccountInformationApiGetAccountBalanceHistoryRequest, AccountInformationApiGetAccountBalanceHistoryRequestByAuthMode, AccountInformationApiGetAccountBalanceHistorycommercialApiKeyRequest, AccountInformationApiGetAccountBalanceHistorypersonalApiKeyRequest, AccountInformationApiGetAllAccountPositionsArgs, AccountInformationApiGetAllAccountPositionsBaseRequest, AccountInformationApiGetAllAccountPositionsRequest, AccountInformationApiGetAllAccountPositionsRequestByAuthMode, AccountInformationApiGetAllAccountPositionscommercialApiKeyRequest, AccountInformationApiGetAllAccountPositionspersonalApiKeyRequest, AccountInformationApiGetUserAccountBalanceArgs, AccountInformationApiGetUserAccountBalanceBaseRequest, AccountInformationApiGetUserAccountBalanceRequest, AccountInformationApiGetUserAccountBalanceRequestByAuthMode, AccountInformationApiGetUserAccountBalancecommercialApiKeyRequest, AccountInformationApiGetUserAccountBalancepersonalApiKeyRequest, AccountInformationApiGetUserAccountDetailsArgs, AccountInformationApiGetUserAccountDetailsBaseRequest, AccountInformationApiGetUserAccountDetailsRequest, AccountInformationApiGetUserAccountDetailsRequestByAuthMode, AccountInformationApiGetUserAccountDetailscommercialApiKeyRequest, AccountInformationApiGetUserAccountDetailspersonalApiKeyRequest, AccountInformationApiGetUserAccountOrderDetailArgs, AccountInformationApiGetUserAccountOrderDetailBaseRequest, AccountInformationApiGetUserAccountOrderDetailRequest, AccountInformationApiGetUserAccountOrderDetailRequestByAuthMode, AccountInformationApiGetUserAccountOrderDetailcommercialApiKeyRequest, AccountInformationApiGetUserAccountOrderDetailpersonalApiKeyRequest, AccountInformationApiGetUserAccountOrdersArgs, AccountInformationApiGetUserAccountOrdersBaseRequest, AccountInformationApiGetUserAccountOrdersRequest, AccountInformationApiGetUserAccountOrdersRequestByAuthMode, AccountInformationApiGetUserAccountOrderscommercialApiKeyRequest, AccountInformationApiGetUserAccountOrderspersonalApiKeyRequest, AccountInformationApiGetUserAccountRecentOrdersArgs, AccountInformationApiGetUserAccountRecentOrdersBaseRequest, AccountInformationApiGetUserAccountRecentOrdersRequest, AccountInformationApiGetUserAccountRecentOrdersRequestByAuthMode, AccountInformationApiGetUserAccountRecentOrderscommercialApiKeyRequest, AccountInformationApiGetUserAccountRecentOrderspersonalApiKeyRequest, AccountInformationApiGetUserAccountReturnRatesArgs, AccountInformationApiGetUserAccountReturnRatesBaseRequest, AccountInformationApiGetUserAccountReturnRatesRequest, AccountInformationApiGetUserAccountReturnRatesRequestByAuthMode, AccountInformationApiGetUserAccountReturnRatescommercialApiKeyRequest, AccountInformationApiGetUserAccountReturnRatespersonalApiKeyRequest, AccountInformationApiGetUserHoldingsArgs, AccountInformationApiGetUserHoldingsBaseRequest, AccountInformationApiGetUserHoldingsRequest, AccountInformationApiGetUserHoldingsRequestByAuthMode, AccountInformationApiGetUserHoldingscommercialApiKeyRequest, AccountInformationApiGetUserHoldingspersonalApiKeyRequest, AccountInformationApiListUserAccountsArgs, AccountInformationApiListUserAccountsBaseRequest, AccountInformationApiListUserAccountsRequest, AccountInformationApiListUserAccountsRequestByAuthMode, AccountInformationApiListUserAccountscommercialApiKeyRequest, AccountInformationApiListUserAccountspersonalApiKeyRequest, AccountInformationApiUpdateUserAccountArgs, AccountInformationApiUpdateUserAccountBaseRequest, AccountInformationApiUpdateUserAccountRequest, AccountInformationApiUpdateUserAccountRequestByAuthMode, AccountInformationApiUpdateUserAccountcommercialApiKeyRequest, AccountInformationApiUpdateUserAccountpersonalApiKeyRequest, AccountInformationGetUserAccountOrderDetailRequest, AccountOrderRecord, AccountOrderRecordChildBrokerageOrderIds, AccountOrderRecordLeg, AccountOrderRecordLegInstrument, AccountOrderRecordOptionSymbol, AccountOrderRecordQuoteCurrency, AccountOrderRecordQuoteUniversalSymbol, AccountOrderRecordStatus, AccountOrderRecordStatusV2, AccountOrderRecordTrailingStop, AccountOrderRecordUniversalSymbol, AccountOrderRecordV2, AccountOrderRecordV2OrderRole, AccountOrdersV2Response, AccountPosition, AccountSimple, AccountSyncStatus, AccountUniversalActivity, AccountUniversalActivityCurrency, AccountUniversalActivityCurrencyUniversalSymbol, AccountUniversalActivityOptionSymbol, AccountUniversalActivitySymbol, AccountValueHistoryItem, AccountValueHistoryResponse, ActionStrict, ActionStrictWithOptions, AdrInstrument, AllAccountPositionsResponse, AllAccountPositionsResponseDataFreshness, ApiKey, ApiStatusApi, ApiStatusApiAxiosParamCreator, ApiStatusApiFactory, ApiStatusApiFp, ApiStatusApiGenerated, type AuthMode, AuthenticationApi, AuthenticationApiAxiosParamCreator, AuthenticationApiDeleteSnapTradeUserArgs, AuthenticationApiDeleteSnapTradeUserBaseRequest, AuthenticationApiDeleteSnapTradeUserRequest, AuthenticationApiDeleteSnapTradeUserRequestByAuthMode, AuthenticationApiDeleteSnapTradeUsercommercialApiKeyRequest, AuthenticationApiFactory, AuthenticationApiFp, AuthenticationApiGenerated, AuthenticationApiLoginSnapTradeUserArgs, AuthenticationApiLoginSnapTradeUserBaseRequest, AuthenticationApiLoginSnapTradeUserRequest, AuthenticationApiLoginSnapTradeUserRequestByAuthMode, AuthenticationApiLoginSnapTradeUsercommercialApiKeyRequest, AuthenticationApiLoginSnapTradeUserpersonalApiKeyRequest, AuthenticationApiRegisterSnapTradeUserArgs, AuthenticationApiRegisterSnapTradeUserBaseRequest, AuthenticationApiRegisterSnapTradeUserRequest, AuthenticationApiRegisterSnapTradeUserRequestByAuthMode, AuthenticationApiRegisterSnapTradeUsercommercialApiKeyRequest, AuthenticationApiResetSnapTradeUserSecretArgs, AuthenticationApiResetSnapTradeUserSecretBaseRequest, AuthenticationApiResetSnapTradeUserSecretRequest, AuthenticationApiResetSnapTradeUserSecretRequestByAuthMode, AuthenticationApiResetSnapTradeUserSecretcommercialApiKeyRequest, AuthenticationLoginSnapTradeUser200Response, Balance, BalanceCurrency, Brokerage, BrokerageAuthorization, BrokerageAuthorizationDataFreshnessMode, BrokerageAuthorizationDisabledConfirmation, BrokerageAuthorizationRefreshConfirmation, BrokerageAuthorizationTransactionsSyncConfirmation, BrokerageAuthorizationTypeReadOnly, BrokerageAuthorizationTypeReadOnlyBrokerage, BrokerageInstrument, BrokerageInstrumentsResponse, BrokerageType, CancelOrderResponse, CefInstrument, CfdInstrument, ChildBrokerageOrderIDs, CommercialApiKeyAuth, ComplexOrderLeg, ComplexOrderResponse, Configuration, ConfigurationParameters, ConfigurationParametersShared, ConnectionAccount, ConnectionAccountSyncStatus, ConnectionsApi, ConnectionsApiAxiosParamCreator, ConnectionsApiDeleteConnectionArgs, ConnectionsApiDeleteConnectionBaseRequest, ConnectionsApiDeleteConnectionRequest, ConnectionsApiDeleteConnectionRequestByAuthMode, ConnectionsApiDeleteConnectioncommercialApiKeyRequest, ConnectionsApiDeleteConnectionpersonalApiKeyRequest, ConnectionsApiDetailBrokerageAuthorizationArgs, ConnectionsApiDetailBrokerageAuthorizationBaseRequest, ConnectionsApiDetailBrokerageAuthorizationRequest, ConnectionsApiDetailBrokerageAuthorizationRequestByAuthMode, ConnectionsApiDetailBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiDetailBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiDisableBrokerageAuthorizationArgs, ConnectionsApiDisableBrokerageAuthorizationBaseRequest, ConnectionsApiDisableBrokerageAuthorizationRequest, ConnectionsApiDisableBrokerageAuthorizationRequestByAuthMode, ConnectionsApiDisableBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiDisableBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiFactory, ConnectionsApiFp, ConnectionsApiGenerated, ConnectionsApiListBrokerageAuthorizationAccountsArgs, ConnectionsApiListBrokerageAuthorizationAccountsBaseRequest, ConnectionsApiListBrokerageAuthorizationAccountsRequest, ConnectionsApiListBrokerageAuthorizationAccountsRequestByAuthMode, ConnectionsApiListBrokerageAuthorizationAccountscommercialApiKeyRequest, ConnectionsApiListBrokerageAuthorizationAccountspersonalApiKeyRequest, ConnectionsApiListBrokerageAuthorizationsArgs, ConnectionsApiListBrokerageAuthorizationsBaseRequest, ConnectionsApiListBrokerageAuthorizationsRequest, ConnectionsApiListBrokerageAuthorizationsRequestByAuthMode, ConnectionsApiListBrokerageAuthorizationscommercialApiKeyRequest, ConnectionsApiListBrokerageAuthorizationspersonalApiKeyRequest, ConnectionsApiRefreshBrokerageAuthorizationArgs, ConnectionsApiRefreshBrokerageAuthorizationBaseRequest, ConnectionsApiRefreshBrokerageAuthorizationRequest, ConnectionsApiRefreshBrokerageAuthorizationRequestByAuthMode, ConnectionsApiRefreshBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiRefreshBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiReturnRatesArgs, ConnectionsApiReturnRatesBaseRequest, ConnectionsApiReturnRatesRequest, ConnectionsApiReturnRatesRequestByAuthMode, ConnectionsApiReturnRatescommercialApiKeyRequest, ConnectionsApiReturnRatespersonalApiKeyRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs, ConnectionsApiSyncBrokerageAuthorizationTransactionsBaseRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsRequestByAuthMode, ConnectionsApiSyncBrokerageAuthorizationTransactionscommercialApiKeyRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionspersonalApiKeyRequest, CryptoInstrument, CryptoOrderForm, CryptoOrderPreview, CryptoOrderPreviewEstimatedFee, CryptoTradingInstrument, CryptocurrencyPair, CryptocurrencyPairQuote, Currency, DeleteConnectionConfirmation, DeleteUserResponse, DepositAccount, DepositAccountNetValue, DepositAccountSyncStatus, DividendAtDate, EncryptedResponse, EncryptedResponseEncryptedMessageData, EtfInstrument, Exchange, ExchangeRatePairs, ExperimentalEndpointsApi, ExperimentalEndpointsApiAddSubscriptionArgs, ExperimentalEndpointsApiAddSubscriptionBaseRequest, ExperimentalEndpointsApiAddSubscriptionRequest, ExperimentalEndpointsApiAddSubscriptionRequestByAuthMode, ExperimentalEndpointsApiAddSubscriptioncommercialApiKeyRequest, ExperimentalEndpointsApiAddSubscriptionpersonalApiKeyRequest, ExperimentalEndpointsApiAxiosParamCreator, ExperimentalEndpointsApiCancelSubscriptionArgs, ExperimentalEndpointsApiCancelSubscriptionBaseRequest, ExperimentalEndpointsApiCancelSubscriptionRequest, ExperimentalEndpointsApiCancelSubscriptionRequestByAuthMode, ExperimentalEndpointsApiCancelSubscriptioncommercialApiKeyRequest, ExperimentalEndpointsApiCancelSubscriptionpersonalApiKeyRequest, ExperimentalEndpointsApiFactory, ExperimentalEndpointsApiFp, ExperimentalEndpointsApiGenerated, ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args, ExperimentalEndpointsApiGetUserAccountOrderDetailV2BaseRequest, ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request, ExperimentalEndpointsApiGetUserAccountOrderDetailV2RequestByAuthMode, ExperimentalEndpointsApiGetUserAccountOrderDetailV2commercialApiKeyRequest, ExperimentalEndpointsApiGetUserAccountOrderDetailV2personalApiKeyRequest, ExperimentalEndpointsApiGetUserAccountOrdersV2Args, ExperimentalEndpointsApiGetUserAccountOrdersV2BaseRequest, ExperimentalEndpointsApiGetUserAccountOrdersV2Request, ExperimentalEndpointsApiGetUserAccountOrdersV2RequestByAuthMode, ExperimentalEndpointsApiGetUserAccountOrdersV2commercialApiKeyRequest, ExperimentalEndpointsApiGetUserAccountOrdersV2personalApiKeyRequest, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2BaseRequest, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2RequestByAuthMode, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2commercialApiKeyRequest, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2personalApiKeyRequest, ExperimentalEndpointsApiListConnectionAccountsArgs, ExperimentalEndpointsApiListConnectionAccountsBaseRequest, ExperimentalEndpointsApiListConnectionAccountsRequest, ExperimentalEndpointsApiListConnectionAccountsRequestByAuthMode, ExperimentalEndpointsApiListConnectionAccountscommercialApiKeyRequest, ExperimentalEndpointsApiListConnectionAccountspersonalApiKeyRequest, FigiInstrument, FutureInstrument, HoldingsStatus, Instrument, InvestmentAccount, InvestmentAccountNetValue, LineOfCreditAccount, LineOfCreditAccountAvailableCredit, LineOfCreditAccountMinimumPaymentAmount, LineOfCreditAccountNetValue, LineOfCreditAccountSyncStatus, LoginRedirectURI, ManualTrade, ManualTradeAndImpact, ManualTradeBalance, ManualTradeForm, ManualTradeFormBracket, ManualTradeFormComplex, ManualTradeFormNotionalValue, ManualTradeFormWithOptions, ManualTradeImpact, ManualTradePlaceTimeInForceStrict, ManualTradeReplaceForm, ManualTradeSymbol, MlegActionStrict, MlegInstrumentType, MlegLeg, MlegOrderResponse, MlegOrderTypeStrict, MlegPriceEffectStrict, MlegTradeForm, MlegTradingInstrument, Model400FailedRequestResponse, Model401FailedRequestResponse, Model402BrokerageAuthAlreadyDisabledException, Model402BrokerageAuthDisabledResponse, Model403FailedRequestResponse, Model403FeatureNotEnabledResponse, Model404FailedRequestResponse, Model425FailedRequestResponse, Model429TooManyRequestsResponse, Model500UnexpectedExceptionResponse, Model501NotImplementedResponse, Model503BrokerageRequestResponse, MonthlyDividends, MutualFundInstrument, NetContributions, NetDividend, NotionalValue, OAuthWebhookBase, OptionBrokerageSymbol, OptionChainInner, OptionChainInnerChainPerRootInner, OptionChainInnerChainPerRootInnerChainPerStrikePriceInner, OptionImpact, OptionInstrument, OptionLeg, OptionQuote, OptionQuoteGreeks, OptionStrategy, OptionStrategyLegsInner, OptionsPosition, OptionsPositionCurrency, OptionsSymbol, OrderTypeStrict, OrderUpdatedResponse, OrderUpdatedResponseOrder, OtherInstrument, PaginatedUniversalActivity, PaginationDetails, PartnerData, PastValue, PerformanceCustom, PersonalApiKeyAuth, Position, PositionCurrency, PositionSymbol, RateOfReturnObject, RateOfReturnResponse, RecentOrdersResponse, ReferenceDataApi, ReferenceDataApiAxiosParamCreator, ReferenceDataApiFactory, ReferenceDataApiFp, ReferenceDataApiGenerated, ReferenceDataApiGetSymbolsArgs, ReferenceDataApiGetSymbolsBaseRequest, ReferenceDataApiGetSymbolsByTickerArgs, ReferenceDataApiGetSymbolsByTickerBaseRequest, ReferenceDataApiGetSymbolsByTickerRequest, ReferenceDataApiGetSymbolsByTickerRequestByAuthMode, ReferenceDataApiGetSymbolsByTickercommercialApiKeyRequest, ReferenceDataApiGetSymbolsByTickerpersonalApiKeyRequest, ReferenceDataApiGetSymbolsRequest, ReferenceDataApiGetSymbolsRequestByAuthMode, ReferenceDataApiGetSymbolscommercialApiKeyRequest, ReferenceDataApiGetSymbolspersonalApiKeyRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeArgs, ReferenceDataApiListAllBrokerageAuthorizationTypeBaseRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeRequestByAuthMode, ReferenceDataApiListAllBrokerageAuthorizationTypecommercialApiKeyRequest, ReferenceDataApiListAllBrokerageAuthorizationTypepersonalApiKeyRequest, ReferenceDataApiListAllBrokerageInstrumentsArgs, ReferenceDataApiListAllBrokerageInstrumentsBaseRequest, ReferenceDataApiListAllBrokerageInstrumentsRequest, ReferenceDataApiListAllBrokerageInstrumentsRequestByAuthMode, ReferenceDataApiListAllBrokerageInstrumentscommercialApiKeyRequest, ReferenceDataApiListAllBrokerageInstrumentspersonalApiKeyRequest, ReferenceDataApiSymbolSearchUserAccountArgs, ReferenceDataApiSymbolSearchUserAccountBaseRequest, ReferenceDataApiSymbolSearchUserAccountRequest, ReferenceDataApiSymbolSearchUserAccountRequestByAuthMode, ReferenceDataApiSymbolSearchUserAccountcommercialApiKeyRequest, ReferenceDataApiSymbolSearchUserAccountpersonalApiKeyRequest, SecurityType, SessionEvent, SimpleOrderForm, SnapTradeHoldingsAccount, SnapTradeHoldingsTotalValue, SnapTradeLoginUserRequestBody, SnapTradeRegisterUserRequestBody, Snaptrade, SnaptradeAuth, SnaptradeError, Status, StockInstrument, StockInstrumentFigiInstrument, StopLoss, StrategyOrderRecord, StrategyQuotes, StrategyQuotesGreek, SubPeriodReturnRate, Symbol, SymbolCurrency, SymbolExchange, SymbolQuery, SymbolsQuotesInner, TakeProfit, TaxLot, TimeInForceStrict, TradeDetectionAddSubscriptionRequest, TradeDetectionCancelSubscriptionRequest, TradeDetectionCancelSubscriptionResponse, TradeDetectionSubscription, TradingApi, TradingApiAxiosParamCreator, TradingApiCancelOrderArgs, TradingApiCancelOrderBaseRequest, TradingApiCancelOrderRequest, TradingApiCancelOrderRequestByAuthMode, TradingApiCancelOrdercommercialApiKeyRequest, TradingApiCancelOrderpersonalApiKeyRequest, TradingApiFactory, TradingApiFp, TradingApiGenerated, TradingApiGetCryptocurrencyPairQuoteArgs, TradingApiGetCryptocurrencyPairQuoteBaseRequest, TradingApiGetCryptocurrencyPairQuoteRequest, TradingApiGetCryptocurrencyPairQuoteRequestByAuthMode, TradingApiGetCryptocurrencyPairQuotecommercialApiKeyRequest, TradingApiGetCryptocurrencyPairQuotepersonalApiKeyRequest, TradingApiGetOptionImpactArgs, TradingApiGetOptionImpactBaseRequest, TradingApiGetOptionImpactRequest, TradingApiGetOptionImpactRequestByAuthMode, TradingApiGetOptionImpactcommercialApiKeyRequest, TradingApiGetOptionImpactpersonalApiKeyRequest, TradingApiGetOrderImpactArgs, TradingApiGetOrderImpactBaseRequest, TradingApiGetOrderImpactRequest, TradingApiGetOrderImpactRequestByAuthMode, TradingApiGetOrderImpactcommercialApiKeyRequest, TradingApiGetOrderImpactpersonalApiKeyRequest, TradingApiGetUserAccountOptionQuotesArgs, TradingApiGetUserAccountOptionQuotesBaseRequest, TradingApiGetUserAccountOptionQuotesRequest, TradingApiGetUserAccountOptionQuotesRequestByAuthMode, TradingApiGetUserAccountOptionQuotescommercialApiKeyRequest, TradingApiGetUserAccountOptionQuotespersonalApiKeyRequest, TradingApiGetUserAccountQuotesArgs, TradingApiGetUserAccountQuotesBaseRequest, TradingApiGetUserAccountQuotesRequest, TradingApiGetUserAccountQuotesRequestByAuthMode, TradingApiGetUserAccountQuotescommercialApiKeyRequest, TradingApiGetUserAccountQuotespersonalApiKeyRequest, TradingApiPlaceComplexOrderArgs, TradingApiPlaceComplexOrderBaseRequest, TradingApiPlaceComplexOrderRequest, TradingApiPlaceComplexOrderRequestByAuthMode, TradingApiPlaceComplexOrdercommercialApiKeyRequest, TradingApiPlaceComplexOrderpersonalApiKeyRequest, TradingApiPlaceCryptoOrderArgs, TradingApiPlaceCryptoOrderBaseRequest, TradingApiPlaceCryptoOrderRequest, TradingApiPlaceCryptoOrderRequestByAuthMode, TradingApiPlaceCryptoOrdercommercialApiKeyRequest, TradingApiPlaceCryptoOrderpersonalApiKeyRequest, TradingApiPlaceForceOrderArgs, TradingApiPlaceForceOrderBaseRequest, TradingApiPlaceForceOrderRequest, TradingApiPlaceForceOrderRequestByAuthMode, TradingApiPlaceForceOrdercommercialApiKeyRequest, TradingApiPlaceForceOrderpersonalApiKeyRequest, TradingApiPlaceMlegOrderArgs, TradingApiPlaceMlegOrderBaseRequest, TradingApiPlaceMlegOrderRequest, TradingApiPlaceMlegOrderRequestByAuthMode, TradingApiPlaceMlegOrdercommercialApiKeyRequest, TradingApiPlaceMlegOrderpersonalApiKeyRequest, TradingApiPlaceOrderArgs, TradingApiPlaceOrderBaseRequest, TradingApiPlaceOrderRequest, TradingApiPlaceOrderRequestByAuthMode, TradingApiPlaceOrdercommercialApiKeyRequest, TradingApiPlaceOrderpersonalApiKeyRequest, TradingApiPreviewCryptoOrderArgs, TradingApiPreviewCryptoOrderBaseRequest, TradingApiPreviewCryptoOrderRequest, TradingApiPreviewCryptoOrderRequestByAuthMode, TradingApiPreviewCryptoOrdercommercialApiKeyRequest, TradingApiPreviewCryptoOrderpersonalApiKeyRequest, TradingApiReplaceOrderArgs, TradingApiReplaceOrderBaseRequest, TradingApiReplaceOrderRequest, TradingApiReplaceOrderRequestByAuthMode, TradingApiReplaceOrdercommercialApiKeyRequest, TradingApiReplaceOrderpersonalApiKeyRequest, TradingApiSearchCryptocurrencyPairInstrumentsArgs, TradingApiSearchCryptocurrencyPairInstrumentsBaseRequest, TradingApiSearchCryptocurrencyPairInstrumentsRequest, TradingApiSearchCryptocurrencyPairInstrumentsRequestByAuthMode, TradingApiSearchCryptocurrencyPairInstrumentscommercialApiKeyRequest, TradingApiSearchCryptocurrencyPairInstrumentspersonalApiKeyRequest, TradingInstrument, TradingSearchCryptocurrencyPairInstruments200Response, TradingSession, TrailingStop, TransactionsStatus, USExchange, UnderlyingCfdInstrument, UnderlyingOptionInstrument, UnderlyingSymbol, UnderlyingSymbolExchange, UnderlyingSymbolType, UniversalActivity, UniversalSymbol, UserIDandSecret, ValidatedTradeBody, parseIfJson, readableStreamToString };
|