snaptrade 2.0.125 → 2.0.127
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 +4 -4
- data/Gemfile.lock +2 -2
- data/README.md +16 -5
- data/lib/snaptrade/api/account_information_api.rb +12 -4
- data/lib/snaptrade/api/connections_api.rb +4 -4
- data/lib/snaptrade/api/trading_api.rb +16 -4
- data/lib/snaptrade/version.rb +1 -1
- data/spec/api/account_information_api_spec.rb +1 -1
- data/spec/api/connections_api_spec.rb +1 -1
- data/spec/api/trading_api_spec.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f76bd21456b85ad4893f2ac6ee26379500e230cd8cf14389daf785b684c7648a
|
|
4
|
+
data.tar.gz: 271b4ef9ad2f6c0857653d9377402e20984c9f5cc593a9f3d9e189b5b475feaa
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 97793f804b00d4f34f9cb6678a8f8543a75da9d40bff5db57f84f21c498d12cf02c399052e40b2a31949d25a40ede9edba30aa8b5a7acf697ada34f7a0743867
|
|
7
|
+
data.tar.gz: a1b77ba592b1e45528054b8ef217c62f1b5f18a32eba99921e7f65a17bb194ba515b62b1cd95078cb46042f7844d08e869cbb4dbd834c83e2ffb03008dc4f13c
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
snaptrade (2.0.
|
|
4
|
+
snaptrade (2.0.127)
|
|
5
5
|
faraday (>= 1.0.1, < 3.0)
|
|
6
6
|
faraday-multipart (~> 1.0, >= 1.0.4)
|
|
7
7
|
|
|
@@ -45,7 +45,7 @@ GEM
|
|
|
45
45
|
regexp_parser (2.11.2)
|
|
46
46
|
reline (0.6.2)
|
|
47
47
|
io-console (~> 0.5)
|
|
48
|
-
rexml (3.4.
|
|
48
|
+
rexml (3.4.2)
|
|
49
49
|
rspec (3.13.1)
|
|
50
50
|
rspec-core (~> 3.13.0)
|
|
51
51
|
rspec-expectations (~> 3.13.0)
|
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
|
-
[](https://rubygems.org/gems/snaptrade/versions/2.0.127)
|
|
10
10
|
[](https://snaptrade.com/)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
@@ -81,7 +81,7 @@ Connect brokerage accounts to your app for live positions and trading
|
|
|
81
81
|
Add to Gemfile:
|
|
82
82
|
|
|
83
83
|
```ruby
|
|
84
|
-
gem 'snaptrade', '~> 2.0.
|
|
84
|
+
gem 'snaptrade', '~> 2.0.127'
|
|
85
85
|
```
|
|
86
86
|
|
|
87
87
|
## Getting Started<a id="getting-started"></a>
|
|
@@ -320,7 +320,11 @@ p result
|
|
|
320
320
|
|
|
321
321
|
### `snaptrade.account_information.get_user_account_order_detail`<a id="snaptradeaccount_informationget_user_account_order_detail"></a>
|
|
322
322
|
|
|
323
|
-
Returns the detail of a single order in the specified account.
|
|
323
|
+
Returns the detail of a single order in the specified account.
|
|
324
|
+
|
|
325
|
+
This endpoint is always realtime and does not rely on cached data.
|
|
326
|
+
|
|
327
|
+
This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
324
328
|
|
|
325
329
|
|
|
326
330
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -949,7 +953,7 @@ p result
|
|
|
949
953
|
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.
|
|
950
954
|
This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
|
|
951
955
|
|
|
952
|
-
**
|
|
956
|
+
**Because of the cost of refreshing a connection, each call to this endpoint incurs a additional charge based on your [Pricing Plan](https://snaptrade.com/pricing)**
|
|
953
957
|
|
|
954
958
|
|
|
955
959
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -1689,7 +1693,14 @@ The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
|
|
|
1689
1693
|
|
|
1690
1694
|
### `snaptrade.trading.get_user_account_quotes`<a id="snaptradetradingget_user_account_quotes"></a>
|
|
1691
1695
|
|
|
1692
|
-
Returns quotes from the brokerage for the specified symbols and account.
|
|
1696
|
+
Returns quotes from the brokerage for the specified symbols and account.
|
|
1697
|
+
|
|
1698
|
+
The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.
|
|
1699
|
+
|
|
1700
|
+
This endpoint does not work for options quotes.
|
|
1701
|
+
|
|
1702
|
+
This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
1703
|
+
|
|
1693
1704
|
|
|
1694
1705
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
1695
1706
|
|
|
@@ -499,7 +499,11 @@ module SnapTrade
|
|
|
499
499
|
|
|
500
500
|
# Get account order detail
|
|
501
501
|
#
|
|
502
|
-
# Returns the detail of a single order in the specified account.
|
|
502
|
+
# Returns the detail of a single order in the specified account.
|
|
503
|
+
#
|
|
504
|
+
# This endpoint is always realtime and does not rely on cached data.
|
|
505
|
+
#
|
|
506
|
+
# This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
503
507
|
#
|
|
504
508
|
# @param user_id [String]
|
|
505
509
|
# @param user_secret [String]
|
|
@@ -513,7 +517,11 @@ module SnapTrade
|
|
|
513
517
|
|
|
514
518
|
# Get account order detail
|
|
515
519
|
#
|
|
516
|
-
# Returns the detail of a single order in the specified account.
|
|
520
|
+
# Returns the detail of a single order in the specified account.
|
|
521
|
+
#
|
|
522
|
+
# This endpoint is always realtime and does not rely on cached data.
|
|
523
|
+
#
|
|
524
|
+
# This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
517
525
|
#
|
|
518
526
|
# @param user_id [String]
|
|
519
527
|
# @param user_secret [String]
|
|
@@ -525,7 +533,7 @@ module SnapTrade
|
|
|
525
533
|
end
|
|
526
534
|
|
|
527
535
|
# Get account order detail
|
|
528
|
-
# Returns the detail of a single order in the specified account.
|
|
536
|
+
# Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
529
537
|
# @param user_id [String]
|
|
530
538
|
# @param user_secret [String]
|
|
531
539
|
# @param account_id [String]
|
|
@@ -538,7 +546,7 @@ module SnapTrade
|
|
|
538
546
|
end
|
|
539
547
|
|
|
540
548
|
# Get account order detail
|
|
541
|
-
# Returns the detail of a single order in the specified account.
|
|
549
|
+
# Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
542
550
|
# @param user_id [String]
|
|
543
551
|
# @param user_secret [String]
|
|
544
552
|
# @param account_id [String]
|
|
@@ -337,7 +337,7 @@ module SnapTrade
|
|
|
337
337
|
# 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.
|
|
338
338
|
# This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
|
|
339
339
|
#
|
|
340
|
-
# **
|
|
340
|
+
# **Because of the cost of refreshing a connection, each call to this endpoint incurs a additional charge based on your [Pricing Plan](https://snaptrade.com/pricing)**
|
|
341
341
|
#
|
|
342
342
|
# @param authorization_id [String]
|
|
343
343
|
# @param user_id [String]
|
|
@@ -353,7 +353,7 @@ module SnapTrade
|
|
|
353
353
|
# 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.
|
|
354
354
|
# This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
|
|
355
355
|
#
|
|
356
|
-
# **
|
|
356
|
+
# **Because of the cost of refreshing a connection, each call to this endpoint incurs a additional charge based on your [Pricing Plan](https://snaptrade.com/pricing)**
|
|
357
357
|
#
|
|
358
358
|
# @param authorization_id [String]
|
|
359
359
|
# @param user_id [String]
|
|
@@ -364,7 +364,7 @@ module SnapTrade
|
|
|
364
364
|
end
|
|
365
365
|
|
|
366
366
|
# Refresh holdings for a connection
|
|
367
|
-
# 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. **
|
|
367
|
+
# 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 a additional charge based on your [Pricing Plan](https://snaptrade.com/pricing)**
|
|
368
368
|
# @param authorization_id [String]
|
|
369
369
|
# @param user_id [String]
|
|
370
370
|
# @param user_secret [String]
|
|
@@ -376,7 +376,7 @@ module SnapTrade
|
|
|
376
376
|
end
|
|
377
377
|
|
|
378
378
|
# Refresh holdings for a connection
|
|
379
|
-
# 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. **
|
|
379
|
+
# 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 a additional charge based on your [Pricing Plan](https://snaptrade.com/pricing)**
|
|
380
380
|
# @param authorization_id [String]
|
|
381
381
|
# @param user_id [String]
|
|
382
382
|
# @param user_secret [String]
|
|
@@ -528,7 +528,13 @@ module SnapTrade
|
|
|
528
528
|
|
|
529
529
|
# Get equity symbol quotes
|
|
530
530
|
#
|
|
531
|
-
# Returns quotes from the brokerage for the specified symbols and account.
|
|
531
|
+
# Returns quotes from the brokerage for the specified symbols and account.
|
|
532
|
+
#
|
|
533
|
+
# The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.
|
|
534
|
+
#
|
|
535
|
+
# This endpoint does not work for options quotes.
|
|
536
|
+
#
|
|
537
|
+
# This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
532
538
|
#
|
|
533
539
|
# @param user_id [String]
|
|
534
540
|
# @param user_secret [String]
|
|
@@ -544,7 +550,13 @@ module SnapTrade
|
|
|
544
550
|
|
|
545
551
|
# Get equity symbol quotes
|
|
546
552
|
#
|
|
547
|
-
# Returns quotes from the brokerage for the specified symbols and account.
|
|
553
|
+
# Returns quotes from the brokerage for the specified symbols and account.
|
|
554
|
+
#
|
|
555
|
+
# The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.
|
|
556
|
+
#
|
|
557
|
+
# This endpoint does not work for options quotes.
|
|
558
|
+
#
|
|
559
|
+
# This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
548
560
|
#
|
|
549
561
|
# @param user_id [String]
|
|
550
562
|
# @param user_secret [String]
|
|
@@ -558,7 +570,7 @@ module SnapTrade
|
|
|
558
570
|
end
|
|
559
571
|
|
|
560
572
|
# Get equity symbol quotes
|
|
561
|
-
# Returns quotes from the brokerage for the specified symbols and account.
|
|
573
|
+
# Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
562
574
|
# @param user_id [String]
|
|
563
575
|
# @param user_secret [String]
|
|
564
576
|
# @param symbols [String] List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
|
|
@@ -572,7 +584,7 @@ module SnapTrade
|
|
|
572
584
|
end
|
|
573
585
|
|
|
574
586
|
# Get equity symbol quotes
|
|
575
|
-
# Returns quotes from the brokerage for the specified symbols and account.
|
|
587
|
+
# Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
576
588
|
# @param user_id [String]
|
|
577
589
|
# @param user_secret [String]
|
|
578
590
|
# @param symbols [String] List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
|
data/lib/snaptrade/version.rb
CHANGED
|
@@ -90,7 +90,7 @@ describe 'AccountInformationApi' do
|
|
|
90
90
|
|
|
91
91
|
# unit tests for get_user_account_order_detail
|
|
92
92
|
# Get account order detail
|
|
93
|
-
# Returns the detail of a single order in the specified account.
|
|
93
|
+
# Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
94
94
|
# @param user_id
|
|
95
95
|
# @param user_secret
|
|
96
96
|
# @param account_id
|
|
@@ -70,7 +70,7 @@ describe 'ConnectionsApi' do
|
|
|
70
70
|
|
|
71
71
|
# unit tests for refresh_brokerage_authorization
|
|
72
72
|
# Refresh holdings for a connection
|
|
73
|
-
# 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. **
|
|
73
|
+
# 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 a additional charge based on your [Pricing Plan](https://snaptrade.com/pricing)**
|
|
74
74
|
# @param authorization_id
|
|
75
75
|
# @param user_id
|
|
76
76
|
# @param user_secret
|
|
@@ -88,7 +88,7 @@ describe 'TradingApi' do
|
|
|
88
88
|
|
|
89
89
|
# unit tests for get_user_account_quotes
|
|
90
90
|
# Get equity symbol quotes
|
|
91
|
-
# Returns quotes from the brokerage for the specified symbols and account.
|
|
91
|
+
# Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
92
92
|
# @param user_id
|
|
93
93
|
# @param user_secret
|
|
94
94
|
# @param symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: snaptrade
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 2.0.
|
|
4
|
+
version: 2.0.127
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- SnapTrade
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2025-08-
|
|
11
|
+
date: 2025-08-27 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: faraday
|