snaptrade-typescript-sdk 9.0.195 → 9.0.197
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 +17 -15
- package/dist/api/account-information-api-generated.d.ts +36 -32
- package/dist/api/account-information-api-generated.js +36 -32
- package/dist/api/connections-api-generated.d.ts +8 -8
- package/dist/api/connections-api-generated.js +8 -8
- package/dist/api/options-api-generated.d.ts +4 -4
- package/dist/api/options-api-generated.js +4 -4
- package/dist/api/transactions-and-reporting-api-generated.d.ts +4 -4
- package/dist/api/transactions-and-reporting-api-generated.js +4 -4
- package/dist/browser.js +1 -1
- package/dist/configuration.js +1 -1
- package/dist/models/account-position.d.ts +1 -1
- package/dist/models/account.d.ts +1 -1
- package/dist/models/future-instrument.d.ts +1 -1
- package/dist/models/option-instrument.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
Connect brokerage accounts to your app for live positions and trading
|
|
8
8
|
|
|
9
|
-
[](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.197)
|
|
10
10
|
[](https://snaptrade.com/)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
@@ -206,7 +206,7 @@ This endpoint is paginated with a default page size of 1000. The endpoint will r
|
|
|
206
206
|
|
|
207
207
|
Transaction are returned in reverse chronological order, using the `trade_date` field.
|
|
208
208
|
|
|
209
|
-
|
|
209
|
+
This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
210
210
|
|
|
211
211
|
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.
|
|
212
212
|
|
|
@@ -309,7 +309,7 @@ Returns a list of all positions in the specified account.
|
|
|
309
309
|
|
|
310
310
|
The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
|
|
311
311
|
|
|
312
|
-
|
|
312
|
+
`mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account.
|
|
313
313
|
|
|
314
314
|
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.
|
|
315
315
|
|
|
@@ -397,7 +397,7 @@ Returns a list of balances for the account. Each element of the list has a disti
|
|
|
397
397
|
|
|
398
398
|
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:
|
|
399
399
|
- If you do, this endpoint returns real-time data.
|
|
400
|
-
- If you don't,
|
|
400
|
+
- 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.
|
|
401
401
|
|
|
402
402
|
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.
|
|
403
403
|
|
|
@@ -440,7 +440,7 @@ Returns account detail known to SnapTrade for the specified account.
|
|
|
440
440
|
|
|
441
441
|
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:
|
|
442
442
|
- If you do, this endpoint returns real-time data.
|
|
443
|
-
- If you don't,
|
|
443
|
+
- 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.
|
|
444
444
|
|
|
445
445
|
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.
|
|
446
446
|
|
|
@@ -531,7 +531,7 @@ Returns a list of recent orders in the specified account.
|
|
|
531
531
|
|
|
532
532
|
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:
|
|
533
533
|
- If you do, this endpoint returns real-time data.
|
|
534
|
-
- If you don't,
|
|
534
|
+
- 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.
|
|
535
535
|
|
|
536
536
|
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.
|
|
537
537
|
|
|
@@ -586,7 +586,7 @@ Consider using the newer [unified positions endpoint](/reference/Account%20Infor
|
|
|
586
586
|
|
|
587
587
|
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:
|
|
588
588
|
- If you do, this endpoint returns real-time data.
|
|
589
|
-
- If you don't,
|
|
589
|
+
- 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.
|
|
590
590
|
|
|
591
591
|
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.
|
|
592
592
|
|
|
@@ -710,12 +710,14 @@ Optional comma separated list of rate-of-return timeframes to return. Supported
|
|
|
710
710
|
|
|
711
711
|
|
|
712
712
|
### `snaptrade.accountInformation.getUserHoldings`<a id="snaptradeaccountinformationgetuserholdings"></a>
|
|
713
|
+

|
|
713
714
|
|
|
714
|
-
|
|
715
|
+
**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).
|
|
716
|
+
Returns a list of balances, positions, and recent orders for the specified account.
|
|
715
717
|
|
|
716
718
|
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:
|
|
717
719
|
- If you do, this endpoint returns real-time data.
|
|
718
|
-
- If you don't,
|
|
720
|
+
- 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.
|
|
719
721
|
|
|
720
722
|
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.
|
|
721
723
|
|
|
@@ -759,7 +761,7 @@ const getUserHoldingsResponse =
|
|
|
759
761
|
|
|
760
762
|
Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
761
763
|
|
|
762
|
-
This data is cached and
|
|
764
|
+
This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
763
765
|
|
|
764
766
|
|
|
765
767
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -1165,9 +1167,9 @@ const disableBrokerageAuthorizationResponse =
|
|
|
1165
1167
|
|
|
1166
1168
|
Returns all brokerage accounts that belong to the specified connection for the authenticated user.
|
|
1167
1169
|
|
|
1168
|
-
On
|
|
1170
|
+
On Pay as you Go / Real-time, this endpoint refreshes each account's opening date, funding date, and total value live from the brokerage on each call.
|
|
1169
1171
|
|
|
1170
|
-
On
|
|
1172
|
+
On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1171
1173
|
|
|
1172
1174
|
Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
1173
1175
|
|
|
@@ -1248,7 +1250,7 @@ Trigger a holdings update for all accounts under this connection. Updates will b
|
|
|
1248
1250
|
This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
|
|
1249
1251
|
|
|
1250
1252
|
**Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
|
|
1251
|
-
**Please note this endpoint is disabled for
|
|
1253
|
+
**Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
|
|
1252
1254
|
|
|
1253
1255
|
|
|
1254
1256
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -1585,7 +1587,7 @@ Consider using the newer [unified positions endpoint](/reference/Account%20Infor
|
|
|
1585
1587
|
|
|
1586
1588
|
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:
|
|
1587
1589
|
- If you do, this endpoint returns real-time data.
|
|
1588
|
-
- If you don't,
|
|
1590
|
+
- 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.
|
|
1589
1591
|
|
|
1590
1592
|
|
|
1591
1593
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -2991,7 +2993,7 @@ Returns all historical transactions for the specified user and filtering criteri
|
|
|
2991
2993
|
|
|
2992
2994
|
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.
|
|
2993
2995
|
|
|
2994
|
-
|
|
2996
|
+
This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
2995
2997
|
|
|
2996
2998
|
**Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
2997
2999
|
|
|
@@ -19,7 +19,7 @@ import { RecentOrdersResponse } from '../models';
|
|
|
19
19
|
*/
|
|
20
20
|
export declare const AccountInformationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
21
|
/**
|
|
22
|
-
* 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.
|
|
22
|
+
* 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.
|
|
23
23
|
* @summary List account activities
|
|
24
24
|
* @param {string} accountId
|
|
25
25
|
* @param {string} userId
|
|
@@ -44,7 +44,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
44
44
|
*/
|
|
45
45
|
getAccountBalanceHistory: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
46
|
/**
|
|
47
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
47
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
48
48
|
* @summary List all account positions
|
|
49
49
|
* @param {string} userId
|
|
50
50
|
* @param {string} userSecret
|
|
@@ -65,7 +65,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
65
65
|
*/
|
|
66
66
|
getAllUserHoldings: (userId: string, userSecret: string, brokerageAuthorizations?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
67
|
/**
|
|
68
|
-
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t,
|
|
68
|
+
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
69
69
|
* @summary List account balances
|
|
70
70
|
* @param {string} userId
|
|
71
71
|
* @param {string} userSecret
|
|
@@ -75,7 +75,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
75
75
|
*/
|
|
76
76
|
getUserAccountBalance: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
77
|
/**
|
|
78
|
-
* Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t,
|
|
78
|
+
* Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
79
79
|
* @summary Get account detail
|
|
80
80
|
* @param {string} userId
|
|
81
81
|
* @param {string} userSecret
|
|
@@ -96,7 +96,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
96
96
|
*/
|
|
97
97
|
getUserAccountOrderDetail: (accountId: string, userId: string, userSecret: string, accountInformationGetUserAccountOrderDetailRequest: AccountInformationGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
98
98
|
/**
|
|
99
|
-
* Returns a list of recent orders in the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t,
|
|
99
|
+
* Returns a list of recent orders in the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
100
100
|
* @summary List account orders
|
|
101
101
|
* @param {string} userId
|
|
102
102
|
* @param {string} userSecret
|
|
@@ -108,7 +108,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
108
108
|
*/
|
|
109
109
|
getUserAccountOrders: (userId: string, userSecret: string, accountId: string, state?: 'all' | 'open' | 'executed', days?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
110
110
|
/**
|
|
111
|
-
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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,
|
|
111
|
+
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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.
|
|
112
112
|
* @summary List account positions
|
|
113
113
|
* @param {string} userId
|
|
114
114
|
* @param {string} userSecret
|
|
@@ -140,17 +140,18 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
140
140
|
*/
|
|
141
141
|
getUserAccountReturnRates: (userId: string, userSecret: string, accountId: string, timeframes?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
142
142
|
/**
|
|
143
|
-
*
|
|
143
|
+
* **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.
|
|
144
144
|
* @summary List account holdings
|
|
145
145
|
* @param {string} accountId
|
|
146
146
|
* @param {string} userId
|
|
147
147
|
* @param {string} userSecret
|
|
148
148
|
* @param {*} [options] Override http request option.
|
|
149
|
+
* @deprecated
|
|
149
150
|
* @throws {RequiredError}
|
|
150
151
|
*/
|
|
151
152
|
getUserHoldings: (accountId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
152
153
|
/**
|
|
153
|
-
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This data is cached and
|
|
154
|
+
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
154
155
|
* @summary List accounts
|
|
155
156
|
* @param {string} userId
|
|
156
157
|
* @param {string} userSecret
|
|
@@ -176,7 +177,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
176
177
|
*/
|
|
177
178
|
export declare const AccountInformationApiFp: (configuration?: Configuration) => {
|
|
178
179
|
/**
|
|
179
|
-
* 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.
|
|
180
|
+
* 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.
|
|
180
181
|
* @summary List account activities
|
|
181
182
|
* @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
|
|
182
183
|
* @param {*} [options] Override http request option.
|
|
@@ -192,7 +193,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
192
193
|
*/
|
|
193
194
|
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountValueHistoryResponse>>;
|
|
194
195
|
/**
|
|
195
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
196
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
196
197
|
* @summary List all account positions
|
|
197
198
|
* @param {AccountInformationApiGetAllAccountPositionsRequest} requestParameters Request parameters.
|
|
198
199
|
* @param {*} [options] Override http request option.
|
|
@@ -209,7 +210,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
209
210
|
*/
|
|
210
211
|
getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountHoldings>>>;
|
|
211
212
|
/**
|
|
212
|
-
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t,
|
|
213
|
+
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
213
214
|
* @summary List account balances
|
|
214
215
|
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
215
216
|
* @param {*} [options] Override http request option.
|
|
@@ -217,7 +218,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
217
218
|
*/
|
|
218
219
|
getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Balance>>>;
|
|
219
220
|
/**
|
|
220
|
-
* Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t,
|
|
221
|
+
* Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
221
222
|
* @summary Get account detail
|
|
222
223
|
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
223
224
|
* @param {*} [options] Override http request option.
|
|
@@ -233,7 +234,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
233
234
|
*/
|
|
234
235
|
getUserAccountOrderDetail(requestParameters: AccountInformationApiGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
235
236
|
/**
|
|
236
|
-
* Returns a list of recent orders in the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t,
|
|
237
|
+
* Returns a list of recent orders in the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
237
238
|
* @summary List account orders
|
|
238
239
|
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
239
240
|
* @param {*} [options] Override http request option.
|
|
@@ -241,7 +242,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
241
242
|
*/
|
|
242
243
|
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountOrderRecord>>>;
|
|
243
244
|
/**
|
|
244
|
-
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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,
|
|
245
|
+
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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.
|
|
245
246
|
* @summary List account positions
|
|
246
247
|
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
247
248
|
* @param {*} [options] Override http request option.
|
|
@@ -265,15 +266,16 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
265
266
|
*/
|
|
266
267
|
getUserAccountReturnRates(requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RateOfReturnResponse>>;
|
|
267
268
|
/**
|
|
268
|
-
*
|
|
269
|
+
* **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.
|
|
269
270
|
* @summary List account holdings
|
|
270
271
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
271
272
|
* @param {*} [options] Override http request option.
|
|
273
|
+
* @deprecated
|
|
272
274
|
* @throws {RequiredError}
|
|
273
275
|
*/
|
|
274
276
|
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountHoldingsAccount>>;
|
|
275
277
|
/**
|
|
276
|
-
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This data is cached and
|
|
278
|
+
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
277
279
|
* @summary List accounts
|
|
278
280
|
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
279
281
|
* @param {*} [options] Override http request option.
|
|
@@ -296,7 +298,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
296
298
|
*/
|
|
297
299
|
export declare const AccountInformationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
298
300
|
/**
|
|
299
|
-
* 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.
|
|
301
|
+
* 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.
|
|
300
302
|
* @summary List account activities
|
|
301
303
|
* @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
|
|
302
304
|
* @param {*} [options] Override http request option.
|
|
@@ -312,7 +314,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
312
314
|
*/
|
|
313
315
|
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest, options?: AxiosRequestConfig): AxiosPromise<AccountValueHistoryResponse>;
|
|
314
316
|
/**
|
|
315
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
317
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
316
318
|
* @summary List all account positions
|
|
317
319
|
* @param {AccountInformationApiGetAllAccountPositionsRequest} requestParameters Request parameters.
|
|
318
320
|
* @param {*} [options] Override http request option.
|
|
@@ -329,7 +331,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
329
331
|
*/
|
|
330
332
|
getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountHoldings>>;
|
|
331
333
|
/**
|
|
332
|
-
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t,
|
|
334
|
+
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
333
335
|
* @summary List account balances
|
|
334
336
|
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
335
337
|
* @param {*} [options] Override http request option.
|
|
@@ -337,7 +339,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
337
339
|
*/
|
|
338
340
|
getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Balance>>;
|
|
339
341
|
/**
|
|
340
|
-
* Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t,
|
|
342
|
+
* Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
341
343
|
* @summary Get account detail
|
|
342
344
|
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
343
345
|
* @param {*} [options] Override http request option.
|
|
@@ -353,7 +355,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
353
355
|
*/
|
|
354
356
|
getUserAccountOrderDetail(requestParameters: AccountInformationApiGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
355
357
|
/**
|
|
356
|
-
* Returns a list of recent orders in the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t,
|
|
358
|
+
* Returns a list of recent orders in the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
357
359
|
* @summary List account orders
|
|
358
360
|
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
359
361
|
* @param {*} [options] Override http request option.
|
|
@@ -361,7 +363,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
361
363
|
*/
|
|
362
364
|
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountOrderRecord>>;
|
|
363
365
|
/**
|
|
364
|
-
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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,
|
|
366
|
+
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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.
|
|
365
367
|
* @summary List account positions
|
|
366
368
|
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
367
369
|
* @param {*} [options] Override http request option.
|
|
@@ -385,15 +387,16 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
385
387
|
*/
|
|
386
388
|
getUserAccountReturnRates(requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest, options?: AxiosRequestConfig): AxiosPromise<RateOfReturnResponse>;
|
|
387
389
|
/**
|
|
388
|
-
*
|
|
390
|
+
* **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.
|
|
389
391
|
* @summary List account holdings
|
|
390
392
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
391
393
|
* @param {*} [options] Override http request option.
|
|
394
|
+
* @deprecated
|
|
392
395
|
* @throws {RequiredError}
|
|
393
396
|
*/
|
|
394
397
|
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<AccountHoldingsAccount>;
|
|
395
398
|
/**
|
|
396
|
-
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This data is cached and
|
|
399
|
+
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
397
400
|
* @summary List accounts
|
|
398
401
|
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
399
402
|
* @param {*} [options] Override http request option.
|
|
@@ -816,7 +819,7 @@ export type AccountInformationApiUpdateUserAccountRequest = {
|
|
|
816
819
|
*/
|
|
817
820
|
export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
818
821
|
/**
|
|
819
|
-
* 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.
|
|
822
|
+
* 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.
|
|
820
823
|
* @summary List account activities
|
|
821
824
|
* @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
|
|
822
825
|
* @param {*} [options] Override http request option.
|
|
@@ -834,7 +837,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
834
837
|
*/
|
|
835
838
|
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountValueHistoryResponse, any, {}>>;
|
|
836
839
|
/**
|
|
837
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
840
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
838
841
|
* @summary List all account positions
|
|
839
842
|
* @param {AccountInformationApiGetAllAccountPositionsRequest} requestParameters Request parameters.
|
|
840
843
|
* @param {*} [options] Override http request option.
|
|
@@ -853,7 +856,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
853
856
|
*/
|
|
854
857
|
getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldings[], any, {}>>;
|
|
855
858
|
/**
|
|
856
|
-
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t,
|
|
859
|
+
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
857
860
|
* @summary List account balances
|
|
858
861
|
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
859
862
|
* @param {*} [options] Override http request option.
|
|
@@ -862,7 +865,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
862
865
|
*/
|
|
863
866
|
getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Balance[], any, {}>>;
|
|
864
867
|
/**
|
|
865
|
-
* Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t,
|
|
868
|
+
* Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
866
869
|
* @summary Get account detail
|
|
867
870
|
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
868
871
|
* @param {*} [options] Override http request option.
|
|
@@ -880,7 +883,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
880
883
|
*/
|
|
881
884
|
getUserAccountOrderDetail(requestParameters: AccountInformationApiGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
|
|
882
885
|
/**
|
|
883
|
-
* Returns a list of recent orders in the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t,
|
|
886
|
+
* Returns a list of recent orders in the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
884
887
|
* @summary List account orders
|
|
885
888
|
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
886
889
|
* @param {*} [options] Override http request option.
|
|
@@ -889,7 +892,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
889
892
|
*/
|
|
890
893
|
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord[], any, {}>>;
|
|
891
894
|
/**
|
|
892
|
-
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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,
|
|
895
|
+
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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.
|
|
893
896
|
* @summary List account positions
|
|
894
897
|
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
895
898
|
* @param {*} [options] Override http request option.
|
|
@@ -916,16 +919,17 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
916
919
|
*/
|
|
917
920
|
getUserAccountReturnRates(requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RateOfReturnResponse, any, {}>>;
|
|
918
921
|
/**
|
|
919
|
-
*
|
|
922
|
+
* **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.
|
|
920
923
|
* @summary List account holdings
|
|
921
924
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
922
925
|
* @param {*} [options] Override http request option.
|
|
926
|
+
* @deprecated
|
|
923
927
|
* @throws {RequiredError}
|
|
924
928
|
* @memberof AccountInformationApiGenerated
|
|
925
929
|
*/
|
|
926
930
|
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldingsAccount, any, {}>>;
|
|
927
931
|
/**
|
|
928
|
-
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This data is cached and
|
|
932
|
+
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
929
933
|
* @summary List accounts
|
|
930
934
|
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
931
935
|
* @param {*} [options] Override http request option.
|