Home Notices Documents Classes Download Others Rice
Classes  >  bitbankapi  >  CancelOrders(string,list{long})
bitbankapi class : CancelOrders(string,list{long}) method

Description

Cancels specified orders.

Syntax

bitbankapiInstance.CancelOrders(string currencyPair, list{long} orderIds)

Arguments

ClassNameDescription
stringcurrencyPairCurrency pair.
list{long}orderIdsList of order ids.

Return value

ClassDescription
bitbankresResponse to request, with JSON-text.

Sample code

1:

string apiKey = "3622c294-zs5m-587w-vv7j-sdf454h1sdbl";

2:

string secretKey = "4be789k3-dd7r-9d23-jy45-qng4c83hjk1g";

3:

bitbankapi bitbankapiIns = new bitbankapi(apiKey, secretKey);

4:

list{long} ids;

5:

ids.Add(39917305L);

6:

ids.Add(39917306L);

7:

bitbankres bitbankresIns = bitbankapiIns.CancelOrders("btc_jpy", ids);

8:

string jsonStr = bitbankresIns.Result;

Example for JSON-text

{"success":1,"data":{"orders":[{"order_id":39917305,"pair":"btc_jpy","side":"buy","type":"limit","start_amount":"0.0001","remaining_amount":"0.0001","executed_amount":"0.0000","price":"50000","average_price":"0","ordered_at":1582847142657,"canceled_at":1582848005272,"status":"CANCELED_UNFILLED"},{"order_id":39917306,"pair":"btc_jpy","side":"buy","type":"limit","start_amount":"0.0001","remaining_amount":"0.0001","executed_amount":"0.0000","price":"50000","average_price":"0","ordered_at":1582847116840,"canceled_at":1582848005272,"status":"CANCELED_UNFILLED"}]}}

Notes

Private API. API key and secret key are necessary.

Valid first argument : btc_jpy, xrp_jpy, ltc_btc, eth_btc, mona_jpy, mona_btc, bcc_jpy, bcc_btc

It passes a list of order IDs to the second argument. You can cancel multiple orders at once.

An instance of the bitbankres class is returned as the response to the request. This instance holds the JSON-text of the result of the response.

If the argument is incorrect, the following JSON-text will be returned.

{"success":0,"data":{"code":xxxxx}}

The "code" is a different number for each 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 is returned.

{"success": -1001,"error": { "typename" : "TaskCanceledException", "message": "A task was cancelled."}}

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.

Links for reference

Copyright © Rice All rights reserved.