kabustation_client 1.0.0 → 1.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.
data/docs/InfoApi.md CHANGED
@@ -21,7 +21,7 @@ All URIs are relative to *http://localhost:18080/kabusapi*
21
21
 
22
22
  ## apisoftlimit_get
23
23
 
24
- > <ApiSoftLimitResponse> apisoftlimit_get(x_api_key)
24
+ > <ApiSoftLimitResponse> apisoftlimit_get
25
25
 
26
26
  ソフトリミット
27
27
 
@@ -32,13 +32,19 @@ kabuステーションAPIのソフトリミット値を取得する
32
32
  ```ruby
33
33
  require 'time'
34
34
  require 'kabustation_client'
35
+ # setup authorization
36
+ KabustationClient.configure do |config|
37
+ # Configure API key authorization: ApiKeyAuth
38
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
39
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
40
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
41
+ end
35
42
 
36
43
  api_instance = KabustationClient::InfoApi.new
37
- x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
38
44
 
39
45
  begin
40
46
  # ソフトリミット
41
- result = api_instance.apisoftlimit_get(x_api_key)
47
+ result = api_instance.apisoftlimit_get
42
48
  p result
43
49
  rescue KabustationClient::ApiError => e
44
50
  puts "Error when calling InfoApi->apisoftlimit_get: #{e}"
@@ -49,12 +55,12 @@ end
49
55
 
50
56
  This returns an Array which contains the response data, status code and headers.
51
57
 
52
- > <Array(<ApiSoftLimitResponse>, Integer, Hash)> apisoftlimit_get_with_http_info(x_api_key)
58
+ > <Array(<ApiSoftLimitResponse>, Integer, Hash)> apisoftlimit_get_with_http_info
53
59
 
54
60
  ```ruby
55
61
  begin
56
62
  # ソフトリミット
57
- data, status_code, headers = api_instance.apisoftlimit_get_with_http_info(x_api_key)
63
+ data, status_code, headers = api_instance.apisoftlimit_get_with_http_info
58
64
  p status_code # => 2xx
59
65
  p headers # => { ... }
60
66
  p data # => <ApiSoftLimitResponse>
@@ -65,9 +71,7 @@ end
65
71
 
66
72
  ### Parameters
67
73
 
68
- | Name | Type | Description | Notes |
69
- | ---- | ---- | ----------- | ----- |
70
- | **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
74
+ This endpoint does not need any parameter.
71
75
 
72
76
  ### Return type
73
77
 
@@ -75,7 +79,7 @@ end
75
79
 
76
80
  ### Authorization
77
81
 
78
- No authorization required
82
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
79
83
 
80
84
  ### HTTP request headers
81
85
 
@@ -85,7 +89,7 @@ No authorization required
85
89
 
86
90
  ## board_get
87
91
 
88
- > <BoardSuccess> board_get(x_api_key, symbol)
92
+ > <BoardSuccess> board_get(symbol)
89
93
 
90
94
  時価情報・板情報
91
95
 
@@ -96,14 +100,20 @@ No authorization required
96
100
  ```ruby
97
101
  require 'time'
98
102
  require 'kabustation_client'
103
+ # setup authorization
104
+ KabustationClient.configure do |config|
105
+ # Configure API key authorization: ApiKeyAuth
106
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
107
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
108
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
109
+ end
99
110
 
100
111
  api_instance = KabustationClient::InfoApi.new
101
- x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
102
112
  symbol = 'symbol_example' # String | 銘柄コード <br> ※次の形式で入力してください。<br> [銘柄コード]@[市場コード]<br> ※市場コードは下記の定義値から選択してください。<br> ※SOR市場は取扱っておりませんのでご注意ください。<b>市場コード</b><br> <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>東証</td> </tr> <tr> <td>3</td> <td>名証</td> </tr> <tr> <td>5</td> <td>福証</td> </tr> <tr> <td>6</td> <td>札証</td> </tr> <tr> <td>2</td> <td>日通し</td> </tr> <tr> <td>23</td> <td>日中</td> </tr> <tr> <td>24</td> <td>夜間</td> </tr> </tbody> </table>
103
113
 
104
114
  begin
105
115
  # 時価情報・板情報
106
- result = api_instance.board_get(x_api_key, symbol)
116
+ result = api_instance.board_get(symbol)
107
117
  p result
108
118
  rescue KabustationClient::ApiError => e
109
119
  puts "Error when calling InfoApi->board_get: #{e}"
@@ -114,12 +124,12 @@ end
114
124
 
115
125
  This returns an Array which contains the response data, status code and headers.
116
126
 
117
- > <Array(<BoardSuccess>, Integer, Hash)> board_get_with_http_info(x_api_key, symbol)
127
+ > <Array(<BoardSuccess>, Integer, Hash)> board_get_with_http_info(symbol)
118
128
 
119
129
  ```ruby
120
130
  begin
121
131
  # 時価情報・板情報
122
- data, status_code, headers = api_instance.board_get_with_http_info(x_api_key, symbol)
132
+ data, status_code, headers = api_instance.board_get_with_http_info(symbol)
123
133
  p status_code # => 2xx
124
134
  p headers # => { ... }
125
135
  p data # => <BoardSuccess>
@@ -132,7 +142,6 @@ end
132
142
 
133
143
  | Name | Type | Description | Notes |
134
144
  | ---- | ---- | ----------- | ----- |
135
- | **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
136
145
  | **symbol** | **String** | 銘柄コード &lt;br&gt; ※次の形式で入力してください。&lt;br&gt; [銘柄コード]@[市場コード]&lt;br&gt; ※市場コードは下記の定義値から選択してください。&lt;br&gt; ※SOR市場は取扱っておりませんのでご注意ください。&lt;b&gt;市場コード&lt;/b&gt;&lt;br&gt; &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;定義値&lt;/th&gt; &lt;th&gt;説明&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;1&lt;/td&gt; &lt;td&gt;東証&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;3&lt;/td&gt; &lt;td&gt;名証&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;5&lt;/td&gt; &lt;td&gt;福証&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;6&lt;/td&gt; &lt;td&gt;札証&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;2&lt;/td&gt; &lt;td&gt;日通し&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;23&lt;/td&gt; &lt;td&gt;日中&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;24&lt;/td&gt; &lt;td&gt;夜間&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; | |
137
146
 
138
147
  ### Return type
@@ -141,7 +150,7 @@ end
141
150
 
142
151
  ### Authorization
143
152
 
144
- No authorization required
153
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
145
154
 
146
155
  ### HTTP request headers
147
156
 
@@ -151,7 +160,7 @@ No authorization required
151
160
 
152
161
  ## exchange_get
