snaptrade-typescript-sdk 9.0.34 → 9.0.36
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 +54 -41
- package/dist/api/account-information-api-generated.d.ts +42 -42
- package/dist/api/account-information-api-generated.js +37 -37
- package/dist/api/authentication-api-generated.d.ts +28 -28
- package/dist/api/authentication-api-generated.js +28 -28
- package/dist/api/connections-api-generated.d.ts +4 -4
- package/dist/api/connections-api-generated.js +2 -2
- package/dist/api/options-api-generated.d.ts +10 -10
- package/dist/api/options-api-generated.js +9 -9
- package/dist/api/transactions-and-reporting-api-generated.d.ts +16 -16
- package/dist/api/transactions-and-reporting-api-generated.js +10 -10
- package/dist/browser.js +1 -1
- package/dist/configuration.js +1 -1
- package/dist/models/account-balance-total.d.ts +1 -1
- package/dist/models/account-holdings-account.d.ts +3 -3
- package/dist/models/account-order-record-universal-symbol.d.ts +6 -6
- package/dist/models/account-order-record.d.ts +1 -1
- package/dist/models/account-simple.d.ts +4 -4
- package/dist/models/account-sync-status.d.ts +1 -1
- package/dist/models/account.d.ts +12 -10
- package/dist/models/balance-currency.d.ts +25 -0
- package/dist/models/balance.d.ts +3 -3
- package/dist/models/delete-user-response.d.ts +8 -2
- package/dist/models/holdings-status.d.ts +4 -4
- package/dist/models/index.d.ts +6 -5
- package/dist/models/index.js +6 -5
- package/dist/models/login-redirect-uri.d.ts +4 -4
- package/dist/models/snap-trade-login-user-request-body.d.ts +6 -6
- package/dist/models/{universal-symbol-currency.d.ts → symbol-currency.d.ts} +5 -5
- package/dist/models/{universal-symbol-exchange.d.ts → symbol-exchange.d.ts} +10 -10
- package/dist/models/symbol.d.ts +13 -13
- package/dist/models/transactions-status.d.ts +6 -6
- package/dist/models/underlying-symbol.d.ts +3 -3
- package/dist/models/universal-activity-currency.d.ts +25 -0
- package/dist/models/universal-activity-option-symbol.d.ts +52 -0
- package/dist/models/universal-activity-symbol.d.ts +65 -0
- package/dist/models/universal-activity-symbol.js +2 -0
- package/dist/models/universal-activity.d.ts +40 -40
- package/dist/models/universal-symbol.d.ts +6 -6
- package/dist/models/user-idand-secret.d.ts +1 -1
- package/package.json +1 -1
- package/dist/models/amount.d.ts +0 -19
- package/dist/models/snap-trade-holdings-account-account-id-balance.d.ts +0 -14
- package/dist/models/snap-trade-holdings-account-account-id.d.ts +0 -74
- /package/dist/models/{amount.js → balance-currency.js} +0 -0
- /package/dist/models/{snap-trade-holdings-account-account-id-balance.js → symbol-currency.js} +0 -0
- /package/dist/models/{snap-trade-holdings-account-account-id.js → symbol-exchange.js} +0 -0
- /package/dist/models/{universal-symbol-currency.js → universal-activity-currency.js} +0 -0
- /package/dist/models/{universal-symbol-exchange.js → universal-activity-option-symbol.js} +0 -0
|
@@ -63,8 +63,8 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
63
63
|
* Returns a list of session events associated with a user.
|
|
64
64
|
* @summary Get all session events for a user
|
|
65
65
|
* @param {string} partnerClientId
|
|
66
|
-
* @param {string} [userId] Optional comma
|
|
67
|
-
* @param {string} [sessionId] Optional comma
|
|
66
|
+
* @param {string} [userId] Optional comma separated list of user IDs used to filter the request on specific users
|
|
67
|
+
* @param {string} [sessionId] Optional comma separated list of session IDs used to filter the request on specific users
|
|
68
68
|
* @param {*} [options] Override http request option.
|
|
69
69
|
* @throws {RequiredError}
|
|
70
70
|
*/
|
|
@@ -310,13 +310,13 @@ export type ConnectionsApiSessionEventsRequest = {
|
|
|
310
310
|
*/
|
|
311
311
|
readonly partnerClientId: string;
|
|
312
312
|
/**
|
|
313
|
-
* Optional comma
|
|
313
|
+
* Optional comma separated list of user IDs used to filter the request on specific users
|
|
314
314
|
* @type {string}
|
|
315
315
|
* @memberof ConnectionsApiSessionEvents
|
|
316
316
|
*/
|
|
317
317
|
readonly userId?: string;
|
|
318
318
|
/**
|
|
319
|
-
* Optional comma
|
|
319
|
+
* Optional comma separated list of session IDs used to filter the request on specific users
|
|
320
320
|
* @type {string}
|
|
321
321
|
* @memberof ConnectionsApiSessionEvents
|
|
322
322
|
*/
|
|
@@ -310,8 +310,8 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
|
|
|
310
310
|
* Returns a list of session events associated with a user.
|
|
311
311
|
* @summary Get all session events for a user
|
|
312
312
|
* @param {string} partnerClientId
|
|
313
|
-
* @param {string} [userId] Optional comma
|
|
314
|
-
* @param {string} [sessionId] Optional comma
|
|
313
|
+
* @param {string} [userId] Optional comma separated list of user IDs used to filter the request on specific users
|
|
314
|
+
* @param {string} [sessionId] Optional comma separated list of session IDs used to filter the request on specific users
|
|
315
315
|
* @param {*} [options] Override http request option.
|
|
316
316
|
* @throws {RequiredError}
|
|
317
317
|
*/
|
|
@@ -46,11 +46,11 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
46
46
|
*/
|
|
47
47
|
getOptionsStrategyQuote: (userId: string, userSecret: string, accountId: string, optionStrategyId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48
48
|
/**
|
|
49
|
-
* Returns a list of
|
|
50
|
-
* @summary
|
|
49
|
+
* 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). The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
50
|
+
* @summary List account option positions
|
|
51
51
|
* @param {string} userId
|
|
52
52
|
* @param {string} userSecret
|
|
53
|
-
* @param {string} accountId
|
|
53
|
+
* @param {string} accountId
|
|
54
54
|
* @param {*} [options] Override http request option.
|
|
55
55
|
* @throws {RequiredError}
|
|
56
56
|
*/
|
|
@@ -98,8 +98,8 @@ export declare const OptionsApiFp: (configuration?: Configuration) => {
|
|
|
98
98
|
*/
|
|
99
99
|
getOptionsStrategyQuote(requestParameters: OptionsApiGetOptionsStrategyQuoteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StrategyQuotes>>;
|
|
100
100
|
/**
|
|
101
|
-
* Returns a list of
|
|
102
|
-
* @summary
|
|
101
|
+
* 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). The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
102
|
+
* @summary List account option positions
|
|
103
103
|
* @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
|
|
104
104
|
* @param {*} [options] Override http request option.
|
|
105
105
|
* @throws {RequiredError}
|
|
@@ -144,8 +144,8 @@ export declare const OptionsApiFactory: (configuration?: Configuration, basePath
|
|
|
144
144
|
*/
|
|
145
145
|
getOptionsStrategyQuote(requestParameters: OptionsApiGetOptionsStrategyQuoteRequest, options?: AxiosRequestConfig): AxiosPromise<StrategyQuotes>;
|
|
146
146
|
/**
|
|
147
|
-
* Returns a list of
|
|
148
|
-
* @summary
|
|
147
|
+
* 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). The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
148
|
+
* @summary List account option positions
|
|
149
149
|
* @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
|
|
150
150
|
* @param {*} [options] Override http request option.
|
|
151
151
|
* @throws {RequiredError}
|
|
@@ -266,7 +266,7 @@ export type OptionsApiListOptionHoldingsRequest = {
|
|
|
266
266
|
*/
|
|
267
267
|
readonly userSecret: string;
|
|
268
268
|
/**
|
|
269
|
-
*
|
|
269
|
+
*
|
|
270
270
|
* @type {string}
|
|
271
271
|
* @memberof OptionsApiListOptionHoldings
|
|
272
272
|
*/
|
|
@@ -338,8 +338,8 @@ export declare class OptionsApiGenerated extends BaseAPI {
|
|
|
338
338
|
*/
|
|
339
339
|
getOptionsStrategyQuote(requestParameters: OptionsApiGetOptionsStrategyQuoteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StrategyQuotes, any>>;
|
|
340
340
|
/**
|
|
341
|
-
* Returns a list of
|
|
342
|
-
* @summary
|
|
341
|
+
* 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). The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
342
|
+
* @summary List account option positions
|
|
343
343
|
* @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
|
|
344
344
|
* @param {*} [options] Override http request option.
|
|
345
345
|
* @throws {RequiredError}
|
|
@@ -217,11 +217,11 @@ const OptionsApiAxiosParamCreator = function (configuration) {
|
|
|
217
217
|
};
|
|
218
218
|
}),
|
|
219
219
|
/**
|
|
220
|
-
* Returns a list of
|
|
221
|
-
* @summary
|
|
220
|
+
* 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). The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
221
|
+
* @summary List account option positions
|
|
222
222
|
* @param {string} userId
|
|
223
223
|
* @param {string} userSecret
|
|
224
|
-
* @param {string} accountId
|
|
224
|
+
* @param {string} accountId
|
|
225
225
|
* @param {*} [options] Override http request option.
|
|
226
226
|
* @throws {RequiredError}
|
|
227
227
|
*/
|
|
@@ -391,8 +391,8 @@ const OptionsApiFp = function (configuration) {
|
|
|
391
391
|
});
|
|
392
392
|
},
|
|
393
393
|
/**
|
|
394
|
-
* Returns a list of
|
|
395
|
-
* @summary
|
|
394
|
+
* 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). The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
395
|
+
* @summary List account option positions
|
|
396
396
|
* @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
|
|
397
397
|
* @param {*} [options] Override http request option.
|
|
398
398
|
* @throws {RequiredError}
|
|
@@ -462,8 +462,8 @@ const OptionsApiFactory = function (configuration, basePath, axios) {
|
|
|
462
462
|
return localVarFp.getOptionsStrategyQuote(requestParameters, options).then((request) => request(axios, basePath));
|
|
463
463
|
},
|
|
464
464
|
/**
|
|
465
|
-
* Returns a list of
|
|
466
|
-
* @summary
|
|
465
|
+
* 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). The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
466
|
+
* @summary List account option positions
|
|
467
467
|
* @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
|
|
468
468
|
* @param {*} [options] Override http request option.
|
|
469
469
|
* @throws {RequiredError}
|
|
@@ -525,8 +525,8 @@ class OptionsApiGenerated extends base_1.BaseAPI {
|
|
|
525
525
|
return (0, exports.OptionsApiFp)(this.configuration).getOptionsStrategyQuote(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
526
526
|
}
|
|
527
527
|
/**
|
|
528
|
-
* Returns a list of
|
|
529
|
-
* @summary
|
|
528
|
+
* 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). The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
529
|
+
* @summary List account option positions
|
|
530
530
|
* @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
|
|
531
531
|
* @param {*} [options] Override http request option.
|
|
532
532
|
* @throws {RequiredError}
|
|
@@ -9,15 +9,15 @@ import { UniversalActivity } from '../models';
|
|
|
9
9
|
*/
|
|
10
10
|
export declare const TransactionsAndReportingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11
11
|
/**
|
|
12
|
-
* Returns
|
|
12
|
+
* 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. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
13
13
|
* @summary Get transaction history for a user
|
|
14
14
|
* @param {string} userId
|
|
15
15
|
* @param {string} userSecret
|
|
16
|
-
* @param {string | Date} [startDate]
|
|
17
|
-
* @param {string | Date} [endDate]
|
|
18
|
-
* @param {string} [accounts] Optional comma
|
|
19
|
-
* @param {string} [brokerageAuthorizations] Optional comma
|
|
20
|
-
* @param {string} [type] Optional comma
|
|
16
|
+
* @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`.
|
|
17
|
+
* @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`.
|
|
18
|
+
* @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.
|
|
19
|
+
* @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.
|
|
20
|
+
* @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 - SELL - DIVIDEND - CONTRIBUTION - WITHDRAWAL - REI - INTEREST - FEE
|
|
21
21
|
* @param {*} [options] Override http request option.
|
|
22
22
|
* @throws {RequiredError}
|
|
23
23
|
*/
|
|
@@ -29,7 +29,7 @@ export declare const TransactionsAndReportingApiAxiosParamCreator: (configuratio
|
|
|
29
29
|
* @param {string | Date} endDate
|
|
30
30
|
* @param {string} userId
|
|
31
31
|
* @param {string} userSecret
|
|
32
|
-
* @param {string} [accounts] Optional comma
|
|
32
|
+
* @param {string} [accounts] Optional comma separated list of account IDs used to filter the request on specific accounts
|
|
33
33
|
* @param {boolean} [detailed] Optional, increases frequency of data points for the total value and contribution charts if set to true
|
|
34
34
|
* @param {string} [frequency] Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
|
|
35
35
|
* @param {*} [options] Override http request option.
|
|
@@ -44,7 +44,7 @@ export declare const TransactionsAndReportingApiAxiosParamCreator: (configuratio
|
|
|
44
44
|
*/
|
|
45
45
|
export declare const TransactionsAndReportingApiFp: (configuration?: Configuration) => {
|
|
46
46
|
/**
|
|
47
|
-
* Returns
|
|
47
|
+
* 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. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
48
48
|
* @summary Get transaction history for a user
|
|
49
49
|
* @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
|
|
50
50
|
* @param {*} [options] Override http request option.
|
|
@@ -67,7 +67,7 @@ export declare const TransactionsAndReportingApiFp: (configuration?: Configurati
|
|
|
67
67
|
*/
|
|
68
68
|
export declare const TransactionsAndReportingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
69
69
|
/**
|
|
70
|
-
* Returns
|
|
70
|
+
* 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. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
71
71
|
* @summary Get transaction history for a user
|
|
72
72
|
* @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
|
|
73
73
|
* @param {*} [options] Override http request option.
|
|
@@ -103,31 +103,31 @@ export type TransactionsAndReportingApiGetActivitiesRequest = {
|
|
|
103
103
|
*/
|
|
104
104
|
readonly userSecret: string;
|
|
105
105
|
/**
|
|
106
|
-
*
|
|
106
|
+
* 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`.
|
|
107
107
|
* @type {string | Date}
|
|
108
108
|
* @memberof TransactionsAndReportingApiGetActivities
|
|
109
109
|
*/
|
|
110
110
|
readonly startDate?: string | Date;
|
|
111
111
|
/**
|
|
112
|
-
*
|
|
112
|
+
* 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`.
|
|
113
113
|
* @type {string | Date}
|
|
114
114
|
* @memberof TransactionsAndReportingApiGetActivities
|
|
115
115
|
*/
|
|
116
116
|
readonly endDate?: string | Date;
|
|
117
117
|
/**
|
|
118
|
-
* Optional comma
|
|
118
|
+
* 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.
|
|
119
119
|
* @type {string}
|
|
120
120
|
* @memberof TransactionsAndReportingApiGetActivities
|
|
121
121
|
*/
|
|
122
122
|
readonly accounts?: string;
|
|
123
123
|
/**
|
|
124
|
-
* Optional comma
|
|
124
|
+
* 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.
|
|
125
125
|
* @type {string}
|
|
126
126
|
* @memberof TransactionsAndReportingApiGetActivities
|
|
127
127
|
*/
|
|
128
128
|
readonly brokerageAuthorizations?: string;
|
|
129
129
|
/**
|
|
130
|
-
* Optional comma
|
|
130
|
+
* 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 - SELL - DIVIDEND - CONTRIBUTION - WITHDRAWAL - REI - INTEREST - FEE
|
|
131
131
|
* @type {string}
|
|
132
132
|
* @memberof TransactionsAndReportingApiGetActivities
|
|
133
133
|
*/
|
|
@@ -164,7 +164,7 @@ export type TransactionsAndReportingApiGetReportingCustomRangeRequest = {
|
|
|
164
164
|
*/
|
|
165
165
|
readonly userSecret: string;
|
|
166
166
|
/**
|
|
167
|
-
* Optional comma
|
|
167
|
+
* Optional comma separated list of account IDs used to filter the request on specific accounts
|
|
168
168
|
* @type {string}
|
|
169
169
|
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
170
170
|
*/
|
|
@@ -190,7 +190,7 @@ export type TransactionsAndReportingApiGetReportingCustomRangeRequest = {
|
|
|
190
190
|
*/
|
|
191
191
|
export declare class TransactionsAndReportingApiGenerated extends BaseAPI {
|
|
192
192
|
/**
|
|
193
|
-
* Returns
|
|
193
|
+
* 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. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
194
194
|
* @summary Get transaction history for a user
|
|
195
195
|
* @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
|
|
196
196
|
* @param {*} [options] Override http request option.
|
|
@@ -36,15 +36,15 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
|
|
|
36
36
|
const TransactionsAndReportingApiAxiosParamCreator = function (configuration) {
|
|
37
37
|
return {
|
|
38
38
|
/**
|
|
39
|
-
* Returns
|
|
39
|
+
* 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. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
40
40
|
* @summary Get transaction history for a user
|
|
41
41
|
* @param {string} userId
|
|
42
42
|
* @param {string} userSecret
|
|
43
|
-
* @param {string | Date} [startDate]
|
|
44
|
-
* @param {string | Date} [endDate]
|
|
45
|
-
* @param {string} [accounts] Optional comma
|
|
46
|
-
* @param {string} [brokerageAuthorizations] Optional comma
|
|
47
|
-
* @param {string} [type] Optional comma
|
|
43
|
+
* @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`.
|
|
44
|
+
* @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`.
|
|
45
|
+
* @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.
|
|
46
|
+
* @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.
|
|
47
|
+
* @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 - SELL - DIVIDEND - CONTRIBUTION - WITHDRAWAL - REI - INTEREST - FEE
|
|
48
48
|
* @param {*} [options] Override http request option.
|
|
49
49
|
* @throws {RequiredError}
|
|
50
50
|
*/
|
|
@@ -117,7 +117,7 @@ const TransactionsAndReportingApiAxiosParamCreator = function (configuration) {
|
|
|
117
117
|
* @param {string | Date} endDate
|
|
118
118
|
* @param {string} userId
|
|
119
119
|
* @param {string} userSecret
|
|
120
|
-
* @param {string} [accounts] Optional comma
|
|
120
|
+
* @param {string} [accounts] Optional comma separated list of account IDs used to filter the request on specific accounts
|
|
121
121
|
* @param {boolean} [detailed] Optional, increases frequency of data points for the total value and contribution charts if set to true
|
|
122
122
|
* @param {string} [frequency] Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
|
|
123
123
|
* @param {*} [options] Override http request option.
|
|
@@ -201,7 +201,7 @@ const TransactionsAndReportingApiFp = function (configuration) {
|
|
|
201
201
|
const localVarAxiosParamCreator = (0, exports.TransactionsAndReportingApiAxiosParamCreator)(configuration);
|
|
202
202
|
return {
|
|
203
203
|
/**
|
|
204
|
-
* Returns
|
|
204
|
+
* 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. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
205
205
|
* @summary Get transaction history for a user
|
|
206
206
|
* @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
|
|
207
207
|
* @param {*} [options] Override http request option.
|
|
@@ -238,7 +238,7 @@ const TransactionsAndReportingApiFactory = function (configuration, basePath, ax
|
|
|
238
238
|
const localVarFp = (0, exports.TransactionsAndReportingApiFp)(configuration);
|
|
239
239
|
return {
|
|
240
240
|
/**
|
|
241
|
-
* Returns
|
|
241
|
+
* 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. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
242
242
|
* @summary Get transaction history for a user
|
|
243
243
|
* @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
|
|
244
244
|
* @param {*} [options] Override http request option.
|
|
@@ -269,7 +269,7 @@ exports.TransactionsAndReportingApiFactory = TransactionsAndReportingApiFactory;
|
|
|
269
269
|
*/
|
|
270
270
|
class TransactionsAndReportingApiGenerated extends base_1.BaseAPI {
|
|
271
271
|
/**
|
|
272
|
-
* Returns
|
|
272
|
+
* 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. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
273
273
|
* @summary Get transaction history for a user
|
|
274
274
|
* @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
|
|
275
275
|
* @param {*} [options] Override http request option.
|