cryptomkt/cryptomkt-guzzle-php

Crypto Market PHP Client

CryptoMarket PHP Client

Official Client library CryptoMarket API v1 to integrate CryptoMarket into your PHP project, using Guzzle Http client [Guzzle][3]., _(*1)

Installation

This library could be installed using Composer. Please read the Composer Documentation., _(*2)

"require": {
    "cryptomkt/cryptomkt-guzzle-php": "dev-master"
}

Authentication

API Key

Use an API key and secret to access your own Crypto Market account., _(*3)

use Cryptomkt\Exchange\Client;
use Cryptomkt\Exchange\Configuration;

$configuration = Configuration::apiKey($apiKey, $apiSecret);
$client = Client::create($configuration);

Warnings

this library will log all warnings to a standard PSR-3 logger if one is configured., _(*4)

use Cryptomkt\Exchange\Client;
use Cryptomkt\Exchange\Configuration;

$configuration = Configuration::apiKey($apiKey, $apiSecret);
$configuration->setLogger($logger);
$client = Client::create($configuration);

Responses

Each resource object has a getRawData() method which you can use to access any field that are not mapped to the object properties., _(*5)

$data = $markets->getRawData();

Raw data from the last HTTP response is also available on the client object., _(*6)

$data = $client->decodeLastResponse();

Usage

For more references, go to the official documentation., _(*7)

Market Data

List markets, _(*8)

$markets = $client->getMarkets();

Get ticker, _(*9)

$arguments = array('market' => 'ETHARS');
$ticker = $client->getTicker($arguments); 

Get trades, _(*10)

$arguments = array('market' => 'ETHCLP','start' => '2017-05-20', 'end' => '2017-05-30', 'page' => 1);
$trades = $client->getTrades($arguments);

Orders

Get orders, _(*11)

$arguments = array('market' => 'ETHARS','type' => 'buy', 'page' => 1);
$orders = $client->getOrders($arguments); 

Get order, _(*12)

$arguments = array('id' => 'M107435');
$order = $client->getOrder($arguments);  

Get active orders, _(*13)

$arguments = array('market' => 'ETHCLP', 'page' => 0);
$active_orders = $client->getActiveOrders($arguments); 

Get executed orders, _(*14)

$arguments = array('market' => 'ETHCLP', 'page' => 0);
var_dump($client->getExecutedOrders($arguments)); 

Create order, _(*15)

$arguments = array(
        'amount' => '0.3',
        'market' => 'ethclp',
        'price' => '200000',
        'type' => 'sell'
    );
$response = $client->createOrder($arguments); 

Cancel order, _(*16)

$arguments = array('id' => 'M107441');
$response = $client->cancelOrder($arguments); 

Balance

Get balance, _(*17)

$response = $client->getBalance(); 

Create pay order, _(*18)

$arguments = array(
    'to_receive' => '3000',
    'to_receive_currency' => 'CLP',
    'payment_receiver' => 'receiver@email.com',
    'external_id' => '123456CM',
    'callback_url' => '',
    'error_url' => '',
    'success_url' => '',
    'refund_email' => 'refund@email.com'
);

$response = $client->createPayOrder($arguments);  

Pay orders

Get pay order, _(*19)

$arguments = array('id' => 'P13565');
$response = $client->getPayOrder($arguments);  

Get pay orders, _(*20)

$arguments = array('start_date' => '1/05/2018','end_date' => '31/05/2018');
$response = $client->getPayOrders($arguments);  

## Contributing and testing

The test suite is built using PHPUnit. Run the suite of unit tests by running
the `phpunit` command.

phpunit ```, _(*21)