kabustation_client 1.0.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.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +188 -0
- data/Rakefile +10 -0
- data/docs/ApiSoftLimitResponse.md +32 -0
- data/docs/AuthApi.md +72 -0
- data/docs/BoardSuccess.md +142 -0
- data/docs/BoardSuccessBuy1.md +24 -0
- data/docs/BoardSuccessBuy10.md +20 -0
- data/docs/BoardSuccessBuy2.md +20 -0
- data/docs/BoardSuccessBuy3.md +20 -0
- data/docs/BoardSuccessBuy4.md +20 -0
- data/docs/BoardSuccessBuy5.md +20 -0
- data/docs/BoardSuccessBuy6.md +20 -0
- data/docs/BoardSuccessBuy7.md +20 -0
- data/docs/BoardSuccessBuy8.md +20 -0
- data/docs/BoardSuccessBuy9.md +20 -0
- data/docs/BoardSuccessSell1.md +24 -0
- data/docs/BoardSuccessSell10.md +20 -0
- data/docs/BoardSuccessSell2.md +20 -0
- data/docs/BoardSuccessSell3.md +20 -0
- data/docs/BoardSuccessSell4.md +20 -0
- data/docs/BoardSuccessSell5.md +20 -0
- data/docs/BoardSuccessSell6.md +20 -0
- data/docs/BoardSuccessSell7.md +20 -0
- data/docs/BoardSuccessSell8.md +20 -0
- data/docs/BoardSuccessSell9.md +20 -0
- data/docs/ErrorResponse.md +20 -0
- data/docs/ExchangeResponse.md +28 -0
- data/docs/InfoApi.md +924 -0
- data/docs/MarginPremiumResponse.md +22 -0
- data/docs/MarginPremiumResponseDayTrade.md +26 -0
- data/docs/MarginPremiumResponseGeneralMargin.md +26 -0
- data/docs/OrderApi.md +275 -0
- data/docs/OrderSuccess.md +20 -0
- data/docs/OrdersSuccess.md +58 -0
- data/docs/OrdersSuccessDetailsInner.md +44 -0
- data/docs/Positions.md +20 -0
- data/docs/PositionsDeriv.md +20 -0
- data/docs/PositionsSuccess.md +58 -0
- data/docs/PrimaryExchangeResponse.md +20 -0
- data/docs/RankingByCategoryResponse.md +22 -0
- data/docs/RankingByCategoryResponseRankingInner.md +34 -0
- data/docs/RankingByMarginResponse.md +22 -0
- data/docs/RankingByMarginResponseRankingInner.md +36 -0
- data/docs/RankingByTickCountResponse.md +22 -0
- data/docs/RankingByTickCountResponseRankingInner.md +46 -0
- data/docs/RankingByTradeValueResponse.md +22 -0
- data/docs/RankingByTradeValueResponseRankingInner.md +42 -0
- data/docs/RankingByTradeVolumeResponse.md +22 -0
- data/docs/RankingByTradeVolumeResponseRankingInner.md +42 -0
- data/docs/RankingDefaultResponse.md +22 -0
- data/docs/RankingDefaultResponseRankingInner.md +42 -0
- data/docs/RankingGet200Response.md +57 -0
- data/docs/RegistSuccess.md +18 -0
- data/docs/RegisterApi.md +206 -0
- data/docs/RegulationsResponse.md +20 -0
- data/docs/RegulationsResponseRegulationsInfoInner.md +30 -0
- data/docs/RequestCancelOrder.md +20 -0
- data/docs/RequestRegister.md +18 -0
- data/docs/RequestRegisterSymbolsInner.md +20 -0
- data/docs/RequestSendOrder.md +52 -0
- data/docs/RequestSendOrderDerivFuture.md +42 -0
- data/docs/RequestSendOrderDerivFutureReverseLimitOrder.md +24 -0
- data/docs/RequestSendOrderDerivOption.md +42 -0
- data/docs/RequestSendOrderReverseLimitOrder.md +26 -0
- data/docs/RequestToken.md +18 -0
- data/docs/RequestUnregister.md +18 -0
- data/docs/SymbolNameSuccess.md +20 -0
- data/docs/SymbolSuccess.md +64 -0
- data/docs/TokenSuccess.md +20 -0
- data/docs/UnregisterAllSuccess.md +18 -0
- data/docs/WalletApi.md +535 -0
- data/docs/WalletCashSuccess.md +22 -0
- data/docs/WalletFutureSuccess.md +22 -0
- data/docs/WalletMarginSuccess.md +24 -0
- data/docs/WalletOptionSuccess.md +22 -0
- data/git_push.sh +57 -0
- data/kabustation_client.gemspec +39 -0
- data/lib/kabustation_client/api/auth_api.rb +90 -0
- data/lib/kabustation_client/api/info_api.rb +1044 -0
- data/lib/kabustation_client/api/order_api.rb +322 -0
- data/lib/kabustation_client/api/register_api.rb +236 -0
- data/lib/kabustation_client/api/wallet_api.rb +558 -0
- data/lib/kabustation_client/api_client.rb +393 -0
- data/lib/kabustation_client/api_error.rb +58 -0
- data/lib/kabustation_client/configuration.rb +295 -0
- data/lib/kabustation_client/models/api_soft_limit_response.rb +285 -0
- data/lib/kabustation_client/models/board_success.rb +816 -0
- data/lib/kabustation_client/models/board_success_buy1.rb +246 -0
- data/lib/kabustation_client/models/board_success_buy10.rb +226 -0
- data/lib/kabustation_client/models/board_success_buy2.rb +226 -0
- data/lib/kabustation_client/models/board_success_buy3.rb +226 -0
- data/lib/kabustation_client/models/board_success_buy4.rb +226 -0
- data/lib/kabustation_client/models/board_success_buy5.rb +226 -0
- data/lib/kabustation_client/models/board_success_buy6.rb +226 -0
- data/lib/kabustation_client/models/board_success_buy7.rb +226 -0
- data/lib/kabustation_client/models/board_success_buy8.rb +226 -0
- data/lib/kabustation_client/models/board_success_buy9.rb +226 -0
- data/lib/kabustation_client/models/board_success_sell1.rb +246 -0
- data/lib/kabustation_client/models/board_success_sell10.rb +226 -0
- data/lib/kabustation_client/models/board_success_sell2.rb +226 -0
- data/lib/kabustation_client/models/board_success_sell3.rb +226 -0
- data/lib/kabustation_client/models/board_success_sell4.rb +226 -0
- data/lib/kabustation_client/models/board_success_sell5.rb +226 -0
- data/lib/kabustation_client/models/board_success_sell6.rb +226 -0
- data/lib/kabustation_client/models/board_success_sell7.rb +226 -0
- data/lib/kabustation_client/models/board_success_sell8.rb +226 -0
- data/lib/kabustation_client/models/board_success_sell9.rb +226 -0
- data/lib/kabustation_client/models/error_response.rb +225 -0
- data/lib/kabustation_client/models/exchange_response.rb +265 -0
- data/lib/kabustation_client/models/margin_premium_response.rb +233 -0
- data/lib/kabustation_client/models/margin_premium_response_day_trade.rb +256 -0
- data/lib/kabustation_client/models/margin_premium_response_general_margin.rb +256 -0
- data/lib/kabustation_client/models/order_success.rb +225 -0
- data/lib/kabustation_client/models/orders_success.rb +417 -0
- data/lib/kabustation_client/models/orders_success_details_inner.rb +345 -0
- data/lib/kabustation_client/models/positions.rb +225 -0
- data/lib/kabustation_client/models/positions_deriv.rb +225 -0
- data/lib/kabustation_client/models/positions_success.rb +415 -0
- data/lib/kabustation_client/models/primary_exchange_response.rb +225 -0
- data/lib/kabustation_client/models/ranking_by_category_response.rb +237 -0
- data/lib/kabustation_client/models/ranking_by_category_response_ranking_inner.rb +295 -0
- data/lib/kabustation_client/models/ranking_by_margin_response.rb +237 -0
- data/lib/kabustation_client/models/ranking_by_margin_response_ranking_inner.rb +305 -0
- data/lib/kabustation_client/models/ranking_by_tick_count_response.rb +237 -0
- data/lib/kabustation_client/models/ranking_by_tick_count_response_ranking_inner.rb +355 -0
- data/lib/kabustation_client/models/ranking_by_trade_value_response.rb +237 -0
- data/lib/kabustation_client/models/ranking_by_trade_value_response_ranking_inner.rb +335 -0
- data/lib/kabustation_client/models/ranking_by_trade_volume_response.rb +237 -0
- data/lib/kabustation_client/models/ranking_by_trade_volume_response_ranking_inner.rb +335 -0
- data/lib/kabustation_client/models/ranking_default_response.rb +237 -0
- data/lib/kabustation_client/models/ranking_default_response_ranking_inner.rb +335 -0
- data/lib/kabustation_client/models/ranking_get200_response.rb +109 -0
- data/lib/kabustation_client/models/regist_success.rb +217 -0
- data/lib/kabustation_client/models/regulations_response.rb +227 -0
- data/lib/kabustation_client/models/regulations_response_regulations_info_inner.rb +275 -0
- data/lib/kabustation_client/models/request_cancel_order.rb +239 -0
- data/lib/kabustation_client/models/request_register.rb +216 -0
- data/lib/kabustation_client/models/request_register_symbols_inner.rb +225 -0
- data/lib/kabustation_client/models/request_send_order.rb +470 -0
- data/lib/kabustation_client/models/request_send_order_deriv_future.rb +406 -0
- data/lib/kabustation_client/models/request_send_order_deriv_future_reverse_limit_order.rb +274 -0
- data/lib/kabustation_client/models/request_send_order_deriv_option.rb +406 -0
- data/lib/kabustation_client/models/request_send_order_reverse_limit_order.rb +291 -0
- data/lib/kabustation_client/models/request_token.rb +222 -0
- data/lib/kabustation_client/models/request_unregister.rb +217 -0
- data/lib/kabustation_client/models/symbol_name_success.rb +225 -0
- data/lib/kabustation_client/models/symbol_success.rb +445 -0
- data/lib/kabustation_client/models/token_success.rb +225 -0
- data/lib/kabustation_client/models/unregister_all_success.rb +215 -0
- data/lib/kabustation_client/models/wallet_cash_success.rb +235 -0
- data/lib/kabustation_client/models/wallet_future_success.rb +235 -0
- data/lib/kabustation_client/models/wallet_margin_success.rb +245 -0
- data/lib/kabustation_client/models/wallet_option_success.rb +235 -0
- data/lib/kabustation_client/version.rb +15 -0
- data/lib/kabustation_client.rb +112 -0
- data/spec/api/auth_api_spec.rb +47 -0
- data/spec/api/info_api_spec.rb +222 -0
- data/spec/api/order_api_spec.rb +87 -0
- data/spec/api/register_api_spec.rb +73 -0
- data/spec/api/wallet_api_spec.rb +135 -0
- data/spec/models/api_soft_limit_response_spec.rb +78 -0
- data/spec/models/board_success_buy10_spec.rb +42 -0
- data/spec/models/board_success_buy1_spec.rb +54 -0
- data/spec/models/board_success_buy2_spec.rb +42 -0
- data/spec/models/board_success_buy3_spec.rb +42 -0
- data/spec/models/board_success_buy4_spec.rb +42 -0
- data/spec/models/board_success_buy5_spec.rb +42 -0
- data/spec/models/board_success_buy6_spec.rb +42 -0
- data/spec/models/board_success_buy7_spec.rb +42 -0
- data/spec/models/board_success_buy8_spec.rb +42 -0
- data/spec/models/board_success_buy9_spec.rb +42 -0
- data/spec/models/board_success_sell10_spec.rb +42 -0
- data/spec/models/board_success_sell1_spec.rb +54 -0
- data/spec/models/board_success_sell2_spec.rb +42 -0
- data/spec/models/board_success_sell3_spec.rb +42 -0
- data/spec/models/board_success_sell4_spec.rb +42 -0
- data/spec/models/board_success_sell5_spec.rb +42 -0
- data/spec/models/board_success_sell6_spec.rb +42 -0
- data/spec/models/board_success_sell7_spec.rb +42 -0
- data/spec/models/board_success_sell8_spec.rb +42 -0
- data/spec/models/board_success_sell9_spec.rb +42 -0
- data/spec/models/board_success_spec.rb +408 -0
- data/spec/models/error_response_spec.rb +42 -0
- data/spec/models/exchange_response_spec.rb +66 -0
- data/spec/models/margin_premium_response_day_trade_spec.rb +60 -0
- data/spec/models/margin_premium_response_general_margin_spec.rb +60 -0
- data/spec/models/margin_premium_response_spec.rb +48 -0
- data/spec/models/order_success_spec.rb +42 -0
- data/spec/models/orders_success_details_inner_spec.rb +114 -0
- data/spec/models/orders_success_spec.rb +156 -0
- data/spec/models/positions_deriv_spec.rb +42 -0
- data/spec/models/positions_spec.rb +42 -0
- data/spec/models/positions_success_spec.rb +156 -0
- data/spec/models/primary_exchange_response_spec.rb +42 -0
- data/spec/models/ranking_by_category_response_ranking_inner_spec.rb +84 -0
- data/spec/models/ranking_by_category_response_spec.rb +48 -0
- data/spec/models/ranking_by_margin_response_ranking_inner_spec.rb +90 -0
- data/spec/models/ranking_by_margin_response_spec.rb +48 -0
- data/spec/models/ranking_by_tick_count_response_ranking_inner_spec.rb +120 -0
- data/spec/models/ranking_by_tick_count_response_spec.rb +48 -0
- data/spec/models/ranking_by_trade_value_response_ranking_inner_spec.rb +108 -0
- data/spec/models/ranking_by_trade_value_response_spec.rb +48 -0
- data/spec/models/ranking_by_trade_volume_response_ranking_inner_spec.rb +108 -0
- data/spec/models/ranking_by_trade_volume_response_spec.rb +48 -0
- data/spec/models/ranking_default_response_ranking_inner_spec.rb +108 -0
- data/spec/models/ranking_default_response_spec.rb +48 -0
- data/spec/models/ranking_get200_response_spec.rb +32 -0
- data/spec/models/regist_success_spec.rb +36 -0
- data/spec/models/regulations_response_regulations_info_inner_spec.rb +72 -0
- data/spec/models/regulations_response_spec.rb +42 -0
- data/spec/models/request_cancel_order_spec.rb +42 -0
- data/spec/models/request_register_spec.rb +36 -0
- data/spec/models/request_register_symbols_inner_spec.rb +42 -0
- data/spec/models/request_send_order_deriv_future_reverse_limit_order_spec.rb +54 -0
- data/spec/models/request_send_order_deriv_future_spec.rb +108 -0
- data/spec/models/request_send_order_deriv_option_spec.rb +108 -0
- data/spec/models/request_send_order_reverse_limit_order_spec.rb +60 -0
- data/spec/models/request_send_order_spec.rb +138 -0
- data/spec/models/request_token_spec.rb +36 -0
- data/spec/models/request_unregister_spec.rb +36 -0
- data/spec/models/symbol_name_success_spec.rb +42 -0
- data/spec/models/symbol_success_spec.rb +174 -0
- data/spec/models/token_success_spec.rb +42 -0
- data/spec/models/unregister_all_success_spec.rb +36 -0
- data/spec/models/wallet_cash_success_spec.rb +48 -0
- data/spec/models/wallet_future_success_spec.rb +48 -0
- data/spec/models/wallet_margin_success_spec.rb +54 -0
- data/spec/models/wallet_option_success_spec.rb +48 -0
- data/spec/spec_helper.rb +111 -0
- metadata +387 -0
data/docs/InfoApi.md
ADDED
|
@@ -0,0 +1,924 @@
|
|
|
1
|
+
# KabustationClient::InfoApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:18080/kabusapi*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**apisoftlimit_get**](InfoApi.md#apisoftlimit_get) | **GET** /apisoftlimit | ソフトリミット |
|
|
8
|
+
| [**board_get**](InfoApi.md#board_get) | **GET** /board/{symbol} | 時価情報・板情報 |
|
|
9
|
+
| [**exchange_get**](InfoApi.md#exchange_get) | **GET** /exchange/{symbol} | 為替情報 |
|
|
10
|
+
| [**marginpremium_get**](InfoApi.md#marginpremium_get) | **GET** /margin/marginpremium/{symbol} | プレミアム料取得 |
|
|
11
|
+
| [**orders_get**](InfoApi.md#orders_get) | **GET** /orders | 注文約定照会 |
|
|
12
|
+
| [**positions_get**](InfoApi.md#positions_get) | **GET** /positions | 残高照会 |
|
|
13
|
+
| [**primary_exchange_get**](InfoApi.md#primary_exchange_get) | **GET** /primaryexchange/{symbol} | 優先市場 |
|
|
14
|
+
| [**ranking_get**](InfoApi.md#ranking_get) | **GET** /ranking | 詳細ランキング |
|
|
15
|
+
| [**regulations_get**](InfoApi.md#regulations_get) | **GET** /regulations/{symbol} | 規制情報 |
|
|
16
|
+
| [**symbol_get**](InfoApi.md#symbol_get) | **GET** /symbol/{symbol} | 銘柄情報 |
|
|
17
|
+
| [**symbolname_future_get**](InfoApi.md#symbolname_future_get) | **GET** /symbolname/future | 先物銘柄コード取得 |
|
|
18
|
+
| [**symbolname_option_get**](InfoApi.md#symbolname_option_get) | **GET** /symbolname/option | オプション銘柄コード取得 |
|
|
19
|
+
| [**symbolname_option_mini_get**](InfoApi.md#symbolname_option_mini_get) | **GET** /symbolname/minioptionweekly | ミニオプション(限週)銘柄コード取得 |
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
## apisoftlimit_get
|
|
23
|
+
|
|
24
|
+
> <ApiSoftLimitResponse> apisoftlimit_get(x_api_key)
|
|
25
|
+
|
|
26
|
+
ソフトリミット
|
|
27
|
+
|
|
28
|
+
kabuステーションAPIのソフトリミット値を取得する
|
|
29
|
+
|
|
30
|
+
### Examples
|
|
31
|
+
|
|
32
|
+
```ruby
|
|
33
|
+
require 'time'
|
|
34
|
+
require 'kabustation_client'
|
|
35
|
+
|
|
36
|
+
api_instance = KabustationClient::InfoApi.new
|
|
37
|
+
x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
|
|
38
|
+
|
|
39
|
+
begin
|
|
40
|
+
# ソフトリミット
|
|
41
|
+
result = api_instance.apisoftlimit_get(x_api_key)
|
|
42
|
+
p result
|
|
43
|
+
rescue KabustationClient::ApiError => e
|
|
44
|
+
puts "Error when calling InfoApi->apisoftlimit_get: #{e}"
|
|
45
|
+
end
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
#### Using the apisoftlimit_get_with_http_info variant
|
|
49
|
+
|
|
50
|
+
This returns an Array which contains the response data, status code and headers.
|
|
51
|
+
|
|
52
|
+
> <Array(<ApiSoftLimitResponse>, Integer, Hash)> apisoftlimit_get_with_http_info(x_api_key)
|
|
53
|
+
|
|
54
|
+
```ruby
|
|
55
|
+
begin
|
|
56
|
+
# ソフトリミット
|
|
57
|
+
data, status_code, headers = api_instance.apisoftlimit_get_with_http_info(x_api_key)
|
|
58
|
+
p status_code # => 2xx
|
|
59
|
+
p headers # => { ... }
|
|
60
|
+
p data # => <ApiSoftLimitResponse>
|
|
61
|
+
rescue KabustationClient::ApiError => e
|
|
62
|
+
puts "Error when calling InfoApi->apisoftlimit_get_with_http_info: #{e}"
|
|
63
|
+
end
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Parameters
|
|
67
|
+
|
|
68
|
+
| Name | Type | Description | Notes |
|
|
69
|
+
| ---- | ---- | ----------- | ----- |
|
|
70
|
+
| **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
|
|
71
|
+
|
|
72
|
+
### Return type
|
|
73
|
+
|
|
74
|
+
[**ApiSoftLimitResponse**](ApiSoftLimitResponse.md)
|
|
75
|
+
|
|
76
|
+
### Authorization
|
|
77
|
+
|
|
78
|
+
No authorization required
|
|
79
|
+
|
|
80
|
+
### HTTP request headers
|
|
81
|
+
|
|
82
|
+
- **Content-Type**: Not defined
|
|
83
|
+
- **Accept**: application/json
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
## board_get
|
|
87
|
+
|
|
88
|
+
> <BoardSuccess> board_get(x_api_key, symbol)
|
|
89
|
+
|
|
90
|
+
時価情報・板情報
|
|
91
|
+
|
|
92
|
+
指定した銘柄の時価情報・板情報を取得します<br> レスポンスの一部にnullが発生した場合、該当銘柄を銘柄登録をしてから、 <br>再度時価情報・板情報APIを実行してください。
|
|
93
|
+
|
|
94
|
+
### Examples
|
|
95
|
+
|
|
96
|
+
```ruby
|
|
97
|
+
require 'time'
|
|
98
|
+
require 'kabustation_client'
|
|
99
|
+
|
|
100
|
+
api_instance = KabustationClient::InfoApi.new
|
|
101
|
+
x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
|
|
102
|
+
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
|
+
|
|
104
|
+
begin
|
|
105
|
+
# 時価情報・板情報
|
|
106
|
+
result = api_instance.board_get(x_api_key, symbol)
|
|
107
|
+
p result
|
|
108
|
+
rescue KabustationClient::ApiError => e
|
|
109
|
+
puts "Error when calling InfoApi->board_get: #{e}"
|
|
110
|
+
end
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
#### Using the board_get_with_http_info variant
|
|
114
|
+
|
|
115
|
+
This returns an Array which contains the response data, status code and headers.
|
|
116
|
+
|
|
117
|
+
> <Array(<BoardSuccess>, Integer, Hash)> board_get_with_http_info(x_api_key, symbol)
|
|
118
|
+
|
|
119
|
+
```ruby
|
|
120
|
+
begin
|
|
121
|
+
# 時価情報・板情報
|
|
122
|
+
data, status_code, headers = api_instance.board_get_with_http_info(x_api_key, symbol)
|
|
123
|
+
p status_code # => 2xx
|
|
124
|
+
p headers # => { ... }
|
|
125
|
+
p data # => <BoardSuccess>
|
|
126
|
+
rescue KabustationClient::ApiError => e
|
|
127
|
+
puts "Error when calling InfoApi->board_get_with_http_info: #{e}"
|
|
128
|
+
end
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Parameters
|
|
132
|
+
|
|
133
|
+
| Name | Type | Description | Notes |
|
|
134
|
+
| ---- | ---- | ----------- | ----- |
|
|
135
|
+
| **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
|
|
136
|
+
| **symbol** | **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> | |
|
|
137
|
+
|
|
138
|
+
### Return type
|
|
139
|
+
|
|
140
|
+
[**BoardSuccess**](BoardSuccess.md)
|
|
141
|
+
|
|
142
|
+
### Authorization
|
|
143
|
+
|
|
144
|
+
No authorization required
|
|
145
|
+
|
|
146
|
+
### HTTP request headers
|
|
147
|
+
|
|
148
|
+
- **Content-Type**: Not defined
|
|
149
|
+
- **Accept**: application/json
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
## exchange_get
|
|
153
|
+
|
|
154
|
+
> <ExchangeResponse> exchange_get(x_api_key, symbol)
|
|
155
|
+
|
|
156
|
+
為替情報
|
|
157
|
+
|
|
158
|
+
マネービューの情報を取得する
|
|
159
|
+
|
|
160
|
+
### Examples
|
|
161
|
+
|
|
162
|
+
```ruby
|
|
163
|
+
require 'time'
|
|
164
|
+
require 'kabustation_client'
|
|
165
|
+
|
|
166
|
+
api_instance = KabustationClient::InfoApi.new
|
|
167
|
+
x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
|
|
168
|
+
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
|
+
|
|
170
|
+
begin
|
|
171
|
+
# 為替情報
|
|
172
|
+
result = api_instance.exchange_get(x_api_key, symbol)
|
|
173
|
+
p result
|
|
174
|
+
rescue KabustationClient::ApiError => e
|
|
175
|
+
puts "Error when calling InfoApi->exchange_get: #{e}"
|
|
176
|
+
end
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
#### Using the exchange_get_with_http_info variant
|
|
180
|
+
|
|
181
|
+
This returns an Array which contains the response data, status code and headers.
|
|
182
|
+
|
|
183
|
+
> <Array(<ExchangeResponse>, Integer, Hash)> exchange_get_with_http_info(x_api_key, symbol)
|
|
184
|
+
|
|
185
|
+
```ruby
|
|
186
|
+
begin
|
|
187
|
+
# 為替情報
|
|
188
|
+
data, status_code, headers = api_instance.exchange_get_with_http_info(x_api_key, symbol)
|
|
189
|
+
p status_code # => 2xx
|
|
190
|
+
p headers # => { ... }
|
|
191
|
+
p data # => <ExchangeResponse>
|
|
192
|
+
rescue KabustationClient::ApiError => e
|
|
193
|
+
puts "Error when calling InfoApi->exchange_get_with_http_info: #{e}"
|
|
194
|
+
end
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### Parameters
|
|
198
|
+
|
|
199
|
+
| Name | Type | Description | Notes |
|
|
200
|
+
| ---- | ---- | ----------- | ----- |
|
|
201
|
+
| **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
|
|
202
|
+
| **symbol** | **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> | |
|
|
203
|
+
|
|
204
|
+
### Return type
|
|
205
|
+
|
|
206
|
+
[**ExchangeResponse**](ExchangeResponse.md)
|
|
207
|
+
|
|
208
|
+
### Authorization
|
|
209
|
+
|
|
210
|
+
No authorization required
|
|
211
|
+
|
|
212
|
+
### HTTP request headers
|
|
213
|
+
|
|
214
|
+
- **Content-Type**: Not defined
|
|
215
|
+
- **Accept**: application/json
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
## marginpremium_get
|
|
219
|
+
|
|
220
|
+
> <MarginPremiumResponse> marginpremium_get(x_api_key, symbol)
|
|
221
|
+
|
|
222
|
+
プレミアム料取得
|
|
223
|
+
|
|
224
|
+
指定した銘柄のプレミアム料を取得するAPI
|
|
225
|
+
|
|
226
|
+
### Examples
|
|
227
|
+
|
|
228
|
+
```ruby
|
|
229
|
+
require 'time'
|
|
230
|
+
require 'kabustation_client'
|
|
231
|
+
|
|
232
|
+
api_instance = KabustationClient::InfoApi.new
|
|
233
|
+
x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
|
|
234
|
+
symbol = 'symbol_example' # String | 銘柄コード
|
|
235
|
+
|
|
236
|
+
begin
|
|
237
|
+
# プレミアム料取得
|
|
238
|
+
result = api_instance.marginpremium_get(x_api_key, symbol)
|
|
239
|
+
p result
|
|
240
|
+
rescue KabustationClient::ApiError => e
|
|
241
|
+
puts "Error when calling InfoApi->marginpremium_get: #{e}"
|
|
242
|
+
end
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
#### Using the marginpremium_get_with_http_info variant
|
|
246
|
+
|
|
247
|
+
This returns an Array which contains the response data, status code and headers.
|
|
248
|
+
|
|
249
|
+
> <Array(<MarginPremiumResponse>, Integer, Hash)> marginpremium_get_with_http_info(x_api_key, symbol)
|
|
250
|
+
|
|
251
|
+
```ruby
|
|
252
|
+
begin
|
|
253
|
+
# プレミアム料取得
|
|
254
|
+
data, status_code, headers = api_instance.marginpremium_get_with_http_info(x_api_key, symbol)
|
|
255
|
+
p status_code # => 2xx
|
|
256
|
+
p headers # => { ... }
|
|
257
|
+
p data # => <MarginPremiumResponse>
|
|
258
|
+
rescue KabustationClient::ApiError => e
|
|
259
|
+
puts "Error when calling InfoApi->marginpremium_get_with_http_info: #{e}"
|
|
260
|
+
end
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
### Parameters
|
|
264
|
+
|
|
265
|
+
| Name | Type | Description | Notes |
|
|
266
|
+
| ---- | ---- | ----------- | ----- |
|
|
267
|
+
| **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
|
|
268
|
+
| **symbol** | **String** | 銘柄コード | |
|
|
269
|
+
|
|
270
|
+
### Return type
|
|
271
|
+
|
|
272
|
+
[**MarginPremiumResponse**](MarginPremiumResponse.md)
|
|
273
|
+
|
|
274
|
+
### Authorization
|
|
275
|
+
|
|
276
|
+
No authorization required
|
|
277
|
+
|
|
278
|
+
### HTTP request headers
|
|
279
|
+
|
|
280
|
+
- **Content-Type**: Not defined
|
|
281
|
+
- **Accept**: application/json
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
## orders_get
|
|
285
|
+
|
|
286
|
+
> <Array<OrdersSuccess>> orders_get(x_api_key, opts)
|
|
287
|
+
|
|
288
|
+
注文約定照会
|
|
289
|
+
|
|
290
|
+
注文一覧を取得します。<br> ※下記Queryパラメータは任意設定となります。
|
|
291
|
+
|
|
292
|
+
### Examples
|
|
293
|
+
|
|
294
|
+
```ruby
|
|
295
|
+
require 'time'
|
|
296
|
+
require 'kabustation_client'
|
|
297
|
+
|
|
298
|
+
api_instance = KabustationClient::InfoApi.new
|
|
299
|
+
x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
|
|
300
|
+
opts = {
|
|
301
|
+
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
|
+
id: 'id_example', # String | 注文番号<br> ※指定された注文番号と一致する注文のみレスポンスします。<br> ※指定された注文番号との比較では大文字小文字を区別しません。<br> ※複数の注文番号を指定することはできません。
|
|
303
|
+
updtime: 'updtime_example', # String | 更新日時<br> ※形式:yyyyMMddHHmmss (例:20201201123456)<br> ※指定された更新日時以降(指定日時含む)に更新された注文のみレスポンスします。<br> ※複数の更新日時を指定することはできません。
|
|
304
|
+
details: 'details_example', # String | 注文詳細抑止 <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>
|
|
305
|
+
symbol: 'symbol_example', # String | 銘柄コード<br>※指定された銘柄コードと一致する注文のみレスポンスします。<br>※複数の銘柄コードを指定することができません。
|
|
306
|
+
state: '1', # String | 状態<br> ※指定された状態と一致する注文のみレスポンスします。<br> ※フィルタには数字の入力のみ受け付けます。<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>終了(発注エラー・取消済・全約定・失効・期限切れ)</td> </tr> </tbody> </table>
|
|
307
|
+
side: '1', # String | 売買区分<br> ※指定された売買区分と一致する注文のみレスポンスします。<br> ※フィルタには数字の入力のみ受け付けます。<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> </tbody> </table>
|
|
308
|
+
cashmargin: '2' # String | 取引区分<br> ※指定された取引区分と一致する注文のみレスポンスします。<br> ※フィルタには数字の入力のみ受け付けます。<br> ※複数の取引区分を指定することができません。 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>2</td> <td>新規</td> </tr> <tr> <td>3</td> <td>返済</td> </tr> </tbody> </table>
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
begin
|
|
312
|
+
# 注文約定照会
|
|
313
|
+
result = api_instance.orders_get(x_api_key, opts)
|
|
314
|
+
p result
|
|
315
|
+
rescue KabustationClient::ApiError => e
|
|
316
|
+
puts "Error when calling InfoApi->orders_get: #{e}"
|
|
317
|
+
end
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
#### Using the orders_get_with_http_info variant
|
|
321
|
+
|
|
322
|
+
This returns an Array which contains the response data, status code and headers.
|
|
323
|
+
|
|
324
|
+
> <Array(<Array<OrdersSuccess>>, Integer, Hash)> orders_get_with_http_info(x_api_key, opts)
|
|
325
|
+
|
|
326
|
+
```ruby
|
|
327
|
+
begin
|
|
328
|
+
# 注文約定照会
|
|
329
|
+
data, status_code, headers = api_instance.orders_get_with_http_info(x_api_key, opts)
|
|
330
|
+
p status_code # => 2xx
|
|
331
|
+
p headers # => { ... }
|
|
332
|
+
p data # => <Array<OrdersSuccess>>
|
|
333
|
+
rescue KabustationClient::ApiError => e
|
|
334
|
+
puts "Error when calling InfoApi->orders_get_with_http_info: #{e}"
|
|
335
|
+
end
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
### Parameters
|
|
339
|
+
|
|
340
|
+
| Name | Type | Description | Notes |
|
|
341
|
+
| ---- | ---- | ----------- | ----- |
|
|
342
|
+
| **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
|
|
343
|
+
| **product** | **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> | [optional] |
|
|
344
|
+
| **id** | **String** | 注文番号<br> ※指定された注文番号と一致する注文のみレスポンスします。<br> ※指定された注文番号との比較では大文字小文字を区別しません。<br> ※複数の注文番号を指定することはできません。 | [optional] |
|
|
345
|
+
| **updtime** | **String** | 更新日時<br> ※形式:yyyyMMddHHmmss (例:20201201123456)<br> ※指定された更新日時以降(指定日時含む)に更新された注文のみレスポンスします。<br> ※複数の更新日時を指定することはできません。 | [optional] |
|
|
346
|
+
| **details** | **String** | 注文詳細抑止 <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> | [optional] |
|
|
347
|
+
| **symbol** | **String** | 銘柄コード<br>※指定された銘柄コードと一致する注文のみレスポンスします。<br>※複数の銘柄コードを指定することができません。 | [optional] |
|
|
348
|
+
| **state** | **String** | 状態<br> ※指定された状態と一致する注文のみレスポンスします。<br> ※フィルタには数字の入力のみ受け付けます。<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>終了(発注エラー・取消済・全約定・失効・期限切れ)</td> </tr> </tbody> </table> | [optional] |
|
|
349
|
+
| **side** | **String** | 売買区分<br> ※指定された売買区分と一致する注文のみレスポンスします。<br> ※フィルタには数字の入力のみ受け付けます。<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> </tbody> </table> | [optional] |
|
|
350
|
+
| **cashmargin** | **String** | 取引区分<br> ※指定された取引区分と一致する注文のみレスポンスします。<br> ※フィルタには数字の入力のみ受け付けます。<br> ※複数の取引区分を指定することができません。 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>2</td> <td>新規</td> </tr> <tr> <td>3</td> <td>返済</td> </tr> </tbody> </table> | [optional] |
|
|
351
|
+
|
|
352
|
+
### Return type
|
|
353
|
+
|
|
354
|
+
[**Array<OrdersSuccess>**](OrdersSuccess.md)
|
|
355
|
+
|
|
356
|
+
### Authorization
|
|
357
|
+
|
|
358
|
+
No authorization required
|
|
359
|
+
|
|
360
|
+
### HTTP request headers
|
|
361
|
+
|
|
362
|
+
- **Content-Type**: Not defined
|
|
363
|
+
- **Accept**: application/json
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
## positions_get
|
|
367
|
+
|
|
368
|
+
> <Array<PositionsSuccess>> positions_get(x_api_key, opts)
|
|
369
|
+
|
|
370
|
+
残高照会
|
|
371
|
+
|
|
372
|
+
残高一覧を取得します。<br>※下記Queryパラメータは任意設定となります。
|
|
373
|
+
|
|
374
|
+
### Examples
|
|
375
|
+
|
|
376
|
+
```ruby
|
|
377
|
+
require 'time'
|
|
378
|
+
require 'kabustation_client'
|
|
379
|
+
|
|
380
|
+
api_instance = KabustationClient::InfoApi.new
|
|
381
|
+
x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
|
|
382
|
+
opts = {
|
|
383
|
+
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
|
+
symbol: 'symbol_example', # String | 銘柄コード<br>※指定された銘柄コードと一致するポジションのみレスポンスします。<br>※複数の銘柄コードを指定することはできません。
|
|
385
|
+
side: '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> </tbody> </table>
|
|
386
|
+
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>
|
|
387
|
+
}
|
|
388
|
+
|
|
389
|
+
begin
|
|
390
|
+
# 残高照会
|
|
391
|
+
result = api_instance.positions_get(x_api_key, opts)
|
|
392
|
+
p result
|
|
393
|
+
rescue KabustationClient::ApiError => e
|
|
394
|
+
puts "Error when calling InfoApi->positions_get: #{e}"
|
|
395
|
+
end
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
#### Using the positions_get_with_http_info variant
|
|
399
|
+
|
|
400
|
+
This returns an Array which contains the response data, status code and headers.
|
|
401
|
+
|
|
402
|
+
> <Array(<Array<PositionsSuccess>>, Integer, Hash)> positions_get_with_http_info(x_api_key, opts)
|
|
403
|
+
|
|
404
|
+
```ruby
|
|
405
|
+
begin
|
|
406
|
+
# 残高照会
|
|
407
|
+
data, status_code, headers = api_instance.positions_get_with_http_info(x_api_key, opts)
|
|
408
|
+
p status_code # => 2xx
|
|
409
|
+
p headers # => { ... }
|
|
410
|
+
p data # => <Array<PositionsSuccess>>
|
|
411
|
+
rescue KabustationClient::ApiError => e
|
|
412
|
+
puts "Error when calling InfoApi->positions_get_with_http_info: #{e}"
|
|
413
|
+
end
|
|
414
|
+
```
|
|
415
|
+
|
|
416
|
+
### Parameters
|
|
417
|
+
|
|
418
|
+
| Name | Type | Description | Notes |
|
|
419
|
+
| ---- | ---- | ----------- | ----- |
|
|
420
|
+
| **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
|
|
421
|
+
| **product** | **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> | [optional] |
|
|
422
|
+
| **symbol** | **String** | 銘柄コード<br>※指定された銘柄コードと一致するポジションのみレスポンスします。<br>※複数の銘柄コードを指定することはできません。 | [optional] |
|
|
423
|
+
| **side** | **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> </tbody> </table> | [optional] |
|
|
424
|
+
| **addinfo** | **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> | [optional] |
|
|
425
|
+
|
|
426
|
+
### Return type
|
|
427
|
+
|
|
428
|
+
[**Array<PositionsSuccess>**](PositionsSuccess.md)
|
|
429
|
+
|
|
430
|
+
### Authorization
|
|
431
|
+
|
|
432
|
+
No authorization required
|
|
433
|
+
|
|
434
|
+
### HTTP request headers
|
|
435
|
+
|
|
436
|
+
- **Content-Type**: Not defined
|
|
437
|
+
- **Accept**: application/json
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
## primary_exchange_get
|
|
441
|
+
|
|
442
|
+
> <PrimaryExchangeResponse> primary_exchange_get(x_api_key, symbol)
|
|
443
|
+
|
|
444
|
+
優先市場
|
|
445
|
+
|
|
446
|
+
株式の優先市場を取得する
|
|
447
|
+
|
|
448
|
+
### Examples
|
|
449
|
+
|
|
450
|
+
```ruby
|
|
451
|
+
require 'time'
|
|
452
|
+
require 'kabustation_client'
|
|
453
|
+
|
|
454
|
+
api_instance = KabustationClient::InfoApi.new
|
|
455
|
+
x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
|
|
456
|
+
symbol = 'symbol_example' # String | 銘柄コード
|
|
457
|
+
|
|
458
|
+
begin
|
|
459
|
+
# 優先市場
|
|
460
|
+
result = api_instance.primary_exchange_get(x_api_key, symbol)
|
|
461
|
+
p result
|
|
462
|
+
rescue KabustationClient::ApiError => e
|
|
463
|
+
puts "Error when calling InfoApi->primary_exchange_get: #{e}"
|
|
464
|
+
end
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
#### Using the primary_exchange_get_with_http_info variant
|
|
468
|
+
|
|
469
|
+
This returns an Array which contains the response data, status code and headers.
|
|
470
|
+
|
|
471
|
+
> <Array(<PrimaryExchangeResponse>, Integer, Hash)> primary_exchange_get_with_http_info(x_api_key, symbol)
|
|
472
|
+
|
|
473
|
+
```ruby
|
|
474
|
+
begin
|
|
475
|
+
# 優先市場
|
|
476
|
+
data, status_code, headers = api_instance.primary_exchange_get_with_http_info(x_api_key, symbol)
|
|
477
|
+
p status_code # => 2xx
|
|
478
|
+
p headers # => { ... }
|
|
479
|
+
p data # => <PrimaryExchangeResponse>
|
|
480
|
+
rescue KabustationClient::ApiError => e
|
|
481
|
+
puts "Error when calling InfoApi->primary_exchange_get_with_http_info: #{e}"
|
|
482
|
+
end
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
### Parameters
|
|
486
|
+
|
|
487
|
+
| Name | Type | Description | Notes |
|
|
488
|
+
| ---- | ---- | ----------- | ----- |
|
|
489
|
+
| **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
|
|
490
|
+
| **symbol** | **String** | 銘柄コード | |
|
|
491
|
+
|
|
492
|
+
### Return type
|
|
493
|
+
|
|
494
|
+
[**PrimaryExchangeResponse**](PrimaryExchangeResponse.md)
|
|
495
|
+
|
|
496
|
+
### Authorization
|
|
497
|
+
|
|
498
|
+
No authorization required
|
|
499
|
+
|
|
500
|
+
### HTTP request headers
|
|
501
|
+
|
|
502
|
+
- **Content-Type**: Not defined
|
|
503
|
+
- **Accept**: application/json
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
## ranking_get
|
|
507
|
+
|
|
508
|
+
> <RankingGet200Response> ranking_get(x_api_key, type, exchange_division)
|
|
509
|
+
|
|
510
|
+
詳細ランキング
|
|
511
|
+
|
|
512
|
+
詳細ランキング画面と同様の各種ランキングを返します。 <br>ランキングの対象日はkabuステーションが保持している当日のデータとなります。 <br>※株価情報ランキング、業種別指数ランキングは、下記の時間帯でデータがクリアされるため、 <br>その間の詳細ランキングAPIは空レスポンスとなります。 <br>データクリア:平日7:53頃-9:00過ぎ頃 <br>※信用情報ランキングは毎週第3営業日の7:55頃にデータが更新されます。
|
|
513
|
+
|
|
514
|
+
### Examples
|
|
515
|
+
|
|
516
|
+
```ruby
|
|
517
|
+
require 'time'
|
|
518
|
+
require 'kabustation_client'
|
|
519
|
+
|
|
520
|
+
api_instance = KabustationClient::InfoApi.new
|
|
521
|
+
x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
|
|
522
|
+
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
|
+
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
|
+
|
|
525
|
+
begin
|
|
526
|
+
# 詳細ランキング
|
|
527
|
+
result = api_instance.ranking_get(x_api_key, type, exchange_division)
|
|
528
|
+
p result
|
|
529
|
+
rescue KabustationClient::ApiError => e
|
|
530
|
+
puts "Error when calling InfoApi->ranking_get: #{e}"
|
|
531
|
+
end
|
|
532
|
+
```
|
|
533
|
+
|
|
534
|
+
#### Using the ranking_get_with_http_info variant
|
|
535
|
+
|
|
536
|
+
This returns an Array which contains the response data, status code and headers.
|
|
537
|
+
|
|
538
|
+
> <Array(<RankingGet200Response>, Integer, Hash)> ranking_get_with_http_info(x_api_key, type, exchange_division)
|
|
539
|
+
|
|
540
|
+
```ruby
|
|
541
|
+
begin
|
|
542
|
+
# 詳細ランキング
|
|
543
|
+
data, status_code, headers = api_instance.ranking_get_with_http_info(x_api_key, type, exchange_division)
|
|
544
|
+
p status_code # => 2xx
|
|
545
|
+
p headers # => { ... }
|
|
546
|
+
p data # => <RankingGet200Response>
|
|
547
|
+
rescue KabustationClient::ApiError => e
|
|
548
|
+
puts "Error when calling InfoApi->ranking_get_with_http_info: #{e}"
|
|
549
|
+
end
|
|
550
|
+
```
|
|
551
|
+
|
|
552
|
+
### Parameters
|
|
553
|
+
|
|
554
|
+
| Name | Type | Description | Notes |
|
|
555
|
+
| ---- | ---- | ----------- | ----- |
|
|
556
|
+
| **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
|
|
557
|
+
| **type** | **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> | |
|
|
558
|
+
| **exchange_division** | **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> | |
|
|
559
|
+
|
|
560
|
+
### Return type
|
|
561
|
+
|
|
562
|
+
[**RankingGet200Response**](RankingGet200Response.md)
|
|
563
|
+
|
|
564
|
+
### Authorization
|
|
565
|
+
|
|
566
|
+
No authorization required
|
|
567
|
+
|
|
568
|
+
### HTTP request headers
|
|
569
|
+
|
|
570
|
+
- **Content-Type**: Not defined
|
|
571
|
+
- **Accept**: application/json
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
## regulations_get
|
|
575
|
+
|
|
576
|
+
> <RegulationsResponse> regulations_get(x_api_key, symbol)
|
|
577
|
+
|
|
578
|
+
規制情報
|
|
579
|
+
|
|
580
|
+
規制情報+空売り規制情報を取得する
|
|
581
|
+
|
|
582
|
+
### Examples
|
|
583
|
+
|
|
584
|
+
```ruby
|
|
585
|
+
require 'time'
|
|
586
|
+
require 'kabustation_client'
|
|
587
|
+
|
|
588
|
+
api_instance = KabustationClient::InfoApi.new
|
|
589
|
+
x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
|
|
590
|
+
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
|
+
|
|
592
|
+
begin
|
|
593
|
+
# 規制情報
|
|
594
|
+
result = api_instance.regulations_get(x_api_key, symbol)
|
|
595
|
+
p result
|
|
596
|
+
rescue KabustationClient::ApiError => e
|
|
597
|
+
puts "Error when calling InfoApi->regulations_get: #{e}"
|
|
598
|
+
end
|
|
599
|
+
```
|
|
600
|
+
|
|
601
|
+
#### Using the regulations_get_with_http_info variant
|
|
602
|
+
|
|
603
|
+
This returns an Array which contains the response data, status code and headers.
|
|
604
|
+
|
|
605
|
+
> <Array(<RegulationsResponse>, Integer, Hash)> regulations_get_with_http_info(x_api_key, symbol)
|
|
606
|
+
|
|
607
|
+
```ruby
|
|
608
|
+
begin
|
|
609
|
+
# 規制情報
|
|
610
|
+
data, status_code, headers = api_instance.regulations_get_with_http_info(x_api_key, symbol)
|
|
611
|
+
p status_code # => 2xx
|
|
612
|
+
p headers # => { ... }
|
|
613
|
+
p data # => <RegulationsResponse>
|
|
614
|
+
rescue KabustationClient::ApiError => e
|
|
615
|
+
puts "Error when calling InfoApi->regulations_get_with_http_info: #{e}"
|
|
616
|
+
end
|
|
617
|
+
```
|
|
618
|
+
|
|
619
|
+
### Parameters
|
|
620
|
+
|
|
621
|
+
| Name | Type | Description | Notes |
|
|
622
|
+
| ---- | ---- | ----------- | ----- |
|
|
623
|
+
| **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
|
|
624
|
+
| **symbol** | **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> | |
|
|
625
|
+
|
|
626
|
+
### Return type
|
|
627
|
+
|
|
628
|
+
[**RegulationsResponse**](RegulationsResponse.md)
|
|
629
|
+
|
|
630
|
+
### Authorization
|
|
631
|
+
|
|
632
|
+
No authorization required
|
|
633
|
+
|
|
634
|
+
### HTTP request headers
|
|
635
|
+
|
|
636
|
+
- **Content-Type**: Not defined
|
|
637
|
+
- **Accept**: application/json
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
## symbol_get
|
|
641
|
+
|
|
642
|
+
> <SymbolSuccess> symbol_get(x_api_key, symbol, opts)
|
|
643
|
+
|
|
644
|
+
銘柄情報
|
|
645
|
+
|
|
646
|
+
指定した銘柄情報を取得します
|
|
647
|
+
|
|
648
|
+
### Examples
|
|
649
|
+
|
|
650
|
+
```ruby
|
|
651
|
+
require 'time'
|
|
652
|
+
require 'kabustation_client'
|
|
653
|
+
|
|
654
|
+
api_instance = KabustationClient::InfoApi.new
|
|
655
|
+
x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
|
|
656
|
+
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
|
+
opts = {
|
|
658
|
+
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>
|
|
659
|
+
}
|
|
660
|
+
|
|
661
|
+
begin
|
|
662
|
+
# 銘柄情報
|
|
663
|
+
result = api_instance.symbol_get(x_api_key, symbol, opts)
|
|
664
|
+
p result
|
|
665
|
+
rescue KabustationClient::ApiError => e
|
|
666
|
+
puts "Error when calling InfoApi->symbol_get: #{e}"
|
|
667
|
+
end
|
|
668
|
+
```
|
|
669
|
+
|
|
670
|
+
#### Using the symbol_get_with_http_info variant
|
|
671
|
+
|
|
672
|
+
This returns an Array which contains the response data, status code and headers.
|
|
673
|
+
|
|
674
|
+
> <Array(<SymbolSuccess>, Integer, Hash)> symbol_get_with_http_info(x_api_key, symbol, opts)
|
|
675
|
+
|
|
676
|
+
```ruby
|
|
677
|
+
begin
|
|
678
|
+
# 銘柄情報
|
|
679
|
+
data, status_code, headers = api_instance.symbol_get_with_http_info(x_api_key, symbol, opts)
|
|
680
|
+
p status_code # => 2xx
|
|
681
|
+
p headers # => { ... }
|
|
682
|
+
p data # => <SymbolSuccess>
|
|
683
|
+
rescue KabustationClient::ApiError => e
|
|
684
|
+
puts "Error when calling InfoApi->symbol_get_with_http_info: #{e}"
|
|
685
|
+
end
|
|
686
|
+
```
|
|
687
|
+
|
|
688
|
+
### Parameters
|
|
689
|
+
|
|
690
|
+
| Name | Type | Description | Notes |
|
|
691
|
+
| ---- | ---- | ----------- | ----- |
|
|
692
|
+
| **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
|
|
693
|
+
| **symbol** | **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> | |
|
|
694
|
+
| **addinfo** | **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> | [optional] |
|
|
695
|
+
|
|
696
|
+
### Return type
|
|
697
|
+
|
|
698
|
+
[**SymbolSuccess**](SymbolSuccess.md)
|
|
699
|
+
|
|
700
|
+
### Authorization
|
|
701
|
+
|
|
702
|
+
No authorization required
|
|
703
|
+
|
|
704
|
+
### HTTP request headers
|
|
705
|
+
|
|
706
|
+
- **Content-Type**: Not defined
|
|
707
|
+
- **Accept**: application/json
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
## symbolname_future_get
|
|
711
|
+
|
|
712
|
+
> <SymbolNameSuccess> symbolname_future_get(x_api_key, deriv_month, opts)
|
|
713
|
+
|
|
714
|
+
先物銘柄コード取得
|
|
715
|
+
|
|
716
|
+
先物銘柄コード取得
|
|
717
|
+
|
|
718
|
+
### Examples
|
|
719
|
+
|
|
720
|
+
```ruby
|
|
721
|
+
require 'time'
|
|
722
|
+
require 'kabustation_client'
|
|
723
|
+
|
|
724
|
+
api_instance = KabustationClient::InfoApi.new
|
|
725
|
+
x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
|
|
726
|
+
deriv_month = 56 # Integer | 限月<br> ※限月はyyyyMM形式で指定します。0を指定した場合、直近限月となります。<br> ※取引最終日に「0」(直近限月)を指定した場合、日中・夜間の時間帯に関わらず、 取引最終日を迎える限月の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。<br>
|
|
727
|
+
opts = {
|
|
728
|
+
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>
|
|
729
|
+
}
|
|
730
|
+
|
|
731
|
+
begin
|
|
732
|
+
# 先物銘柄コード取得
|
|
733
|
+
result = api_instance.symbolname_future_get(x_api_key, deriv_month, opts)
|
|
734
|
+
p result
|
|
735
|
+
rescue KabustationClient::ApiError => e
|
|
736
|
+
puts "Error when calling InfoApi->symbolname_future_get: #{e}"
|
|
737
|
+
end
|
|
738
|
+
```
|
|
739
|
+
|
|
740
|
+
#### Using the symbolname_future_get_with_http_info variant
|
|
741
|
+
|
|
742
|
+
This returns an Array which contains the response data, status code and headers.
|
|
743
|
+
|
|
744
|
+
> <Array(<SymbolNameSuccess>, Integer, Hash)> symbolname_future_get_with_http_info(x_api_key, deriv_month, opts)
|
|
745
|
+
|
|
746
|
+
```ruby
|
|
747
|
+
begin
|
|
748
|
+
# 先物銘柄コード取得
|
|
749
|
+
data, status_code, headers = api_instance.symbolname_future_get_with_http_info(x_api_key, deriv_month, opts)
|
|
750
|
+
p status_code # => 2xx
|
|
751
|
+
p headers # => { ... }
|
|
752
|
+
p data # => <SymbolNameSuccess>
|
|
753
|
+
rescue KabustationClient::ApiError => e
|
|
754
|
+
puts "Error when calling InfoApi->symbolname_future_get_with_http_info: #{e}"
|
|
755
|
+
end
|
|
756
|
+
```
|
|
757
|
+
|
|
758
|
+
### Parameters
|
|
759
|
+
|
|
760
|
+
| Name | Type | Description | Notes |
|
|
761
|
+
| ---- | ---- | ----------- | ----- |
|
|
762
|
+
| **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
|
|
763
|
+
| **deriv_month** | **Integer** | 限月<br> ※限月はyyyyMM形式で指定します。0を指定した場合、直近限月となります。<br> ※取引最終日に「0」(直近限月)を指定した場合、日中・夜間の時間帯に関わらず、 取引最終日を迎える限月の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。<br> | |
|
|
764
|
+
| **future_code** | **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> | [optional] |
|
|
765
|
+
|
|
766
|
+
### Return type
|
|
767
|
+
|
|
768
|
+
[**SymbolNameSuccess**](SymbolNameSuccess.md)
|
|
769
|
+
|
|
770
|
+
### Authorization
|
|
771
|
+
|
|
772
|
+
No authorization required
|
|
773
|
+
|
|
774
|
+
### HTTP request headers
|
|
775
|
+
|
|
776
|
+
- **Content-Type**: Not defined
|
|
777
|
+
- **Accept**: application/json
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
## symbolname_option_get
|
|
781
|
+
|
|
782
|
+
> <SymbolNameSuccess> symbolname_option_get(x_api_key, deriv_month, put_or_call, strike_price, opts)
|
|
783
|
+
|
|
784
|
+
オプション銘柄コード取得
|
|
785
|
+
|
|
786
|
+
オプション銘柄コード取得
|
|
787
|
+
|
|
788
|
+
### Examples
|
|
789
|
+
|
|
790
|
+
```ruby
|
|
791
|
+
require 'time'
|
|
792
|
+
require 'kabustation_client'
|
|
793
|
+
|
|
794
|
+
api_instance = KabustationClient::InfoApi.new
|
|
795
|
+
x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
|
|
796
|
+
deriv_month = 56 # Integer | 限月<br>※限月はyyyyMM形式で指定します。0を指定した場合、直近限月となります。<br>※取引最終日に「0」(直近限月)を指定した場合、日中・夜間の時間帯に関わらず、取引最終日を迎える限月の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。
|
|
797
|
+
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
|
+
strike_price = 56 # Integer | 権利行使価格<br>※0を指定した場合、APIを実行した時点でのATMとなります。
|
|
799
|
+
opts = {
|
|
800
|
+
option_code: 'option_code_example' # String | オプションコード<br> ※指定なしの場合は、日経225オプションを対象とする。<br> <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>NK225op</td> <td>日経225オプション</td> </tr> <tr> <td>NK225miniop</td> <td>日経225ミニオプション</td> </tr> </tbody> </table>
|
|
801
|
+
}
|
|
802
|
+
|
|
803
|
+
begin
|
|
804
|
+
# オプション銘柄コード取得
|
|
805
|
+
result = api_instance.symbolname_option_get(x_api_key, deriv_month, put_or_call, strike_price, opts)
|
|
806
|
+
p result
|
|
807
|
+
rescue KabustationClient::ApiError => e
|
|
808
|
+
puts "Error when calling InfoApi->symbolname_option_get: #{e}"
|
|
809
|
+
end
|
|
810
|
+
```
|
|
811
|
+
|
|
812
|
+
#### Using the symbolname_option_get_with_http_info variant
|
|
813
|
+
|
|
814
|
+
This returns an Array which contains the response data, status code and headers.
|
|
815
|
+
|
|
816
|
+
> <Array(<SymbolNameSuccess>, Integer, Hash)> symbolname_option_get_with_http_info(x_api_key, deriv_month, put_or_call, strike_price, opts)
|
|
817
|
+
|
|
818
|
+
```ruby
|
|
819
|
+
begin
|
|
820
|
+
# オプション銘柄コード取得
|
|
821
|
+
data, status_code, headers = api_instance.symbolname_option_get_with_http_info(x_api_key, deriv_month, put_or_call, strike_price, opts)
|
|
822
|
+
p status_code # => 2xx
|
|
823
|
+
p headers # => { ... }
|
|
824
|
+
p data # => <SymbolNameSuccess>
|
|
825
|
+
rescue KabustationClient::ApiError => e
|
|
826
|
+
puts "Error when calling InfoApi->symbolname_option_get_with_http_info: #{e}"
|
|
827
|
+
end
|
|
828
|
+
```
|
|
829
|
+
|
|
830
|
+
### Parameters
|
|
831
|
+
|
|
832
|
+
| Name | Type | Description | Notes |
|
|
833
|
+
| ---- | ---- | ----------- | ----- |
|
|
834
|
+
| **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
|
|
835
|
+
| **deriv_month** | **Integer** | 限月<br>※限月はyyyyMM形式で指定します。0を指定した場合、直近限月となります。<br>※取引最終日に「0」(直近限月)を指定した場合、日中・夜間の時間帯に関わらず、取引最終日を迎える限月の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。 | |
|
|
836
|
+
| **put_or_call** | **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> | |
|
|
837
|
+
| **strike_price** | **Integer** | 権利行使価格<br>※0を指定した場合、APIを実行した時点でのATMとなります。 | |
|
|
838
|
+
| **option_code** | **String** | オプションコード<br> ※指定なしの場合は、日経225オプションを対象とする。<br> <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>NK225op</td> <td>日経225オプション</td> </tr> <tr> <td>NK225miniop</td> <td>日経225ミニオプション</td> </tr> </tbody> </table> | [optional] |
|
|
839
|
+
|
|
840
|
+
### Return type
|
|
841
|
+
|
|
842
|
+
[**SymbolNameSuccess**](SymbolNameSuccess.md)
|
|
843
|
+
|
|
844
|
+
### Authorization
|
|
845
|
+
|
|
846
|
+
No authorization required
|
|
847
|
+
|
|
848
|
+
### HTTP request headers
|
|
849
|
+
|
|
850
|
+
- **Content-Type**: Not defined
|
|
851
|
+
- **Accept**: application/json
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
## symbolname_option_mini_get
|
|
855
|
+
|
|
856
|
+
> <SymbolNameSuccess> symbolname_option_mini_get(x_api_key, deriv_month, deriv_weekly, put_or_call, strike_price)
|
|
857
|
+
|
|
858
|
+
ミニオプション(限週)銘柄コード取得
|
|
859
|
+
|
|
860
|
+
ミニオプション(限週)銘柄コード取得
|
|
861
|
+
|
|
862
|
+
### Examples
|
|
863
|
+
|
|
864
|
+
```ruby
|
|
865
|
+
require 'time'
|
|
866
|
+
require 'kabustation_client'
|
|
867
|
+
|
|
868
|
+
api_instance = KabustationClient::InfoApi.new
|
|
869
|
+
x_api_key = 'x_api_key_example' # String | トークン発行メソッドで取得した文字列
|
|
870
|
+
deriv_month = 56 # Integer | 限月<br>※限月はyyyyMM形式で指定します。0を指定した場合、直近限月となります。<br>※取引最終日に「0」(直近限月)を指定した場合、日中・夜間の時間帯に関わらず、取引最終日を迎える限月の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。
|
|
871
|
+
deriv_weekly = 56 # Integer | 限週<br>※限週は0,1,3,4,5のいずれかを指定します。0を指定した場合、指定した限月の直近限週となります。<br>※取引最終日に「0」(直近限週)を指定した場合、日中・夜間の時間帯に関わらず、取引最終日を迎える限週の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。
|
|
872
|
+
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>
|
|
873
|
+
strike_price = 56 # Integer | 権利行使価格<br>※0を指定した場合、APIを実行した時点でのATMとなります。
|
|
874
|
+
|
|
875
|
+
begin
|
|
876
|
+
# ミニオプション(限週)銘柄コード取得
|
|
877
|
+
result = api_instance.symbolname_option_mini_get(x_api_key, deriv_month, deriv_weekly, put_or_call, strike_price)
|
|
878
|
+
p result
|
|
879
|
+
rescue KabustationClient::ApiError => e
|
|
880
|
+
puts "Error when calling InfoApi->symbolname_option_mini_get: #{e}"
|
|
881
|
+
end
|
|
882
|
+
```
|
|
883
|
+
|
|
884
|
+
#### Using the symbolname_option_mini_get_with_http_info variant
|
|
885
|
+
|
|
886
|
+
This returns an Array which contains the response data, status code and headers.
|
|
887
|
+
|
|
888
|
+
> <Array(<SymbolNameSuccess>, Integer, Hash)> symbolname_option_mini_get_with_http_info(x_api_key, deriv_month, deriv_weekly, put_or_call, strike_price)
|
|
889
|
+
|
|
890
|
+
```ruby
|
|
891
|
+
begin
|
|
892
|
+
# ミニオプション(限週)銘柄コード取得
|
|
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)
|
|
894
|
+
p status_code # => 2xx
|
|
895
|
+
p headers # => { ... }
|
|
896
|
+
p data # => <SymbolNameSuccess>
|
|
897
|
+
rescue KabustationClient::ApiError => e
|
|
898
|
+
puts "Error when calling InfoApi->symbolname_option_mini_get_with_http_info: #{e}"
|
|
899
|
+
end
|
|
900
|
+
```
|
|
901
|
+
|
|
902
|
+
### Parameters
|
|
903
|
+
|
|
904
|
+
| Name | Type | Description | Notes |
|
|
905
|
+
| ---- | ---- | ----------- | ----- |
|
|
906
|
+
| **x_api_key** | **String** | トークン発行メソッドで取得した文字列 | |
|
|
907
|
+
| **deriv_month** | **Integer** | 限月<br>※限月はyyyyMM形式で指定します。0を指定した場合、直近限月となります。<br>※取引最終日に「0」(直近限月)を指定した場合、日中・夜間の時間帯に関わらず、取引最終日を迎える限月の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。 | |
|
|
908
|
+
| **deriv_weekly** | **Integer** | 限週<br>※限週は0,1,3,4,5のいずれかを指定します。0を指定した場合、指定した限月の直近限週となります。<br>※取引最終日に「0」(直近限週)を指定した場合、日中・夜間の時間帯に関わらず、取引最終日を迎える限週の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。 | |
|
|
909
|
+
| **put_or_call** | **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> | |
|
|
910
|
+
| **strike_price** | **Integer** | 権利行使価格<br>※0を指定した場合、APIを実行した時点でのATMとなります。 | |
|
|
911
|
+
|
|
912
|
+
### Return type
|
|
913
|
+
|
|
914
|
+
[**SymbolNameSuccess**](SymbolNameSuccess.md)
|
|
915
|
+
|
|
916
|
+
### Authorization
|
|
917
|
+
|
|
918
|
+
No authorization required
|
|
919
|
+
|
|
920
|
+
### HTTP request headers
|
|
921
|
+
|
|
922
|
+
- **Content-Type**: Not defined
|
|
923
|
+
- **Accept**: application/json
|
|
924
|
+
|