madmis/kuna-api

Kuna.io REST API php client

Kuna.io REST API PHP Client

![Build Status][testing-image] [][coverage-link] , _(*1)

Kuna.io provides REST APIs that you can use to interact with platform programmatically., _(*2)

This API client will help you interact with Kuna by REST API., _(*3)

Table Of Contents

• License
• Kuna REST API Reference
• Contributing
• Install
• Usage
  • Mapping
  • Error handling
• Running the tests
  • Running Unit tests
• Library api
  
  • Shared resources (Public Kuna API)
  • Private resources (Private Kuna API)

License

MIT License, _(*4)

Kuna REST API Reference

https://kuna.io/documents/api, _(*5)

Contributing

To create new endpoint - create issue or create pull request, _(*6)

Install

composer require cryptopupua/kuna-api 1.1.*

Usage

require __DIR__.'/vendor/autoload.php';

use cryptopupua\KunaApi\Api;
use cryptopupua\KunaApi\Exception\IncorrectResponseException;
use cryptopupua\KunaApi\KunaApi;
use cryptopupua\KunaApi\Model\History;
use cryptopupua\KunaApi\Model\MyAccount;
use cryptopupua\KunaApi\Model\Order;
use cryptopupua\KunaApi\Model\Ticker;


$api = new KunaApi(
    'https://kuna.io',
    'public key',
    'secret key'
);
$timestamp = $api->shared()->timestamp();

Mapping

Each endpoint response (exclude: timestamp) can be received as array or as object., _(*7)

To use mapping response to object set parameter $mapping to true., _(*8)

$issue = $api->signed()->activeOrders(Http::PAIR_ETHUAH, true);

// Result
[
    {
    class madmis\KunaApi\Model\Order {
        protected $id => 10003
        protected $side => "sell"
        protected $ordType => "limit"
        protected $price => 10000
        protected $avgPrice => 0
        protected $state => "wait"
        protected $market => "ethuah"
        protected $createdAt => DateTime
        protected $volume => 0.01
        protected $volume => 0.01
        protected $remainingVolume => 0.01
        protected $executedVolume => 0
        protected $tradesCount => 0
      }

    },
    ...
] 

Error handling

Each client request errors wrapped to custom exception madmis\ExchangeApi\Exception\ClientException, _(*9)

class madmis\ExchangeApi\Exception\ClientException {
  private $request => class GuzzleHttp\Psr7\Request
  private $response => NULL
  protected $message => "cURL error 7: Failed to connect to 127.0.0.1 port 8080: Connection refused (see http://curl.haxx.se/libcurl/c/libcurl-errors.html)"
  ...
}

ClientException contains original request object and response object if response available, _(*10)

class madmis\ExchangeApi\Exception\ClientException {
  private $request => class GuzzleHttp\Psr7\Request 
  private $response => class GuzzleHttp\Psr7\Response {
    private $reasonPhrase => "Unauthorized"
    private $statusCode => 401
    ...
  }
  protected $message => "Client error: 401"
  ...  
}

So, to handle errors use try/catch, _(*11)

try {
    $api->signed()->activeOrders(Http::PAIR_ETHUAH, true);
} catch (madmis\ExchangeApi\Exception\ClientException $ex) {
    // any actions (log error, send email, ...) 
}

Running the tests

To run the tests, you'll need to install phpunit. Easiest way to do this is through composer., _(*12)

composer install

Running Unit tests

php vendor/bin/phpunit -c phpunit.xml.dist

Library api

Shared resources (Public Kuna API)

• Time from the exchange server, _(*13)

  $timestamp = $api->shared()->timestamp();
  

• Recent Market Data, _(*14)

   $tickers = $api->shared()->tickers('btcuah');
  

• Order Book, _(*15)

   $orders = $api->shared()->orderBook('btcuah');
  

• Asks Order Book, _(*16)

   $orders = $api->shared()->asksOrderBook('btcuah');
  

• Bids Order Book, _(*17)

   $orders = $api->shared()->bidsOrderBook('btcuah');
  

• Trades History, _(*18)

   $orders = $api->shared()->tradesHistory('btcuah');
  

Private resources (Private Kuna API)

• Information About the User and Assets, _(*19)

   $orders = $api->signed()->me();
  

• Order Placing - create BUY order, _(*20)

   $orders = $api->signed()->createBuyOrder('btcuah', 1.00, 350000, true);
  

• Order Placing - create SELL order, _(*21)

   $orders = $api->signed()->createSellOrder('btcuah', 1.00, 420000, true);
  

• Order Cancel, _(*22)

   $orders = $api->signed()->cancelOrder(124578, true);
  

• Active User Orders, _(*23)

   $orders = $api->signed()->activeOrders('btcuah', true);
  

• User Trade History, _(*24)

   $orders = $api->signed()->myHistory('btcuah', true);