whitebit / php-sdk

1.0.2 2024-04-17 07:52 UTC

Requires

• php: ^8.2
• ext-json: *
• illuminate/collections: ^9.0|^10.0|^11.0
• illuminate/support: ^9.0|^10.0|^11.0
• saloonphp/saloon: ^2.0

Requires (Dev)

• laravel/pint: dev-main
• mockery/mockery: 2.0.x-dev
• pestphp/pest: 2.x-dev
• phpstan/phpstan: 1.11.x-dev
• rector/rector: ^1.0.4

MIT

Published on Packagist.org on 2024-04-17 07:53 UTC

README

Official PHP SDK for the WhiteBIT API. (WhiteBIT API Documentation)

Requirements

• PHP 8.2 or higher

Installation

You can install this SDK via Composer:

composer require whitebit/php-sdk

Usage

Plain PHP with autoload

<?php

use WhiteBIT\Sdk\Connectors\WhiteBITConnector;
use WhiteBIT\Sdk\Connectors\ConnectorConfig;
use WhiteBIT\Sdk\Requests\General\V1\KlineRequest;

$connector = new WhiteBITConnector(
    new ConnectorConfig('api_key', 'api_secret')
);

$connector->send(new KlineRequest('BTC_USDT'))

Laravel

Package automatically injects WhiteBITServiceProvider.php into your app.

Publish config

php artisan vendor:publish --provider="WhiteBIT\Sdk\WhiteBITServiceProvider"

Environment variables

WHITEBIT_PUBLIC_KEY=
WHITEBIT_SECRET_KEY=

Usage

namespace App\Http\Controllers;
 
use Illuminate\View\View;
use WhiteBIT\Sdk\Connectors\WhiteBITConnector;
use WhiteBIT\Sdk\Requests\General\V1\KlineRequest;
 
class ExampleController extends Controller
{

    public function show(WhiteBITConnector $connector): View
    {
        $response = $connector->send(new KlineRequest('BTC_USDT'));
    
        return response()->json(
            $response->json()
        );
    }
}

Notes

WhiteBITServiceProvider registers WhiteBITConnector as singleton, use it with care in runtimes like openswoole, roadrunner etc.

Available requests

Requests
├── General
│   ├── AssetsRequest.php
│   ├── CollateralMarketsRequest.php
│   ├── FeeRequest.php
│   ├── FutureMarketsRequest.php
│   ├── HealthRequest.php
│   ├── MarketActivityRequest.php
│   ├── MarketsRequest.php
│   ├── OrderBookRequest.php
│   ├── TimeRequest.php
│   ├── TradesRequest.php
│   └── V1
│       ├── KlineRequest.php
│       ├── MarketActivityRequest.php
│       ├── SingleMarketActivityRequest.php
│       └── TradeHistoryRequest.php
└── Private
    ├── AddressRequest.php
    ├── Codes
    │   ├── ApplyCodeRequest.php
    │   ├── CodesHistoryRequest.php
    │   ├── CreateCodeRequest.php
    │   └── MyCodesRequest.php
    ├── Main
    │   ├── CreateNewAddressRequest.php
    │   ├── CreateWithdrawPayRequest.php
    │   ├── CreateWithdrawRequest.php
    │   ├── FiatDepositUrlRequest.php
    │   ├── HistoryRequest.php
    │   └── TransferBetweenBalancesRequest.php
    ├── MainBalanceRequest.php
    └── Trade
        ├── Spot
        │   ├── DealsHistoryRequest.php
        │   ├── OrderDealsRequest.php
        │   ├── OrderHistoryRequest.php
        │   ├── Orders
        │   │   ├── CancelOrderRequest.php
        │   │   ├── CreateBulkLimitOrderRequest.php
        │   │   ├── CreateLimitOrderRequest.php
        │   │   ├── CreateMarketOrderRequest.php
        │   │   ├── CreateStockMarketOrderRequest.php
        │   │   ├── CreateStopLimitOrderRequest.php
        │   │   └── CreateStopMarketOrderRequest.php
        │   └── UnexecutedOrdersRequest.php
        ├── StatusKillSwitchRequest.php
        ├── SyncKillSwitchRequest.php
        └── TradeBalanceRequest.php