snaptrade-typescript-sdk 9.0.147 → 9.0.149
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 +121 -9
- package/dist/api/account-information-api-generated.d.ts +24 -24
- package/dist/api/account-information-api-generated.js +24 -24
- package/dist/api/connections-api-generated.d.ts +4 -4
- package/dist/api/connections-api-generated.js +4 -4
- package/dist/api/experimental-endpoints-api-generated.d.ts +171 -0
- package/dist/api/experimental-endpoints-api-generated.js +259 -0
- package/dist/api/experimental-endpoints-api.d.ts +4 -0
- package/dist/api/experimental-endpoints-api.js +22 -0
- package/dist/api/options-api-generated.d.ts +4 -4
- package/dist/api/options-api-generated.js +4 -4
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/browser.js +1 -1
- package/dist/client.d.ts +2 -1
- package/dist/client.js +1 -0
- package/dist/configuration.js +1 -1
- package/dist/models/account-order-record-leg-instrument.d.ts +38 -0
- package/dist/models/account-order-record-leg-instrument.js +2 -0
- package/dist/models/account-order-record-leg.d.ts +58 -0
- package/dist/models/account-order-record-leg.js +2 -0
- package/dist/models/account-order-record-status-v2.d.ts +6 -0
- package/dist/models/account-order-record-status-v2.js +2 -0
- package/dist/models/account-order-record-v2.d.ts +76 -0
- package/dist/models/account-order-record-v2.js +2 -0
- package/dist/models/account-orders-v2-response.d.ts +15 -0
- package/dist/models/account-orders-v2-response.js +2 -0
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/dist/operationParameterMap.js +35 -0
- 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.149)
|
|
10
10
|
[](https://snaptrade.com/)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
@@ -43,6 +43,8 @@ Connect brokerage accounts to your app for live positions and trading
|
|
|
43
43
|
* [`snaptrade.connections.removeBrokerageAuthorization`](#snaptradeconnectionsremovebrokerageauthorization)
|
|
44
44
|
* [`snaptrade.connections.returnRates`](#snaptradeconnectionsreturnrates)
|
|
45
45
|
* [`snaptrade.connections.sessionEvents`](#snaptradeconnectionssessionevents)
|
|
46
|
+
* [`snaptrade.experimentalEndpoints.getUserAccountOrdersV2`](#snaptradeexperimentalendpointsgetuseraccountordersv2)
|
|
47
|
+
* [`snaptrade.experimentalEndpoints.getUserAccountRecentOrdersV2`](#snaptradeexperimentalendpointsgetuseraccountrecentordersv2)
|
|
46
48
|
* [`snaptrade.options.getOptionsChain`](#snaptradeoptionsgetoptionschain)
|
|
47
49
|
* [`snaptrade.options.listOptionHoldings`](#snaptradeoptionslistoptionholdings)
|
|
48
50
|
* [`snaptrade.referenceData.getCurrencyExchangeRatePair`](#snaptradereferencedatagetcurrencyexchangeratepair)
|
|
@@ -303,7 +305,9 @@ Optional. Comma separated list of authorization IDs (only use if filtering is ne
|
|
|
303
305
|
|
|
304
306
|
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).
|
|
305
307
|
|
|
306
|
-
|
|
308
|
+
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:
|
|
309
|
+
- If you do, this endpoint returns real-time data.
|
|
310
|
+
- If you don't, the data is cached and refreshed once a day. 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, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
307
311
|
|
|
308
312
|
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.
|
|
309
313
|
|
|
@@ -344,7 +348,9 @@ const getUserAccountBalanceResponse =
|
|
|
344
348
|
|
|
345
349
|
Returns account detail known to SnapTrade for the specified account.
|
|
346
350
|
|
|
347
|
-
|
|
351
|
+
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:
|
|
352
|
+
- If you do, this endpoint returns real-time data.
|
|
353
|
+
- If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
348
354
|
|
|
349
355
|
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.
|
|
350
356
|
|
|
@@ -433,7 +439,9 @@ Order ID returned by brokerage. This is the unique identifier for the order in t
|
|
|
433
439
|
|
|
434
440
|
Returns a list of recent orders in the specified account.
|
|
435
441
|
|
|
436
|
-
|
|
442
|
+
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:
|
|
443
|
+
- If you do, this endpoint returns real-time data.
|
|
444
|
+
- If you don't, the data is cached and refreshed once a day. 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, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
437
445
|
|
|
438
446
|
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.
|
|
439
447
|
|
|
@@ -484,7 +492,9 @@ Number of days in the past to fetch the most recent orders. Defaults to the last
|
|
|
484
492
|
|
|
485
493
|
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).
|
|
486
494
|
|
|
487
|
-
|
|
495
|
+
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:
|
|
496
|
+
- If you do, this endpoint returns real-time data.
|
|
497
|
+
- If you don't, the data is cached and refreshed once a day. 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, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
488
498
|
|
|
489
499
|
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.
|
|
490
500
|
|
|
@@ -607,7 +617,9 @@ const getUserAccountReturnRatesResponse =
|
|
|
607
617
|
|
|
608
618
|
Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
609
619
|
|
|
610
|
-
|
|
620
|
+
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:
|
|
621
|
+
- If you do, this endpoint returns real-time data.
|
|
622
|
+
- If you don't, the data is cached and refreshed once a day. 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, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
611
623
|
|
|
612
624
|
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.
|
|
613
625
|
|
|
@@ -648,7 +660,9 @@ const getUserHoldingsResponse =
|
|
|
648
660
|
|
|
649
661
|
Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
650
662
|
|
|
651
|
-
|
|
663
|
+
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:
|
|
664
|
+
- If you do, this endpoint returns real-time data.
|
|
665
|
+
- If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
652
666
|
|
|
653
667
|
|
|
654
668
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -1053,7 +1067,7 @@ const listBrokerageAuthorizationsResponse =
|
|
|
1053
1067
|
Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.
|
|
1054
1068
|
This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
|
|
1055
1069
|
|
|
1056
|
-
**
|
|
1070
|
+
**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)**
|
|
1057
1071
|
|
|
1058
1072
|
|
|
1059
1073
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -1197,6 +1211,102 @@ Optional comma separated list of session IDs used to filter the request on speci
|
|
|
1197
1211
|
---
|
|
1198
1212
|
|
|
1199
1213
|
|
|
1214
|
+
### `snaptrade.experimentalEndpoints.getUserAccountOrdersV2`<a id="snaptradeexperimentalendpointsgetuseraccountordersv2"></a>
|
|
1215
|
+
|
|
1216
|
+
Returns a list of recent orders in the specified account.
|
|
1217
|
+
|
|
1218
|
+
The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.
|
|
1219
|
+
|
|
1220
|
+
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.
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
1224
|
+
|
|
1225
|
+
```typescript
|
|
1226
|
+
const getUserAccountOrdersV2Response =
|
|
1227
|
+
await snaptrade.experimentalEndpoints.getUserAccountOrdersV2({
|
|
1228
|
+
userId: "snaptrade-user-123",
|
|
1229
|
+
userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
1230
|
+
state: "all",
|
|
1231
|
+
days: 30,
|
|
1232
|
+
accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
1233
|
+
});
|
|
1234
|
+
```
|
|
1235
|
+
|
|
1236
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
1237
|
+
|
|
1238
|
+
##### userId: `string`<a id="userid-string"></a>
|
|
1239
|
+
|
|
1240
|
+
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
1241
|
+
|
|
1242
|
+
##### accountId: `string`<a id="accountid-string"></a>
|
|
1243
|
+
|
|
1244
|
+
##### state: `'all' | 'open' | 'executed'`<a id="state-all--open--executed"></a>
|
|
1245
|
+
|
|
1246
|
+
defaults value is set to \"all\"
|
|
1247
|
+
|
|
1248
|
+
##### days: `number`<a id="days-number"></a>
|
|
1249
|
+
|
|
1250
|
+
Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in.
|
|
1251
|
+
|
|
1252
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
|
1253
|
+
|
|
1254
|
+
[AccountOrdersV2Response](./models/account-orders-v2-response.ts)
|
|
1255
|
+
|
|
1256
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
1257
|
+
|
|
1258
|
+
`/accounts/{accountId}/orders/v2` `GET`
|
|
1259
|
+
|
|
1260
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
1261
|
+
|
|
1262
|
+
---
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
### `snaptrade.experimentalEndpoints.getUserAccountRecentOrdersV2`<a id="snaptradeexperimentalendpointsgetuseraccountrecentordersv2"></a>
|
|
1266
|
+
|
|
1267
|
+
A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format.
|
|
1268
|
+
This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders.
|
|
1269
|
+
Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days.
|
|
1270
|
+
By default only returns executed orders, but that can be changed by setting *only_executed* to false.
|
|
1271
|
+
**Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
1275
|
+
|
|
1276
|
+
```typescript
|
|
1277
|
+
const getUserAccountRecentOrdersV2Response =
|
|
1278
|
+
await snaptrade.experimentalEndpoints.getUserAccountRecentOrdersV2({
|
|
1279
|
+
userId: "snaptrade-user-123",
|
|
1280
|
+
userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
1281
|
+
accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
1282
|
+
});
|
|
1283
|
+
```
|
|
1284
|
+
|
|
1285
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
1286
|
+
|
|
1287
|
+
##### userId: `string`<a id="userid-string"></a>
|
|
1288
|
+
|
|
1289
|
+
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
1290
|
+
|
|
1291
|
+
##### accountId: `string`<a id="accountid-string"></a>
|
|
1292
|
+
|
|
1293
|
+
##### onlyExecuted: `boolean`<a id="onlyexecuted-boolean"></a>
|
|
1294
|
+
|
|
1295
|
+
Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
|
|
1296
|
+
|
|
1297
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
|
1298
|
+
|
|
1299
|
+
[AccountOrdersV2Response](./models/account-orders-v2-response.ts)
|
|
1300
|
+
|
|
1301
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
1302
|
+
|
|
1303
|
+
`/accounts/{accountId}/recentOrders/v2` `GET`
|
|
1304
|
+
|
|
1305
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
1306
|
+
|
|
1307
|
+
---
|
|
1308
|
+
|
|
1309
|
+
|
|
1200
1310
|
### `snaptrade.options.getOptionsChain`<a id="snaptradeoptionsgetoptionschain"></a>
|
|
1201
1311
|
|
|
1202
1312
|
Returns the option chain for the specified symbol in the specified account.
|
|
@@ -1243,7 +1353,9 @@ Universal symbol ID if symbol
|
|
|
1243
1353
|
|
|
1244
1354
|
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).
|
|
1245
1355
|
|
|
1246
|
-
|
|
1356
|
+
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:
|
|
1357
|
+
- If you do, this endpoint returns real-time data.
|
|
1358
|
+
- If you don't, the data is cached and refreshed once a day. 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, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
1247
1359
|
|
|
1248
1360
|
|
|
1249
1361
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -43,7 +43,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
43
43
|
*/
|
|
44
44
|
getAllUserHoldings: (userId: string, userSecret: string, brokerageAuthorizations?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
45
|
/**
|
|
46
|
-
* 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).
|
|
46
|
+
* 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, the data is cached and refreshed once a day. 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, 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.
|
|
47
47
|
* @summary List account balances
|
|
48
48
|
* @param {string} userId
|
|
49
49
|
* @param {string} userSecret
|
|
@@ -53,7 +53,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
53
53
|
*/
|
|
54
54
|
getUserAccountBalance: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
55
|
/**
|
|
56
|
-
* Returns account detail known to SnapTrade for the specified account.
|
|
56
|
+
* 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, the data is cached and refreshed once a day. 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.
|
|
57
57
|
* @summary Get account detail
|
|
58
58
|
* @param {string} userId
|
|
59
59
|
* @param {string} userSecret
|
|
@@ -74,7 +74,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
74
74
|
*/
|
|
75
75
|
getUserAccountOrderDetail: (accountId: string, userId: string, userSecret: string, accountInformationGetUserAccountOrderDetailRequest: AccountInformationGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
76
|
/**
|
|
77
|
-
* Returns a list of recent orders in the specified account.
|
|
77
|
+
* 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, the data is cached and refreshed once a day. 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, 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.
|
|
78
78
|
* @summary List account orders
|
|
79
79
|
* @param {string} userId
|
|
80
80
|
* @param {string} userSecret
|
|
@@ -86,7 +86,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
86
86
|
*/
|
|
87
87
|
getUserAccountOrders: (userId: string, userSecret: string, accountId: string, state?: 'all' | 'open' | 'executed', days?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
88
88
|
/**
|
|
89
|
-
* 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).
|
|
89
|
+
* Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, the data is cached and refreshed once a day. 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, 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.
|
|
90
90
|
* @summary List account positions
|
|
91
91
|
* @param {string} userId
|
|
92
92
|
* @param {string} userSecret
|
|
@@ -117,7 +117,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
117
117
|
*/
|
|
118
118
|
getUserAccountReturnRates: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
119
119
|
/**
|
|
120
|
-
* Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
120
|
+
* Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ 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, the data is cached and refreshed once a day. 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, 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.
|
|
121
121
|
* @summary List account holdings
|
|
122
122
|
* @param {string} accountId
|
|
123
123
|
* @param {string} userId
|
|
@@ -127,7 +127,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
127
127
|
*/
|
|
128
128
|
getUserHoldings: (accountId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
129
129
|
/**
|
|
130
|
-
* Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
130
|
+
* Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. 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, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
131
131
|
* @summary List accounts
|
|
132
132
|
* @param {string} userId
|
|
133
133
|
* @param {string} userSecret
|
|
@@ -169,7 +169,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
169
169
|
*/
|
|
170
170
|
getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountHoldings>>>;
|
|
171
171
|
/**
|
|
172
|
-
* 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).
|
|
172
|
+
* 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, the data is cached and refreshed once a day. 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, 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.
|
|
173
173
|
* @summary List account balances
|
|
174
174
|
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
175
175
|
* @param {*} [options] Override http request option.
|
|
@@ -177,7 +177,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
177
177
|
*/
|
|
178
178
|
getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Balance>>>;
|
|
179
179
|
/**
|
|
180
|
-
* Returns account detail known to SnapTrade for the specified account.
|
|
180
|
+
* 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, the data is cached and refreshed once a day. 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.
|
|
181
181
|
* @summary Get account detail
|
|
182
182
|
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
@@ -193,7 +193,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
193
193
|
*/
|
|
194
194
|
getUserAccountOrderDetail(requestParameters: AccountInformationApiGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
195
195
|
/**
|
|
196
|
-
* Returns a list of recent orders in the specified account.
|
|
196
|
+
* 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, the data is cached and refreshed once a day. 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, 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.
|
|
197
197
|
* @summary List account orders
|
|
198
198
|
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
199
199
|
* @param {*} [options] Override http request option.
|
|
@@ -201,7 +201,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
201
201
|
*/
|
|
202
202
|
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountOrderRecord>>>;
|
|
203
203
|
/**
|
|
204
|
-
* 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).
|
|
204
|
+
* Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, the data is cached and refreshed once a day. 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, 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.
|
|
205
205
|
* @summary List account positions
|
|
206
206
|
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
207
207
|
* @param {*} [options] Override http request option.
|
|
@@ -225,7 +225,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
225
225
|
*/
|
|
226
226
|
getUserAccountReturnRates(requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RateOfReturnResponse>>;
|
|
227
227
|
/**
|
|
228
|
-
* Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
228
|
+
* Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ 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, the data is cached and refreshed once a day. 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, 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.
|
|
229
229
|
* @summary List account holdings
|
|
230
230
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
231
231
|
* @param {*} [options] Override http request option.
|
|
@@ -233,7 +233,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
233
233
|
*/
|
|
234
234
|
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountHoldingsAccount>>;
|
|
235
235
|
/**
|
|
236
|
-
* Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
236
|
+
* Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. 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, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
237
237
|
* @summary List accounts
|
|
238
238
|
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
239
239
|
* @param {*} [options] Override http request option.
|
|
@@ -272,7 +272,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
272
272
|
*/
|
|
273
273
|
getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountHoldings>>;
|
|
274
274
|
/**
|
|
275
|
-
* 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).
|
|
275
|
+
* 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, the data is cached and refreshed once a day. 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, 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.
|
|
276
276
|
* @summary List account balances
|
|
277
277
|
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
278
278
|
* @param {*} [options] Override http request option.
|
|
@@ -280,7 +280,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
280
280
|
*/
|
|
281
281
|
getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Balance>>;
|
|
282
282
|
/**
|
|
283
|
-
* Returns account detail known to SnapTrade for the specified account.
|
|
283
|
+
* 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, the data is cached and refreshed once a day. 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.
|
|
284
284
|
* @summary Get account detail
|
|
285
285
|
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
286
286
|
* @param {*} [options] Override http request option.
|
|
@@ -296,7 +296,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
296
296
|
*/
|
|
297
297
|
getUserAccountOrderDetail(requestParameters: AccountInformationApiGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
298
298
|
/**
|
|
299
|
-
* Returns a list of recent orders in the specified account.
|
|
299
|
+
* 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, the data is cached and refreshed once a day. 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, 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.
|
|
300
300
|
* @summary List account orders
|
|
301
301
|
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
302
302
|
* @param {*} [options] Override http request option.
|
|
@@ -304,7 +304,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
304
304
|
*/
|
|
305
305
|
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountOrderRecord>>;
|
|
306
306
|
/**
|
|
307
|
-
* 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).
|
|
307
|
+
* Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, the data is cached and refreshed once a day. 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, 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.
|
|
308
308
|
* @summary List account positions
|
|
309
309
|
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
310
310
|
* @param {*} [options] Override http request option.
|
|
@@ -328,7 +328,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
328
328
|
*/
|
|
329
329
|
getUserAccountReturnRates(requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest, options?: AxiosRequestConfig): AxiosPromise<RateOfReturnResponse>;
|
|
330
330
|
/**
|
|
331
|
-
* Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
331
|
+
* Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ 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, the data is cached and refreshed once a day. 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, 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.
|
|
332
332
|
* @summary List account holdings
|
|
333
333
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
334
334
|
* @param {*} [options] Override http request option.
|
|
@@ -336,7 +336,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
336
336
|
*/
|
|
337
337
|
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<AccountHoldingsAccount>;
|
|
338
338
|
/**
|
|
339
|
-
* Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
339
|
+
* Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. 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, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
340
340
|
* @summary List accounts
|
|
341
341
|
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
342
342
|
* @param {*} [options] Override http request option.
|
|
@@ -721,7 +721,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
721
721
|
*/
|
|
722
722
|
getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldings[], any>>;
|
|
723
723
|
/**
|
|
724
|
-
* 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).
|
|
724
|
+
* 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, the data is cached and refreshed once a day. 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, 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.
|
|
725
725
|
* @summary List account balances
|
|
726
726
|
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
727
727
|
* @param {*} [options] Override http request option.
|
|
@@ -730,7 +730,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
730
730
|
*/
|
|
731
731
|
getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Balance[], any>>;
|
|
732
732
|
/**
|
|
733
|
-
* Returns account detail known to SnapTrade for the specified account.
|
|
733
|
+
* 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, the data is cached and refreshed once a day. 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.
|
|
734
734
|
* @summary Get account detail
|
|
735
735
|
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
736
736
|
* @param {*} [options] Override http request option.
|
|
@@ -748,7 +748,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
748
748
|
*/
|
|
749
749
|
getUserAccountOrderDetail(requestParameters: AccountInformationApiGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
|
|
750
750
|
/**
|
|
751
|
-
* Returns a list of recent orders in the specified account.
|
|
751
|
+
* 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, the data is cached and refreshed once a day. 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, 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.
|
|
752
752
|
* @summary List account orders
|
|
753
753
|
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
754
754
|
* @param {*} [options] Override http request option.
|
|
@@ -757,7 +757,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
757
757
|
*/
|
|
758
758
|
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord[], any>>;
|
|
759
759
|
/**
|
|
760
|
-
* 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).
|
|
760
|
+
* Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, the data is cached and refreshed once a day. 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, 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.
|
|
761
761
|
* @summary List account positions
|
|
762
762
|
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
763
763
|
* @param {*} [options] Override http request option.
|
|
@@ -784,7 +784,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
784
784
|
*/
|
|
785
785
|
getUserAccountReturnRates(requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RateOfReturnResponse, any>>;
|
|
786
786
|
/**
|
|
787
|
-
* Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
787
|
+
* Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ 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, the data is cached and refreshed once a day. 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, 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.
|
|
788
788
|
* @summary List account holdings
|
|
789
789
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
790
790
|
* @param {*} [options] Override http request option.
|
|
@@ -793,7 +793,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
793
793
|
*/
|
|
794
794
|
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldingsAccount, any>>;
|
|
795
795
|
/**
|
|
796
|
-
* Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
796
|
+
* Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. 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, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
797
797
|
* @summary List accounts
|
|
798
798
|
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
799
799
|
* @param {*} [options] Override http request option.
|