153
162
 
154
- > <ExchangeResponse> exchange_get(x_api_key, symbol)
163
+ > <ExchangeResponse> exchange_get(symbol)
155
164
 
156
165
  為替情報
157
166
 
@@ -162,14 +171,20 @@ No authorization required
162
171
  ```ruby
163
172
  require 'time'
164
173
  require 'kabustation_client'
174
+ # setup authorization
175
+ KabustationClient.configure do |config|
176
+ # Configure API key authorization: ApiKeyAuth
177
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
178
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
179
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
180
+ end
165
181
 
166
182
  api_instance = KabustationClient::InfoApi.new
167
- x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
168
183
  symbol = 'usdjpy' # String | 通貨 <table> <thead> <tr> <th>定義値</th> <th>内容</th> </tr> </thead> <tbody> <tr> <td>usdjpy</td> <td>USD/JPY</td> </tr> <tr> <td>eurjpy</td> <td>EUR/JPY</td> </tr> <tr> <td>gbpjpy</td> <td>GBP/JPY</td> </tr> <tr> <td>audjpy</td> <td>AUD/JPY</td> </tr> <tr> <td>chfjpy</td> <td>CHF/JPY</td> </tr> <tr> <td>cadjpy</td> <td>CAD/JPY</td> </tr> <tr> <td>nzdjpy</td> <td>NZD/JPY</td> </tr> <tr> <td>zarjpy</td> <td>ZAR/JPY</td> </tr> <tr> <td>eurusd</td> <td>EUR/USD</td> </tr> <tr> <td>gbpusd</td> <td>GBP/USD</td> </tr> <tr> <td>audusd</td> <td>AUD/USD</td> </tr> </tbody> </table>
169
184
 
170
185
  begin
171
186
  # 為替情報
172
- result = api_instance.exchange_get(x_api_key, symbol)
187
+ result = api_instance.exchange_get(symbol)
173
188
  p result
174
189
  rescue KabustationClient::ApiError => e
175
190
  puts "Error when calling InfoApi->exchange_get: #{e}"
@@ -180,12 +195,12 @@ end
180
195
 
181
196
  This returns an Array which contains the response data, status code and headers.
182
197
 
183
- > <Array(<ExchangeResponse>, Integer, Hash)> exchange_get_with_http_info(x_api_key, symbol)
198
+ > <Array(<ExchangeResponse>, Integer, Hash)> exchange_get_with_http_info(symbol)
184
199
 
185
200
  ```ruby
186
201
  begin
187
202
  # 為替情報
188
- data, status_code, headers = api_instance.exchange_get_with_http_info(x_api_key, symbol)
203
+ data, status_code, headers = api_instance.exchange_get_with_http_info(symbol)
189
204
  p status_code # => 2xx
190
205
  p headers # => { ... }
191
206
  p data # => <ExchangeResponse>
@@ -198,7 +213,6 @@ end
198
213
 
199
214
  | Name | Type | Description | Notes |
200
215
  | ---- | ---- | ----------- | ----- |
201
- | **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
202
216
  | **symbol** | **String** | 通貨 &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;定義値&lt;/th&gt; &lt;th&gt;内容&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;usdjpy&lt;/td&gt; &lt;td&gt;USD/JPY&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;eurjpy&lt;/td&gt; &lt;td&gt;EUR/JPY&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;gbpjpy&lt;/td&gt; &lt;td&gt;GBP/JPY&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;audjpy&lt;/td&gt; &lt;td&gt;AUD/JPY&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;chfjpy&lt;/td&gt; &lt;td&gt;CHF/JPY&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;cadjpy&lt;/td&gt; &lt;td&gt;CAD/JPY&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;nzdjpy&lt;/td&gt; &lt;td&gt;NZD/JPY&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;zarjpy&lt;/td&gt; &lt;td&gt;ZAR/JPY&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;eurusd&lt;/td&gt; &lt;td&gt;EUR/USD&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;gbpusd&lt;/td&gt; &lt;td&gt;GBP/USD&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;audusd&lt;/td&gt; &lt;td&gt;AUD/USD&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; | |
203
217
 
204
218
  ### Return type
@@ -207,7 +221,7 @@ end
207
221
 
208
222
  ### Authorization
209
223
 
210
- No authorization required
224
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
211
225
 
212
226
  ### HTTP request headers
213
227
 
@@ -217,7 +231,7 @@ No authorization required
217
231
 
218
232
  ## marginpremium_get
219
233
 
220
- > <MarginPremiumResponse> marginpremium_get(x_api_key, symbol)
234
+ > <MarginPremiumResponse> marginpremium_get(symbol)
221
235
 
222
236
  プレミアム料取得
223
237
 
@@ -228,14 +242,20 @@ No authorization required
228
242
  ```ruby
229
243
  require 'time'
230
244
  require 'kabustation_client'
245
+ # setup authorization
246
+ KabustationClient.configure do |config|
247
+ # Configure API key authorization: ApiKeyAuth
248
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
249
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
250
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
251
+ end
231
252
 
232
253
  api_instance = KabustationClient::InfoApi.new
233
- x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
234
254
  symbol = 'symbol_example' # String | 銘柄コード
235
255
 
236
256
  begin
237
257
  # プレミアム料取得
238
- result = api_instance.marginpremium_get(x_api_key, symbol)
258
+ result = api_instance.marginpremium_get(symbol)
239
259
  p result
240
260
  rescue KabustationClient::ApiError => e
241
261
  puts "Error when calling InfoApi->marginpremium_get: #{e}"
@@ -246,12 +266,12 @@ end
246
266
 
247
267
  This returns an Array which contains the response data, status code and headers.
248
268
 
249
- > <Array(<MarginPremiumResponse>, Integer, Hash)> marginpremium_get_with_http_info(x_api_key, symbol)
269
+ > <Array(<MarginPremiumResponse>, Integer, Hash)> marginpremium_get_with_http_info(symbol)
250
270
 
251
271
  ```ruby
252
272
  begin
253
273
  # プレミアム料取得
254
- data, status_code, headers = api_instance.marginpremium_get_with_http_info(x_api_key, symbol)
274
+ data, status_code, headers = api_instance.marginpremium_get_with_http_info(symbol)
255
275
  p status_code # => 2xx
256
276
  p headers # => { ... }
257
277
  p data # => <MarginPremiumResponse>
@@ -264,7 +284,6 @@ end
264
284
 
265
285
  | Name | Type | Description | Notes |
266
286
  | ---- | ---- | ----------- | ----- |
267
- | **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
268
287
  | **symbol** | **String** | 銘柄コード | |
269
288
 
270
289
  ### Return type
