README

Also available: Zoomex Go Client

PHP/Laravel SDK for Zoomex crypto exchange API v3. Works with REST and WebSocket — market data, trading, positions, account, assets.

📖 Full Documentation on Wiki

What's inside

• Full Zoomex API v3 coverage (REST + WebSocket)
• HMAC-SHA256 request signing
• Laravel support out of the box (service provider, facade, config)
• Testnet/mainnet switching
• PHP 8.1+ with enums and strict types
• Tested with Pest

Requirements

• PHP 8.1+
• Composer
• Laravel 9/10/11/12 (optional)

Installation

composer require tigusigalpa/zoomex-php

Setup

Laravel

php artisan vendor:publish --tag=zoomex-config

.env:

ZOOMEX_API_KEY=your_api_key
ZOOMEX_SECRET_KEY=your_secret_key
ZOOMEX_TESTNET=false

Standalone PHP

use Tigusigalpa\Zoomex\Client;

$client = new Client([
    'api_key' => 'your_api_key',
    'secret_key' => 'your_secret_key',
    'testnet' => false,
]);

// or fluent style
$client = Client::make()
    ->withApiKey('your_api_key')
    ->withSecretKey('your_secret_key')
    ->withTestnet(false);

Quick examples

Get tickers

use Tigusigalpa\Zoomex\Facades\Zoomex;
use Tigusigalpa\Zoomex\DTO\Market\GetTickersRequest;
use Tigusigalpa\Zoomex\Enums\Category;

$tickers = Zoomex::market()->getTickers(
    new GetTickersRequest(category: Category::LINEAR, symbol: 'BTCUSDT')
);

Place order

use Tigusigalpa\Zoomex\DTO\Trade\PlaceOrderRequest;
use Tigusigalpa\Zoomex\Enums\{Category, OrderSide, OrderType, TimeInForce};

$order = Zoomex::trade()->placeOrder(new PlaceOrderRequest(
    category: Category::LINEAR,
    symbol: 'BTCUSDT',
    side: OrderSide::BUY,
    orderType: OrderType::LIMIT,
    qty: '0.01',
    price: '50000',
    timeInForce: TimeInForce::GTC
));

Get positions

use Tigusigalpa\Zoomex\DTO\Position\GetPositionInfoRequest;

$positions = Zoomex::position()->getPositionInfo(
    new GetPositionInfoRequest(category: Category::LINEAR, symbol: 'BTCUSDT')
);

Get wallet balance

use Tigusigalpa\Zoomex\DTO\Account\GetWalletBalanceRequest;
use Tigusigalpa\Zoomex\Enums\AccountType;

$balance = Zoomex::account()->getWalletBalance(
    new GetWalletBalanceRequest(accountType: AccountType::CONTRACT)
);

WebSocket — orderbook stream

use Tigusigalpa\Zoomex\WebSocket;

$ws = new WebSocket(['api_key' => '...', 'secret_key' => '...']);

$ws->subscribeOrderbook('BTCUSDT', 50, function ($data) {
    print_r($data);
});

$ws->run();

WebSocket — private order updates

$ws->subscribePrivateOrders(function ($data) {
    print_r($data);
});

API Reference

Market (public)

Trade (private)

Position (private)

Account (private)

Asset (private)

WebSocket Topics

Errors

Two exception types:

• ZoomexApiException — API returned error (retCode !== 0)
• ZoomexRequestException — HTTP/network failure

use Tigusigalpa\Zoomex\Exceptions\{ZoomexApiException, ZoomexRequestException};

try {
    $order = Zoomex::trade()->placeOrder($request);
} catch (ZoomexApiException $e) {
    // $e->retCode, $e->retMsg
} catch (ZoomexRequestException $e) {
    // network issue
}

Rate limits

See official docs.

Testing

composer test

Contributing

See CONTRIBUTING.md.

Security

Found a vulnerability? Email sovletig@gmail.com (don't open public issues).

Author

Igor Sazonov

Based on zoomex-go.

License

MIT. See LICENSE.

Links

• Zoomex API v3 docs
• Zoomex