snaptrade-typescript-sdk 11.0.4 → 11.1.0
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 +43 -1
- package/dist/browser.umd.js +1 -1
- package/dist/index.cjs +117 -1
- package/dist/index.d.cts +216 -1
- package/dist/index.d.mts +216 -1
- package/dist/index.d.ts +216 -1
- package/dist/index.mjs +117 -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/11.1.0)
|
|
10
10
|
[](https://snaptrade.com/)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
@@ -53,6 +53,7 @@ Connect brokerage accounts to your app for live positions and trading
|
|
|
53
53
|
* [`snaptrade.experimentalEndpoints.getUserAccountOrderDetailV2`](#snaptradeexperimentalendpointsgetuseraccountorderdetailv2)
|
|
54
54
|
* [`snaptrade.experimentalEndpoints.getUserAccountOrdersV2`](#snaptradeexperimentalendpointsgetuseraccountordersv2)
|
|
55
55
|
* [`snaptrade.experimentalEndpoints.getUserAccountRecentOrdersV2`](#snaptradeexperimentalendpointsgetuseraccountrecentordersv2)
|
|
56
|
+
* [`snaptrade.experimentalEndpoints.listConnectionAccounts`](#snaptradeexperimentalendpointslistconnectionaccounts)
|
|
56
57
|
* [`snaptrade.experimentalEndpoints.listSubscriptions`](#snaptradeexperimentalendpointslistsubscriptions)
|
|
57
58
|
* [`snaptrade.options.listOptionHoldings`](#snaptradeoptionslistoptionholdings)
|
|
58
59
|
* [`snaptrade.referenceData.getCurrencyExchangeRatePair`](#snaptradereferencedatagetcurrencyexchangeratepair)
|
|
@@ -1499,6 +1500,47 @@ Defaults to true. Indicates if request should fetch only executed orders. Set to
|
|
|
1499
1500
|
---
|
|
1500
1501
|
|
|
1501
1502
|
|
|
1503
|
+
### `snaptrade.experimentalEndpoints.listConnectionAccounts`<a id="snaptradeexperimentalendpointslistconnectionaccounts"></a>
|
|
1504
|
+
|
|
1505
|
+
Experimental and subject to change without notice.
|
|
1506
|
+
|
|
1507
|
+
Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape.
|
|
1508
|
+
|
|
1509
|
+
Each item in the response carries a `kind` field (currently only `investment` is implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema.
|
|
1510
|
+
|
|
1511
|
+
On Pay as you Go / Real-time, this endpoint refreshes each account's opening date, funding date, and market value live from the brokerage on each call.
|
|
1512
|
+
|
|
1513
|
+
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).
|
|
1514
|
+
|
|
1515
|
+
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.
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
1519
|
+
|
|
1520
|
+
```typescript
|
|
1521
|
+
const listConnectionAccountsResponse =
|
|
1522
|
+
await snaptrade.experimentalEndpoints.listConnectionAccounts({
|
|
1523
|
+
authorizationId: "87b24961-b51e-4db8-9226-f198f6518a89",
|
|
1524
|
+
});
|
|
1525
|
+
```
|
|
1526
|
+
|
|
1527
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
1528
|
+
|
|
1529
|
+
##### authorizationId: `string`<a id="authorizationid-string"></a>
|
|
1530
|
+
|
|
1531
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
|
1532
|
+
|
|
1533
|
+
[ConnectionAccount](./models/connection-account.ts)
|
|
1534
|
+
|
|
1535
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
1536
|
+
|
|
1537
|
+
`/connections/{authorizationId}/accounts` `GET`
|
|
1538
|
+
|
|
1539
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
1540
|
+
|
|
1541
|
+
---
|
|
1542
|
+
|
|
1543
|
+
|
|
1502
1544
|
### `snaptrade.experimentalEndpoints.listSubscriptions`<a id="snaptradeexperimentalendpointslistsubscriptions"></a>
|
|
1503
1545
|
|
|
1504
1546
|
Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
|