@@ -273,7 +292,7 @@ end
273
292
 
274
293
  ### Authorization
275
294
 
276
- No authorization required
295
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
277
296
 
278
297
  ### HTTP request headers
279
298
 
@@ -283,7 +302,7 @@ No authorization required
283
302
 
284
303
  ## orders_get
285
304
 
286
- > <Array<OrdersSuccess>> orders_get(x_api_key, opts)
305
+ > <Array<OrdersSuccess>> orders_get(opts)
287
306
 
288
307
  注文約定照会
289
308
 
@@ -294,9 +313,15 @@ No authorization required
294
313
  ```ruby
295
314
  require 'time'
296
315
  require 'kabustation_client'
316
+ # setup authorization
317
+ KabustationClient.configure do |config|
318
+ # Configure API key authorization: ApiKeyAuth
319
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
320
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
321
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
322
+ end
297
323
 
298
324
  api_instance = KabustationClient::InfoApi.new
299
- x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
300
325
  opts = {
301
326
  product: '0', # String | 取得する商品 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>0</td> <td>すべて </td> </tr> <tr> <td>1</td> <td>現物</td> </tr> <tr> <td>2</td> <td>信用</td> </tr> <tr> <td>3</td> <td>先物</td> </tr> <tr> <td>4</td> <td>OP</td> </tr> </tbody> </table>
302
327
  id: 'id_example', # String | 注文番号<br> ※指定された注文番号と一致する注文のみレスポンスします。<br> ※指定された注文番号との比較では大文字小文字を区別しません。<br> ※複数の注文番号を指定することはできません。
@@ -310,7 +335,7 @@ opts = {
310
335
 
311
336
  begin
312
337
  # 注文約定照会
313
- result = api_instance.orders_get(x_api_key, opts)
338
+ result = api_instance.orders_get(opts)
314
339
  p result
315
340
  rescue KabustationClient::ApiError => e
316
341
  puts "Error when calling InfoApi->orders_get: #{e}"
@@ -321,12 +346,12 @@ end
321
346
 
322
347
  This returns an Array which contains the response data, status code and headers.
323
348
 
324
- > <Array(<Array<OrdersSuccess>>, Integer, Hash)> orders_get_with_http_info(x_api_key, opts)
349
+ > <Array(<Array<OrdersSuccess>>, Integer, Hash)> orders_get_with_http_info(opts)
325
350
 
326
351
  ```ruby
327
352
  begin
328
353
  # 注文約定照会
329
- data, status_code, headers = api_instance.orders_get_with_http_info(x_api_key, opts)
354
+ data, status_code, headers = api_instance.orders_get_with_http_info(opts)
330
355
  p status_code # => 2xx
331
356
  p headers # => { ... }
332
357
  p data # => <Array<OrdersSuccess>>
@@ -339,7 +364,6 @@ end
339
364
 
340
365
  | Name | Type | Description | Notes |
341
366
  | ---- | ---- | ----------- | ----- |
342
- | **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
343
367
  | **product** | **String** | 取得する商品 &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;定義値&lt;/th&gt; &lt;th&gt;説明&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;0&lt;/td&gt; &lt;td&gt;すべて &lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;1&lt;/td&gt; &lt;td&gt;現物&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;2&lt;/td&gt; &lt;td&gt;信用&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;3&lt;/td&gt; &lt;td&gt;先物&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;4&lt;/td&gt; &lt;td&gt;OP&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; | [optional] |
344
368
  | **id** | **String** | 注文番号&lt;br&gt; ※指定された注文番号と一致する注文のみレスポンスします。&lt;br&gt; ※指定された注文番号との比較では大文字小文字を区別しません。&lt;br&gt; ※複数の注文番号を指定することはできません。 | [optional] |
345
369
  | **updtime** | **String** | 更新日時&lt;br&gt; ※形式:yyyyMMddHHmmss (例:20201201123456)&lt;br&gt; ※指定された更新日時以降(指定日時含む)に更新された注文のみレスポンスします。&lt;br&gt; ※複数の更新日時を指定することはできません。 | [optional] |
@@ -355,7 +379,7 @@ end
355
379
 
356
380
  ### Authorization
357
381
 
358
- No authorization required
382
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
359
383
 
360
384
  ### HTTP request headers
361
385
 
@@ -365,7 +389,7 @@ No authorization required
365
389
 
366
390
  ## positions_get
367
391
 
368
- > <Array<PositionsSuccess>> positions_get(x_api_key, opts)
392
+ > <Array<PositionsSuccess>> positions_get(opts)
369
393
 
370
394
  残高照会
371
395
 
@@ -376,9 +400,15 @@ No authorization required
376
400
  ```ruby
377
401
  require 'time'
378
402
  require 'kabustation_client'
403
+ # setup authorization
404
+ KabustationClient.configure do |config|
405
+ # Configure API key authorization: ApiKeyAuth
406
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
407
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
408
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
409
+ end
379
410
 
380
411
  api_instance = KabustationClient::InfoApi.new
381
- x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
382
412
  opts = {
383
413
  product: '0', # String | 取得する商品 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>0</td> <td>すべて</td> </tr> <tr> <td>1</td> <td>現物</td> </tr> <tr> <td>2</td> <td>信用</td> </tr> <tr> <td>3</td> <td>先物</td> </tr> <tr> <td>4</td> <td>OP</td> </tr> </tbody> </table>
384
414
  symbol: 'symbol_example', # String | 銘柄コード<br>※指定された銘柄コードと一致するポジションのみレスポンスします。<br>※複数の銘柄コードを指定することはできません。
@@ -388,7 +418,7 @@ opts = {
388
418
 
389
419
  begin
390
420
  # 残高照会
391
- result = api_instance.positions_get(x_api_key, opts)
421
+ result = api_instance.positions_get(opts)
392
422
  p result
393
423
  rescue KabustationClient::ApiError => e
394
424
  puts "Error when calling InfoApi->positions_get: #{e}"
@@ -399,12 +429,12 @@ end
399
429
 
400
430
  This returns an Array which contains the response data, status code and headers.
401
431
 
402
- > <Array(<Array<PositionsSuccess>>, Integer, Hash)> positions_get_with_http_info(x_api_key, opts)
432
+ > <Array(<Array<PositionsSuccess>>, Integer, Hash)> positions_get_with_http_info(opts)
403
433
 
404
434
  ```ruby
405
435
  begin
406
436
  # 残高照会
407
- data, status_code, headers = api_instance.positions_get_with_http_info(x_api_key, opts)
437
+ data, status_code, headers = api_instance.positions_get_with_http_info(opts)
408
438
  p status_code # => 2xx
409
439
  p headers # => { ... }
