snaptrade 2.0.198 → 2.0.200

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 549dce81d5aba7fd22eb51ae0c30a30bd265beaf349ae8e494d6f548e93d8dad
4
- data.tar.gz: a848545dc765563b8f295e6fe64a440949290ebc37217b820e9c0f4397a998f3
3
+ metadata.gz: d87185f08df515ab5566fef9cd67c702edd74fe28d9dfa92f16ed611cf872312
4
+ data.tar.gz: 07c1955dcf04be048d8be261d4dcbd4976c24b2ad72e5a765b6a23fab3bdbabc
5
5
  SHA512:
6
- metadata.gz: 5cf4015c11eff238a93863fe4cb99e9441693da9b9f5d1725f5014b168478fde0060e16bd66d997bfc5cbce3d875159b69b5a7026441e2e18d9bce411469672b
7
- data.tar.gz: 33af1227b4f7025da23afe774d5b6abee0792678c0e55322ce30bab5d47c8a927623c93d72e62c653d976cb13b088217577548fcadd31ef15356849e097b7af2
6
+ metadata.gz: 84840d2f8761592234b075108bc2fa580f8d5536e7c5c0ab62ac9973623e42992913ebf9a90d85b71f30a9f73ef36e292b59a475a75d9d1fd36884f01832d9ab
7
+ data.tar.gz: 7db1ca3e5f098b56c65e70cd625cfbe3a4e4e6fb91c20a1fcffdfc558fa9403aad126d43eb27700cf88b9e81ba02a94478ed9e8d9bb47556b7f337b2d0208291
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- snaptrade (2.0.198)
4
+ snaptrade (2.0.200)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart (~> 1.0, >= 1.0.4)
7
7
 
