PHPackages tigusigalpa/bingx-php - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. tigusigalpa/bingx-php ActiveLibrary[API Development](/categories/api) tigusigalpa/bingx-php ===================== BingX API v3 client for PHP with Laravel 8-12 integration - TWAP orders, trailing stops, multi-assets margin, advanced risk management v3.0.4(1mo ago)2014MITPHPPHP ^7.4|^8.0|^8.1|^8.2 Since Nov 18Pushed 1mo ago1 watchersCompare [ Source](https://github.com/tigusigalpa/bingx-php)[ Packagist](https://packagist.org/packages/tigusigalpa/bingx-php)[ RSS](/packages/tigusigalpa-bingx-php/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (8)Dependencies (8)Versions (9)Used By (0) BingX PHP SDK ============= [](#bingx-php-sdk) [![BingX PHP SDK](https://private-user-images.githubusercontent.com/2721390/515847930-bc9acf4c-79c7-4e02-bb8d-75f2d8784b29.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzU0MzQzNjUsIm5iZiI6MTc3NTQzNDA2NSwicGF0aCI6Ii8yNzIxMzkwLzUxNTg0NzkzMC1iYzlhY2Y0Yy03OWM3LTRlMDItYmI4ZC03NWYyZDg3ODRiMjkucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI2MDQwNiUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNjA0MDZUMDAwNzQ1WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZTM4NDBjMTNiNjIyYWRiYjc5MmY4ZTFmYzAzZTAyMzQ2MzhiYjk3NTlhZjU0YzQ4OTgwNDNmYmRkYWUyNjhlMCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.cSftDl-BQ6w1HzkAvnLSSFGVP06ENRFgzoZFUd9-SFs)](https://private-user-images.githubusercontent.com/2721390/515847930-bc9acf4c-79c7-4e02-bb8d-75f2d8784b29.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzU0MzQzNjUsIm5iZiI6MTc3NTQzNDA2NSwicGF0aCI6Ii8yNzIxMzkwLzUxNTg0NzkzMC1iYzlhY2Y0Yy03OWM3LTRlMDItYmI4ZC03NWYyZDg3ODRiMjkucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI2MDQwNiUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNjA0MDZUMDAwNzQ1WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZTM4NDBjMTNiNjIyYWRiYjc5MmY4ZTFmYzAzZTAyMzQ2MzhiYjk3NTlhZjU0YzQ4OTgwNDNmYmRkYWUyNjhlMCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.cSftDl-BQ6w1HzkAvnLSSFGVP06ENRFgzoZFUd9-SFs) [![PHP Version](https://camo.githubusercontent.com/c98a048f3f814cae5e63c041e7e0c1731105d777ded8c0719b1414684af867f5/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d253345253344382e312d626c75653f7374796c653d666c61742d737175617265266c6f676f3d706870)](https://www.php.net/)[![Composer](https://camo.githubusercontent.com/1a8be01b9c574f0003c3d23582da32a6c498155e666f66d6b79b3d44da1a16a6/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f6d706f7365722d76322d6f72616e67653f7374796c653d666c61742d737175617265266c6f676f3d636f6d706f736572)](https://getcomposer.org/)[![License](https://camo.githubusercontent.com/422db9fd40f5831c765cf6530b6750c081b696bd18d904cf89554df98c676277/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d677265656e3f7374796c653d666c61742d737175617265)](LICENSE)[![API v3](https://camo.githubusercontent.com/24cd675375367a970e9c0b6c3aec0e82c0971cf2fb0d46756e93b8377053e921/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f42696e67582532304150492d76332d737563636573733f7374796c653d666c61742d737175617265)](https://bingx-api.github.io/docs-v3/)[![GitHub Stars](https://camo.githubusercontent.com/b520bd7c52f1afe7715933bba9899c29df86a918850ead57279553f27f0701c4/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f74696775736967616c70612f62696e67782d7068703f7374796c653d666c61742d737175617265266c6f676f3d676974687562)](https://github.com/tigusigalpa/bingx-php)[![Latest Release](https://camo.githubusercontent.com/7658f3d7b9dd47a975685138cd4fd6017f90e0e7257ab08b56fc0c2d286bd44b/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f74696775736967616c70612f62696e67782d7068703f7374796c653d666c61742d737175617265266c6f676f3d676974687562)](https://github.com/tigusigalpa/bingx-php/releases)[![Test Coverage](https://camo.githubusercontent.com/12df98b1e1de009916ed2c1794c85b78db665621ebf6a94263b0fd95999984db/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f7665726167652d31313925324225323074657374732d627269676874677265656e3f7374796c653d666c61742d737175617265)](#-testing) English | [Русский](README-ru.md) The most complete PHP client for [BingX](https://bingx.com) exchange. Whether you're building a trading bot, need real-time market data, or want to automate your portfolio — we've got you covered. **What's inside:** USDT-M & Coin-M futures, spot trading, TWAP algorithmic orders, trailing stops, portfolio margin, copy trading, sub-accounts, WebSocket streaming, and seamless Laravel integration. Over 250 methods ready to use. > 📖 **[Full documentation on Wiki](https://github.com/tigusigalpa/bingx-php/wiki)** — examples, guides, and API reference Table of Contents ----------------- [](#table-of-contents) - [Features](#features) - [🚀 API v3 Features](#-api-v3-features) - [Quick Start](#quick-start) - [Installation](#installation) - [Usage](#usage) - [Market Service](#market-service---market-data) - [Quote API](#quote-api---optimized-market-data) - [TWAP Orders](#twap-orders---algorithmic-trading) - [Account Service](#account-service---account-management) - [Trade Service](#trade-service---trading-operations) - [Wallet Service](#wallet-service---wallet-management) - [Spot Account Service](#spot-account-service---spot-account) - [Contract Service](#contract-service---standard-futures) - [WebSocket API](#websocket-api) - [Coin-M Perpetual Futures](#coin-m-perpetual-futures---crypto-margined-contracts) - [OrderBuilder](#orderbuilder---advanced-order-creation) - [Error Handling](#error-handling) - [Testing](#testing) - [Documentation](#documentation) - [Versions](#versions) - [License](#license) --- Features -------- [](#features) ### What can you do with this SDK? [](#what-can-you-do-with-this-sdk) ServiceDescriptionMethods**USDT-M Perpetual Futures****Market Service**Market data, Quote API, symbols, prices, candles, OI46**TWAP Service** *(v3)*Time-Weighted Average Price algorithmic orders7**Account Service**Balance, positions, leverage, risk monitoring45**Trade Service**Orders, trade history, position management, v3 types60**Wallet Service**Deposits, withdrawals, wallet addresses6**Spot Account Service**Spot balance, transfers, internal transfers8**Sub-Account Service**Sub-account management, API keys, transfers20**Copy Trading Service**Copy trading for futures and spot13**Contract Service**Standard contract API3**Listen Key Service**WebSocket authentication3**Coin-M Perpetual Futures****Coin-M Market**Contract info, ticker, depth, klines, open interest6**Coin-M Trade**Orders, positions, leverage, margin, balance17**Coin-M Listen Key**WebSocket authentication for Coin-M3### Security — we take it seriously [](#security--we-take-it-seriously) - **HMAC-SHA256 signatures** on every request - **Automatic timestamp handling** — no more "timestamp out of recvWindow" errors - **Flexible encoding** — base64 or hex, your choice - **Replay protection** via recvWindow - **Smart exceptions** — know exactly what went wrong ### Built for developers [](#built-for-developers) - **Fluent interface** — chain methods like a pro - **IDE-friendly** — full autocomplete with type hints - **Battle-tested** — 119+ tests and counting - **Your way** — works with pure PHP or Laravel --- 🚀 API v3 Features ----------------- [](#-api-v3-features) The new hotness. These features bring institutional-grade tools to everyone. ### TWAP Orders — Execute like the big players [](#twap-orders--execute-like-the-big-players) Ever tried to buy 10 BTC at once and watched the price spike against you? That's slippage, and TWAP solves it by spreading your order over time: ``` // Execute 10 BTC over 1 hour $twap = Bingx::twap()->buy( symbol: 'BTC-USDT', quantity: 10.0, duration: 3600, // seconds positionSide: 'LONG' ); // Monitor progress $details = Bingx::twap()->getOrderDetail($twap['orderId']); ``` ### New Order Types — More ways to trade [](#new-order-types--more-ways-to-trade) **Trailing Stop Market** — The stop-loss that follows your profits: ``` $order = Bingx::trade()->order() ->futures() ->symbol('ETH-USDT') ->sell() ->long() ->type('TRAILING_STOP_MARKET') ->activationPrice(3000.0) ->callbackRate(1.0) // Trail 1% behind peak ->quantity(1.0) ->execute(); ``` **Trigger Limit** — Wait for your price, then use a limit (not market): ``` $order = Bingx::trade()->order() ->futures() ->type('TRIGGER_LIMIT') ->stopPrice(49500.0) // Trigger ->price(50000.0) // Limit ->execute(); ``` ### Multi-Assets Margin — Use your whole portfolio [](#multi-assets-margin--use-your-whole-portfolio) Why lock up margin for each position when your portfolio can back everything? ``` // Enable portfolio margin Bingx::trade()->switchMultiAssetsMode(true); // Check margin details $margin = Bingx::trade()->getMultiAssetsMargin(); ``` ### Position Risk Monitoring — Know before you blow [](#position-risk-monitoring--know-before-you-blow) Knowing your liquidation price *before* you get liquidated is kind of important: ``` $risk = Bingx::account()->getPositionRisk('BTC-USDT'); echo "Liquidation Price: {$risk['liquidationPrice']}\n"; echo "Margin Ratio: {$risk['marginRatio']}\n"; ``` ### One-Click Position Reversal — Change your mind instantly [](#one-click-position-reversal--change-your-mind-instantly) Market turned? Flip your position in one atomic operation — no gap, no exposure: ``` // Reverse: LONG → SHORT or SHORT → LONG Bingx::trade()->oneClickReversePosition('BTC-USDT'); ``` ### Income & P&L Tracking — Where did my money go? [](#income--pl-tracking--where-did-my-money-go) Break down your profits, losses, fees, and funding payments: ``` // Get income by type $income = Bingx::account()->getIncomeHistory( symbol: 'BTC-USDT', incomeType: 'REALIZED_PNL' ); // Commission history $commissions = Bingx::account()->getCommissionHistory('BTC-USDT'); ``` ### Enhanced Market Data — See what others can't [](#enhanced-market-data--see-what-others-cant) ``` // Open interest $oi = Bingx::market()->getOpenInterest('BTC-USDT'); // Funding rate info $funding = Bingx::market()->getFundingRateInfo('BTC-USDT'); // Book ticker (best bid/ask) $ticker = Bingx::market()->getBookTicker('BTC-USDT'); ``` > 📘 **[Complete API v3 Migration Guide](API_V3_MIGRATION.md)** — Your existing code keeps working. New features are opt-in. --- Quick Start ----------- [](#quick-start) Let's get you trading in under 5 minutes. ### With Laravel — The easy way [](#with-laravel--the-easy-way) ``` // Get current price $price = Bingx::market()->getLatestPrice('BTC-USDT'); echo "BTC price: {$price['price']}"; // Get account balance $balance = Bingx::account()->getBalance(); // Create an order using OrderBuilder $order = Bingx::trade()->order() ->futures() ->symbol('BTC-USDT') ->buy() ->long() ->type('LIMIT') ->margin(100) ->price(50000) ->leverage(10) ->stopLossPercent(5) ->takeProfitPercent(15) ->execute(); ``` ### Pure PHP — No framework needed [](#pure-php--no-framework-needed) ``` use Tigusigalpa\BingX\BingxClient; use Tigusigalpa\BingX\Http\BaseHttpClient; $http = new BaseHttpClient('API_KEY', 'API_SECRET', 'https://open-api.bingx.com'); $bingx = new BingxClient($http); $price = $bingx->market()->getLatestPrice('BTC-USDT'); ``` --- Installation ------------ [](#installation) ### What you'll need [](#what-youll-need) - **PHP 8.1+** — we use modern features - **Composer** — for dependency management - **Laravel 8-12** — optional, but makes life easier ### Step 1: Add Repository [](#step-1-add-repository) In your root `composer.json`: ``` { "repositories": [ { "type": "path", "url": "packages/bingx-php" } ] } ``` ### Step 2: Install Package [](#step-2-install-package) ``` composer require tigusigalpa/bingx-php:* ``` ### Step 3: (Laravel Only) Publish Configuration [](#step-3-laravel-only-publish-configuration) ``` php artisan vendor:publish --tag=bingx-config ``` ### Step 4: Configure Environment Variables [](#step-4-configure-environment-variables) Add to `.env`: ``` BINGX_API_KEY=your_api_key_here BINGX_API_SECRET=your_api_secret_here BINGX_SOURCE_KEY=optional_source_key BINGX_BASE_URI=https://open-api.bingx.com BINGX_SIGNATURE_ENCODING=base64 ``` ### Getting your API keys [](#getting-your-api-keys) 1. Head to [BingX API Settings](https://bingx.com/en-US/accounts/api) 2. Hit "Create API" 3. **Important:** Save your Secret Key immediately — you'll only see it once! 4. Set up permissions (read, trade, withdraw — whatever you need) 5. Store both keys somewhere safe (not in your code!) --- Usage ----- [](#usage) ### Market Service - Market Data [](#market-service---market-data) #### Trading Pairs and Symbols [](#trading-pairs-and-symbols) ``` // Get all available symbols (spot + futures) $allSymbols = Bingx::market()->getAllSymbols(); // ['spot' => [...], 'futures' => [...]] // Only spot pairs $spotSymbols = Bingx::market()->getSpotSymbols(); // Only futures symbols $futuresSymbols = Bingx::market()->getFuturesSymbols(); ``` #### Prices and Statistics [](#prices-and-statistics) ``` // Current price $futuresPrice = Bingx::market()->getLatestPrice('BTC-USDT'); $spotPrice = Bingx::market()->getSpotLatestPrice('BTC-USDT'); // 24h statistics $ticker = Bingx::market()->get24hrTicker('BTC-USDT'); $spotTicker = Bingx::market()->getSpot24hrTicker('BTC-USDT'); // All symbols at once $allTickers = Bingx::market()->get24hrTicker(); ``` #### Market Depth and Candles [](#market-depth-and-candles) ``` // Order book depth $depth = Bingx::market()->getDepth('BTC-USDT', 20); $spotDepth = Bingx::market()->getSpotDepth('BTC-USDT', 20); // Candlesticks $klines = Bingx::market()->getKlines('BTC-USDT', '1h', 100); $spotKlines = Bingx::market()->getSpotKlines('BTC-USDT', '1h', 100); // With time range $klines = Bingx::market()->getKlines( 'BTC-USDT', '1h', 100, strtotime('2024-01-01') * 1000, strtotime('2024-01-02') * 1000 ); // Spot klines with timezone (v2 endpoint) // timeZone: 0=UTC (default), 8=UTC+8 $spotKlines = Bingx::market()->getSpotKlines( 'BTC-USDT', '1h', 100, strtotime('2024-01-01') * 1000, strtotime('2024-01-02') * 1000, 8 // UTC+8 timezone ); ``` #### Funding and Mark Price [](#funding-and-mark-price) ``` // Funding rate history $fundingRate = Bingx::market()->getFundingRateHistory('BTC-USDT', 100); // Mark price $markPrice = Bingx::market()->getMarkPrice('BTC-USDT'); // Premium index $premiumKlines = Bingx::market()->getPremiumIndexKlines('BTC-USDT', '1h', 100); // Continuous contracts $continuousKlines = Bingx::market()->getContinuousKlines('BTC-USDT', '1h', 100); ``` #### Trades [](#trades) ``` // Aggregate trades $aggTrades = Bingx::market()->getAggregateTrades('BTC-USDT', 500); // Recent trades $recentTrades = Bingx::market()->getRecentTrades('BTC-USDT', 500); // Spot trades $spotAggTrades = Bingx::market()->getSpotAggregateTrades('BTC-USDT', 500); $spotRecentTrades = Bingx::market()->getSpotRecentTrades('BTC-USDT', 500); ``` #### Market Sentiment Analysis [](#market-sentiment-analysis) ``` // Long/Short ratio $longShortRatio = Bingx::market()->getTopLongShortRatio('BTC-USDT', 10); // Historical ratios $historicalRatio = Bingx::market()->getHistoricalTopLongShortRatio( 'BTC-USDT', 500, strtotime('2024-01-01') * 1000, strtotime('2024-01-02') * 1000 ); // Contract basis data $basis = Bingx::market()->getBasis('BTC-USDT', 'PERPETUAL', 100); ``` --- ### Quote API - Optimized Market Data [](#quote-api---optimized-market-data) #### Contract Information [](#contract-information) ``` // Get all contract specifications $contracts = Bingx::market()->getContracts(); foreach ($contracts as $contract) { echo "Symbol: {$contract['symbol']}\n"; echo "Min Qty: {$contract['minQty']}\n"; echo "Max Leverage: {$contract['maxLeverage']}\n"; } ``` #### Market Depth (Quote API) [](#market-depth-quote-api) ``` // Order book via Quote API (optimized) $depth = Bingx::market()->getQuoteDepth('BTC-USDT', 20); echo "Best Bid: {$depth['bids'][0][0]}\n"; echo "Best Ask: {$depth['asks'][0][0]}\n"; // Best bid/ask prices $bookTicker = Bingx::market()->getBookTicker('BTC-USDT'); echo "Bid: {$bookTicker['bidPrice']} / Ask: {$bookTicker['askPrice']}\n"; ``` #### Price Data (Quote API) [](#price-data-quote-api) ``` // 24hr ticker via Quote API $ticker = Bingx::market()->getQuoteTicker('BTC-USDT'); echo "Price: {$ticker['lastPrice']}\n"; echo "24h Change: {$ticker['priceChangePercent']}%\n"; // Funding rate $fundingRate = Bingx::market()->getQuoteFundingRate('BTC-USDT'); echo "Funding Rate: {$fundingRate['fundingRate']}\n"; // Open interest $openInterest = Bingx::market()->getQuoteOpenInterest('BTC-USDT'); echo "Open Interest: {$openInterest['openInterest']}\n"; // Premium index $premium = Bingx::market()->getPremiumIndex('BTC-USDT'); echo "Mark Price: {$premium['markPrice']}\n"; ``` #### Recent Trades (Quote API) [](#recent-trades-quote-api) ``` // Get recent trades via Quote API $trades = Bingx::market()->getQuoteTrades('BTC-USDT', 100); foreach ($trades as $trade) { $side = $trade['isBuyerMaker'] ? 'SELL' : 'BUY'; echo "{$side}: {$trade['qty']} @ {$trade['price']}\n"; } ``` #### Advanced Market Data [](#advanced-market-data) ``` // K-lines v3 (improved performance) $klines = Bingx::market()->getKlinesV3('BTC-USDT', '1h', 500); // Trading rules $rules = Bingx::market()->getTradingRules('BTC-USDT'); echo "Min Qty: {$rules['minQty']}\n"; echo "Max Qty: {$rules['maxQty']}\n"; // Historical trades (v1) $historicalTrades = Bingx::market()->getHistoricalTradesV1('BTC-USDT', 500); // Mark price klines (v1) $markKlines = Bingx::market()->getMarkPriceKlinesV1('BTC-USDT', '1h', 500); // Ticker price (v1) $tickerPrice = Bingx::market()->getTickerPriceV1('BTC-USDT'); ``` See detailed examples: [EXAMPLES\_QUOTE\_API.md](EXAMPLES_QUOTE_API.md) --- ### TWAP Orders - Algorithmic Trading [](#twap-orders---algorithmic-trading) TWAP (Time-Weighted Average Price) orders allow executing large orders over time to minimize market impact. #### Creating TWAP Orders [](#creating-twap-orders) ``` // Simple TWAP buy order $order = Bingx::twap()->buy( symbol: 'BTC-USDT', quantity: 1.0, duration: 1800, // 30 minutes in seconds price: null, // null = market price positionSide: 'LONG' ); echo "TWAP Order ID: {$order['orderId']}\n"; // TWAP sell order with limit price $order = Bingx::twap()->sell( symbol: 'ETH-USDT', quantity: 2.0, duration: 3600, // 1 hour price: 2000.0, // limit price positionSide: 'SHORT' ); ``` #### Advanced TWAP Order [](#advanced-twap-order) ``` // Create TWAP order with custom parameters $order = Bingx::twap()->createOrder([ 'symbol' => 'BTC-USDT', 'side' => 'BUY', 'positionSide' => 'LONG', 'quantity' => 5.0, 'duration' => 7200, // 2 hours 'price' => 45000.0, 'clientOrderId' => 'my-twap-001' ]); ``` #### Managing TWAP Orders [](#managing-twap-orders) ``` // Cancel TWAP order Bingx::twap()->cancelOrder('orderId', 'BTC-USDT'); // Get open TWAP orders $openOrders = Bingx::twap()->getOpenOrders('BTC-USDT'); // Get TWAP order history $history = Bingx::twap()->getHistoryOrders( symbol: 'BTC-USDT', limit: 100, startTime: strtotime('-24 hours') * 1000, endTime: time() * 1000 ); // Get detailed order information $details = Bingx::twap()->getOrderDetail('orderId'); echo "Progress: {$details['executedQty']}/{$details['totalQty']}\n"; echo "Average Price: {$details['avgPrice']}\n"; echo "Status: {$details['status']}\n"; ``` #### Monitoring TWAP Execution [](#monitoring-twap-execution) ``` // Monitor TWAP order progress $orderId = $order['orderId']; while (true) { $details = Bingx::twap()->getOrderDetail($orderId); $progress = ($details['executedQty'] / $details['totalQty']) * 100; echo "Progress: " . round($progress, 2) . "%\n"; if (in_array($details['status'], ['FILLED', 'CANCELLED'])) { echo "Order completed: {$details['status']}\n"; break; } sleep(60); // Check every minute } ``` See detailed examples: [EXAMPLES\_TWAP.md](EXAMPLES_TWAP.md) --- ### Account Service - Account Management [](#account-service---account-management) #### Balance and Positions [](#balance-and-positions) ``` // Get account balance $balance = Bingx::account()->getBalance(); // All positions $allPositions = Bingx::account()->getPositions(); // Positions for specific symbol $positions = Bingx::account()->getPositions('BTC-USDT'); // Account information $accountInfo = Bingx::account()->getAccountInfo(); ``` #### Leverage and Margin Management [](#leverage-and-margin-management) ``` // Get current leverage $leverage = Bingx::account()->getLeverage('BTC-USDT'); // Set leverage Bingx::account()->setLeverage('BTC-USDT', 'BOTH', 20); // Margin mode (ISOLATED or CROSSED) $marginMode = Bingx::account()->getMarginMode('BTC-USDT'); Bingx::account()->setMarginMode('BTC-USDT', 'ISOLATED'); // Position margin Bingx::account()->setPositionMargin('BTC-USDT', 'LONG', 100.0, 1); ``` #### Trading Fees [](#trading-fees) ``` // Fees for symbol $fees = Bingx::account()->getTradingFees('BTC-USDT'); // API permissions $permissions = Bingx::account()->getAccountPermissions(); // API key information $apiKey = Bingx::account()->getApiKey(); // User commission rates $userRates = Bingx::account()->getUserCommissionRates('BTC-USDT'); // API rate limits $rateLimits = Bingx::account()->getApiRateLimits(); ``` #### Operation History [](#operation-history) ``` // Balance history $balanceHistory = Bingx::account()->getBalanceHistory('USDT', 100); // Deposit history $deposits = Bingx::account()->getDepositHistory('USDT', 100); // Withdrawal history $withdrawals = Bingx::account()->getWithdrawHistory('USDT', 100); ``` #### Asset Management [](#asset-management) ``` // Asset details $assetDetails = Bingx::account()->getAssetDetails('USDT'); // All available assets $allAssets = Bingx::account()->getAllAssets(); // Funding wallet $fundingWallet = Bingx::account()->getFundingWallet('USDT'); // Dust conversion (small assets) Bingx::account()->dustTransfer(['BTC', 'ETH']); ``` --- ### Trade Service - Trading Operations [](#trade-service---trading-operations) #### Quick Trade Methods [](#quick-trade-methods) ``` // Spot orders $buy = Bingx::trade()->spotMarketBuy('BTC-USDT', 0.001); $sell = Bingx::trade()->spotMarketSell('BTC-USDT', 0.001); // Spot limit orders $limitBuy = Bingx::trade()->spotLimitBuy('BTC-USDT', 0.001, 50000); $limitSell = Bingx::trade()->spotLimitSell('BTC-USDT', 0.001, 60000); // Futures orders $longOrder = Bingx::trade()->futuresLongMarket('BTC-USDT', 100, 10); $shortOrder = Bingx::trade()->futuresShortMarket('BTC-USDT', 100, 10); // With protective orders $longLimit = Bingx::trade()->futuresLongLimit( 'BTC-USDT', 100, 50000, 48000, 55000, 10 ); ``` #### Creating and Managing Orders [](#creating-and-managing-orders) ``` // Create order $order = Bingx::trade()->createOrder([ 'symbol' => 'BTC-USDT', 'side' => 'BUY', 'type' => 'MARKET', 'quantity' => 0.001 ]); // Test order (no execution) $testOrder = Bingx::trade()->createTestOrder([ 'symbol' => 'BTC-USDT', 'side' => 'BUY', 'type' => 'LIMIT', 'quantity' => 0.001, 'price' => 50000 ]); // Batch creation $batchOrders = Bingx::trade()->createBatchOrders([ [ 'symbol' => 'BTC-USDT', 'side' => 'BUY', 'type' => 'LIMIT', 'quantity' => 0.001, 'price' => 50000 ], [ 'symbol' => 'ETH-USDT', 'side' => 'SELL', 'type' => 'LIMIT', 'quantity' => 0.01, 'price' => 3000 ] ]); ``` #### Canceling Orders [](#canceling-orders) ``` // Cancel specific order Bingx::trade()->cancelOrder('BTC-USDT', '123456789'); // Cancel all orders for symbol Bingx::trade()->cancelAllOrders('BTC-USDT'); // Batch cancel Bingx::trade()->cancelBatchOrders('BTC-USDT', ['123456789', '987654321']); // Cancel and replace Bingx::trade()->cancelAndReplaceOrder( 'BTC-USDT', '123456789', 'BUY', 'LIMIT', 0.001, 50000 ); ``` #### Getting Order Information [](#getting-order-information) ``` // Order details $order = Bingx::trade()->getOrder('BTC-USDT', '123456789'); // Open orders $openOrders = Bingx::trade()->getOpenOrders(); $openOrdersForSymbol = Bingx::trade()->getOpenOrders('BTC-USDT', 50); // Order history $orderHistory = Bingx::trade()->getOrderHistory('BTC-USDT', 100); // Trade history $userTrades = Bingx::trade()->getUserTrades('BTC-USDT', 100); ``` #### Fee Calculation [](#fee-calculation) ``` // Calculate futures fee $commission = Bingx::trade()->calculateFuturesCommission(100, 10); // Returns detailed fee information // Quick amount calculation $amount = Bingx::trade()->getCommissionAmount(100, 10); // 0.45 // Batch calculation $batchCommission = Bingx::trade()->calculateBatchCommission([ ['margin' => 100, 'leverage' => 10], ['margin' => 200, 'leverage' => 5] ]); // Get fee rates $rates = Bingx::trade()->getCommissionRates(); ``` #### Position Management [](#position-management) ``` // Position mode $positionMode = Bingx::trade()->getPositionMode(); Bingx::trade()->setPositionMode('HEDGE_MODE'); // Position side $positionSide = Bingx::trade()->getPositionSide(); Bingx::trade()->setPositionSide('BOTH'); // Close all positions Bingx::trade()->closeAllPositions('BTC-USDT'); // Margin type $marginType = Bingx::trade()->getMarginType('BTC-USDT'); Bingx::trade()->changeMarginType('BTC-USDT', 'ISOLATED'); ``` --- ### Wallet Service - Wallet Management [](#wallet-service---wallet-management) ``` // Deposit history $deposits = Bingx::wallet()->getDepositHistory( coin: 'USDT', status: 1, startTime: strtotime('2024-01-01') * 1000, endTime: strtotime('2024-01-31') * 1000 ); // Deposit address $address = Bingx::wallet()->getDepositAddress('USDT', 'TRC20'); // Withdrawal history $withdrawals = Bingx::wallet()->getWithdrawalHistory( coin: 'USDT', status: 6 ); // Create withdrawal $withdrawal = Bingx::wallet()->withdraw( coin: 'USDT', address: 'TXxx...xxx', amount: 100.0, network: 'TRC20' ); // Coin information $coins = Bingx::wallet()->getAllCoinInfo(); ``` --- ### Spot Account Service - Spot Account [](#spot-account-service---spot-account) ``` // Spot account balance $balance = Bingx::spotAccount()->getBalance(); // Fund balance $fundBalance = Bingx::spotAccount()->getFundBalance(); // Universal transfer $transfer = Bingx::spotAccount()->universalTransfer( type: 'FUND_PFUTURES', asset: 'USDT', amount: 100.0 ); // Transfer history $history = Bingx::spotAccount()->getAssetTransferRecords( type: 'FUND_PFUTURES', startTime: strtotime('2024-01-01') * 1000, endTime: strtotime('2024-01-31') * 1000 ); // Internal transfer (main account internal transfer) // Wallet types: 1=Fund Account, 2=Standard Futures, 3=Perpetual Futures, 4=Spot Account // User account types: 1=UID, 2=Phone number, 3=Email $internalTransfer = Bingx::spotAccount()->internalTransfer( coin: 'USDT', walletType: 4, // Spot Account amount: 50.0, userAccountType: 1, // UID userAccount: '123456', callingCode: null, // Required when userAccountType=2 transferClientId: 'transfer-001', // Optional custom ID recvWindow: null ); // Get all account balances $allBalances = Bingx::spotAccount()->getAllAccountBalances(); ``` --- ### Sub-Account Service - Sub-Account Management [](#sub-account-service---sub-account-management) #### Creating and Managing Sub-Accounts [](#creating-and-managing-sub-accounts) ``` // Create a new sub-account $result = Bingx::subAccount()->createSubAccount('sub_account_001'); // Get account UID $uid = Bingx::subAccount()->getAccountUid(); // Get list of all sub-accounts $subAccounts = Bingx::subAccount()->getSubAccountList(); // Get specific sub-account with pagination $subAccounts = Bingx::subAccount()->getSubAccountList( subAccountString: 'sub_account_001', current: 1, size: 10 ); // Get sub-account assets $assets = Bingx::subAccount()->getSubAccountAssets('12345678'); // Update sub-account status Bingx::subAccount()->updateSubAccountStatus('sub_account_001', 1); // 1: enable, 2: disable // Get all sub-account balances $balances = Bingx::subAccount()->getAllSubAccountBalances(); ``` #### Sub-Account API Key Management [](#sub-account-api-key-management) ``` // Create API key for sub-account $apiKey = Bingx::subAccount()->createSubAccountApiKey( subAccountString: 'sub_account_001', label: 'Trading Bot', permissions: ['spot' => true, 'futures' => true], ip: '192.168.1.1' // Optional IP whitelist ); // Query API key information $apiKeys = Bingx::subAccount()->queryApiKey('sub_account_001'); // Edit sub-account API key Bingx::subAccount()->editSubAccountApiKey( subAccountString: 'sub_account_001', apiKey: 'your_api_key', permissions: ['spot' => true, 'futures' => false], ip: '192.168.1.100' ); // Delete sub-account API key Bingx::subAccount()->deleteSubAccountApiKey('sub_account_001', 'your_api_key'); ``` #### Sub-Account Transfers [](#sub-account-transfers) ``` // Authorize sub-account for internal transfers Bingx::subAccount()->authorizeSubAccountInternalTransfer('sub_account_001', 1); // 1: authorize, 0: revoke // Sub-account internal transfer // Wallet types: 1=Fund Account, 2=Standard Futures, 3=Perpetual Futures, 15=Spot Account // User account types: 1=UID, 2=Phone number, 3=Email $transfer = Bingx::subAccount()->subAccountInternalTransfer( coin: 'USDT', walletType: 15, // Spot Account amount: 100.0, userAccountType: 1, // UID userAccount: '12345678', callingCode: null, // Required when userAccountType=2 transferClientId: 'transfer-001', // Optional custom ID recvWindow: null ); // Sub-Mother Account Asset Transfer (master account only) // Flexible transfer between parent and sub-accounts $transfer = Bingx::subAccount()->subMotherAccountAssetTransfer( assetName: 'USDT', transferAmount: 100.0, fromUid: 123456, fromType: 1, // 1=Parent account, 2=Sub-account fromAccountType: 1, // 1=Funding, 2=Standard futures, 3=Perpetual U-based, 15=Spot toUid: 789012, toType: 2, // 1=Parent account, 2=Sub-account toAccountType: 15, // Spot account remark: 'Transfer to sub-account', recvWindow: null ); // Query transferable amount (master account only) $transferable = Bingx::subAccount()->getSubMotherAccountTransferableAmount( fromUid: 123456, fromAccountType: 1, // Funding toUid: 789012, toAccountType: 15, // Spot recvWindow: null ); // Query transfer history (master account only) $history = Bingx::subAccount()->getSubMotherAccountTransferHistory( uid: 123456, type: null, // Optional filter tranId: null, // Optional filter startTime: strtotime('-7 days') * 1000, endTime: time() * 1000, pageId: 1, pagingSize: 50, recvWindow: null ); // Get internal transfer records $records = Bingx::subAccount()->getSubAccountInternalTransferRecords( startTime: strtotime('-7 days') * 1000, endTime: time() * 1000, current: 1, size: 50 ); // Sub-account asset transfer $assetTransfer = Bingx::subAccount()->subAccountAssetTransfer( subUid: '12345678', type: 'FUND_PFUTURES', asset: 'USDT', amount: 100.0 ); // Get supported coins for sub-account transfers $supportedCoins = Bingx::subAccount()->getSubAccountTransferSupportedCoins('12345678'); // Get asset transfer history $history = Bingx::subAccount()->getSubAccountAssetTransferHistory( subUid: '12345678', type: 'FUND_PFUTURES', startTime: strtotime('-30 days') * 1000, endTime: time() * 1000 ); ``` #### Sub-Account Deposit Management [](#sub-account-deposit-management) ``` // Create deposit address for sub-account $address = Bingx::subAccount()->createSubAccountDepositAddress( coin: 'USDT', network: 'TRC20', subUid: '12345678' ); // Get sub-account deposit address $depositAddress = Bingx::subAccount()->getSubAccountDepositAddress( coin: 'USDT', subUid: '12345678', network: 'TRC20' ); // Get sub-account deposit history $deposits = Bingx::subAccount()->getSubAccountDepositHistory( subUid: '12345678', coin: 'USDT', status: 1, // 0: pending, 1: success, 6: credited but cannot withdraw startTime: strtotime('-30 days') * 1000, endTime: time() * 1000, limit: 100 ); ``` --- ### Copy Trading Service - Copy Trading Operations [](#copy-trading-service---copy-trading-operations) #### Perpetual Futures Copy Trading [](#perpetual-futures-copy-trading) ``` // Get current track orders $orders = Bingx::copyTrading()->getCurrentTrackOrders('BTC-USDT'); // Close position by order number $result = Bingx::copyTrading()->closeTrackOrder('1252864099381234567'); // Set take profit and stop loss Bingx::copyTrading()->setTPSL( positionId: '1252864099381234567', stopLoss: 48000.0, takeProfit: 52000.0 ); // Get trader details $details = Bingx::copyTrading()->getTraderDetail(); // Get profit summary $summary = Bingx::copyTrading()->getProfitSummary(); // Get profit details with pagination $profits = Bingx::copyTrading()->getProfitDetail( pageIndex: 1, pageSize: 20 ); // Set commission rate Bingx::copyTrading()->setCommission(5.0); // 5% commission // Get available trading pairs $pairs = Bingx::copyTrading()->getTradingPairs(); ``` #### Spot Copy Trading [](#spot-copy-trading) ``` // Sell spot order based on buy order ID $result = Bingx::copyTrading()->sellSpotOrder('1253517936071234567'); // Get spot trader details $details = Bingx::copyTrading()->getSpotTraderDetail(); // Get spot profit summary $summary = Bingx::copyTrading()->getSpotProfitSummary(); // Get spot profit details $profits = Bingx::copyTrading()->getSpotProfitDetail( pageIndex: 1, pageSize: 20 ); // Query historical spot orders $history = Bingx::copyTrading()->getSpotHistoryOrders( pageIndex: 1, pageSize: 50 ); ``` --- ### Contract Service - Standard Futures [](#contract-service---standard-futures) ``` // Get all positions for standard contracts $positions = Bingx::contract()->getAllPositions(); // Get historical orders for a specific symbol $orders = Bingx::contract()->getAllOrders( symbol: 'BTC-USDT', limit: 100, startTime: strtotime('-7 days') * 1000, endTime: time() * 1000 ); // Query standard contract account balance $balance = Bingx::contract()->getBalance(); // With custom parameters $positions = Bingx::contract()->getAllPositions( timestamp: time() * 1000, recvWindow: 5000 ); ``` --- ### WebSocket API [](#websocket-api) #### Install Dependency [](#install-dependency) ``` composer require textalk/websocket ``` #### Market Data Stream (Public Data) [](#market-data-stream-public-data) ``` use Tigusigalpa\BingX\WebSocket\MarketDataStream; $stream = new MarketDataStream(); $stream->connect(); // Subscribe to events $stream->subscribeTrade('BTC-USDT'); $stream->subscribeKline('BTC-USDT', '1m'); $stream->subscribeDepth('BTC-USDT', 20); $stream->subscribeTicker('BTC-USDT'); $stream->subscribeBookTicker('BTC-USDT'); // Handle messages $stream->onMessage(function ($data) { echo "Data: " . json_encode($data) . PHP_EOL; if (isset($data['dataType'])) { switch ($data['dataType']) { case 'BTC-USDT@trade': echo "New trade: {$data['data']['p']}"; break; case 'BTC-USDT@kline_1m': echo "New candle"; break; } } }); // Start listening $stream->listen(); // Unsubscribe and close $stream->unsubscribeTrade('BTC-USDT'); $stream->disconnect(); ``` #### Account Data Stream (Private Data) [](#account-data-stream-private-data) ``` use Tigusigalpa\BingX\WebSocket\AccountDataStream; // 1. Get Listen Key $response = Bingx::listenKey()->generate(); $listenKey = $response['listenKey']; // 2. Create connection $stream = new AccountDataStream($listenKey); $stream->connect(); // 3. Listen for updates $stream->onBalanceUpdate(function ($balances) { foreach ($balances as $balance) { echo "Balance {$balance['a']}: {$balance['wb']}"; } }); $stream->onPositionUpdate(function ($positions) { foreach ($positions as $position) { echo "Position {$position['s']}: {$position['pa']}"; } }); $stream->onOrderUpdate(function ($order) { echo "Order #{$order['i']}: {$order['X']}"; }); // 4. Start listening $stream->listen(); // 5. Extend Listen Key (every 30 minutes) Bingx::listenKey()->extend($listenKey); // 6. Close connection Bingx::listenKey()->delete($listenKey); $stream->disconnect(); ``` #### Listen Key Management [](#listen-key-management) ``` // Create new key (valid for 60 minutes) $response = Bingx::listenKey()->generate(); $listenKey = $response['listenKey']; // Extend validity (recommended every 30 minutes) Bingx::listenKey()->extend($listenKey); // Delete key Bingx::listenKey()->delete($listenKey); ``` --- ### Coin-M Perpetual Futures - Crypto-Margined Contracts [](#coin-m-perpetual-futures---crypto-margined-contracts) Coin-M futures are margined and settled in cryptocurrency (BTC, ETH, etc.) instead of USDT. API path: `/openApi/cswap/v1/`. #### Key Differences from USDT-M Futures [](#key-differences-from-usdt-m-futures) FeatureUSDT-M FuturesCoin-M Futures**Margin Currency**USDT (stablecoin)Cryptocurrency (BTC, ETH, etc.)**Settlement**USDTBase cryptocurrency**API Path**`/openApi/swap/v2/``/openApi/cswap/v1/`**Symbol Format**BTC-USDTBTC-USD, ETH-USD**Price Denomination**USD valueContracts per coin#### Market Data Endpoints [](#market-data-endpoints) ``` // Contract information $contracts = Bingx::coinM()->market()->getContracts(); // Current price and funding rate $ticker = Bingx::coinM()->market()->getTicker('BTC-USD'); // Open positions (open interest) $openPositions = Bingx::coinM()->market()->getOpenPositions('BTC-USD'); // K-line data $klines = Bingx::coinM()->market()->getKlines('BTC-USD', '1h', 100); // Order book depth $depth = Bingx::coinM()->market()->getDepth('BTC-USD', 20); // 24-hour price change $priceChange = Bingx::coinM()->market()->get24hrPriceChange('BTC-USD'); ``` #### Trading Endpoints [](#trading-endpoints) ``` // Place order $order = Bingx::coinM()->trade()->createOrder([ 'symbol' => 'BTC-USD', 'side' => 'BUY', 'positionSide' => 'LONG', 'type' => 'LIMIT', 'quantity' => 100, 'price' => 50000 ]); // Query leverage $leverage = Bingx::coinM()->trade()->getLeverage('BTC-USD'); // Set leverage Bingx::coinM()->trade()->setLeverage('BTC-USD', 10); // Get positions $positions = Bingx::coinM()->trade()->getPositions('BTC-USD'); // Get account balance $balance = Bingx::coinM()->trade()->getBalance(); // Cancel all orders Bingx::coinM()->trade()->cancelAllOrders('BTC-USD'); // Close all positions Bingx::coinM()->trade()->closeAllPositions('BTC-USD'); // Query margin type $marginType = Bingx::coinM()->trade()->getMarginType('BTC-USD'); // Set margin type (ISOLATED/CROSSED) Bingx::coinM()->trade()->setMarginType('BTC-USD', 'ISOLATED'); // Adjust isolated margin Bingx::coinM()->trade()->adjustMargin('BTC-USD', 'LONG', 100, 1); ``` #### Listen Key Management [](#listen-key-management-1) ``` // Generate listen key for WebSocket $response = Bingx::coinM()->listenKey()->generate(); $listenKey = $response['listenKey']; // Extend listen key validity (every 30 minutes) Bingx::coinM()->listenKey()->extend($listenKey); // Delete listen key when done Bingx::coinM()->listenKey()->delete($listenKey); ``` > **Note:** WebSocket streams for Coin-M are planned for future releases. Currently, you can use the listen key management for authentication. #### Hedging example [](#hedging-example) ``` // Hedge 1 BTC holding with Coin-M short position $btcHolding = 1.0; // 1 BTC in wallet $contractValue = 100; // USD per contract // Open short position to hedge $hedgeOrder = Bingx::coinM()->trade()->createOrder([ 'symbol' => 'BTC-USD', 'side' => 'SELL', 'positionSide' => 'SHORT', 'type' => 'MARKET', 'quantity' => $btcHolding * $contractValue // 100 contracts ]); // If BTC price drops, short position gains offset wallet loss // If BTC price rises, wallet gains offset short position loss ``` --- OrderBuilder - Advanced Order Creation -------------------------------------- [](#orderbuilder---advanced-order-creation) ### Simple Examples [](#simple-examples) ``` // Futures order with leverage $order = Bingx::trade()->order() ->futures() ->symbol('BTC-USDT') ->buy() ->long() ->type('LIMIT') ->margin(100) ->price(50000) ->leverage(10) ->execute(); // Spot limit order $order = Bingx::trade()->order() ->spot() ->symbol('ETH-USDT') ->sell() ->type('LIMIT') ->quantity(0.1) ->price(3000) ->execute(); ``` ### Orders with Protective Stops [](#orders-with-protective-stops) ``` // Long with percentage stops $order = Bingx::trade()->order() ->futures() ->symbol('BTC-USDT') ->buy() ->long() ->type('LIMIT') ->margin(200) ->price(50000) ->leverage(10) ->stopLossPercent(5) // Stop Loss 5% below ->takeProfitPercent(15) // Take Profit 15% above ->execute(); // Short with fixed prices $order = Bingx::trade()->order() ->futures() ->symbol('BTC-USDT') ->sell() ->short() ->type('MARKET') ->margin(150) ->leverage(5) ->stopLossPrice(52000) // Fixed Stop Loss ->takeProfitPrice(45000) // Fixed Take Profit ->execute(); ``` ### Advanced Parameters [](#advanced-parameters) ``` $order = Bingx::trade()->order() ->futures() ->symbol('BTC-USDT') ->buy() ->long() ->type('STOP_MARKET') ->margin(150) ->leverage(10) ->stopPrice(48000) // Entry trigger ->stopGuaranteed() // Guaranteed stop ->stopLoss(47000) // Protective stop loss ->takeProfit(51000) // Take profit ->reduceOnly() // Don't increase position ->clientOrderId('strategy-001') ->workingType('MARK_PRICE') ->newOrderRespType('FULL') ->recvWindow(5000) ->execute(); ``` ### Available OrderBuilder Methods [](#available-orderbuilder-methods) MethodDescriptionUse Case`spot()` / `futures()`Market typeRequired`symbol('BTC-USDT')`Trading pairRequired`buy()` / `sell()`DirectionRequired`type('MARKET|LIMIT|STOP')`Order typeRequired`long()` / `short()`PositionFutures`leverage(10)`Leverage (1-125)Futures`quantity(0.001)`Order sizeSpot`margin(100)`MarginFutures`price(50000)`PriceLIMIT/STOP`stopLoss(49000)`Stop loss (price)Futures`stopLossPercent(5)`Stop loss (%)Futures`takeProfit(52000)`Take profit (price)Futures`takeProfitPercent(10)`Take profit (%)Futures`clientOrderId('id')`Custom IDAll types`timeInForce('GTC')`Time in force (GTC/IOC/FOK)LIMIT/STOP`reduceOnly()`Close position onlyFutures`stopPrice(48000)`Trigger priceConditional`workingType('MARK_PRICE')`Trigger typeFutures`newOrderRespType('FULL')`Response formatAll types`test()`Test orderAll types--- Error Handling -------------- [](#error-handling) ``` use Tigusigalpa\BingX\Exceptions\{ BingxException, AuthenticationException, RateLimitException, InsufficientBalanceException, ApiException }; try { $balance = Bingx::account()->getBalance(); } catch (AuthenticationException $e) { // Authentication error (invalid key/signature) echo "Auth error: " . $e->getMessage(); } catch (RateLimitException $e) { // Request limit exceeded echo "Rate limit exceeded. Retry after: " . $e->getRetryAfter(); } catch (InsufficientBalanceException $e) { // Insufficient funds echo "Insufficient balance"; } catch (ApiException $e) { // API error (business logic) echo "API error: " . $e->getErrorCode() . " - " . $e->getMessage(); } catch (BingxException $e) { // Library general errors echo "BingX error: " . $e->getMessage(); } ``` --- Testing ------- [](#testing) ### Install Dependencies [](#install-dependencies) ``` composer install --dev ``` ### Setup Environment [](#setup-environment) ``` cp tests/.env.example tests/.env ``` Fill `tests/.env`: ``` BINGX_API_KEY=your_api_key_here BINGX_API_SECRET=your_api_secret_here BINGX_BASE_URI=https://open-api.bingx.com BINGX_TEST_SYMBOL=BTC-USDT BINGX_TEST_SYMBOL_SPOT=BTC-USDT BINGX_TEST_LEVERAGE=10 BINGX_TEST_MARGIN=100 BINGX_TEST_QUANTITY=0.001 ``` ### Run Tests [](#run-tests) ``` # Only safe tests (read-only) vendor/bin/phpunit # All tests including dangerous operations vendor/bin/phpunit --group dangerous # Specific services vendor/bin/phpunit tests/Integration/MarketServiceTest.php vendor/bin/phpunit tests/Integration/AccountServiceTest.php vendor/bin/phpunit tests/Integration/TradeServiceTest.php # Unit tests only vendor/bin/phpunit tests/Unit/ ``` ### Test Types [](#test-types) - **Unit tests** — check basic functionality without API calls - **Integration tests** — check real BingX API endpoints - **Safe tests** (`@group safe`) — read-only operations - **Dangerous tests** (`@group dangerous`) — data-modifying operations --- API Coverage ------------ [](#api-coverage) ServiceMethodsStatus**USDT-M Perpetual Futures**Market Service40✅TWAP Service7✅Account Service40✅Trade Service54✅Wallet Service6✅Spot Account Service9✅Sub-Account Service20✅Copy Trading Service13✅Contract Service3✅Listen Key Service3✅**Coin-M Perpetual Futures**Coin-M Market Service6✅Coin-M Trade Service17✅Coin-M Listen Key Service3✅**Total****220****100% Coverage**--- Documentation ------------- [](#documentation) - **Wiki** — [Documentation & Guides](https://github.com/tigusigalpa/bingx-php/wiki) - **BingX API** — - **GitHub Repository** — - **Issues & Support** — [GitHub Issues](https://github.com/tigusigalpa/bingx-php/issues) --- Versions -------- [](#versions) - **2.2.0** — Coin-M Perpetual Futures API (23 methods), crypto-margined contracts support - **2.1.0** — Quote API, TWAP orders, advanced trading features, position management (160+ methods) - **2.0.0** — Complete refactor: modular architecture, error handling, 100% API coverage - **1.0.0** — Basic authentication and wrappers - **0.1.0** — Initial release --- Author ------ [](#author) - **Igor Sazonov** (`@tigusigalpa`) - **Email:** - **GitHub:** [github.com/tigusigalpa](https://github.com/tigusigalpa) --- License ------- [](#license) MIT License — see [LICENSE](LICENSE) file for details. --- Contributing ------------ [](#contributing) Pull requests are welcome! Please ensure: 1. Code follows PSR-12 2. Tests are added for new functionality 3. Documentation is updated ### Getting Started with Development [](#getting-started-with-development) ``` # Fork the repository git clone https://github.com/your-username/bingx-php.git cd bingx-php # Create feature branch git checkout -b feature/YourFeature # Make changes and add tests # Run tests vendor/bin/phpunit # Commit and push git commit -m "Add your feature" git push origin feature/YourFeature # Open Pull Request ``` ### Health Score 45 — FairBetter than 92% of packages Maintenance93 Actively maintained with recent releases Popularity15 Limited adoption so far Community7 Small or concentrated contributor base Maturity53 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~19 days Recently: every ~28 days Total 8 Last Release 36d ago Major Versions v0.2.2 → v2.2.12025-11-30 v2.5.51 → v3.0.42026-04-05 ### Community Maintainers ![](https://www.gravatar.com/avatar/76c3a1d93c3213a8a22b4b637708d8b66a1ba3a5252624046cae7683a198b3a8?d=identicon)[tigusigalpa](/maintainers/tigusigalpa) --- Top Contributors [![tigusigalpa](https://avatars.githubusercontent.com/u/2721390?v=4)](https://github.com/tigusigalpa "tigusigalpa (24 commits)") --- Tags apibingxbingx-apibitcoinchainlinkcryptocurrencylaravelnear-protocolphp ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/tigusigalpa-bingx-php/health.svg) ``` [![Health](https://phpackages.com/badges/tigusigalpa-bingx-php/health.svg)](https://phpackages.com/packages/tigusigalpa-bingx-php) ``` ### Alternatives [skagarwal/google-places-api Google Places Api 1913.0M8](/packages/skagarwal-google-places-api)[dcblogdev/laravel-microsoft-graph A Laravel Microsoft Graph API (Office365) package 168285.5k1](/packages/dcblogdev-laravel-microsoft-graph)[vluzrmos/slack-api Wrapper for Slack.com WEB API. 102589.1k3](/packages/vluzrmos-slack-api)[smodav/mpesa M-Pesa API implementation 16363.7k1](/packages/smodav-mpesa)[jasara/php-amzn-selling-partner-api A fluent interface for Amazon's Selling Partner API in PHP 1344.8k1](/packages/jasara-php-amzn-selling-partner-api)[grantholle/powerschool-api A Laravel package to make interacting with PowerSchool less painful. 1715.6k1](/packages/grantholle-powerschool-api) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)