410
440
  p data # => <Array<PositionsSuccess>>
@@ -417,7 +447,6 @@ end
417
447
 
418
448
  | Name | Type | Description | Notes |
419
449
  | ---- | ---- | ----------- | ----- |
420
- | **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
421
450
  | **product** | **String** | 取得する商品 &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;定義値&lt;/th&gt; &lt;th&gt;説明&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;0&lt;/td&gt; &lt;td&gt;すべて&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;1&lt;/td&gt; &lt;td&gt;現物&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;2&lt;/td&gt; &lt;td&gt;信用&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;3&lt;/td&gt; &lt;td&gt;先物&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;4&lt;/td&gt; &lt;td&gt;OP&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; | [optional] |
422
451
  | **symbol** | **String** | 銘柄コード&lt;br&gt;※指定された銘柄コードと一致するポジションのみレスポンスします。&lt;br&gt;※複数の銘柄コードを指定することはできません。 | [optional] |
423
452
  | **side** | **String** | 売買区分フィルタ&lt;br&gt; 指定された売買区分と一致する注文を返す &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;定義値&lt;/th&gt; &lt;th&gt;説明&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;1&lt;/td&gt; &lt;td&gt;売&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;2&lt;/td&gt; &lt;td&gt;買&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; | [optional] |
@@ -429,7 +458,7 @@ end
429
458
 
430
459
  ### Authorization
431
460
 
432
- No authorization required
461
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
433
462
 
434
463
  ### HTTP request headers
435
464
 
@@ -439,7 +468,7 @@ No authorization required
439
468
 
440
469
  ## primary_exchange_get
441
470
 
442
- > <PrimaryExchangeResponse> primary_exchange_get(x_api_key, symbol)
471
+ > <PrimaryExchangeResponse> primary_exchange_get(symbol)
443
472
 
444
473
  優先市場
445
474
 
@@ -450,14 +479,20 @@ No authorization required
450
479
  ```ruby
451
480
  require 'time'
452
481
  require 'kabustation_client'
482
+ # setup authorization
483
+ KabustationClient.configure do |config|
484
+ # Configure API key authorization: ApiKeyAuth
485
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
486
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
487
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
488
+ end
453
489
 
454
490
  api_instance = KabustationClient::InfoApi.new
455
- x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
456
491
  symbol = 'symbol_example' # String | 銘柄コード
457
492
 
458
493
  begin
459
494
  # 優先市場
460
- result = api_instance.primary_exchange_get(x_api_key, symbol)
495
+ result = api_instance.primary_exchange_get(symbol)
461
496
  p result
462
497
  rescue KabustationClient::ApiError => e
463
498
  puts "Error when calling InfoApi->primary_exchange_get: #{e}"
@@ -468,12 +503,12 @@ end
468
503
 
469
504
  This returns an Array which contains the response data, status code and headers.
470
505
 
471
- > <Array(<PrimaryExchangeResponse>, Integer, Hash)> primary_exchange_get_with_http_info(x_api_key, symbol)
506
+ > <Array(<PrimaryExchangeResponse>, Integer, Hash)> primary_exchange_get_with_http_info(symbol)
472
507
 
473
508
  ```ruby
474
509
  begin
475
510
  # 優先市場
476
- data, status_code, headers = api_instance.primary_exchange_get_with_http_info(x_api_key, symbol)
511
+ data, status_code, headers = api_instance.primary_exchange_get_with_http_info(symbol)
477
512
  p status_code # => 2xx
478
513
  p headers # => { ... }
479
514
  p data # => <PrimaryExchangeResponse>
@@ -486,7 +521,6 @@ end
486
521
 
487
522
  | Name | Type | Description | Notes |
488
523
  | ---- | ---- | ----------- | ----- |
489
- | **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
490
524
  | **symbol** | **String** | 銘柄コード | |
491
525
 
492
526
  ### Return type
@@ -495,7 +529,7 @@ end
495
529
 
496
530
  ### Authorization
497
531
 
498
- No authorization required
532
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
499
533
 
500
534
  ### HTTP request headers
501
535
 
@@ -505,7 +539,7 @@ No authorization required
505
539
 
506
540
  ## ranking_get
507
541
 
508
- > <RankingGet200Response> ranking_get(x_api_key, type, exchange_division)
542
+ > <RankingGet200Response> ranking_get(type, exchange_division)
509
543
 
510
544
  詳細ランキング
511
545
 
@@ -516,15 +550,21 @@ No authorization required
516
550
  ```ruby
517
551
  require 'time'
518
552
  require 'kabustation_client'
553
+ # setup authorization
554
+ KabustationClient.configure do |config|
555
+ # Configure API key authorization: ApiKeyAuth
556
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
557
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
558
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
559
+ end
519
560
 
520
561
  api_instance = KabustationClient::InfoApi.new
521
- x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
522
562
  type = '1' # String | 種別<br> ※信用情報ランキングに「福証」「札証」を指定した場合は、空レスポンスになります <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>値上がり率(デフォルト)</td> </tr> <tr> <td>2</td> <td>値下がり率</td> </tr> <tr> <td>3</td> <td>売買高上位</td> </tr> <tr> <td>4</td> <td>売買代金</td> </tr> <tr> <td>5</td> <td>TICK回数</td> </tr> <tr> <td>6</td> <td>売買高急増</td> </tr> <tr> <td>7</td> <td>売買代金急増</td> </tr> <tr> <td>8</td> <td>信用売残増</td> </tr> <tr> <td>9</td> <td>信用売残減</td> </tr> <tr> <td>10</td> <td>信用買残増</td> </tr> <tr> <td>11</td> <td>信用買残減</td> </tr> <tr> <td>12</td> <td>信用高倍率</td> </tr> <tr> <td>13</td> <td>信用低倍率</td> </tr> <tr> <td>14</td> <td>業種別値上がり率</td> </tr> <tr> <td>15</td> <td>業種別値下がり率</td> </tr> </tbody> </table>
523
563
  exchange_division = 'ALL' # String | 市場<br> ※業種別値上がり率・値下がり率に市場を指定しても無視されます <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>ALL</td> <td>全市場(デフォルト)</td> </tr> <tr> <td>T</td> <td>東証全体</td> </tr> <tr> <td>TP</td> <td>東証プライム</td> </tr> <tr> <td>TS</td> <td>東証スタンダード</td> </tr> <tr> <td>TG</td> <td>グロース250</td> </tr> <tr> <td>M</td> <td>名証</td> </tr> <tr> <td>FK</td> <td>福証</td> </tr> <tr> <td>S</td> <td>札証</td> </tr> </tbody> </table>
524
564
 
525
565
  begin
526
566
  # 詳細ランキング
527
- result = api_instance.ranking_get(x_api_key, type, exchange_division)
567
+ result = api_instance.ranking_get(type, exchange_division)
528
568
  p result
529
569
  rescue KabustationClient::ApiError => e
530
570
  puts "Error when calling InfoApi->ranking_get: #{e}"
@@ -535,12 +575,12 @@ end
535
575
 
536
576
  This returns an Array which contains the response data, status code and headers.
537
577
 
538
- > <Array(<RankingGet200Response>, Integer, Hash)> ranking_get_with_http_info(x_api_key, type, exchange_division)
578
+ > <Array(<RankingGet200Response>, Integer, Hash)> ranking_get_with_http_info(type, exchange_division)
539
579
 
540
580
  ```ruby
