editOrder added

Author: yzh-pelle

php-binance-api.php

@@ -1968,6 +1968,44 @@ protected function createSpotOrderRequest(string $side, string $symbol, $quantit
         return array_merge($request, $params);
     }
 
+    /**
+     * editOrder - edits a quantity of an existing order
+     *
+     * @link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#order-amend-keep-priority-trade
+     * @link https://developers.binance.com/docs/binance-spot-api-docs/faqs/order_amend_keep_priority
+     *
+     * @param string $symbol (mandatory) market symbol
+     * @param string $quantity (mandatory) new quantity (must be greater than 0 and less than the original order quantity)
+     * @param string $orderId (optional) order id to be amended (mandatory if origClientOrderId is not set)
+     * @param string $origClientOrderId (optional) original client order id to be amended (mandatory if orderId is not set)
+     * @param array $params (optional) additional transaction options
+     * - @param string $params['newClientOrderId'] - custom client order id
+     *
+     * @return array containing the response
+     * @throws \Exception
+     */
+    public function editOrder(string $symbol, $quantity, ?string $orderId = null, ?string $origClientOrderId = null, array $params = [])
+    {
+        $request = [
+            "symbol" => $symbol,
+            "newQty" => $quantity,
+        ];
+
+        if (!is_null($orderId)) {
+            $request['orderId'] = $orderId;
+        } else if (is_null($origClientOrderId)) {
+            throw new \Exception('editOrder(): Either orderId or origClientOrderId must be set');
+        } else {
+            $request['origClientOrderId'] = $origClientOrderId;
+        }
+        if (isset($params['newClientOrderId'])) {
+            $request['newClientOrderId'] = $params['newClientOrderId'];
+        } else {
+            $request['newClientOrderId'] = $this->generateSpotClientOrderId();
+        }
+        return $this->apiRequest("v3/order/amend/keepPriority", "PUT", array_merge($request, $params), true);
+    }
+
     /**
      * sorOrder creates an order using the SOR endpoint
      *

tests/BinanceStaticTests.php

@@ -164,6 +164,25 @@ public function testSpotReplaceOrder()
         $this->assertTrue(str_starts_with($params['newClientOrderId'], $this->SPOT_ORDER_PREFIX));
     }
 
+    public function testSpotEditOrder()
+    {
+        try  {
+            $this->binance->editOrder('ETHUSDT', 0.009, '123456789');
+        } catch(\Throwable $e) {
+
+        }
+        $endpoint = "https://api.binance.com/api/v3/order/amend/keepPriority?";
+        $this->assertTrue(str_starts_with(self::$capturedUrl, $endpoint));
+
+        $queryString = substr(self::$capturedUrl, strlen($endpoint));
+        parse_str($queryString, $params);
+
+        $this->assertEquals("ETHUSDT", $params['symbol']);
+        $this->assertEquals(0.009, $params['newQty']);
+        $this->assertEquals('123456789', $params['orderId']);
+        $this->assertTrue(str_starts_with($params['newClientOrderId'], $this->SPOT_ORDER_PREFIX));
+    }
+
     public function testSpotBuy()
     {
         try  {