dzarezenko/hitbtc-api

<?php

namespace hitbtc\api;

use hitbtc\api\tools\Request;

/**
 * HitBTC Trading API Methods.
 *
 * Please note that making more than 6 calls per second to the public API, or
 * repeatedly and needlessly fetching excessive amounts of data, can result in
 * your IP being banned.
 *
 * @link URL https://hitbtc.com/api
 *
 * @category HitBTC API
 * @author Dmytro Zarezenko <dmytro.zarezenko@gmail.com>
 * @copyright (c) 2017, Dmytro Zarezenko
 *
 * @git https://github.com/dzarezenko/hitbtc-api
 * @license http://opensource.org/licenses/MIT
 */
class HitBtcAPITrading {

    private $apiKey = "";
    private $apiSecret = "";

    private $request = null;

    /**
     * Constructor of the class.
     *
     * @param string $apiKey HitBTC API key
     * @param string $apiSecret HitBTC API secret
     * @param bool $isDemoAPI Demo API flag
     */
    public function __construct($apiKey, $apiSecret, $isDemoAPI = false) {
        $this->apiKey = $apiKey;
        $this->apiSecret = $apiSecret;

        $this->request = new Request($this->apiKey, $this->apiSecret, $this->apiVersion, $isDemoAPI);
    }

    /**
     * Returns all of your available balances.
     *
     * @param bool $hideZeroBalances Hide zero balances or not.
     *
     * @return array JSON data.
     */
    public function getBalances($hideZeroBalances = false) {
        switch ($this->apiVersion) {
            case 1:
                $balances = $this->request('balance');
                if ($hideZeroBalances) {
                    return array_filter($balances, function ($e) {
                        return ($e['cash'] != 0 || $e['reserved'] != 0);
                    });
                }
                break;
            case 2:
                $balances = $this->request('balance', "trading/balance");
                if ($hideZeroBalances) {
                    return array_filter($balances, function ($e) {
                        return ($e['available'] != 0 || $e['reserved'] != 0);
                    });
                }
                break;
        }

        return $balances;
    }

    /**
     * Returns all orders in status new or partiallyFilled.
     *
     * @param string $clientOrderId Unique order ID.
     *
     * @return array JSON data.
     */
    public function getActiveOrders($clientOrderId = null) {
        $params = [];
        if ($clientOrderId) {
            $params['clientOrderId'] = $clientOrderId;
        }

        switch ($this->apiVersion) {
            case 1:
                return $this->request('orders', "orders/active", $params);
            case 2:
                return $this->request('order', $clientOrderId ? "order/{$clientOrderId}" : null);
        }
    }

    /**
     * create a new buy order at the market price
     * (or other option from $optional['type']: limit, stopLimit, stopMarket).
     *
     * @param string $currency is a currency symbol traded on HitBTC exchange
     *           (see https://hitbtc.com/api#cursymbols)
     * @param string $amount order quantity
     * @param string $rate order price
     * @param array $optional Optional parameters array.
     *
     * @return json
     */
    public function buy($currency, $amount, $rate = null, $optional = []) {
         $optional['side'] = 'buy';

         return $this->addOrder($currency, $amount, $rate, $optional);
    }

    /**
     * create a new sell order at the market price
     * (or other option from $optional['type']: limit, stopLimit, stopMarket).
     *
     * @param string $currency is a currency symbol traded on HitBTC exchange
     *           (see https://hitbtc.com/api#cursymbols)
     * @param string $amount order quantity
     * @param string $rate order price
     * @param array $optional Optional parameters array.
     *
     * @return json
     */
    public function sell($currency, $amount, $rate = null, $optional = []) {
         $optional['side'] = 'sell';

         return $this->addOrder($currency, $amount, $rate, $optional);
    }

    /**
     * Create a new order at the market price.
     *
     * @param string $currency is a currency symbol traded on HitBTC exchange
     *           (see https://hitbtc.com/api#cursymbols)
     * @param string $amount order quantity
     * @param string $rate order price
     * @param array $params parameters array.
     *
     * @return json
     */
    public function addOrder($currency, $amount, $rate = null, $params = []) {
        $params['symbol'] = $currency;
        $params['quantity'] = $amount;
        if (empty($params['type'])) {
            $params['type'] = 'market';
        }
        if (!empty($rate)) {
            $params['price'] = $rate;
        }

        return $this->request('order', null, $params, 'POST');
    }

    /**
     * Closes all orders in status new or partiallyFilled.
     */
    public function cancelAllOrders() {
         return $this->request('order', null, [], 'DELETE');
    }
    /**
     * JSON request functionality wrapper.
     *
     * @param string $method API method name
     * @param string $request API request
     * @param string $httpmethod GET or POST
     *
     * @return array JSON data.
     */
    private function request($method, $request = null, $params = [], $httpmethod = 'GET') {
        if (is_null($request)) {
            $request = $method;
        }

        $response = $this->request->exec($request, $params, $httpmethod);

        if (isset($response[$method])) {
            return $response[$method];
        }

        return $response;
    }

}