541
581
  begin
542
582
  # 詳細ランキング
543
- data, status_code, headers = api_instance.ranking_get_with_http_info(x_api_key, type, exchange_division)
583
+ data, status_code, headers = api_instance.ranking_get_with_http_info(type, exchange_division)
544
584
  p status_code # => 2xx
545
585
  p headers # => { ... }
546
586
  p data # => <RankingGet200Response>
@@ -553,7 +593,6 @@ end
553
593
 
554
594
  | Name | Type | Description | Notes |
555
595
  | ---- | ---- | ----------- | ----- |
556
- | **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
557
596
  | **type** | **String** | 種別&lt;br&gt; ※信用情報ランキングに「福証」「札証」を指定した場合は、空レスポンスになります &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;定義値&lt;/th&gt; &lt;th&gt;説明&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;1&lt;/td&gt; &lt;td&gt;値上がり率(デフォルト)&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;2&lt;/td&gt; &lt;td&gt;値下がり率&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;3&lt;/td&gt; &lt;td&gt;売買高上位&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;4&lt;/td&gt; &lt;td&gt;売買代金&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;5&lt;/td&gt; &lt;td&gt;TICK回数&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;6&lt;/td&gt; &lt;td&gt;売買高急増&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;7&lt;/td&gt; &lt;td&gt;売買代金急増&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;8&lt;/td&gt; &lt;td&gt;信用売残増&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;9&lt;/td&gt; &lt;td&gt;信用売残減&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;10&lt;/td&gt; &lt;td&gt;信用買残増&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;11&lt;/td&gt; &lt;td&gt;信用買残減&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;12&lt;/td&gt; &lt;td&gt;信用高倍率&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;13&lt;/td&gt; &lt;td&gt;信用低倍率&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;14&lt;/td&gt; &lt;td&gt;業種別値上がり率&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;15&lt;/td&gt; &lt;td&gt;業種別値下がり率&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; | |
558
597
  | **exchange_division** | **String** | 市場&lt;br&gt; ※業種別値上がり率・値下がり率に市場を指定しても無視されます &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;定義値&lt;/th&gt; &lt;th&gt;説明&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;ALL&lt;/td&gt; &lt;td&gt;全市場(デフォルト)&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;T&lt;/td&gt; &lt;td&gt;東証全体&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;TP&lt;/td&gt; &lt;td&gt;東証プライム&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;TS&lt;/td&gt; &lt;td&gt;東証スタンダード&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;TG&lt;/td&gt; &lt;td&gt;グロース250&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;M&lt;/td&gt; &lt;td&gt;名証&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;FK&lt;/td&gt; &lt;td&gt;福証&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;S&lt;/td&gt; &lt;td&gt;札証&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; | |
559
598
 
@@ -563,7 +602,7 @@ end
563
602
 
564
603
  ### Authorization
565
604
 
566
- No authorization required
605
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
567
606
 
568
607
  ### HTTP request headers
569
608
 
@@ -573,7 +612,7 @@ No authorization required
573
612
 
574
613
  ## regulations_get
575
614
 
576
- > <RegulationsResponse> regulations_get(x_api_key, symbol)
615
+ > <RegulationsResponse> regulations_get(symbol)
577
616
 
578
617
  規制情報
579
618
 
@@ -584,14 +623,20 @@ No authorization required
584
623
  ```ruby
585
624
  require 'time'
586
625
  require 'kabustation_client'
626
+ # setup authorization
627
+ KabustationClient.configure do |config|
628
+ # Configure API key authorization: ApiKeyAuth
629
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
630
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
631
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
632
+ end
587
633
 
588
634
  api_instance = KabustationClient::InfoApi.new
589
- x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
590
635
  symbol = 'symbol_example' # String | 銘柄コード <br> ※次の形式で入力してください。<br> [銘柄コード]@[市場コード]<br> ※市場コードは下記の定義値から選択してください。 <b>市場コード</b> <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>東証</td> </tr> <tr> <td>3</td> <td>名証</td> </tr> <tr> <td>5</td> <td>福証</td> </tr> <tr> <td>6</td> <td>札証</td> </tr> </tbody> </table>
591
636
 
592
637
  begin
593
638
  # 規制情報
594
- result = api_instance.regulations_get(x_api_key, symbol)
639
+ result = api_instance.regulations_get(symbol)
595
640
  p result
596
641
  rescue KabustationClient::ApiError => e
597
642
  puts "Error when calling InfoApi->regulations_get: #{e}"
@@ -602,12 +647,12 @@ end
602
647
 
603
648
  This returns an Array which contains the response data, status code and headers.
604
649
 
605
- > <Array(<RegulationsResponse>, Integer, Hash)> regulations_get_with_http_info(x_api_key, symbol)
650
+ > <Array(<RegulationsResponse>, Integer, Hash)> regulations_get_with_http_info(symbol)
606
651
 
607
652
  ```ruby
608
653
  begin
609
654
  # 規制情報
610
- data, status_code, headers = api_instance.regulations_get_with_http_info(x_api_key, symbol)
655
+ data, status_code, headers = api_instance.regulations_get_with_http_info(symbol)
611
656
  p status_code # => 2xx
612
657
  p headers # => { ... }
613
658
  p data # => <RegulationsResponse>
@@ -620,7 +665,6 @@ end
620
665
 
621
666
  | Name | Type | Description | Notes |
622
667
  | ---- | ---- | ----------- | ----- |
623
- | **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
624
668
  | **symbol** | **String** | 銘柄コード &lt;br&gt; ※次の形式で入力してください。&lt;br&gt; [銘柄コード]@[市場コード]&lt;br&gt; ※市場コードは下記の定義値から選択してください。 &lt;b&gt;市場コード&lt;/b&gt; &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;定義値&lt;/th&gt; &lt;th&gt;説明&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;1&lt;/td&gt; &lt;td&gt;東証&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;3&lt;/td&gt; &lt;td&gt;名証&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;5&lt;/td&gt; &lt;td&gt;福証&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;6&lt;/td&gt; &lt;td&gt;札証&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; | |
