Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
Apr 18, 2021
Mar 4, 2021
Jan 8, 2019
Jan 31, 2019
Mar 4, 2021

PHP SDK for KuCoin API

The detailed document https://docs.kucoin.com, in order to receive the latest API change notifications, please Watch this repository.

Latest Version PHP Version Build Status Total Downloads License

Requirements

Dependency Requirement
PHP >=5.5.0 Recommend PHP7+
guzzlehttp/guzzle ^6.0|^7.0

Install

Install package via Composer.

composer require "kucoin/kucoin-php-sdk:~1.1.0"

Usage

Choose environment

Environment BaseUri
Production https://api.kucoin.com(DEFAULT) https://api.kucoin.top
Sandbox https://openapi-sandbox.kucoin.com
// Switch to the sandbox environment
KuCoinApi::setBaseUri('https://openapi-sandbox.kucoin.com');

Debug mode & logging

// Debug mode will record the logs of API and WebSocket to files in the directory "KuCoinApi::getLogPath()" according to the minimum log level "KuCoinApi::getLogLevel()".
KuCoinApi::setDebugMode(true);

// Logging in your code
// KuCoinApi::setLogPath('/tmp');
// KuCoinApi::setLogLevel(Monolog\Logger::DEBUG);
KuCoinApi::getLogger()->debug("I'm a debug message");

Examples

See the test case for more examples.

Example of API without authentication

use KuCoin\SDK\PublicApi\Time;

$api = new Time();
$timestamp = $api->timestamp();
var_dump($timestamp);
Note

