allocations() added

Author: yzh-pelle

php-binance-api.php

@@ -3577,6 +3577,52 @@ public function preventedMatches(string $symbol, ?string $preventedMatchId = nul
         return $this->apiRequest("v3/myPreventedMatches", 'GET', array_merge($request, $params), true);
     }
 
+    /**
+     * allocations - Get the allocations resulting from SOR order placement
+     *
+     * @link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/account-endpoints#query-allocations-user_data
+     *
+     * @property int $weight 20
+     *
+     * @param string $symbol (mandatory) The symbol, e.g. BTCUSDT
+     * @param int    $startTime (optional) The start time of the query
+     * @param int    $endTime (optional) The end time of the query
+     * @param string $fromAllocationId (optional) The ID of the allocation to start from
+     * @param int    $limit (optional) The number of results to return (default is 500, max is 1000)
+     * @param string $orderId (optional) The ID of the order
+     * @param array  $params (optional) An array of additional parameters that the API endpoint allows
+     *
+     * @return array with error message or the rate limit details
+     * @throws \Exception
+     */
+    public function allocations(string $symbol, ?int $startTime = null, ?int $endTime = null, ?string $fromAllocationId = null, ?int $limit = null, ?string $orderId = null, array $params = []) {
+        $request = [
+            'symbol' => $symbol,
+        ];
+
+        if ($startTime) {
+            $request['startTime'] = $startTime;
+        }
+
+        if ($endTime) {
+            $request['endTime'] = $endTime;
+        }
+
+        if ($fromAllocationId) {
+            $request['fromAllocationId'] = $fromAllocationId;
+        }
+
+        if (!is_null($limit)) {
+            $request['limit'] = $limit;
+        }
+
+        if ($orderId) {
+            $request['orderId'] = $orderId;
+        }
+
+        return $this->apiRequest("v3/myAllocations", 'GET', array_merge($request, $params), true);
+    }
+
     /**
      * ocoOrder - Create a new OCO order
      *

tests/BinanceLiveTests.php

@@ -431,6 +431,12 @@ public function testPreventedMatchesSpot()
         $this->assertIsArray($res);
     }
 
+    public function testAllocationsSpot()
+    {
+        $res = $this->spotBinance->allocations($this->symbol);
+        $this->assertIsArray($res);
+    }
+
     public function testTimeFutures()
     {
         $res = $this->futuresBinance->futuresTime();

tests/BinanceStaticTests.php

@@ -1130,6 +1130,28 @@ public function testPreventedMatches()
 
     }
 
+    public function testAllocations()
+    {
+        try  {
+            $this->binance->allocations($this->symbol, $this->startTime, $this->endTime, $this->fromId, $this->limit, $this->orderId);
+
+        } catch (\Throwable $e) {
+
+        }
+        $endpoint = "https://api.binance.com/api/v3/myAllocations?";
+        $this->assertTrue(str_starts_with(self::$capturedUrl, $endpoint));
+
+        $queryString = substr(self::$capturedUrl, strlen($endpoint));
+        parse_str($queryString, $params);
+
+        $this->assertEquals($this->symbol, $params['symbol']);
+        $this->assertEquals($this->startTime, $params['startTime']);
+        $this->assertEquals($this->endTime, $params['endTime']);
+        $this->assertEquals($this->fromId, $params['fromAllocationId']);
+        $this->assertEquals($this->limit, $params['limit']);
+        $this->assertEquals($this->orderId, $params['orderId']);
+    }
+
     public function testFuturesAccountSnapshot()
     {
         try  {