625
669
 
626
670
  ### Return type
@@ -629,7 +673,7 @@ end
629
673
 
630
674
  ### Authorization
631
675
 
632
- No authorization required
676
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
633
677
 
634
678
  ### HTTP request headers
635
679
 
@@ -639,7 +683,7 @@ No authorization required
639
683
 
640
684
  ## symbol_get
641
685
 
642
- > <SymbolSuccess> symbol_get(x_api_key, symbol, opts)
686
+ > <SymbolSuccess> symbol_get(symbol, opts)
643
687
 
644
688
  銘柄情報
645
689
 
@@ -650,9 +694,15 @@ No authorization required
650
694
  ```ruby
651
695
  require 'time'
652
696
  require 'kabustation_client'
697
+ # setup authorization
698
+ KabustationClient.configure do |config|
699
+ # Configure API key authorization: ApiKeyAuth
700
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
701
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
702
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
703
+ end
653
704
 
654
705
  api_instance = KabustationClient::InfoApi.new
655
- x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
656
706
  symbol = 'symbol_example' # String | 銘柄コード <br> ※次の形式で入力してください。<br> [銘柄コード]@[市場コード]<br> ※市場コードは下記の定義値から選択してください。<br> ※SOR市場は取扱っておりませんのでご注意ください。<b>市場コード</b><br> <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>東証</td> </tr> <tr> <td>3</td> <td>名証</td> </tr> <tr> <td>5</td> <td>福証</td> </tr> <tr> <td>6</td> <td>札証</td> </tr> <tr> <td>2</td> <td>日通し</td> </tr> <tr> <td>23</td> <td>日中</td> </tr> <tr> <td>24</td> <td>夜間</td> </tr> </tbody> </table>
657
707
  opts = {
658
708
  addinfo: 'addinfo_example' # String | 追加情報出力フラグ(未指定時:true)<br> ※追加情報は、「時価総額」、「発行済み株式数」、「決算期日」、「清算値」を意味します。 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>true</td> <td>追加情報を出力する</td> </tr> <tr> <td>false</td> <td>追加情報を出力しない</td> </tr> </tbody> </table>
@@ -660,7 +710,7 @@ opts = {
660
710
 
661
711
  begin
662
712
  # 銘柄情報
663
- result = api_instance.symbol_get(x_api_key, symbol, opts)
713
+ result = api_instance.symbol_get(symbol, opts)
664
714
  p result
665
715
  rescue KabustationClient::ApiError => e
666
716
  puts "Error when calling InfoApi->symbol_get: #{e}"
@@ -671,12 +721,12 @@ end
671
721
 
672
722
  This returns an Array which contains the response data, status code and headers.
673
723
 
674
- > <Array(<SymbolSuccess>, Integer, Hash)> symbol_get_with_http_info(x_api_key, symbol, opts)
724
+ > <Array(<SymbolSuccess>, Integer, Hash)> symbol_get_with_http_info(symbol, opts)
675
725
 
676
726
  ```ruby
677
727
  begin
678
728
  # 銘柄情報
679
- data, status_code, headers = api_instance.symbol_get_with_http_info(x_api_key, symbol, opts)
729
+ data, status_code, headers = api_instance.symbol_get_with_http_info(symbol, opts)
680
730
  p status_code # => 2xx
681
731
  p headers # => { ... }
682
732
  p data # => <SymbolSuccess>
@@ -689,7 +739,6 @@ end
689
739
 
690
740
  | Name | Type | Description | Notes |
691
741
  | ---- | ---- | ----------- | ----- |
692
- | **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
693
742
  | **symbol** | **String** | 銘柄コード &lt;br&gt; ※次の形式で入力してください。&lt;br&gt; [銘柄コード]@[市場コード]&lt;br&gt; ※市場コードは下記の定義値から選択してください。&lt;br&gt; ※SOR市場は取扱っておりませんのでご注意ください。&lt;b&gt;市場コード&lt;/b&gt;&lt;br&gt; &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;定義値&lt;/th&gt; &lt;th&gt;説明&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;1&lt;/td&gt; &lt;td&gt;東証&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;3&lt;/td&gt; &lt;td&gt;名証&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;5&lt;/td&gt; &lt;td&gt;福証&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;6&lt;/td&gt; &lt;td&gt;札証&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;2&lt;/td&gt; &lt;td&gt;日通し&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;23&lt;/td&gt; &lt;td&gt;日中&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;24&lt;/td&gt; &lt;td&gt;夜間&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; | |
694
743
  | **addinfo** | **String** | 追加情報出力フラグ(未指定時:true)&lt;br&gt; ※追加情報は、「時価総額」、「発行済み株式数」、「決算期日」、「清算値」を意味します。 &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;定義値&lt;/th&gt; &lt;th&gt;説明&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;true&lt;/td&gt; &lt;td&gt;追加情報を出力する&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;false&lt;/td&gt; &lt;td&gt;追加情報を出力しない&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; | [optional] |
695
744
 
@@ -699,7 +748,7 @@ end
699
748
 
700
749
  ### Authorization
701
750
 
702
- No authorization required
751
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
703
752
 
704
753
  ### HTTP request headers
705
754
 
@@ -709,7 +758,7 @@ No authorization required
709
758
 
710
759
  ## symbolname_future_get
711
760
 
712
- > <SymbolNameSuccess> symbolname_future_get(x_api_key, deriv_month, opts)
761
+ > <SymbolNameSuccess> symbolname_future_get(deriv_month, opts)
713
762
 
714
763
  先物銘柄コード取得
715
764
 
