zaifapi クラス : ActivePositions(string,string,string) メソッド
説明
未約定注文一覧を取得します。
構文
zaifapiInstance.ActivePositions(string type, string groupId, string currencyPair)
引数
| クラス | 名前 | 説明 |
| string | type | "margin" か "futures"。 |
| string | groupId | グループ識別子。 |
| string | currencyPair | 通貨ペア。 |
返り値
| クラス | 説明 |
| zaifres | 要求に対する応答、JSON文字列を持つ。 |
サンプルコード
| 1: | string apiKey = "3622c294-zs5m-587w-vv7j-sdf454h1sdbl"; |
| 2: | string secretKey = "4be789k3-dd7r-9d23-jy45-qng4c83hjk1g"; |
| 3: | zaifapi zaifapiIns = new zaifapi(apiKey, secretKey); |
| 4: | zaifres zaifresIns = zaifapiIns.ActivePositions("futures", "1", "btc_jpy"); |
| 5: | string jsonStr = zaifresIns.Result; |
JSON-text 例
| {"success": 1, "return": {"6185413": {"group_id": 1, "currency_pair": "btc_jpy", "action": "bid", "amount": 0.001, "price": 810000.0, "limit": 860000.0, "stop": 780000.0, "timestamp": "1558280346", "leverage": 5.0, "fee_spent": 0.0, "deposit_jpy": 176.14}}} |
| {"success": 1, "return": {}} |
注意
レバレッジ取引APIです。API キーと、秘密キーを設定しなければ情報を取得できません。
type 引数に "margin" を指定した場合は現物の信用取引の未約定注文一覧が返ります。この場合、groupId 引数には空文字列を指定してください。
type 引数に "futures" を指定した場合は AirFX の未約定注文一覧が返ります。この場合、groupId 引数には "1" を指定してください。
currencyPair 引数に空文字列を指定した場合、全通貨ペアの未約定注文一覧が返ります。ただし、レバレッジ取引は "btc_jpy" だけで有効なので "btc_jpy" を指定したのと同じ結果になります。
要求に対する応答として zaifres クラスのインスタンスが返ります。このインスタンスが応答の結果の JSON-text を保持しています。
API エラーが発生した場合、以下の様な JSON-text が返ります。
{"success": 0, "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" は、それぞれの例外で異なります。