zaifapi クラス : Groups(string) メソッド
説明
先物取引の情報を取得します。
構文
zaifapiInstance.Groups(string groupId)
引数
| クラス | 名前 | 説明 |
| string | groupId | グループ識別子。 |
返り値
| クラス | 説明 |
| zaifres | 要求に対する応答、JSON文字列を持つ。 |
サンプルコード
| 1: | zaifapi zaifapiIns = new zaifapi(); |
| 2: | zaifres zaifresIns = zaifapiIns.Groups("all"); |
| 3: | string jsonStr = zaifresIns.Result; |
JSON-text 例
| groupId : "all" |
| [{"id": 1, "currency_pair": "btc_jpy", "start_timestamp": 1490972400, "end_timestamp": 4102412399, "use_swap": true}, {"id": 2, "currency_pair": "btc_jpy", "start_timestamp": 1490972400, "end_timestamp": 1498834800, "use_swap": false}, {"id": 3, "currency_pair": "btc_jpy", "start_timestamp": 1496242800, "end_timestamp": 1506783600, "use_swap": false}, {"id": 4, "currency_pair": "btc_jpy", "start_timestamp": 1504191600, "end_timestamp": 1514732400, "use_swap": false}, {"id": 5, "currency_pair": "btc_jpy", "start_timestamp": 1512054000, "end_timestamp": 1522508400, "use_swap": false}] |
| groupId : "active" |
| [{"id": 1, "currency_pair": "btc_jpy", "start_timestamp": 1490972400, "end_timestamp": 4102412399, "use_swap": true}] |
| groupId : "1" |
| [{"id": 1, "currency_pair": "btc_jpy", "start_timestamp": 1490972400, "end_timestamp": 4102412399, "use_swap": true}] |
注意
先物公開APIです。API キーと秘密キーを設定しなくても情報を取得できます。
groupId 引数には "all" か "active" か "1" 以上の数値文字列を指定してください。
groupId 引数に "all" を指定すると全ての先物取引の情報が返ります。終了している先物取引も含まれていることに注意してください。
groupId 引数に "active" を指定するとアクティブな先物取引の情報が返ります。アクティブな先物取引は AirFXだけなので AirFX の情報が返ります。
groupId 引数に "1" を指定すると AirFX の情報が返ります。
groupId 引数に "2" 以上の数値文字列を指定した場合、終了している先物取引に該当するものがあれば、その情報が返ります。
要求に対する応答として zaifres クラスのインスタンスが返ります。このインスタンスが応答の結果の JSON-text を保持しています。
API エラーが発生した場合、以下の様な JSON-text が返ります。
{"error": "..."}
"error" は、それぞれの API エラーで異なります。
HTTP エラーが発生した場合、以下の様な JSON-text が返ります。
{"success": -1000,"error": { "statuscode" : 404, "message": "Not Found"}}
"statuscode" と "message" は、それぞれの HTTP エラーで異なります。
要求がタイムアウトした場合、以下の JSON-text が返ります。
{"success": -1001,"error": { "typename" : "TaskCanceledException", "message": "タスクが取り消されました。"}}
その他の例外が発生して要求が失敗した場合、以下の様な JSON-text が返ります。
{"success": -1002,"error": { "typename" : "...", "message": "..."}}
"typename" と "message" は、それぞれの例外で異なります。