Merge pull request #9 from mahdimsr/get-trading-pairs-requests

Get trading pairs requests

src/LaravelBitunixApi.php

@@ -9,13 +9,14 @@ use Msr\LaravelBitunixApi\Requests\FlashClosePositionRequestContract;
 use Msr\LaravelBitunixApi\Requests\FutureKLineRequestContract;
 use Msr\LaravelBitunixApi\Requests\GetPendingPositionsRequestContract;
 use Msr\LaravelBitunixApi\Requests\GetSingleAccountRequestContract;
+use Msr\LaravelBitunixApi\Requests\GetTradingPairsRequestContract;
 use Msr\LaravelBitunixApi\Requests\Header;
 use Msr\LaravelBitunixApi\Requests\PlaceOrderRequestContract;
 use Msr\LaravelBitunixApi\Requests\PlacePositionTpSlOrderRequestContract;
 use Msr\LaravelBitunixApi\Requests\PlaceTpSlOrderRequestContract;
 use Psr\Http\Message\ResponseInterface;
 
-class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginModeRequestContract, FlashClosePositionRequestContract, FutureKLineRequestContract, GetPendingPositionsRequestContract, GetSingleAccountRequestContract, PlaceOrderRequestContract, PlacePositionTpSlOrderRequestContract, PlaceTpSlOrderRequestContract
+class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginModeRequestContract, FlashClosePositionRequestContract, FutureKLineRequestContract, GetPendingPositionsRequestContract, GetSingleAccountRequestContract, GetTradingPairsRequestContract, PlaceOrderRequestContract, PlacePositionTpSlOrderRequestContract, PlaceTpSlOrderRequestContract
 {
     private Client $publicFutureClient;
 
@@ -53,6 +54,21 @@ class LaravelBitunixApi implements ChangeLeverageRequestContract, ChangeMarginMo
         return $response;
     }
 
+    public function getTradingPairs(?string $symbols = null): ResponseInterface
+    {
+        $queryParams = [];
+
+        if ($symbols !== null) {
+            $queryParams['symbols'] = $symbols;
+        }
+
+        $response = $this->publicFutureClient->get('trading_pairs', [
+            'query' => $queryParams,
+        ]);
+
+        return $response;
+    }
+
     public function changeLeverage(string $symbol, string $marginCoin, int $leverage): ResponseInterface
     {
         $body = [

src/Requests/GetTradingPairsRequestContract.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Msr\LaravelBitunixApi\Requests;
+
+use Psr\Http\Message\ResponseInterface;
+
+interface GetTradingPairsRequestContract
+{
+    /**
+     * Get future trading pair details
+     *
+     * @param  string|null  $symbols  Trading pairs, comma-separated (e.g., "BTCUSDT,ETHUSDT,XRPUSDT")
+     */
+    public function getTradingPairs(?string $symbols = null): ResponseInterface;
+}

tests/GetTradingPairsTest.php

@@ -0,0 +1,108 @@
+<?php
+
+use Msr\LaravelBitunixApi\Requests\GetTradingPairsRequestContract;
+
+beforeEach(function () {
+    config([
+        'bitunix-api.future_base_uri' => 'https://fapi.bitunix.com/',
+        'bitunix-api.api_key' => 'test-api-key',
+        'bitunix-api.api_secret' => 'test-secret-key',
+        'bitunix-api.language' => 'en-US',
+    ]);
+});
+
+it('check trading pairs request response code', function () {
+    $bootedClass = app(GetTradingPairsRequestContract::class);
+    $response = $bootedClass->getTradingPairs();
+    expect($response->getStatusCode())
+        ->toBe(200)
+        ->and(json_decode($response->getBody()->getContents(), true))
+        ->toHaveKeys(['code', 'data', 'msg']);
+});
+
+it('can get trading pairs with specific symbols', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    expect(fn () => $api->getTradingPairs('BTCUSDT,ETHUSDT'))
+        ->not->toThrow(Exception::class);
+});
+
+it('can get trading pairs without symbols parameter', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    expect(fn () => $api->getTradingPairs())
+        ->not->toThrow(Exception::class);
+});
+
+it('validates get trading pairs method exists', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    expect(method_exists($api, 'getTradingPairs'))->toBeTrue();
+});
+
+it('can handle single symbol', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    expect(fn () => $api->getTradingPairs('BTCUSDT'))
+        ->not->toThrow(Exception::class);
+});
+
+it('can handle multiple symbols', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    $symbols = 'BTCUSDT,ETHUSDT,XRPUSDT';
+    expect(fn () => $api->getTradingPairs($symbols))
+        ->not->toThrow(Exception::class);
+});
+
+it('validates trading pairs response structure', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    $response = $api->getTradingPairs();
+    $data = json_decode($response->getBody()->getContents(), true);
+
+    expect($response->getStatusCode())->toBe(200)
+        ->and($data)->toHaveKeys(['code', 'data', 'msg']);
+
+    if (isset($data['data']) && is_array($data['data']) && count($data['data']) > 0) {
+        $firstPair = $data['data'][0];
+        expect($firstPair)->toHaveKeys([
+            'symbol',
+            'base',
+            'quote',
+            'minTradeVolume',
+            'minBuyPriceOffset',
+            'maxSellPriceOffset',
+            'maxLimitOrderVolume',
+            'maxMarketOrderVolume',
+            'basePrecision',
+            'quotePrecision',
+            'maxLeverage',
+            'minLeverage',
+            'defaultLeverage',
+            'defaultMarginMode',
+            'priceProtectScope',
+            'symbolStatus',
+        ]);
+    }
+});
+
+it('can handle different symbol formats', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    // Test with uppercase symbols
+    expect(fn () => $api->getTradingPairs('BTCUSDT'))
+        ->not->toThrow(Exception::class);
+
+    // Test with lowercase symbols
+    expect(fn () => $api->getTradingPairs('btcusdt'))
+        ->not->toThrow(Exception::class);
+});
+
+it('can handle empty symbols parameter', function () {
+    $api = app(GetTradingPairsRequestContract::class);
+
+    // Test with null (should return all trading pairs)
+    expect(fn () => $api->getTradingPairs(null))
+        ->not->toThrow(Exception::class);
+});