@@ -720,9 +769,15 @@ No authorization required
720
769
  ```ruby
721
770
  require 'time'
722
771
  require 'kabustation_client'
772
+ # setup authorization
773
+ KabustationClient.configure do |config|
774
+ # Configure API key authorization: ApiKeyAuth
775
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
776
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
777
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
778
+ end
723
779
 
724
780
  api_instance = KabustationClient::InfoApi.new
725
- x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
726
781
  deriv_month = 56 # Integer | 限月<br> ※限月はyyyyMM形式で指定します。0を指定した場合、直近限月となります。<br> ※取引最終日に「0」(直近限月)を指定した場合、日中・夜間の時間帯に関わらず、 取引最終日を迎える限月の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。<br>
727
782
  opts = {
728
783
  future_code: 'future_code_example' # String | 先物コード<br> ※大文字小文字は区別しません。 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>NK225</td> <td>日経平均先物</td> </tr> <tr> <td>NK225mini</td> <td>日経225mini先物</td> </tr> <tr> <td>TOPIX</td> <td>TOPIX先物</td> </tr> <tr> <td>TOPIXmini</td> <td>ミニTOPIX先物</td> </tr> <tr> <td>GROWTH</td> <td>グロース250先物</td> </tr> <tr> <td>JPX400</td> <td>JPX日経400先物</td> </tr> <tr> <td>DOW</td> <td>NYダウ先物</td> </tr> <tr> <td>VI</td> <td>日経平均VI先物</td> </tr> <tr> <td>Core30</td> <td>TOPIX Core30先物</td> </tr> <tr> <td>REIT</td> <td>東証REIT指数先物</td> </tr> <tr> <td>NK225micro</td> <td>日経225マイクロ先物</td> </tr> </tbody> </table>
@@ -730,7 +785,7 @@ opts = {
730
785
 
731
786
  begin
732
787
  # 先物銘柄コード取得
733
- result = api_instance.symbolname_future_get(x_api_key, deriv_month, opts)
788
+ result = api_instance.symbolname_future_get(deriv_month, opts)
734
789
  p result
735
790
  rescue KabustationClient::ApiError => e
736
791
  puts "Error when calling InfoApi->symbolname_future_get: #{e}"
@@ -741,12 +796,12 @@ end
741
796
 
742
797
  This returns an Array which contains the response data, status code and headers.
743
798
 
744
- > <Array(<SymbolNameSuccess>, Integer, Hash)> symbolname_future_get_with_http_info(x_api_key, deriv_month, opts)
799
+ > <Array(<SymbolNameSuccess>, Integer, Hash)> symbolname_future_get_with_http_info(deriv_month, opts)
745
800
 
746
801
  ```ruby
747
802
  begin
748
803
  # 先物銘柄コード取得
749
- data, status_code, headers = api_instance.symbolname_future_get_with_http_info(x_api_key, deriv_month, opts)
804
+ data, status_code, headers = api_instance.symbolname_future_get_with_http_info(deriv_month, opts)
750
805
  p status_code # => 2xx
751
806
  p headers # => { ... }
752
807
  p data # => <SymbolNameSuccess>
@@ -759,7 +814,6 @@ end
759
814
 
760
815
  | Name | Type | Description | Notes |
761
816
  | ---- | ---- | ----------- | ----- |
762
- | **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
763
817
  | **deriv_month** | **Integer** | 限月&lt;br&gt; ※限月はyyyyMM形式で指定します。0を指定した場合、直近限月となります。&lt;br&gt; ※取引最終日に「0」(直近限月)を指定した場合、日中・夜間の時間帯に関わらず、 取引最終日を迎える限月の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。&lt;br&gt; | |
764
818
  | **future_code** | **String** | 先物コード&lt;br&gt; ※大文字小文字は区別しません。 &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;定義値&lt;/th&gt; &lt;th&gt;説明&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;NK225&lt;/td&gt; &lt;td&gt;日経平均先物&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;NK225mini&lt;/td&gt; &lt;td&gt;日経225mini先物&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;TOPIX&lt;/td&gt; &lt;td&gt;TOPIX先物&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;TOPIXmini&lt;/td&gt; &lt;td&gt;ミニTOPIX先物&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;GROWTH&lt;/td&gt; &lt;td&gt;グロース250先物&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;JPX400&lt;/td&gt; &lt;td&gt;JPX日経400先物&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;DOW&lt;/td&gt; &lt;td&gt;NYダウ先物&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;VI&lt;/td&gt; &lt;td&gt;日経平均VI先物&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;Core30&lt;/td&gt; &lt;td&gt;TOPIX Core30先物&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;REIT&lt;/td&gt; &lt;td&gt;東証REIT指数先物&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;NK225micro&lt;/td&gt; &lt;td&gt;日経225マイクロ先物&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; | [optional] |
765
819
 
@@ -769,7 +823,7 @@ end
769
823
 
770
824
  ### Authorization
771
825
 
772
- No authorization required
826
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
773
827
 
774
828
  ### HTTP request headers
775
829
 
@@ -779,7 +833,7 @@ No authorization required
779
833
 
780
834
  ## symbolname_option_get
781
835
 
782
- > <SymbolNameSuccess> symbolname_option_get(x_api_key, deriv_month, put_or_call, strike_price, opts)
836
+ > <SymbolNameSuccess> symbolname_option_get(deriv_month, put_or_call, strike_price, opts)
783
837
 
784
838
  オプション銘柄コード取得
785
839
 
@@ -790,9 +844,15 @@ No authorization required
790
844
  ```ruby
791
845
  require 'time'
792
846
  require 'kabustation_client'
847
+ # setup authorization
848
+ KabustationClient.configure do |config|
849
+ # Configure API key authorization: ApiKeyAuth
850
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
851
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
852
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
853
+ end
793
854
 
794
855
  api_instance = KabustationClient::InfoApi.new
795
- x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
796
856
  deriv_month = 56 # Integer | 限月<br>※限月はyyyyMM形式で指定します。0を指定した場合、直近限月となります。<br>※取引最終日に「0」(直近限月)を指定した場合、日中・夜間の時間帯に関わらず、取引最終日を迎える限月の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。
797
857
  put_or_call = 'put_or_call_example' # String | コール or プット<br> ※大文字小文字は区別しません。 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>P</td> <td>PUT</td> </tr> <tr> <td>C</td> <td>CALL</td> </tr> </tbody> </table>
798
858
  strike_price = 56 # Integer | 権利行使価格<br>※0を指定した場合、APIを実行した時点でのATMとなります。
@@ -802,7 +862,7 @@ opts = {
802
862
 
803
863
  begin
804
864
  # オプション銘柄コード取得
805
- result = api_instance.symbolname_option_get(x_api_key, deriv_month, put_or_call, strike_price, opts)
865
+ result = api_instance.symbolname_option_get(deriv_month, put_or_call, strike_price, opts)
806
866
  p result
807
867
  rescue KabustationClient::ApiError => e
808
868
  puts "Error when calling InfoApi->symbolname_option_get: #{e}"
@@ -813,12 +873,12 @@ end
813
873
 
814
874
  This returns an Array which contains the response data, status code and headers.
815
875
 
816
- > <Array(<SymbolNameSuccess>, Integer, Hash)> symbolname_option_get_with_http_info(x_api_key, deriv_month, put_or_call, strike_price, opts)
876
+ > <Array(<SymbolNameSuccess>, Integer, Hash)> symbolname_option_get_with_http_info(deriv_month, put_or_call, strike_price, opts)
817
877
 
818
878
  ```ruby