To reinforce the security of the API, KuCoin upgraded the API key to version 2.0, the validation logic has also been changed. It is recommended to create(https://www.kucoin.com/account/api) and update your API key to version 2.0. The API key of version 1.0 will be still valid until May 1, 2021

Example of API with authentication

use KuCoin\SDK\PrivateApi\Account;
use KuCoin\SDK\Exceptions\HttpException;
use KuCoin\SDK\Exceptions\BusinessException;
use Kucoin\SDK\Auth;

// Auth version v2 (recommend)
$auth = new Auth('key', 'secret', 'passphrase', Auth::API_KEY_VERSION_V2);
// Auth version v1
// $auth = new Auth('key', 'secret', 'passphrase');

$api = new Account($auth);

try {
    $result = $api->getList(['type' => 'main']);
    var_dump($result);
} catch (HttpException $e) {
    var_dump($e->getMessage());
} catch (BusinessException $e) {
    var_dump($e->getMessage());
}

Example of WebSocket feed

use KuCoin\SDK\Auth;
use KuCoin\SDK\PrivateApi\WebSocketFeed;
use Ratchet\Client\WebSocket;
use React\EventLoop\Factory;
use React\EventLoop\LoopInterface;

$auth = null;
// Need to pass the Auth parameter when subscribing to a private channel($api->subscribePrivateChannel()).
// $auth = new Auth('key', 'secret', 'passphrase');
$api = new WebSocketFeed($auth);

// Use a custom event loop instance if you like
//$loop = Factory::create();
//$loop->addPeriodicTimer(1, function () {
//    var_dump(date('Y-m-d H:i:s'));
//});
//$api->setLoop($loop);

$query = ['connectId' => uniqid('', true)];
$channels = [
    ['topic' => '/market/ticker:KCS-BTC'], // Subscribe multiple channels
    ['topic' => '/market/ticker:ETH-BTC'],
];

$api->subscribePublicChannels($query, $channels, function (array $message, WebSocket $ws, LoopInterface $loop) use ($api) {
    var_dump($message);

    // Unsubscribe the channel
    // $ws->send(json_encode($api->createUnsubscribeMessage('/market/ticker:ETH-BTC')));

    // Stop loop
    // $loop->stop();
}, function ($code, $reason) {
    echo "OnClose: {$code} {$reason}\n";
});

⚡️Coroutine HTTP client for asynchronous IO

See the benchmark, almost 20x faster than curl.

pecl install swoole
composer require swlib/saber
use KuCoin\SDK\Auth;
use KuCoin\SDK\Http\SwooleHttp;
use KuCoin\SDK\KuCoinApi;
use KuCoin\SDK\PrivateApi\Order;
use KuCoin\SDK\PublicApi\Time;

// Require PHP 7.1+ and Swoole 2.1.2+
// Require running in cli mode

go(function () {
    $api = new Time(null, new SwooleHttp);
    $timestamp = $api->timestamp();
    var_dump($timestamp);
});

go(function () {
    // Auth version v2 (recommend)
    $auth = new Auth('key', 'secret', 'passphrase', Auth::API_KEY_VERSION_V2);
    // Auth version v1
    // $auth = new Auth('key', 'secret', 'passphrase');
    $api = new Order($auth, new SwooleHttp);
    // Create 50 orders CONCURRENTLY in 1 second
    for ($i = 0; $i < 50; $i++) {
        go(function () use ($api, $i) {
            $order = [
                'clientOid' => uniqid(),
                'price'     => '1',
                'size'      => '1',
                'symbol'    => 'BTC-USDT',
                'type'      => 'limit',
                'side'      => 'buy',
                'remark'    => 'ORDER#' . $i,
            ];
            try {
                $result = $api->create($order);
                var_dump($result);
            } catch (\Throwable $e) {
                var_dump($e->getMessage());
            }
        });
    }
});

API list

KuCoin\SDK\PrivateApi\TradeFee
API Authentication Description
KuCoin\SDK\PrivateApi\TradeFee::getBaseFee() YES https://docs.kucoin.com/#basic-user-fee
KuCoin\SDK\PrivateApi\TradeFee::getTradeFees() YES https://docs.kucoin.com/#actual-fee-rate-of-the-trading-pair
KuCoin\SDK\PrivateApi\StopOrder
API Authentication Description
KuCoin\SDK\PrivateApi\StopOrder::create() YES https://docs.kucoin.com/#place-a-new-order-2
KuCoin\SDK\PrivateApi\StopOrder::cancel() YES https://docs.kucoin.com/#cancel-an-order-2
KuCoin\SDK\PrivateApi\StopOrder::cancelBatch() YES https://docs.kucoin.com/#cancel-orders
KuCoin\SDK\PrivateApi\StopOrder::getDetail() YES https://docs.kucoin.com/#get-single-order-info
KuCoin\SDK\PrivateApi\StopOrder::getList() YES https://docs.kucoin.com/#list-stop-orders
KuCoin\SDK\PrivateApi\StopOrder::getDetailByClientOid() YES https://docs.kucoin.com/#get-single-order-by-clientoid
KuCoin\SDK\PrivateApi\StopOrder::cancelByClientOid() YES https://docs.kucoin.com/#cancel-single-order-by-clientoid-2
KuCoin\SDK\PrivateApi\Account
API Authentication Description
KuCoin\SDK\PrivateApi\Account::create() YES https://docs.kucoin.com/#create-an-account
KuCoin\SDK\PrivateApi\Account::getList() YES https://docs.kucoin.com/#list-accounts
KuCoin\SDK\PrivateApi\Account::getDetail() YES https://docs.kucoin.com/#get-an-account
KuCoin\SDK\PrivateApi\Account::getLedgers() YES DEPRECATED https://docs.kucoin.com/#get-account-ledgers-deprecated
KuCoin\SDK\PrivateApi\Account::getHolds() YES https://docs.kucoin.com/#get-holds
KuCoin\SDK\PrivateApi\Account::innerTransfer() YES DEPRECATED https://docs.kucoin.com/#inner-transfer
KuCoin\SDK\PrivateApi\Account::innerTransferV2() YES https://docs.kucoin.com/#inner-transfer
KuCoin\SDK\PrivateApi\Account::getSubAccountUsers() YES https://docs.kucoin.com/#get-user-info-of-all-sub-accounts
KuCoin\SDK\PrivateApi\Account::getSubAccountDetail() YES https://docs.kucoin.com/#get-account-balance-of-a-sub-account
KuCoin\SDK\PrivateApi\Account::getSubAccountList() YES https://docs.kucoin.com/#get-the-aggregated-balance-of-all-sub-accounts-of-the-current-user
KuCoin\SDK\PrivateApi\Account::subTransfer() YES DEPRECATED https://docs.kucoin.com/#transfer-between-master-account-and-sub-account
KuCoin\SDK\PrivateApi\Account::subTransferV2() YES https://docs.kucoin.com/#transfer-between-master-user-and-sub-user
KuCoin\SDK\PrivateApi\Account::getLedgersV2() YES https://docs.kucoin.com/#get-account-ledgers
KuCoin\SDK\PrivateApi\Deposit
API Authentication Description
KuCoin\SDK\PrivateApi\Deposit::createAddress() YES https://docs.kucoin.com/#create-deposit-address
KuCoin\SDK\PrivateApi\Deposit::getAddress() YES https://docs.kucoin.com/#get-deposit-address
KuCoin\SDK\PrivateApi\Deposit::getDeposits() YES https://docs.kucoin.com/#get-deposit-list
KuCoin\SDK\PrivateApi\Deposit::getV1Deposits() YES https://docs.kucoin.com/#get-v1-historical-deposits-list
KuCoin\SDK\PrivateApi\Fill
API Authentication Description
KuCoin\SDK\PrivateApi\Fill::getList() YES https://docs.kucoin.com/#list-fills
KuCoin\SDK\PrivateApi\Fill::getRecentList() YES https://docs.kucoin.com/#recent-fills
KuCoin\SDK\PrivateApi\Order
API Authentication Description
KuCoin\SDK\PrivateApi\Order::create() YES https://docs.kucoin.com/#place-a-new-order
KuCoin\SDK\PrivateApi\Order::createMulti() YES https://docs.kucoin.com/#place-bulk-orders
KuCoin\SDK\PrivateApi\Order::cancel() YES https://docs.kucoin.com/#cancel-an-order
KuCoin\SDK\PrivateApi\Order::cancelAll() YES https://docs.kucoin.com/#cancel-all-orders
KuCoin\SDK\PrivateApi\Order::getList() YES https://docs.kucoin.com/#list-orders
KuCoin\SDK\PrivateApi\Order::getV1List() YES https://docs.kucoin.com/#get-v1-historical-orders-list
KuCoin\SDK\PrivateApi\Order::getDetail() YES https://docs.kucoin.com/#get-an-order
KuCoin\SDK\PrivateApi\Order::getRecentList() YES https://docs.kucoin.com/#recent-orders
KuCoin\SDK\PrivateApi\Order::createMarginOrder() YES https://docs.kucoin.com/#place-a-margin-order
KuCoin\SDK\PrivateApi\Order::cancelByClientOid() YES https://docs.kucoin.com/#cancel-single-order-by-clientoid
KuCoin\SDK\PrivateApi\Order::getDetailByClientOid() YES https://docs.kucoin.com/#get-single-active-order-by-clientoid
KuCoin\SDK\PrivateApi\WebSocketFeed
API Authentication Description
KuCoin\SDK\PrivateApi\WebSocketFeed::getPublicServer() NO https://docs.kucoin.com/#apply-connect-token
KuCoin\SDK\PrivateApi\WebSocketFeed::getPrivateServer() YES https://docs.kucoin.com/#apply-connect-token
KuCoin\SDK\PrivateApi\WebSocketFeed::subscribePublicChannel() NO https://docs.kucoin.com/#public-channels
KuCoin\SDK\PrivateApi\WebSocketFeed::subscribePublicChannels() NO https://docs.kucoin.com/#public-channels
KuCoin\SDK\PrivateApi\WebSocketFeed::subscribePrivateChannel() YES https://docs.kucoin.com/#private-channels
KuCoin\SDK\PrivateApi\WebSocketFeed::subscribePrivateChannels() YES https://docs.kucoin.com/#private-channels
KuCoin\SDK\PrivateApi\Withdrawal
API Authentication Description
KuCoin\SDK\PrivateApi\Withdrawal::getQuotas() YES https://docs.kucoin.com/#get-withdrawal-quotas
KuCoin\SDK\PrivateApi\Withdrawal::getList() YES https://docs.kucoin.com/#get-withdrawals-list
KuCoin\SDK\PrivateApi\Withdrawal::getV1List() YES https://docs.kucoin.com/#get-v1-historical-withdrawals-list
KuCoin\SDK\PrivateApi\Withdrawal::apply() YES https://docs.kucoin.com/#apply-withdraw
KuCoin\SDK\PrivateApi\Withdrawal::cancel() YES https://docs.kucoin.com/#cancel-withdrawal
KuCoin\SDK\PublicApi\Currency
API Authentication Description
KuCoin\SDK\PublicApi\Currency::getList() NO https://docs.kucoin.com/#get-currencies
KuCoin\SDK\PublicApi\Currency::getDetail() NO https://docs.kucoin.com/#get-currency-detail
KuCoin\SDK\PublicApi\Currency::getPrices() NO https://docs.kucoin.com/#get-fiat-price
KuCoin\SDK\PublicApi\Symbol
API Authentication Description
KuCoin\SDK\PublicApi\Symbol::getList() NO https://docs.kucoin.com/#get-symbols-list
KuCoin\SDK\PublicApi\Symbol::getTicker() NO https://docs.kucoin.com/#get-ticker
KuCoin\SDK\PublicApi\Symbol::getAllTickers() NO https://docs.kucoin.com/#get-all-tickers
KuCoin\SDK\PublicApi\Symbol::getAggregatedPartOrderBook() NO https://docs.kucoin.com/#get-part-order-book-aggregated
KuCoin\SDK\PublicApi\Symbol::getAggregatedFullOrderBook() NO https://docs.kucoin.com/#get-full-order-book-aggregated
KuCoin\SDK\PublicApi\Symbol::getAtomicFullOrderBook() NO https://docs.kucoin.com/#get-full-order-book-atomic
KuCoin\SDK\PublicApi\Symbol::getTradeHistories() NO https://docs.kucoin.com/#get-trade-histories
KuCoin\SDK\PublicApi\Symbol::getKLines() NO https://docs.kucoin.com/#get-klines
KuCoin\SDK\PublicApi\Symbol::get24HStats() NO https://docs.kucoin.com/#get-24hr-stats
KuCoin\SDK\PublicApi\Symbol::getMarkets() NO https://docs.kucoin.com/#get-market-list
KuCoin\SDK\PrivateApi\Margin
API Authentication Description
KuCoin\SDK\PrivateApi\Margin::getMarkPrice() YES https://docs.kucoin.com/#margin-info
KuCoin\SDK\PrivateApi\Margin::getConfig() YES https://docs.kucoin.com/#get-margin-configuration-info
KuCoin\SDK\PrivateApi\Margin::getAccount() YES https://docs.kucoin.com/#get-margin-account
KuCoin\SDK\PrivateApi\Margin::borrow() YES https://docs.kucoin.com/#post-borrow-order
KuCoin\SDK\PrivateApi\Margin::getBorrow() YES https://docs.kucoin.com/#get-borrow-order
KuCoin\SDK\PrivateApi\Margin::getOutstanding() YES https://docs.kucoin.com/#get-repay-record
KuCoin\SDK\PrivateApi\Margin::getRepayRecord() YES https://docs.kucoin.com/#get-repayment-record
KuCoin\SDK\PrivateApi\Margin::repayAll() YES https://docs.kucoin.com/#one-click-repayment
KuCoin\SDK\PrivateApi\Margin::repaySingle() YES https://docs.kucoin.com/#repay-a-single-order
KuCoin\SDK\PrivateApi\Margin::lend() YES https://docs.kucoin.com/#post-lend-order
KuCoin\SDK\PrivateApi\Margin::cancelLend() YES https://docs.kucoin.com/#cancel-lend-order
KuCoin\SDK\PrivateApi\Margin::setAutoLend() YES https://docs.kucoin.com/#set-auto-lend
KuCoin\SDK\PrivateApi\Margin::getLendActive() YES https://docs.kucoin.com/#get-active-order
KuCoin\SDK\PrivateApi\Margin::getLendDone() YES https://docs.kucoin.com/#get-lent-history
KuCoin\SDK\PrivateApi\Margin::getUnsettled() YES https://docs.kucoin.com/#get-active-lend-order-list
KuCoin\SDK\PrivateApi\Margin::getSettled() YES https://docs.kucoin.com/#get-settled-lend-order-history
KuCoin\SDK\PrivateApi\Margin::getLendAssets() YES https://docs.kucoin.com/#get-account-lend-record
KuCoin\SDK\PrivateApi\Margin::getMarket() YES https://docs.kucoin.com/#lending-market-data
KuCoin\SDK\PrivateApi\Margin::getTradeLast() YES https://docs.kucoin.com/#margin-trade-data
KuCoin\SDK\PublicApi\Time
API Authentication Description
KuCoin\SDK\PublicApi\Time::timestamp() NO https://docs.kucoin.com/#server-time
KuCoin\SDK\PublicApi\ServiceStatus
API Authentication Description
KuCoin\SDK\PublicApi\ServiceStatus::getStatus() NO https://docs.kucoin.com/#service-status

Run tests

Modify your API key in phpunit.xml first.

# Add your API configuration items into the environmental variable first
export API_BASE_URI=https://api.kucoin.com
export API_KEY=key
export API_SECRET=secret
export API_PASSPHRASE=passphrase
export API_KEY_VERSION=2

composer test

License

MIT