snaptrade-typescript-sdk 11.0.0 → 11.0.2
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 +24 -18
- package/dist/browser.umd.js +7 -7
- package/dist/index.cjs +43 -43
- package/dist/index.d.cts +46 -46
- package/dist/index.d.mts +46 -46
- package/dist/index.d.ts +46 -46
- package/dist/index.mjs +43 -43
- package/package.json +2 -2
package/dist/index.d.cts
CHANGED
|
@@ -3247,7 +3247,7 @@ interface AccountUniversalActivity {
|
|
|
3247
3247
|
*/
|
|
3248
3248
|
'currency'?: AccountUniversalActivityCurrency | null;
|
|
3249
3249
|
/**
|
|
3250
|
-
* A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of asset(s) from one account to another. - `EXTERNAL_ASSET_TRANSFER_IN` - Incoming transfer of an asset from an external account to this account. - `EXTERNAL_ASSET_TRANSFER_OUT` - Outgoing transfer of an asset from this account to an external account. - `SPLIT` - A stock share split. - `ADJUSTMENT` - A one time adjustment of the account\'s cash balance or shares of an asset
|
|
3250
|
+
* A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of asset(s) from one account to another. - `EXTERNAL_ASSET_TRANSFER_IN` - Incoming transfer of an asset from an external account to this account. - `EXTERNAL_ASSET_TRANSFER_OUT` - Outgoing transfer of an asset from this account to an external account. - `SPLIT` - A stock share split. - `ADJUSTMENT` - A one time adjustment of the account\'s cash balance or shares of an asset
|
|
3251
3251
|
* @type {string}
|
|
3252
3252
|
* @memberof AccountUniversalActivity
|
|
3253
3253
|
*/
|
|
@@ -6885,7 +6885,7 @@ interface UniversalActivity {
|
|
|
6885
6885
|
*/
|
|
6886
6886
|
'currency'?: AccountUniversalActivityCurrency | null;
|
|
6887
6887
|
/**
|
|
6888
|
-
* A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. `option_symbol` contains the related option contract info. - `OPTIONASSIGNMENT` - Option assignment event. `option_symbol` contains the related option contract info. - `OPTIONEXERCISE` - Option exercise event. `option_symbol` contains the related option contract info.
|
|
6888
|
+
* A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. `option_symbol` contains the related option contract info. - `OPTIONASSIGNMENT` - Option assignment event. `option_symbol` contains the related option contract info. - `OPTIONEXERCISE` - Option exercise event. `option_symbol` contains the related option contract info.
|
|
6889
6889
|
* @type {string}
|
|
6890
6890
|
* @memberof UniversalActivity
|
|
6891
6891
|
*/
|
|
@@ -6983,14 +6983,14 @@ interface ValidatedTradeBody {
|
|
|
6983
6983
|
*/
|
|
6984
6984
|
declare const AccountInformationApiAxiosParamCreator: (configuration?: Configuration<AuthMode>) => {
|
|
6985
6985
|
/**
|
|
6986
|
-
* Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
6986
|
+
* This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`. Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
6987
6987
|
* @summary List account activities
|
|
6988
6988
|
* @param {string} accountId
|
|
6989
6989
|
* @param {string | Date} [startDate] The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
|
|
6990
6990
|
* @param {string | Date} [endDate] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
|
|
6991
6991
|
* @param {number} [offset] An integer that specifies the starting point of the paginated results. Default is 0.
|
|
6992
6992
|
* @param {number} [limit] An integer that specifies the maximum number of transactions to return. Default of 1000.
|
|
6993
|
-
* @param {string} [type] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another. - `SPLIT` - A stock share split.
|
|
6993
|
+
* @param {string} [type] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another. - `SPLIT` - A stock share split.
|
|
6994
6994
|
* @param {string} [userId]
|
|
6995
6995
|
* @param {string} [userSecret]
|
|
6996
6996
|
* @param {*} [options] Override http request option.
|
|
@@ -7018,7 +7018,7 @@ declare const AccountInformationApiAxiosParamCreator: (configuration?: Configura
|
|
|
7018
7018
|
*/
|
|
7019
7019
|
getAllAccountPositions: (accountId: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7020
7020
|
/**
|
|
7021
|
-
* **Deprecated
|
|
7021
|
+
* **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7022
7022
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7023
7023
|
* @param {string} [brokerageAuthorizations] Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
7024
7024
|
* @param {string} [userId]
|
|
@@ -7072,7 +7072,7 @@ declare const AccountInformationApiAxiosParamCreator: (configuration?: Configura
|
|
|
7072
7072
|
*/
|
|
7073
7073
|
getUserAccountOrders: (accountId: string, state?: "all" | "open" | "executed", days?: number, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7074
7074
|
/**
|
|
7075
|
-
*
|
|
7075
|
+
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). 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.
|
|
7076
7076
|
* @summary List account positions
|
|
7077
7077
|
* @param {string} accountId
|
|
7078
7078
|
* @param {string} [userId]
|
|
@@ -7105,7 +7105,7 @@ declare const AccountInformationApiAxiosParamCreator: (configuration?: Configura
|
|
|
7105
7105
|
*/
|
|
7106
7106
|
getUserAccountReturnRates: (accountId: string, timeframes?: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7107
7107
|
/**
|
|
7108
|
-
* **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). 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.
|
|
7108
|
+
* **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.
|
|
7109
7109
|
* @summary List account holdings
|
|
7110
7110
|
* @param {string} accountId
|
|
7111
7111
|
* @param {string} [userId]
|
|
@@ -7141,7 +7141,7 @@ declare const AccountInformationApiAxiosParamCreator: (configuration?: Configura
|
|
|
7141
7141
|
*/
|
|
7142
7142
|
declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?: Configuration<TAuth>) => {
|
|
7143
7143
|
/**
|
|
7144
|
-
* Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
7144
|
+
* This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`. Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
7145
7145
|
* @summary List account activities
|
|
7146
7146
|
* @param {AccountInformationApiGetAccountActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
7147
7147
|
* @param {*} [options] Override http request option.
|
|
@@ -7165,7 +7165,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7165
7165
|
*/
|
|
7166
7166
|
getAllAccountPositions(requestParameters: AccountInformationApiGetAllAccountPositionsRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AllAccountPositionsResponse>>;
|
|
7167
7167
|
/**
|
|
7168
|
-
* **Deprecated
|
|
7168
|
+
* **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7169
7169
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7170
7170
|
* @param {AccountInformationApiGetAllUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
7171
7171
|
* @param {*} [options] Override http request option.
|
|
@@ -7206,7 +7206,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7206
7206
|
*/
|
|
7207
7207
|
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountOrderRecord>>>;
|
|
7208
7208
|
/**
|
|
7209
|
-
*
|
|
7209
|
+
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). 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.
|
|
7210
7210
|
* @summary List account positions
|
|
7211
7211
|
* @param {AccountInformationApiGetUserAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
7212
7212
|
* @param {*} [options] Override http request option.
|
|
@@ -7231,7 +7231,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7231
7231
|
*/
|
|
7232
7232
|
getUserAccountReturnRates(requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RateOfReturnResponse>>;
|
|
7233
7233
|
/**
|
|
7234
|
-
* **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). 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.
|
|
7234
|
+
* **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.
|
|
7235
7235
|
* @summary List account holdings
|
|
7236
7236
|
* @param {AccountInformationApiGetUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
7237
7237
|
* @param {*} [options] Override http request option.
|
|
@@ -7262,7 +7262,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7262
7262
|
*/
|
|
7263
7263
|
declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configuration?: Configuration<TAuth>, basePath?: string, axios?: AxiosInstance) => {
|
|
7264
7264
|
/**
|
|
7265
|
-
* Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
7265
|
+
* This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`. Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
7266
7266
|
* @summary List account activities
|
|
7267
7267
|
* @param {AccountInformationApiGetAccountActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
7268
7268
|
* @param {*} [options] Override http request option.
|
|
@@ -7286,7 +7286,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7286
7286
|
*/
|
|
7287
7287
|
getAllAccountPositions(requestParameters: AccountInformationApiGetAllAccountPositionsRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<AllAccountPositionsResponse>;
|
|
7288
7288
|
/**
|
|
7289
|
-
* **Deprecated
|
|
7289
|
+
* **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7290
7290
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7291
7291
|
* @param {AccountInformationApiGetAllUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
7292
7292
|
* @param {*} [options] Override http request option.
|
|
@@ -7327,7 +7327,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7327
7327
|
*/
|
|
7328
7328
|
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<Array<AccountOrderRecord>>;
|
|
7329
7329
|
/**
|
|
7330
|
-
*
|
|
7330
|
+
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). 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.
|
|
7331
7331
|
* @summary List account positions
|
|
7332
7332
|
* @param {AccountInformationApiGetUserAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
7333
7333
|
* @param {*} [options] Override http request option.
|
|
@@ -7352,7 +7352,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7352
7352
|
*/
|
|
7353
7353
|
getUserAccountReturnRates(requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<RateOfReturnResponse>;
|
|
7354
7354
|
/**
|
|
7355
|
-
* **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). 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.
|
|
7355
|
+
* **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.
|
|
7356
7356
|
* @summary List account holdings
|
|
7357
7357
|
* @param {AccountInformationApiGetUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
7358
7358
|
* @param {*} [options] Override http request option.
|
|
@@ -7413,7 +7413,7 @@ type AccountInformationApiGetAccountActivitiesBaseRequest = {
|
|
|
7413
7413
|
*/
|
|
7414
7414
|
readonly limit?: number;
|
|
7415
7415
|
/**
|
|
7416
|
-
* Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another. - `SPLIT` - A stock share split.
|
|
7416
|
+
* Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another. - `SPLIT` - A stock share split.
|
|
7417
7417
|
* @type {string}
|
|
7418
7418
|
* @memberof AccountInformationApiGetAccountActivities
|
|
7419
7419
|
*/
|
|
@@ -7782,7 +7782,7 @@ type AccountInformationApiUpdateUserAccountRequest<TAuth extends AuthMode> = Acc
|
|
|
7782
7782
|
*/
|
|
7783
7783
|
declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth> {
|
|
7784
7784
|
/**
|
|
7785
|
-
* Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
7785
|
+
* This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`. Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
7786
7786
|
* @summary List account activities
|
|
7787
7787
|
* @param {AccountInformationApiGetAccountActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
7788
7788
|
* @param {*} [options] Override http request option.
|
|
@@ -7809,7 +7809,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
7809
7809
|
*/
|
|
7810
7810
|
getAllAccountPositions(requestParameters: AccountInformationApiGetAllAccountPositionsRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<AllAccountPositionsResponse, any, {}>>;
|
|
7811
7811
|
/**
|
|
7812
|
-
* **Deprecated
|
|
7812
|
+
* **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7813
7813
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7814
7814
|
* @param {AccountInformationApiGetAllUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
7815
7815
|
* @param {*} [options] Override http request option.
|
|
@@ -7855,7 +7855,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
7855
7855
|
*/
|
|
7856
7856
|
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<AccountOrderRecord[], any, {}>>;
|
|
7857
7857
|
/**
|
|
7858
|
-
*
|
|
7858
|
+
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). 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.
|
|
7859
7859
|
* @summary List account positions
|
|
7860
7860
|
* @param {AccountInformationApiGetUserAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
7861
7861
|
* @param {*} [options] Override http request option.
|
|
@@ -7883,7 +7883,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
7883
7883
|
*/
|
|
7884
7884
|
getUserAccountReturnRates(requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<RateOfReturnResponse, any, {}>>;
|
|
7885
7885
|
/**
|
|
7886
|
-
* **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). 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.
|
|
7886
|
+
* **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.
|
|
7887
7887
|
* @summary List account holdings
|
|
7888
7888
|
* @param {AccountInformationApiGetUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
7889
7889
|
* @param {*} [options] Override http request option.
|
|
@@ -9226,7 +9226,7 @@ declare class ExperimentalEndpointsApi<TAuth extends AuthMode> extends Experimen
|
|
|
9226
9226
|
*/
|
|
9227
9227
|
declare const OptionsApiAxiosParamCreator: (configuration?: Configuration<AuthMode>) => {
|
|
9228
9228
|
/**
|
|
9229
|
-
*
|
|
9229
|
+
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions). 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.
|
|
9230
9230
|
* @summary List account option positions
|
|
9231
9231
|
* @param {string} accountId
|
|
9232
9232
|
* @param {string} [userId]
|
|
@@ -9243,7 +9243,7 @@ declare const OptionsApiAxiosParamCreator: (configuration?: Configuration<AuthMo
|
|
|
9243
9243
|
*/
|
|
9244
9244
|
declare const OptionsApiFp: <TAuth extends AuthMode>(configuration?: Configuration<TAuth>) => {
|
|
9245
9245
|
/**
|
|
9246
|
-
*
|
|
9246
|
+
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions). 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.
|
|
9247
9247
|
* @summary List account option positions
|
|
9248
9248
|
* @param {OptionsApiListOptionHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
9249
9249
|
* @param {*} [options] Override http request option.
|
|
@@ -9258,7 +9258,7 @@ declare const OptionsApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
9258
9258
|
*/
|
|
9259
9259
|
declare const OptionsApiFactory: <TAuth extends AuthMode>(configuration?: Configuration<TAuth>, basePath?: string, axios?: AxiosInstance) => {
|
|
9260
9260
|
/**
|
|
9261
|
-
*
|
|
9261
|
+
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions). 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.
|
|
9262
9262
|
* @summary List account option positions
|
|
9263
9263
|
* @param {OptionsApiListOptionHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
9264
9264
|
* @param {*} [options] Override http request option.
|
|
@@ -9300,7 +9300,7 @@ type OptionsApiListOptionHoldingsRequest<TAuth extends AuthMode> = OptionsApiLis
|
|
|
9300
9300
|
*/
|
|
9301
9301
|
declare class OptionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth> {
|
|
9302
9302
|
/**
|
|
9303
|
-
*
|
|
9303
|
+
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions). 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.
|
|
9304
9304
|
* @summary List account option positions
|
|
9305
9305
|
* @param {OptionsApiListOptionHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
9306
9306
|
* @param {*} [options] Override http request option.
|
|
@@ -9851,7 +9851,7 @@ declare const TradingApiAxiosParamCreator: (configuration?: Configuration<AuthMo
|
|
|
9851
9851
|
*/
|
|
9852
9852
|
cancelOrder: (accountId: string, accountInformationGetUserAccountOrderDetailRequest: AccountInformationGetUserAccountOrderDetailRequest, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9853
9853
|
/**
|
|
9854
|
-
* **
|
|
9854
|
+
* **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead. Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
9855
9855
|
* @summary Cancel equity order
|
|
9856
9856
|
* @param {string} accountId
|
|
9857
9857
|
* @param {AccountInformationGetUserAccountOrderDetailRequest} accountInformationGetUserAccountOrderDetailRequest
|
|
@@ -9906,7 +9906,7 @@ declare const TradingApiAxiosParamCreator: (configuration?: Configuration<AuthMo
|
|
|
9906
9906
|
*/
|
|
9907
9907
|
getUserAccountOptionQuotes: (accountId: string, symbol: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9908
9908
|
/**
|
|
9909
|
-
* 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.
|
|
9909
|
+
* 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.
|
|
9910
9910
|
* @summary Get equity symbol quotes
|
|
9911
9911
|
* @param {string} symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
|
|
9912
9912
|
* @param {string} accountId
|
|
@@ -9918,7 +9918,7 @@ declare const TradingApiAxiosParamCreator: (configuration?: Configuration<AuthMo
|
|
|
9918
9918
|
*/
|
|
9919
9919
|
getUserAccountQuotes: (symbols: string, accountId: string, useTicker?: boolean, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9920
9920
|
/**
|
|
9921
|
-
* **
|
|
9921
|
+
* **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead. Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
9922
9922
|
* @summary Place bracket order
|
|
9923
9923
|
* @param {string} accountId The ID of the account to execute the trade on.
|
|
9924
9924
|
* @param {ManualTradeFormBracket} manualTradeFormBracket
|
|
@@ -10032,7 +10032,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10032
10032
|
*/
|
|
10033
10033
|
cancelOrder(requestParameters: TradingApiCancelOrderRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelOrderResponse>>;
|
|
10034
10034
|
/**
|
|
10035
|
-
* **
|
|
10035
|
+
* **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead. Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
10036
10036
|
* @summary Cancel equity order
|
|
10037
10037
|
* @param {TradingApiCancelUserAccountOrderRequest<TAuth>} requestParameters Request parameters.
|
|
10038
10038
|
* @param {*} [options] Override http request option.
|
|
@@ -10073,7 +10073,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10073
10073
|
*/
|
|
10074
10074
|
getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionQuote>>;
|
|
10075
10075
|
/**
|
|
10076
|
-
* 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.
|
|
10076
|
+
* 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.
|
|
10077
10077
|
* @summary Get equity symbol quotes
|
|
10078
10078
|
* @param {TradingApiGetUserAccountQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
10079
10079
|
* @param {*} [options] Override http request option.
|
|
@@ -10081,7 +10081,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10081
10081
|
*/
|
|
10082
10082
|
getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SymbolsQuotesInner>>>;
|
|
10083
10083
|
/**
|
|
10084
|
-
* **
|
|
10084
|
+
* **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead. Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
10085
10085
|
* @summary Place bracket order
|
|
10086
10086
|
* @param {TradingApiPlaceBracketOrderRequest<TAuth>} requestParameters Request parameters.
|
|
10087
10087
|
* @param {*} [options] Override http request option.
|
|
@@ -10168,7 +10168,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10168
10168
|
*/
|
|
10169
10169
|
cancelOrder(requestParameters: TradingApiCancelOrderRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<CancelOrderResponse>;
|
|
10170
10170
|
/**
|
|
10171
|
-
* **
|
|
10171
|
+
* **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead. Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
10172
10172
|
* @summary Cancel equity order
|
|
10173
10173
|
* @param {TradingApiCancelUserAccountOrderRequest<TAuth>} requestParameters Request parameters.
|
|
10174
10174
|
* @param {*} [options] Override http request option.
|
|
@@ -10209,7 +10209,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10209
10209
|
*/
|
|
10210
10210
|
getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<OptionQuote>;
|
|
10211
10211
|
/**
|
|
10212
|
-
* 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.
|
|
10212
|
+
* 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.
|
|
10213
10213
|
* @summary Get equity symbol quotes
|
|
10214
10214
|
* @param {TradingApiGetUserAccountQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
10215
10215
|
* @param {*} [options] Override http request option.
|
|
@@ -10217,7 +10217,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10217
10217
|
*/
|
|
10218
10218
|
getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<Array<SymbolsQuotesInner>>;
|
|
10219
10219
|
/**
|
|
10220
|
-
* **
|
|
10220
|
+
* **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead. Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
10221
10221
|
* @summary Place bracket order
|
|
10222
10222
|
* @param {TradingApiPlaceBracketOrderRequest<TAuth>} requestParameters Request parameters.
|
|
10223
10223
|
* @param {*} [options] Override http request option.
|
|
@@ -10729,7 +10729,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10729
10729
|
*/
|
|
10730
10730
|
cancelOrder(requestParameters: TradingApiCancelOrderRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<CancelOrderResponse, any, {}>>;
|
|
10731
10731
|
/**
|
|
10732
|
-
* **
|
|
10732
|
+
* **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead. Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
10733
10733
|
* @summary Cancel equity order
|
|
10734
10734
|
* @param {TradingApiCancelUserAccountOrderRequest<TAuth>} requestParameters Request parameters.
|
|
10735
10735
|
* @param {*} [options] Override http request option.
|
|
@@ -10775,7 +10775,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10775
10775
|
*/
|
|
10776
10776
|
getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<OptionQuote, any, {}>>;
|
|
10777
10777
|
/**
|
|
10778
|
-
* 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.
|
|
10778
|
+
* 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.
|
|
10779
10779
|
* @summary Get equity symbol quotes
|
|
10780
10780
|
* @param {TradingApiGetUserAccountQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
10781
10781
|
* @param {*} [options] Override http request option.
|
|
@@ -10784,7 +10784,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10784
10784
|
*/
|
|
10785
10785
|
getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<SymbolsQuotesInner[], any, {}>>;
|
|
10786
10786
|
/**
|
|
10787
|
-
* **
|
|
10787
|
+
* **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead. Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
10788
10788
|
* @summary Place bracket order
|
|
10789
10789
|
* @param {TradingApiPlaceBracketOrderRequest<TAuth>} requestParameters Request parameters.
|
|
10790
10790
|
* @param {*} [options] Override http request option.
|
|
@@ -10877,13 +10877,13 @@ declare class TradingApi<TAuth extends AuthMode> extends TradingApiGenerated<TAu
|
|
|
10877
10877
|
*/
|
|
10878
10878
|
declare const TransactionsAndReportingApiAxiosParamCreator: (configuration?: Configuration<AuthMode>) => {
|
|
10879
10879
|
/**
|
|
10880
|
-
*
|
|
10880
|
+
* **Deprecated.** Use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) instead, if possible. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. Returns all historical transactions for the specified user and filtering criteria. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
10881
10881
|
* @summary Get transaction history for a user
|
|
10882
10882
|
* @param {string | Date} [startDate] The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
|
|
10883
10883
|
* @param {string | Date} [endDate] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
|
|
10884
10884
|
* @param {string} [accounts] Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
|
|
10885
10885
|
* @param {string} [brokerageAuthorizations] Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
|
|
10886
|
-
* @param {string} [type] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another
|
|
10886
|
+
* @param {string} [type] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another
|
|
10887
10887
|
* @param {string} [userId]
|
|
10888
10888
|
* @param {string} [userSecret]
|
|
10889
10889
|
* @param {*} [options] Override http request option.
|
|
@@ -10892,7 +10892,7 @@ declare const TransactionsAndReportingApiAxiosParamCreator: (configuration?: Con
|
|
|
10892
10892
|
*/
|
|
10893
10893
|
getActivities: (startDate?: string | Date, endDate?: string | Date, accounts?: string, brokerageAuthorizations?: string, type?: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10894
10894
|
/**
|
|
10895
|
-
* Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
10895
|
+
* **Deprecated.** Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
10896
10896
|
* @summary Get performance information for a specific timeframe
|
|
10897
10897
|
* @param {string | Date} startDate
|
|
10898
10898
|
* @param {string | Date} endDate
|
|
@@ -10913,7 +10913,7 @@ declare const TransactionsAndReportingApiAxiosParamCreator: (configuration?: Con
|
|
|
10913
10913
|
*/
|
|
10914
10914
|
declare const TransactionsAndReportingApiFp: <TAuth extends AuthMode>(configuration?: Configuration<TAuth>) => {
|
|
10915
10915
|
/**
|
|
10916
|
-
*
|
|
10916
|
+
* **Deprecated.** Use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) instead, if possible. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. Returns all historical transactions for the specified user and filtering criteria. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
10917
10917
|
* @summary Get transaction history for a user
|
|
10918
10918
|
* @param {TransactionsAndReportingApiGetActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
10919
10919
|
* @param {*} [options] Override http request option.
|
|
@@ -10922,7 +10922,7 @@ declare const TransactionsAndReportingApiFp: <TAuth extends AuthMode>(configurat
|
|
|
10922
10922
|
*/
|
|
10923
10923
|
getActivities(requestParameters?: TransactionsAndReportingApiGetActivitiesRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalActivity>>>;
|
|
10924
10924
|
/**
|
|
10925
|
-
* Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
10925
|
+
* **Deprecated.** Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
10926
10926
|
* @summary Get performance information for a specific timeframe
|
|
10927
10927
|
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth>} requestParameters Request parameters.
|
|
10928
10928
|
* @param {*} [options] Override http request option.
|
|
@@ -10937,7 +10937,7 @@ declare const TransactionsAndReportingApiFp: <TAuth extends AuthMode>(configurat
|
|
|
10937
10937
|
*/
|
|
10938
10938
|
declare const TransactionsAndReportingApiFactory: <TAuth extends AuthMode>(configuration?: Configuration<TAuth>, basePath?: string, axios?: AxiosInstance) => {
|
|
10939
10939
|
/**
|
|
10940
|
-
*
|
|
10940
|
+
* **Deprecated.** Use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) instead, if possible. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. Returns all historical transactions for the specified user and filtering criteria. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
10941
10941
|
* @summary Get transaction history for a user
|
|
10942
10942
|
* @param {TransactionsAndReportingApiGetActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
10943
10943
|
* @param {*} [options] Override http request option.
|
|
@@ -10946,7 +10946,7 @@ declare const TransactionsAndReportingApiFactory: <TAuth extends AuthMode>(confi
|
|
|
10946
10946
|
*/
|
|
10947
10947
|
getActivities(requestParameters?: TransactionsAndReportingApiGetActivitiesRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalActivity>>;
|
|
10948
10948
|
/**
|
|
10949
|
-
* Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
10949
|
+
* **Deprecated.** Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
10950
10950
|
* @summary Get performance information for a specific timeframe
|
|
10951
10951
|
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth>} requestParameters Request parameters.
|
|
10952
10952
|
* @param {*} [options] Override http request option.
|
|
@@ -10985,7 +10985,7 @@ type TransactionsAndReportingApiGetActivitiesBaseRequest = {
|
|
|
10985
10985
|
*/
|
|
10986
10986
|
readonly brokerageAuthorizations?: string;
|
|
10987
10987
|
/**
|
|
10988
|
-
* Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another
|
|
10988
|
+
* Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another
|
|
10989
10989
|
* @type {string}
|
|
10990
10990
|
* @memberof TransactionsAndReportingApiGetActivities
|
|
10991
10991
|
*/
|
|
@@ -11061,7 +11061,7 @@ type TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth extends Aut
|
|
|
11061
11061
|
*/
|
|
11062
11062
|
declare class TransactionsAndReportingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth> {
|
|
11063
11063
|
/**
|
|
11064
|
-
*
|
|
11064
|
+
* **Deprecated.** Use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) instead, if possible. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. Returns all historical transactions for the specified user and filtering criteria. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
11065
11065
|
* @summary Get transaction history for a user
|
|
11066
11066
|
* @param {TransactionsAndReportingApiGetActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
11067
11067
|
* @param {*} [options] Override http request option.
|
|
@@ -11071,7 +11071,7 @@ declare class TransactionsAndReportingApiGenerated<TAuth extends AuthMode> exten
|
|
|
11071
11071
|
*/
|
|
11072
11072
|
getActivities(requestParameters?: TransactionsAndReportingApiGetActivitiesRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<UniversalActivity[], any, {}>>;
|
|
11073
11073
|
/**
|
|
11074
|
-
* Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
11074
|
+
* **Deprecated.** Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
11075
11075
|
* @summary Get performance information for a specific timeframe
|
|
11076
11076
|
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth>} requestParameters Request parameters.
|
|
11077
11077
|
* @param {*} [options] Override http request option.
|