data/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
- [![npm](https://img.shields.io/badge/gem-v2.0.198-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.198)
9
+ [![npm](https://img.shields.io/badge/gem-v2.0.200-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.200)
10
10
  [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
11
11
 
12
12
  </div>
@@ -49,6 +49,12 @@ Connect brokerage accounts to your app for live positions and trading
49
49
  * [`snaptrade.connections.return_rates`](#snaptradeconnectionsreturn_rates)
50
50
  * [`snaptrade.connections.session_events`](#snaptradeconnectionssession_events)
51
51
  * [`snaptrade.connections.sync_brokerage_authorization_transactions`](#snaptradeconnectionssync_brokerage_authorization_transactions)
52
+ * [`snaptrade.experimental_endpoints.add_subscription`](#snaptradeexperimental_endpointsadd_subscription)
53
+ * [`snaptrade.experimental_endpoints.cancel_subscription`](#snaptradeexperimental_endpointscancel_subscription)
54
+ * [`snaptrade.experimental_endpoints.get_user_account_order_detail_v2`](#snaptradeexperimental_endpointsget_user_account_order_detail_v2)
55
+ * [`snaptrade.experimental_endpoints.get_user_account_orders_v2`](#snaptradeexperimental_endpointsget_user_account_orders_v2)
56
+ * [`snaptrade.experimental_endpoints.get_user_account_recent_orders_v2`](#snaptradeexperimental_endpointsget_user_account_recent_orders_v2)
57
+ * [`snaptrade.experimental_endpoints.list_subscriptions`](#snaptradeexperimental_endpointslist_subscriptions)
52
58
  * [`snaptrade.options.list_option_holdings`](#snaptradeoptionslist_option_holdings)
53
59
  * [`snaptrade.reference_data.get_currency_exchange_rate_pair`](#snaptradereference_dataget_currency_exchange_rate_pair)
54
60
  * [`snaptrade.reference_data.get_partner_info`](#snaptradereference_dataget_partner_info)
@@ -88,7 +94,7 @@ Connect brokerage accounts to your app for live positions and trading
88
94
  Add to Gemfile:
89
95
 
90
96
  ```ruby
91
- gem 'snaptrade', '~> 2.0.198'
97
+ gem 'snaptrade', '~> 2.0.200'
92
98
  ```
93
99
 
94
100
  ## Getting Started<a id="getting-started"></a>
@@ -507,10 +513,11 @@ Number of days in the past to fetch the most recent orders. Defaults to the last
507
513
 
508
514
 
509
515
  ### `snaptrade.account_information.get_user_account_positions`<a id="snaptradeaccount_informationget_user_account_positions"></a>
516
+ ![Deprecated](https://img.shields.io/badge/deprecated-yellow)
510
517
 
511
518
  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).
512
519
 
513
- 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.
520
+ This endpoint is deprecated. 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.
514
521
 
515
522
  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:
516
523
  - If you do, this endpoint returns real-time data.
@@ -1161,7 +1168,7 @@ Trigger a holdings update for all accounts under this connection. Updates will b
1161
1168
  This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
1162
1169
 
1163
1170
  **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)**
1164
- **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**
1171
+ **Please note this endpoint is disabled for Personal and Pay as you Go Real-time plans. Real-time plans do not benefit from this feature since data is refreshed when calls are made**
1165
1172
 
1166
1173
 
1167
1174
  #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1334,11 +1341,241 @@ p result
1334
1341
  ---
1335
1342
 
1336
1343
 
1344
+ ### `snaptrade.experimental_endpoints.add_subscription`<a id="snaptradeexperimental_endpointsadd_subscription"></a>
1345
+
1346
+ Adds or restores a Trade Detection subscription for a connected brokerage account.
1347
+ This endpoint requires `userId` and `userSecret` in addition to the partner signature.
1348
+
1349
+
1350
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1351
+
1352
+ ```ruby
1353
+ result = snaptrade.experimental_endpoints.add_subscription(
1354
+ account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1355
+ user_id: "snaptrade-user-123",
1356
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1357
+ )
1358
+ p result
1359
+ ```
1360
+
1361
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1362
+
1363
+ ##### account_id: `String`<a id="account_id-string"></a>
1364
+ Unique identifier for the connected brokerage account. This is the UUID used to
1365
+ reference the account in SnapTrade.
1366
+
1367
+ ##### user_id: `String`<a id="user_id-string"></a>
1368
+ ##### user_secret: `String`<a id="user_secret-string"></a>
1369
+ #### 🔄 Return<a id="🔄-return"></a>
1370
+
1371
+ [TradeDetectionSubscription](./lib/snaptrade/models/trade_detection_subscription.rb)
1372
+
1373
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1374
+
1375
+ `/snapTrade/tradeDetection/subscriptions` `POST`
1376
+
1377
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1378
+
1379
+ ---
1380
+
1381
+
1382
+ ### `snaptrade.experimental_endpoints.cancel_subscription`<a id="snaptradeexperimental_endpointscancel_subscription"></a>
1383
+
1384
+ Cancels a Trade Detection subscription for a connected brokerage account.
1385
+ This endpoint requires partner signature authentication only and does not require `userId` or `userSecret`.
1386
+
1387
+
1388
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1389
+
1390
+ ```ruby
1391
+ result = snaptrade.experimental_endpoints.cancel_subscription(
1392
+ account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1393
+ )
1394
+ p result
1395
+ ```
1396
+
1397
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1398
+
1399
+ ##### account_id: `String`<a id="account_id-string"></a>
1400
+ Unique identifier for the connected brokerage account. This is the UUID used to
1401
+ reference the account in SnapTrade.
1402
+
1403
+ #### 🔄 Return<a id="🔄-return"></a>
1404
+
1405
+ [TradeDetectionCancelSubscriptionResponse](./lib/snaptrade/models/trade_detection_cancel_subscription_response.rb)
1406
+
1407
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1408
+
1409
+ `/snapTrade/tradeDetection/subscriptions/cancel` `POST`
1410
+
1411
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1412
+
1413
+ ---
1414
+
1415
+
1416
+ ### `snaptrade.experimental_endpoints.get_user_account_order_detail_v2`<a id="snaptradeexperimental_endpointsget_user_account_order_detail_v2"></a>
1417
+
1418
+ Returns the detail of a single order using the brokerage order ID provided as a path parameter.
1419
+
1420
+ The V2 order response format includes all legs of the order in the `legs` list field.
1421
+ If the order is single legged, `legs` will be a list of one leg.
1422
+
1423
+ This endpoint is always realtime and does not rely on cached data.
1424
+
1425
+ This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
1426
+
1427
+
1428
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1429
+
1430
+ ```ruby
1431
+ result = snaptrade.experimental_endpoints.get_user_account_order_detail_v2(
1432
+ account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1433
+ brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
1434
+ user_id: "snaptrade-user-123",
1435
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1436
+ )
1437
+ p result
1438
+ ```
1439
+
1440
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1441
+
1442
+ ##### account_id: `String`<a id="account_id-string"></a>
1443
+ ##### brokerage_order_id: `String`<a id="brokerage_order_id-string"></a>
1444
+ ##### user_id: `String`<a id="user_id-string"></a>
1445
+ ##### user_secret: `String`<a id="user_secret-string"></a>
1446
+ #### 🔄 Return<a id="🔄-return"></a>
1447
+
1448
+ [AccountOrderRecordV2](./lib/snaptrade/models/account_order_record_v2.rb)
1449
+
1450
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1451
+
1452
+ `/accounts/{accountId}/orders/details/v2/{brokerageOrderId}` `GET`
1453
+
1454
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1455
+
1456
+ ---
1457
+
1458
+
1459
+ ### `snaptrade.experimental_endpoints.get_user_account_orders_v2`<a id="snaptradeexperimental_endpointsget_user_account_orders_v2"></a>
1460
+
1461
+ Returns a list of recent orders in the specified account.
1462
+
1463
+ 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.
1464
+
1465
+ 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.
1466
+
1467
+
1468
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1469
+
1470
+ ```ruby
1471
+ result = snaptrade.experimental_endpoints.get_user_account_orders_v2(
1472
+ user_id: "snaptrade-user-123",
1473
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1474
+ account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1475
+ state: "all",
1476
+ days: 30,
1477
+ )
1478
+ p result
1479
+ ```
1480
+
1481
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1482
+
1483
+ ##### user_id: `String`<a id="user_id-string"></a>
1484
+ ##### user_secret: `String`<a id="user_secret-string"></a>
1485
+ ##### account_id: `String`<a id="account_id-string"></a>
1486
+ ##### state: `String`<a id="state-string"></a>
1487
+ defaults to \"all\"
1488
+
1489
+ ##### days: `Integer`<a id="days-integer"></a>
1490
+ Number of days in the past to fetch the most recent orders. Defaults to the last
1491
+ 30 days if no value is passed in. Values greater than 90 will be capped at 90.
1492
+
1493
+ #### 🔄 Return<a id="🔄-return"></a>
1494
+
1495
+ [AccountOrdersV2Response](./lib/snaptrade/models/account_orders_v2_response.rb)
1496
+
1497
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1498
+
1499
+ `/accounts/{accountId}/orders/v2` `GET`
1500
+
1501
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1502
+
1503
+ ---
1504
+
1505
+
1506
+ ### `snaptrade.experimental_endpoints.get_user_account_recent_orders_v2`<a id="snaptradeexperimental_endpointsget_user_account_recent_orders_v2"></a>
1507
+
1508
+ A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format.
1509
+ 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.
1510
+ Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days.
1511
+ By default only returns executed orders, but that can be changed by setting *only_executed* to false.
1512
+ **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)**
1513
+
1514
+
1515
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1516
+
1517
+ ```ruby
1518
+ result = snaptrade.experimental_endpoints.get_user_account_recent_orders_v2(
1519
+ user_id: "snaptrade-user-123",
1520
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1521
+ account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1522
+ only_executed: true,
1523
+ )
1524
+ p result
1525
+ ```
1526
+
1527
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1528
+
1529
+ ##### user_id: `String`<a id="user_id-string"></a>
1530
+ ##### user_secret: `String`<a id="user_secret-string"></a>
1531
+ ##### account_id: `String`<a id="account_id-string"></a>
1532
+ ##### only_executed: `Boolean`<a id="only_executed-boolean"></a>
1533
+ Defaults to true. Indicates if request should fetch only executed orders. Set to
1534
+ false to retrieve non executed orders as well
1535
+
1536
+ #### 🔄 Return<a id="🔄-return"></a>
1537
+
1538
+ [AccountOrdersV2Response](./lib/snaptrade/models/account_orders_v2_response.rb)
1539
+
1540
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1541
+
1542
+ `/accounts/{accountId}/recentOrders/v2` `GET`
1543
+
1544
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1545
+
1546
+ ---
1547
+
1548
+
1549
+ ### `snaptrade.experimental_endpoints.list_subscriptions`<a id="snaptradeexperimental_endpointslist_subscriptions"></a>
1550
+
1551
+ Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
1552
+
1553
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1554
+
1555
+ ```ruby
1556
+ result = snaptrade.experimental_endpoints.list_subscriptions
1557
+ p result
1558
+ ```
1559
+
1560
+ #### 🔄 Return<a id="🔄-return"></a>
1561
+
1562
+ [TradeDetectionSubscription](./lib/snaptrade/models/trade_detection_subscription.rb)
1563
+
1564
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1565
+
1566
+ `/snapTrade/tradeDetection/subscriptions` `GET`
1567
+
1568
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1569
+
1570
+ ---
1571
+
1572
+
1337
1573
  ### `snaptrade.options.list_option_holdings`<a id="snaptradeoptionslist_option_holdings"></a>
1574
+ ![Deprecated](https://img.shields.io/badge/deprecated-yellow)
1338
1575
 
1339
1576
  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).
1340
1577
 
1341
- 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.
1578
+ This endpoint is deprecatd. 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.
1342
1579
 
1343
1580
  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:
1344
1581
  - If you do, this endpoint returns real-time data.
@@ -1020,7 +1020,7 @@ module SnapTrade
1020
1020
  #
1021
1021
  # 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).
1022
1022
  #
1023
- # 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.
1023
+ # This endpoint is deprecated. 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.
1024
1024
  #
1025
1025
  # 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:
1026
1026
  # - If you do, this endpoint returns real-time data.
@@ -1041,7 +1041,7 @@ module SnapTrade
1041
1041
  #
1042
1042
  # 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).
1043
1043
  #
1044
- # 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.
1044
+ # This endpoint is deprecated. 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.
1045
1045
  #
1046
1046
  # 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:
1047
1047
  # - If you do, this endpoint returns real-time data.
@@ -1058,7 +1058,7 @@ module SnapTrade
1058
1058
  end
1059
1059
 
1060
1060
  # List account positions
1061
- # 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.
1061
+ # 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). This endpoint is deprecated. 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.
1062
1062
  # @param user_id [String]
1063
1063
  # @param user_secret [String]
1064
1064
  # @param account_id [String]
@@ -1070,7 +1070,7 @@ module SnapTrade
1070
1070
  end
1071
1071
 
1072
1072
  # List account positions
1073
- # 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&#39;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.
1073
+ # 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). This endpoint is deprecated. 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&#39;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.
1074
1074
  # @param user_id [String]
1075
1075
  # @param user_secret [String]
1076
1076
  # @param account_id [String]
@@ -556,7 +556,7 @@ module SnapTrade
556
556
  # This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
557
557
  #
558
558
  # **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)**
559
- # **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**
559
+ # **Please note this endpoint is disabled for Personal and Pay as you Go Real-time plans. Real-time plans do not benefit from this feature since data is refreshed when calls are made**
560
560
  #
561
561
  # @param authorization_id [String]
562
562
  # @param user_id [String]
@@ -573,7 +573,7 @@ module SnapTrade
573
573
  # This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
574
574
  #
575
575
  # **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)**
576
- # **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**
576
+ # **Please note this endpoint is disabled for Personal and Pay as you Go Real-time plans. Real-time plans do not benefit from this feature since data is refreshed when calls are made**
577
577
  #
578
578
  # @param authorization_id [String]
579
579
  # @param user_id [String]
@@ -584,7 +584,7 @@ module SnapTrade
584
584
  end
585
585
 
586
586
  # Refresh holdings for a connection
587
- # 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. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **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)** **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**
587
+ # 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. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **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)** **Please note this endpoint is disabled for Personal and Pay as you Go Real-time plans. Real-time plans do not benefit from this feature since data is refreshed when calls are made**
588
588
  # @param authorization_id [String]
589
589
  # @param user_id [String]
590
590
  # @param user_secret [String]
@@ -596,7 +596,7 @@ module SnapTrade
596
596
  end
597
597
 
598
598
  # Refresh holdings for a connection
599
- # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [&#x60;ACCOUNT_HOLDINGS_UPDATED&#x60; webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **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)** **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**
599
+ # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [&#x60;ACCOUNT_HOLDINGS_UPDATED&#x60; webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **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)** **Please note this endpoint is disabled for Personal and Pay as you Go Real-time plans. Real-time plans do not benefit from this feature since data is refreshed when calls are made**
600
600
  # @param authorization_id [String]
601
601
  # @param user_id [String]
602
602
  # @param user_secret [String]