https://github.com/m-tymchyk/kuna-api-php
Kuna Exchange PHP Rest API
https://github.com/m-tymchyk/kuna-api-php
composer kuna kuna-api-php
Last synced: 8 months ago
JSON representation
Kuna Exchange PHP Rest API
- Host: GitHub
- URL: https://github.com/m-tymchyk/kuna-api-php
- Owner: m-tymchyk
- Created: 2016-06-20T14:17:14.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-02-14T16:13:49.000Z (over 7 years ago)
- Last Synced: 2024-12-15T00:43:11.964Z (10 months ago)
- Topics: composer, kuna, kuna-api-php
- Language: PHP
- Homepage: https://kuna.io/documents/api
- Size: 43 KB
- Stars: 3
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
[<< Kuna API](https://github.com/reilag/kuna-api)
# Kuna Exchange PHP API
[](https://github.com/reilag/kuna-api-php/issues)
[](https://github.com/reilag/kuna-api-php/stargazers)
[](http://www.php.net/)
[](http://docs.guzzlephp.org/)
[](https://packagist.org/packages/reilag/kuna-api-php)
### WARNING! This is not a stable version!
PHP 5.6+ is required.
If you do not want to use Composer or use version less than PHP 5.6 , you can use [Simple API PHP Library](https://github.com/reilag/kuna-api-php-simple)
## 1. Install
You can add Kuna PHP API as a dependency using the **composer.phar** CLI:
```bash
# Install Composer
curl -sS https://getcomposer.org/installer | php
# Add dependency
php composer.phar require reilag/kuna-api-php:^1.0.1
```
Alternatively, you can specify Kuna PHP API as a dependency in your project's existing `composer.json` file:
```json
{
"require": {
"reilag/kuna-api-php": "^1.0.1"
}
}
```
After installing, you need to require Composer's autoloader:
```php
require 'vendor/autoload.php';
```
You can find out more on how to install Composer, configure autoloading, and other best-practices for defining dependencies at [getcomposer.org](//getcomposer.org).
## 2. Public methods
### 2.1. Timestamp
```php
use Kuna\Client;
$kuna = new Client();
$timestamp = $kuna->publicMethod()->timestamp(); //1466486485
```
### 2.2. Tickers
```php
use Kuna\Client;
use Kuna\Constant;
$kuna = new Client();
$tickers = $kuna->publicMethod()->tickers(Constant::MARKET_BTCUAH);
print_r($tickers);
```
Result:
```json
{
"at":1466486520,
"ticker":{
"buy": 18001.0,
"sell": 18939.0,
"low": 18000.0,
"high": 18999.0,
"last": 18000.0,
"vol": 1.6011
}
}
```
### 2.3. Order book
```php
use Kuna\Client;
use Kuna\Constant;
$kuna = new Client();
$orderBook = $kuna->publicMethod()->orderBook(Constant::MARKET_BTCUAH);
print_r($orderBook);
```
Result:
```json
{
"asks": [
{
"id": 1182,
"side": "sell",
"ord_type": "limit",
"price": 18939.0,
"avg_price": 0.0,
"state": "wait",
"market": "btcuah",
"created_at": "2016-06-21T05:09:02Z",
"volume": 0.0326,
"remaining_volume": 0.0326,
"executed_volume": 0.0,
"trades_count":0
}
],
"bids": [
{
"id": 1183,
"side": "buy",
"ord_type": "limit",
"price": 18001.0,
"avg_price": 0.0,
"state": "wait",
"market": "btcuah",
"created_at": "2016-06-21T05:09:03Z",
"volume": 0.0005,
"remaining_volume": 0.0005,
"executed_volume": 0.0,
"trades_count": 0
}
]
}
```
### 2.4. Trades
```php
use Kuna\Client;
use Kuna\Constant;
$kuna = new Client();
$trades = $kuna->publicMethod()->trades(Constant::MARKET_BTCUAH);
print_r($trades);
```
Result:
```json
[
{
"id": 338,
"price": 18000.0,
"volume": 0.369,
"funds": 6642.0,
"market": "btcuah",
"created_at": "2016-06-21T04:44:58Z",
"side": null
}
]
```
## 3. Private methods
```php
use Kuna\Client;
$kuna = new Client([
"publicKey" => "Your public key",
"secretKey" => "Your secret key",
]);
$privateMethod = $kuna->privateMethod();
```
### 3.1. My profile
```php
$me = $privateMethod->me();
print_r($me);
```
Result:
```json
{
"email": "your_email@email.com",
"activated": true,
"accounts": [
{
"currency": "btc",
"balance": 12.4123,
"locked": 0.42
},
{
"currency": "uah",
"balance": 233519.52,
"locked": 4981.315
}
]
}
```
### 3.2. Create new Order
```php
$orderMethod = $privateMethod->order();
/**
* $price
* $volume
* $side
* $market
*/
$newOrder = $orderMethod->create(18000, 0.1, Constant::SIDE_BUY, Constant::MARKET_BTCUAH);
print_r($newOrder);
```
Result:
```json
{
"id": 3091,
"side": "buy",
"ord_type": "market",
"price": 18000,
"avg_price": 0,
"state": "wait",
"market": "btcuah",
"created_at": "2016-06-21T05:09:02Z",
"volume": 0.1,
"remaining_volume": 0.1,
"executed_volume": 0,
"trades_count": 0
}
```
### 3.3. Delete order
```php
$orderMethod = $privateMethod->order();
/**
* @property int $orderId
*/
$deletedOrder = $orderMethod->delete(3091);
print_r($deletedOrder);
```
Result:
```json
{
"id": 3091,
"side": "buy",
"ord_type": "market",
"price": 18000,
"avg_price": 18000,
"state": "wait",
"market": "btcuah",
"created_at": "2016-06-21T05:09:02Z",
"volume": 0.1,
"remaining_volume": 0.05,
"executed_volume": 0.05,
"trades_count": 3
}
```
### 3.4. Active order list
```php
$orderMethod = $privateMethod->order();
$orderList = $orderMethod->orderList(Constant::MARKET_BTCUAH);
print_r($orderList);
```
Result:
```json
[
{
"id": 3994,
"side": "buy",
"ord_type": "market",
"price": 29000,
"avg_price": 40000,
"state": "wait",
"market": "btcuah",
"created_at": "2016-06-21T05:09:02Z",
"volume": 0.8,
"remaining_volume": 0.109,
"executed_volume": 0.691,
"trades_count": 8
}, {
"id": 40,
"side": "sell",
"ord_type": "market",
"price": 28000,
"avg_price": 29910,
"state": "wait",
"market": "btcuah",
"created_at": "2016-06-21T05:09:02Z",
"volume": 0.5,
"remaining_volume": 0.3,
"executed_volume": 0.2,
"trades_count": 10
}
]
```