zaifapi class : CancelPosition(string,string,string) method
Description
Cancels an order.
Syntax
zaifapiInstance.CancelPosition(string type, string groupId, string leverageId)
Arguments
| Class | Name | Description |
| string | type | "margin" or "futures"。 |
| string | groupId | A group identifier. |
| string | leverageId | A leverage order identifier. |
Return value
| Class | Description |
| zaifres | A response to the request which have a JSON-text. |
Sample code
| 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.CancelPosition("futures", "1", "6185413"); |
| 5: | string jsonStr = zaifresIns.Result; |
Example for JSON-text
| {"success": 1, "return": {"leverage_id": 6185413, "fee_spent": 0.0, "timestamp_closed": "1558281875", "refunded_jpy": 176.14, "funds": {"jpy": 476.66100448, "btc": 7.66e-06, "xem": 0.0, "mona": 0.0, "BCH": 9.91e-05, "ETH": 3.89e-05, "ZAIF": 0.0}, "swap": 0.0}} |
Notes
It is a trade API for the leverage transaction. You can not get the information if do not set the API key and the secret key.
It cancels the order for the margin transaction of the spot market if the type argument is specified the "margin". In this case, the groupId argument must be specified an empty string.
It cancels the order for the AirFX market if the type argument is specified the "futures". In this case, the groupId argument must be specified the "1".
An instance of the zaifres class is returned as the response to the request. This instance holds the JSON-text of the result of the response.
If an API error occurs, the following JSON-text will be returned.
{"success": 0, "error": "..."}
"error" is different for each API error.
If an HTTP error occurs, the following JSON-text will be returned.
{"success": -1000,"error": { "statuscode" : 404, "message": "Not Found"}}
"statuscode" and "message" are different for each HTTP error.
If the request times out, the following JSON-text will be returned.
{"success": -1001,"error": { "typename" : "TaskCanceledException", "message": "A task was canceled."}}
If the request fails due to other exceptions, the following JSON-text will be returned.
{"success": -1002,"error": { "typename" : "...", "message": "..."}}
"typename" and "message" are different for each exception.