819
879
  begin
820
880
  # オプション銘柄コード取得
821
- data, status_code, headers = api_instance.symbolname_option_get_with_http_info(x_api_key, deriv_month, put_or_call, strike_price, opts)
881
+ data, status_code, headers = api_instance.symbolname_option_get_with_http_info(deriv_month, put_or_call, strike_price, opts)
822
882
  p status_code # => 2xx
823
883
  p headers # => { ... }
824
884
  p data # => <SymbolNameSuccess>
@@ -831,7 +891,6 @@ end
831
891
 
832
892
  | Name | Type | Description | Notes |
833
893
  | ---- | ---- | ----------- | ----- |
834
- | **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
835
894
  | **deriv_month** | **Integer** | 限月&lt;br&gt;※限月はyyyyMM形式で指定します。0を指定した場合、直近限月となります。&lt;br&gt;※取引最終日に「0」(直近限月)を指定した場合、日中・夜間の時間帯に関わらず、取引最終日を迎える限月の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。 | |
836
895
  | **put_or_call** | **String** | コール or プット&lt;br&gt; ※大文字小文字は区別しません。 &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;定義値&lt;/th&gt; &lt;th&gt;説明&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;P&lt;/td&gt; &lt;td&gt;PUT&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;C&lt;/td&gt; &lt;td&gt;CALL&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; | |
837
896
  | **strike_price** | **Integer** | 権利行使価格&lt;br&gt;※0を指定した場合、APIを実行した時点でのATMとなります。 | |
@@ -843,7 +902,7 @@ end
843
902
 
844
903
  ### Authorization
845
904
 
846
- No authorization required
905
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
847
906
 
848
907
  ### HTTP request headers
849
908
 
@@ -853,7 +912,7 @@ No authorization required
853
912
 
854
913
  ## symbolname_option_mini_get
855
914
 
856
- > <SymbolNameSuccess> symbolname_option_mini_get(x_api_key, deriv_month, deriv_weekly, put_or_call, strike_price)
915
+ > <SymbolNameSuccess> symbolname_option_mini_get(deriv_month, deriv_weekly, put_or_call, strike_price)
857
916
 
858
917
  ミニオプション(限週)銘柄コード取得
859
918
 
@@ -864,9 +923,15 @@ No authorization required
864
923
  ```ruby
865
924
  require 'time'
866
925
  require 'kabustation_client'
926
+ # setup authorization
927
+ KabustationClient.configure do |config|
928
+ # Configure API key authorization: ApiKeyAuth
929
+ config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
930
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
931
+ # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
932
+ end
867
933
 
868
934
  api_instance = KabustationClient::InfoApi.new
869
- x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
870
935
  deriv_month = 56 # Integer | 限月<br>※限月はyyyyMM形式で指定します。0を指定した場合、直近限月となります。<br>※取引最終日に「0」(直近限月)を指定した場合、日中・夜間の時間帯に関わらず、取引最終日を迎える限月の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。
871
936
  deriv_weekly = 56 # Integer | 限週<br>※限週は0,1,3,4,5のいずれかを指定します。0を指定した場合、指定した限月の直近限週となります。<br>※取引最終日に「0」(直近限週)を指定した場合、日中・夜間の時間帯に関わらず、取引最終日を迎える限週の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。
872
937
  put_or_call = 'put_or_call_example' # String | コール or プット<br> ※大文字小文字は区別しません。 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>P</td> <td>PUT</td> </tr> <tr> <td>C</td> <td>CALL</td> </tr> </tbody> </table>
@@ -874,7 +939,7 @@ strike_price = 56 # Integer | 権利行使価格<br>※0を指定した場合、
874
939
 
875
940
  begin
876
941
  # ミニオプション(限週)銘柄コード取得
877
- result = api_instance.symbolname_option_mini_get(x_api_key, deriv_month, deriv_weekly, put_or_call, strike_price)
942
+ result = api_instance.symbolname_option_mini_get(deriv_month, deriv_weekly, put_or_call, strike_price)
878
943
  p result
879
944
  rescue KabustationClient::ApiError => e
880
945
  puts "Error when calling InfoApi->symbolname_option_mini_get: #{e}"
@@ -885,12 +950,12 @@ end
885
950
 
886
951
  This returns an Array which contains the response data, status code and headers.
887
952
 
888
- > <Array(<SymbolNameSuccess>, Integer, Hash)> symbolname_option_mini_get_with_http_info(x_api_key, deriv_month, deriv_weekly, put_or_call, strike_price)
953
+ > <Array(<SymbolNameSuccess>, Integer, Hash)> symbolname_option_mini_get_with_http_info(deriv_month, deriv_weekly, put_or_call, strike_price)
889
954
 
890
955
  ```ruby
891
956
  begin
892
957
  # ミニオプション(限週)銘柄コード取得
893
- data, status_code, headers = api_instance.symbolname_option_mini_get_with_http_info(x_api_key, deriv_month, deriv_weekly, put_or_call, strike_price)
958
+ data, status_code, headers = api_instance.symbolname_option_mini_get_with_http_info(deriv_month, deriv_weekly, put_or_call, strike_price)
894
959
  p status_code # => 2xx
895
960
  p headers # => { ... }
896
961
  p data # => <SymbolNameSuccess>
@@ -903,7 +968,6 @@ end
903
968
 
904
969
  | Name | Type | Description | Notes |
905
970
  | ---- | ---- | ----------- | ----- |
906
- | **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
907
971
  | **deriv_month** | **Integer** | 限月&lt;br&gt;※限月はyyyyMM形式で指定します。0を指定した場合、直近限月となります。&lt;br&gt;※取引最終日に「0」(直近限月)を指定した場合、日中・夜間の時間帯に関わらず、取引最終日を迎える限月の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。 | |
908
972
  | **deriv_weekly** | **Integer** | 限週&lt;br&gt;※限週は0,1,3,4,5のいずれかを指定します。0を指定した場合、指定した限月の直近限週となります。&lt;br&gt;※取引最終日に「0」(直近限週)を指定した場合、日中・夜間の時間帯に関わらず、取引最終日を迎える限週の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。 | |
909
973
  | **put_or_call** | **String** | コール or プット&lt;br&gt; ※大文字小文字は区別しません。 &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;定義値&lt;/th&gt; &lt;th&gt;説明&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;P&lt;/td&gt; &lt;td&gt;PUT&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;C&lt;/td&gt; &lt;td&gt;CALL&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; | |
@@ -915,7 +979,7 @@ end
915
979
 
916
980
  ### Authorization
917
981
 
918
- No authorization required
982
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
919
983
 
920
984
  ### HTTP request headers
921
985