snaptrade 2.0.111 → 2.0.112
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 +1 -1
- data/README.md +41 -41
- data/lib/snaptrade/api/trading_api.rb +117 -0
- data/lib/snaptrade/version.rb +1 -1
- data/lib/snaptrade.rb +0 -3
- data/spec/api/trading_api_spec.rb +16 -0
- metadata +2 -5
- data/lib/snaptrade/api/crypto_trading_api.rb +0 -139
- data/spec/api/crypto_trading_api_spec.rb +0 -46
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a9d344bc943e21cf6568c3d00cb1b267814f284257e1baf66def17e867cd4338
|
4
|
+
data.tar.gz: d9dd8dcf84b00126fb94f4f01b95a079583018d2dda253d1b48fe37eb81098db
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '03056587dc032d0c7aacdebaa3da12e95349844f51a9038ab9dc9d4b4101ef907a8ea627cf8f6078253b34f7168ae40f41c3a7acb793590917803dc63f479baa'
|
7
|
+
data.tar.gz: c173d304f2f565ef74b2ceaf77d19d66e8ef55063cfbef3ca46cbd1c42812fc4da2b0c250b2f9b2d0fb99de92cf64d4ab32e8074344a66cc95fa716f22d66e53
|
data/Gemfile.lock
CHANGED
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.112)
|
10
10
|
[](https://snaptrade.com/)
|
11
11
|
|
12
12
|
</div>
|
@@ -43,7 +43,6 @@ Connect brokerage accounts to your app for live positions and trading
|
|
43
43
|
* [`snaptrade.connections.remove_brokerage_authorization`](#snaptradeconnectionsremove_brokerage_authorization)
|
44
44
|
* [`snaptrade.connections.return_rates`](#snaptradeconnectionsreturn_rates)
|
45
45
|
* [`snaptrade.connections.session_events`](#snaptradeconnectionssession_events)
|
46
|
-
* [`snaptrade.crypto_trading.search_cryptocurrency_pair_instruments`](#snaptradecrypto_tradingsearch_cryptocurrency_pair_instruments)
|
47
46
|
* [`snaptrade.options.get_option_strategy`](#snaptradeoptionsget_option_strategy)
|
48
47
|
* [`snaptrade.options.get_options_chain`](#snaptradeoptionsget_options_chain)
|
49
48
|
* [`snaptrade.options.get_options_strategy_quote`](#snaptradeoptionsget_options_strategy_quote)
|
@@ -72,6 +71,7 @@ Connect brokerage accounts to your app for live positions and trading
|
|
72
71
|
* [`snaptrade.trading.place_simple_order`](#snaptradetradingplace_simple_order)
|
73
72
|
* [`snaptrade.trading.preview_simple_order`](#snaptradetradingpreview_simple_order)
|
74
73
|
* [`snaptrade.trading.replace_order`](#snaptradetradingreplace_order)
|
74
|
+
* [`snaptrade.trading.search_cryptocurrency_pair_instruments`](#snaptradetradingsearch_cryptocurrency_pair_instruments)
|
75
75
|
* [`snaptrade.transactions_and_reporting.get_activities`](#snaptradetransactions_and_reportingget_activities)
|
76
76
|
* [`snaptrade.transactions_and_reporting.get_reporting_custom_range`](#snaptradetransactions_and_reportingget_reporting_custom_range)
|
77
77
|
|
@@ -82,7 +82,7 @@ Connect brokerage accounts to your app for live positions and trading
|
|
82
82
|
Add to Gemfile:
|
83
83
|
|
84
84
|
```ruby
|
85
|
-
gem 'snaptrade', '~> 2.0.
|
85
|
+
gem 'snaptrade', '~> 2.0.112'
|
86
86
|
```
|
87
87
|
|
88
88
|
## Getting Started<a id="getting-started"></a>
|
@@ -1047,44 +1047,6 @@ specific users
|
|
1047
1047
|
---
|
1048
1048
|
|
1049
1049
|
|
1050
|
-
### `snaptrade.crypto_trading.search_cryptocurrency_pair_instruments`<a id="snaptradecrypto_tradingsearch_cryptocurrency_pair_instruments"></a>
|
1051
|
-
|
1052
|
-
Searches cryptocurrency pairs instruments accessible to the specified account.
|
1053
|
-
|
1054
|
-
|
1055
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1056
|
-
|
1057
|
-
```ruby
|
1058
|
-
result = snaptrade.crypto_trading.search_cryptocurrency_pair_instruments(
|
1059
|
-
user_id: "snaptrade-user-123",
|
1060
|
-
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
1061
|
-
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
1062
|
-
base: "BTC",
|
1063
|
-
quote: "USD",
|
1064
|
-
)
|
1065
|
-
p result
|
1066
|
-
```
|
1067
|
-
|
1068
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1069
|
-
|
1070
|
-
##### user_id: `String`<a id="user_id-string"></a>
|
1071
|
-
##### user_secret: `String`<a id="user_secret-string"></a>
|
1072
|
-
##### account_id: `String`<a id="account_id-string"></a>
|
1073
|
-
##### base: `String`<a id="base-string"></a>
|
1074
|
-
##### quote: `String`<a id="quote-string"></a>
|
1075
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
1076
|
-
|
1077
|
-
[TradingSearchCryptocurrencyPairInstruments200Response](./lib/snaptrade/models/trading_search_cryptocurrency_pair_instruments200_response.rb)
|
1078
|
-
|
1079
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1080
|
-
|
1081
|
-
`/accounts/{accountId}/trading/instruments/cryptocurrencyPairs` `GET`
|
1082
|
-
|
1083
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1084
|
-
|
1085
|
-
---
|
1086
|
-
|
1087
|
-
|
1088
1050
|
### `snaptrade.options.get_option_strategy`<a id="snaptradeoptionsget_option_strategy"></a>
|
1089
1051
|
|
1090
1052
|
Creates an option strategy object that will be used to place an option strategy order.
|
@@ -2390,6 +2352,44 @@ The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
|
|
2390
2352
|
---
|
2391
2353
|
|
2392
2354
|
|
2355
|
+
### `snaptrade.trading.search_cryptocurrency_pair_instruments`<a id="snaptradetradingsearch_cryptocurrency_pair_instruments"></a>
|
2356
|
+
|
2357
|
+
Searches cryptocurrency pairs instruments accessible to the specified account.
|
2358
|
+
|
2359
|
+
|
2360
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
2361
|
+
|
2362
|
+
```ruby
|
2363
|
+
result = snaptrade.trading.search_cryptocurrency_pair_instruments(
|
2364
|
+
user_id: "snaptrade-user-123",
|
2365
|
+
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
2366
|
+
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
2367
|
+
base: "BTC",
|
2368
|
+
quote: "USD",
|
2369
|
+
)
|
2370
|
+
p result
|
2371
|
+
```
|
2372
|
+
|
2373
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
2374
|
+
|
2375
|
+
##### user_id: `String`<a id="user_id-string"></a>
|
2376
|
+
##### user_secret: `String`<a id="user_secret-string"></a>
|
2377
|
+
##### account_id: `String`<a id="account_id-string"></a>
|
2378
|
+
##### base: `String`<a id="base-string"></a>
|
2379
|
+
##### quote: `String`<a id="quote-string"></a>
|
2380
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
2381
|
+
|
2382
|
+
[TradingSearchCryptocurrencyPairInstruments200Response](./lib/snaptrade/models/trading_search_cryptocurrency_pair_instruments200_response.rb)
|
2383
|
+
|
2384
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
2385
|
+
|
2386
|
+
`/accounts/{accountId}/trading/instruments/cryptocurrencyPairs` `GET`
|
2387
|
+
|
2388
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
2389
|
+
|
2390
|
+
---
|
2391
|
+
|
2392
|
+
|
2393
2393
|
### `snaptrade.transactions_and_reporting.get_activities`<a id="snaptradetransactions_and_reportingget_activities"></a>
|
2394
2394
|

|
2395
2395
|
|
@@ -1692,6 +1692,123 @@ module SnapTrade
|
|
1692
1692
|
end
|
1693
1693
|
return data, status_code, headers, response
|
1694
1694
|
end
|
1695
|
+
|
1696
|
+
|
1697
|
+
# Search cryptocurrency pairs instruments
|
1698
|
+
#
|
1699
|
+
# Searches cryptocurrency pairs instruments accessible to the specified account.
|
1700
|
+
#
|
1701
|
+
# @param user_id [String]
|
1702
|
+
# @param user_secret [String]
|
1703
|
+
# @param account_id [String]
|
1704
|
+
# @param base [String]
|
1705
|
+
# @param quote [String]
|
1706
|
+
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
1707
|
+
def search_cryptocurrency_pair_instruments(user_id:, user_secret:, account_id:, base: SENTINEL, quote: SENTINEL, extra: {})
|
1708
|
+
extra[:base] = base if base != SENTINEL
|
1709
|
+
extra[:quote] = quote if quote != SENTINEL
|
1710
|
+
data, _status_code, _headers = search_cryptocurrency_pair_instruments_with_http_info_impl(user_id, user_secret, account_id, extra)
|
1711
|
+
data
|
1712
|
+
end
|
1713
|
+
|
1714
|
+
# Search cryptocurrency pairs instruments
|
1715
|
+
#
|
1716
|
+
# Searches cryptocurrency pairs instruments accessible to the specified account.
|
1717
|
+
#
|
1718
|
+
# @param user_id [String]
|
1719
|
+
# @param user_secret [String]
|
1720
|
+
# @param account_id [String]
|
1721
|
+
# @param base [String]
|
1722
|
+
# @param quote [String]
|
1723
|
+
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
1724
|
+
def search_cryptocurrency_pair_instruments_with_http_info(user_id:, user_secret:, account_id:, base: SENTINEL, quote: SENTINEL, extra: {})
|
1725
|
+
extra[:base] = base if base != SENTINEL
|
1726
|
+
extra[:quote] = quote if quote != SENTINEL
|
1727
|
+
search_cryptocurrency_pair_instruments_with_http_info_impl(user_id, user_secret, account_id, extra)
|
1728
|
+
end
|
1729
|
+
|
1730
|
+
# Search cryptocurrency pairs instruments
|
1731
|
+
# Searches cryptocurrency pairs instruments accessible to the specified account.
|
1732
|
+
# @param user_id [String]
|
1733
|
+
# @param user_secret [String]
|
1734
|
+
# @param account_id [String]
|
1735
|
+
# @param [Hash] opts the optional parameters
|
1736
|
+
# @option opts [String] :base
|
1737
|
+
# @option opts [String] :quote
|
1738
|
+
# @return [TradingSearchCryptocurrencyPairInstruments200Response]
|
1739
|
+
private def search_cryptocurrency_pair_instruments_impl(user_id, user_secret, account_id, opts = {})
|
1740
|
+
data, _status_code, _headers = search_cryptocurrency_pair_instruments_with_http_info(user_id, user_secret, account_id, opts)
|
1741
|
+
data
|
1742
|
+
end
|
1743
|
+
|
1744
|
+
# Search cryptocurrency pairs instruments
|
1745
|
+
# Searches cryptocurrency pairs instruments accessible to the specified account.
|
1746
|
+
# @param user_id [String]
|
1747
|
+
# @param user_secret [String]
|
1748
|
+
# @param account_id [String]
|
1749
|
+
# @param [Hash] opts the optional parameters
|
1750
|
+
# @option opts [String] :base
|
1751
|
+
# @option opts [String] :quote
|
1752
|
+
# @return [Array<(TradingSearchCryptocurrencyPairInstruments200Response, Integer, Hash)>] TradingSearchCryptocurrencyPairInstruments200Response data, response status code and response headers
|
1753
|
+
private def search_cryptocurrency_pair_instruments_with_http_info_impl(user_id, user_secret, account_id, opts = {})
|
1754
|
+
if @api_client.config.debugging
|
1755
|
+
@api_client.config.logger.debug 'Calling API: TradingApi.search_cryptocurrency_pair_instruments ...'
|
1756
|
+
end
|
1757
|
+
# verify the required parameter 'user_id' is set
|
1758
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
1759
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling TradingApi.search_cryptocurrency_pair_instruments"
|
1760
|
+
end
|
1761
|
+
# verify the required parameter 'user_secret' is set
|
1762
|
+
if @api_client.config.client_side_validation && user_secret.nil?
|
1763
|
+
fail ArgumentError, "Missing the required parameter 'user_secret' when calling TradingApi.search_cryptocurrency_pair_instruments"
|
1764
|
+
end
|
1765
|
+
# verify the required parameter 'account_id' is set
|
1766
|
+
if @api_client.config.client_side_validation && account_id.nil?
|
1767
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TradingApi.search_cryptocurrency_pair_instruments"
|
1768
|
+
end
|
1769
|
+
# resource path
|
1770
|
+
local_var_path = '/accounts/{accountId}/trading/instruments/cryptocurrencyPairs'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
|
1771
|
+
|
1772
|
+
# query parameters
|
1773
|
+
query_params = opts[:query_params] || {}
|
1774
|
+
query_params[:'userId'] = user_id
|
1775
|
+
query_params[:'userSecret'] = user_secret
|
1776
|
+
query_params[:'base'] = opts[:'base'] if !opts[:'base'].nil?
|
1777
|
+
query_params[:'quote'] = opts[:'quote'] if !opts[:'quote'].nil?
|
1778
|
+
|
1779
|
+
# header parameters
|
1780
|
+
header_params = opts[:header_params] || {}
|
1781
|
+
# HTTP header 'Accept' (if needed)
|
1782
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1783
|
+
|
1784
|
+
# form parameters
|
1785
|
+
form_params = opts[:form_params] || {}
|
1786
|
+
|
1787
|
+
# http body (model)
|
1788
|
+
post_body = opts[:debug_body]
|
1789
|
+
|
1790
|
+
# return_type
|
1791
|
+
return_type = opts[:debug_return_type] || 'TradingSearchCryptocurrencyPairInstruments200Response'
|
1792
|
+
|
1793
|
+
# auth_names
|
1794
|
+
auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
|
1795
|
+
|
1796
|
+
new_options = opts.merge(
|
1797
|
+
:operation => :"TradingApi.search_cryptocurrency_pair_instruments",
|
1798
|
+
:header_params => header_params,
|
1799
|
+
:query_params => query_params,
|
1800
|
+
:form_params => form_params,
|
1801
|
+
:body => post_body,
|
1802
|
+
:auth_names => auth_names,
|
1803
|
+
:return_type => return_type
|
1804
|
+
)
|
1805
|
+
|
1806
|
+
data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
|
1807
|
+
if @api_client.config.debugging
|
1808
|
+
@api_client.config.logger.debug "API called: TradingApi#search_cryptocurrency_pair_instruments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1809
|
+
end
|
1810
|
+
return data, status_code, headers, response
|
1811
|
+
end
|
1695
1812
|
end
|
1696
1813
|
|
1697
1814
|
# top-level client access to avoid having the user to insantiate their own API instances
|
data/lib/snaptrade/version.rb
CHANGED
data/lib/snaptrade.rb
CHANGED
@@ -169,7 +169,6 @@ require 'snaptrade/api/account_information_api'
|
|
169
169
|
require 'snaptrade/api/api_status_api'
|
170
170
|
require 'snaptrade/api/authentication_api'
|
171
171
|
require 'snaptrade/api/connections_api'
|
172
|
-
require 'snaptrade/api/crypto_trading_api'
|
173
172
|
require 'snaptrade/api/options_api'
|
174
173
|
require 'snaptrade/api/reference_data_api'
|
175
174
|
require 'snaptrade/api/trading_api'
|
@@ -243,7 +242,6 @@ module SnapTrade
|
|
243
242
|
attr_reader :api_status
|
244
243
|
attr_reader :authentication
|
245
244
|
attr_reader :connections
|
246
|
-
attr_reader :crypto_trading
|
247
245
|
attr_reader :options
|
248
246
|
attr_reader :reference_data
|
249
247
|
attr_reader :trading
|
@@ -255,7 +253,6 @@ module SnapTrade
|
|
255
253
|
@api_status = SnapTrade::APIStatusApi.new(@api_client)
|
256
254
|
@authentication = SnapTrade::AuthenticationApi.new(@api_client)
|
257
255
|
@connections = SnapTrade::ConnectionsApi.new(@api_client)
|
258
|
-
@crypto_trading = SnapTrade::CryptoTradingApi.new(@api_client)
|
259
256
|
@options = SnapTrade::OptionsApi.new(@api_client)
|
260
257
|
@reference_data = SnapTrade::ReferenceDataApi.new(@api_client)
|
261
258
|
@trading = SnapTrade::TradingApi.new(@api_client)
|
@@ -207,4 +207,20 @@ describe 'TradingApi' do
|
|
207
207
|
end
|
208
208
|
end
|
209
209
|
|
210
|
+
# unit tests for search_cryptocurrency_pair_instruments
|
211
|
+
# Search cryptocurrency pairs instruments
|
212
|
+
# Searches cryptocurrency pairs instruments accessible to the specified account.
|
213
|
+
# @param user_id
|
214
|
+
# @param user_secret
|
215
|
+
# @param account_id
|
216
|
+
# @param [Hash] opts the optional parameters
|
217
|
+
# @option opts [String] :base
|
218
|
+
# @option opts [String] :quote
|
219
|
+
# @return [TradingSearchCryptocurrencyPairInstruments200Response]
|
220
|
+
describe 'search_cryptocurrency_pair_instruments test' do
|
221
|
+
it 'should work' do
|
222
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
223
|
+
end
|
224
|
+
end
|
225
|
+
|
210
226
|
end
|
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.112
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- SnapTrade
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-07-
|
11
|
+
date: 2025-07-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|
@@ -87,7 +87,6 @@ files:
|
|
87
87
|
- lib/snaptrade/api/api_status_api.rb
|
88
88
|
- lib/snaptrade/api/authentication_api.rb
|
89
89
|
- lib/snaptrade/api/connections_api.rb
|
90
|
-
- lib/snaptrade/api/crypto_trading_api.rb
|
91
90
|
- lib/snaptrade/api/options_api.rb
|
92
91
|
- lib/snaptrade/api/reference_data_api.rb
|
93
92
|
- lib/snaptrade/api/trading_api.rb
|
@@ -249,7 +248,6 @@ files:
|
|
249
248
|
- spec/api/api_status_api_spec.rb
|
250
249
|
- spec/api/authentication_api_spec.rb
|
251
250
|
- spec/api/connections_api_spec.rb
|
252
|
-
- spec/api/crypto_trading_api_spec.rb
|
253
251
|
- spec/api/options_api_spec.rb
|
254
252
|
- spec/api/reference_data_api_spec.rb
|
255
253
|
- spec/api/trading_api_spec.rb
|
@@ -439,7 +437,6 @@ test_files:
|
|
439
437
|
- spec/api/authentication_api_spec.rb
|
440
438
|
- spec/api/reference_data_api_spec.rb
|
441
439
|
- spec/api/trading_api_spec.rb
|
442
|
-
- spec/api/crypto_trading_api_spec.rb
|
443
440
|
- spec/api_client_spec.rb
|
444
441
|
- spec/configuration_spec.rb
|
445
442
|
- spec/getting_started_spec.rb
|
@@ -1,139 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#SnapTrade
|
3
|
-
|
4
|
-
#Connect brokerage accounts to your app for live positions and trading
|
5
|
-
|
6
|
-
The version of the OpenAPI document: 1.0.0
|
7
|
-
Contact: api@snaptrade.com
|
8
|
-
=end
|
9
|
-
|
10
|
-
require 'cgi'
|
11
|
-
|
12
|
-
module SnapTrade
|
13
|
-
class CryptoTradingApi
|
14
|
-
attr_accessor :api_client
|
15
|
-
|
16
|
-
def initialize(api_client = ApiClient.default)
|
17
|
-
@api_client = api_client
|
18
|
-
end
|
19
|
-
|
20
|
-
# Search cryptocurrency pairs instruments
|
21
|
-
#
|
22
|
-
# Searches cryptocurrency pairs instruments accessible to the specified account.
|
23
|
-
#
|
24
|
-
# @param user_id [String]
|
25
|
-
# @param user_secret [String]
|
26
|
-
# @param account_id [String]
|
27
|
-
# @param base [String]
|
28
|
-
# @param quote [String]
|
29
|
-
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
30
|
-
def search_cryptocurrency_pair_instruments(user_id:, user_secret:, account_id:, base: SENTINEL, quote: SENTINEL, extra: {})
|
31
|
-
extra[:base] = base if base != SENTINEL
|
32
|
-
extra[:quote] = quote if quote != SENTINEL
|
33
|
-
data, _status_code, _headers = search_cryptocurrency_pair_instruments_with_http_info_impl(user_id, user_secret, account_id, extra)
|
34
|
-
data
|
35
|
-
end
|
36
|
-
|
37
|
-
# Search cryptocurrency pairs instruments
|
38
|
-
#
|
39
|
-
# Searches cryptocurrency pairs instruments accessible to the specified account.
|
40
|
-
#
|
41
|
-
# @param user_id [String]
|
42
|
-
# @param user_secret [String]
|
43
|
-
# @param account_id [String]
|
44
|
-
# @param base [String]
|
45
|
-
# @param quote [String]
|
46
|
-
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
47
|
-
def search_cryptocurrency_pair_instruments_with_http_info(user_id:, user_secret:, account_id:, base: SENTINEL, quote: SENTINEL, extra: {})
|
48
|
-
extra[:base] = base if base != SENTINEL
|
49
|
-
extra[:quote] = quote if quote != SENTINEL
|
50
|
-
search_cryptocurrency_pair_instruments_with_http_info_impl(user_id, user_secret, account_id, extra)
|
51
|
-
end
|
52
|
-
|
53
|
-
# Search cryptocurrency pairs instruments
|
54
|
-
# Searches cryptocurrency pairs instruments accessible to the specified account.
|
55
|
-
# @param user_id [String]
|
56
|
-
# @param user_secret [String]
|
57
|
-
# @param account_id [String]
|
58
|
-
# @param [Hash] opts the optional parameters
|
59
|
-
# @option opts [String] :base
|
60
|
-
# @option opts [String] :quote
|
61
|
-
# @return [TradingSearchCryptocurrencyPairInstruments200Response]
|
62
|
-
private def search_cryptocurrency_pair_instruments_impl(user_id, user_secret, account_id, opts = {})
|
63
|
-
data, _status_code, _headers = search_cryptocurrency_pair_instruments_with_http_info(user_id, user_secret, account_id, opts)
|
64
|
-
data
|
65
|
-
end
|
66
|
-
|
67
|
-
# Search cryptocurrency pairs instruments
|
68
|
-
# Searches cryptocurrency pairs instruments accessible to the specified account.
|
69
|
-
# @param user_id [String]
|
70
|
-
# @param user_secret [String]
|
71
|
-
# @param account_id [String]
|
72
|
-
# @param [Hash] opts the optional parameters
|
73
|
-
# @option opts [String] :base
|
74
|
-
# @option opts [String] :quote
|
75
|
-
# @return [Array<(TradingSearchCryptocurrencyPairInstruments200Response, Integer, Hash)>] TradingSearchCryptocurrencyPairInstruments200Response data, response status code and response headers
|
76
|
-
private def search_cryptocurrency_pair_instruments_with_http_info_impl(user_id, user_secret, account_id, opts = {})
|
77
|
-
if @api_client.config.debugging
|
78
|
-
@api_client.config.logger.debug 'Calling API: CryptoTradingApi.search_cryptocurrency_pair_instruments ...'
|
79
|
-
end
|
80
|
-
# verify the required parameter 'user_id' is set
|
81
|
-
if @api_client.config.client_side_validation && user_id.nil?
|
82
|
-
fail ArgumentError, "Missing the required parameter 'user_id' when calling CryptoTradingApi.search_cryptocurrency_pair_instruments"
|
83
|
-
end
|
84
|
-
# verify the required parameter 'user_secret' is set
|
85
|
-
if @api_client.config.client_side_validation && user_secret.nil?
|
86
|
-
fail ArgumentError, "Missing the required parameter 'user_secret' when calling CryptoTradingApi.search_cryptocurrency_pair_instruments"
|
87
|
-
end
|
88
|
-
# verify the required parameter 'account_id' is set
|
89
|
-
if @api_client.config.client_side_validation && account_id.nil?
|
90
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling CryptoTradingApi.search_cryptocurrency_pair_instruments"
|
91
|
-
end
|
92
|
-
# resource path
|
93
|
-
local_var_path = '/accounts/{accountId}/trading/instruments/cryptocurrencyPairs'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
|
94
|
-
|
95
|
-
# query parameters
|
96
|
-
query_params = opts[:query_params] || {}
|
97
|
-
query_params[:'userId'] = user_id
|
98
|
-
query_params[:'userSecret'] = user_secret
|
99
|
-
query_params[:'base'] = opts[:'base'] if !opts[:'base'].nil?
|
100
|
-
query_params[:'quote'] = opts[:'quote'] if !opts[:'quote'].nil?
|
101
|
-
|
102
|
-
# header parameters
|
103
|
-
header_params = opts[:header_params] || {}
|
104
|
-
# HTTP header 'Accept' (if needed)
|
105
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
106
|
-
|
107
|
-
# form parameters
|
108
|
-
form_params = opts[:form_params] || {}
|
109
|
-
|
110
|
-
# http body (model)
|
111
|
-
post_body = opts[:debug_body]
|
112
|
-
|
113
|
-
# return_type
|
114
|
-
return_type = opts[:debug_return_type] || 'TradingSearchCryptocurrencyPairInstruments200Response'
|
115
|
-
|
116
|
-
# auth_names
|
117
|
-
auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
|
118
|
-
|
119
|
-
new_options = opts.merge(
|
120
|
-
:operation => :"CryptoTradingApi.search_cryptocurrency_pair_instruments",
|
121
|
-
:header_params => header_params,
|
122
|
-
:query_params => query_params,
|
123
|
-
:form_params => form_params,
|
124
|
-
:body => post_body,
|
125
|
-
:auth_names => auth_names,
|
126
|
-
:return_type => return_type
|
127
|
-
)
|
128
|
-
|
129
|
-
data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
|
130
|
-
if @api_client.config.debugging
|
131
|
-
@api_client.config.logger.debug "API called: CryptoTradingApi#search_cryptocurrency_pair_instruments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
132
|
-
end
|
133
|
-
return data, status_code, headers, response
|
134
|
-
end
|
135
|
-
end
|
136
|
-
|
137
|
-
# top-level client access to avoid having the user to insantiate their own API instances
|
138
|
-
CryptoTrading = CryptoTradingApi::new
|
139
|
-
end
|
@@ -1,46 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#SnapTrade
|
3
|
-
|
4
|
-
#Connect brokerage accounts to your app for live positions and trading
|
5
|
-
|
6
|
-
The version of the OpenAPI document: 1.0.0
|
7
|
-
Contact: api@snaptrade.com
|
8
|
-
=end
|
9
|
-
|
10
|
-
require 'spec_helper'
|
11
|
-
require 'json'
|
12
|
-
|
13
|
-
# Unit tests for SnapTrade::CryptoTradingApi
|
14
|
-
describe 'CryptoTradingApi' do
|
15
|
-
before do
|
16
|
-
# run before each test
|
17
|
-
@api_instance = SnapTrade::CryptoTradingApi.new
|
18
|
-
end
|
19
|
-
|
20
|
-
after do
|
21
|
-
# run after each test
|
22
|
-
end
|
23
|
-
|
24
|
-
describe 'test an instance of CryptoTradingApi' do
|
25
|
-
it 'should create an instance of CryptoTradingApi' do
|
26
|
-
expect(@api_instance).to be_instance_of(SnapTrade::CryptoTradingApi)
|
27
|
-
end
|
28
|
-
end
|
29
|
-
|
30
|
-
# unit tests for search_cryptocurrency_pair_instruments
|
31
|
-
# Search cryptocurrency pairs instruments
|
32
|
-
# Searches cryptocurrency pairs instruments accessible to the specified account.
|
33
|
-
# @param user_id
|
34
|
-
# @param user_secret
|
35
|
-
# @param account_id
|
36
|
-
# @param [Hash] opts the optional parameters
|
37
|
-
# @option opts [String] :base
|
38
|
-
# @option opts [String] :quote
|
39
|
-
# @return [TradingSearchCryptocurrencyPairInstruments200Response]
|
40
|
-
describe 'search_cryptocurrency_pair_instruments test' do
|
41
|
-
it 'should work' do
|
42
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
43
|
-
end
|
44
|
-
end
|
45
|
-
|
46
|
-
end
|