MCPcopy Create free account
hub / github.com/ccxt/ccxt / cancel_order

Method cancel_order

python/ccxt/gate.py:5309–5437  ·  view source on GitHub ↗

Cancels an open order https://www.gate.com/docs/developers/apiv4/en/#cancel-single-order https://www.gate.com/docs/developers/apiv4/en/#cancel-single-auto-order https://www.gate.com/docs/developers/apiv4/en/#cancel-single-order-2 https://www.gate.com/docs/de

(self, id: str, symbol: Str = None, params={})

Source from the content-addressed store, hash-verified

5307 return self.filter_by_symbol_since_limit(orders, symbol, since, limit)
5308
5309 def cancel_order(self, id: str, symbol: Str = None, params={}):
5310 """
5311 Cancels an open order
5312
5313 https://www.gate.com/docs/developers/apiv4/en/#cancel-single-order
5314 https://www.gate.com/docs/developers/apiv4/en/#cancel-single-auto-order
5315 https://www.gate.com/docs/developers/apiv4/en/#cancel-single-order-2
5316 https://www.gate.com/docs/developers/apiv4/en/#cancel-single-auto-order-2
5317 https://www.gate.com/docs/developers/apiv4/en/#cancel-single-order-3
5318 https://www.gate.com/docs/developers/apiv4/en/#cancel-single-auto-order-3
5319 https://www.gate.com/docs/developers/apiv4/en/#cancel-single-order-4
5320
5321 :param str id: Order id
5322 :param str symbol: Unified market symbol
5323 :param dict [params]: Parameters specified by the exchange api
5324 :param bool [params.trigger]: True if the order to be cancelled is a trigger order
5325 :param bool [params.unifiedAccount]: set to True for canceling unified account orders
5326 :returns: An `order structure <https://docs.ccxt.com/?id=order-structure>`
5327 """
5328 self.load_markets()
5329 self.load_unified_status()
5330 market = None if (symbol is None) else self.market(symbol)
5331 trigger = self.safe_bool_n(params, ['is_stop_order', 'stop', 'trigger'], False)
5332 params = self.omit(params, ['is_stop_order', 'stop', 'trigger'])
5333 type, query = self.handle_market_type_and_params('cancelOrder', market, params)
5334 request, requestParams = self.spot_order_prepare_request(market, trigger, query) if (type == 'spot' or type == 'margin') else self.prepare_request(market, type, query)
5335 request['order_id'] = id
5336 response: dict
5337 if type == 'spot' or type == 'margin':
5338 if trigger:
5339 response = self.privateSpotDeletePriceOrdersOrderId(self.extend(request, requestParams))
5340 else:
5341 response = self.privateSpotDeleteOrdersOrderId(self.extend(request, requestParams))
5342 elif type == 'swap':
5343 if trigger:
5344 response = self.privateFuturesDeleteSettlePriceOrdersOrderId(self.extend(request, requestParams))
5345 else:
5346 response = self.privateFuturesDeleteSettleOrdersOrderId(self.extend(request, requestParams))
5347 elif type == 'future':
5348 if trigger:
5349 response = self.privateDeliveryDeleteSettlePriceOrdersOrderId(self.extend(request, requestParams))
5350 else:
5351 response = self.privateDeliveryDeleteSettleOrdersOrderId(self.extend(request, requestParams))
5352 elif type == 'option':
5353 response = self.privateOptionsDeleteOrdersOrderId(self.extend(request, requestParams))
5354 else:
5355 raise NotSupported(self.id + ' cancelOrder() not support self market type')
5356 #
5357 # spot
5358 #
5359 # {
5360 # "id": "95282841887",
5361 # "text": "apiv4",
5362 # "create_time": "1637383156",
5363 # "update_time": "1637383235",
5364 # "create_time_ms": 1637383156017,
5365 # "update_time_ms": 1637383235085,
5366 # "status": "cancelled",

Callers

nothing calls this directly

Tested by

no test coverage detected