pxgamer/vinex

A PHP wrapper for the VINEX API.

v1.0.0-beta.2 2019-02-06 17:02 UTC

README

Latest Version on Packagist Software License Build Status Style CI Code Coverage Total Downloads

A PHP wrapper for the VINEX API.

Install

Via Composer

$ composer require pxgamer/vinex

Usage

Create an instance of the API

$adapter = new HttpAdapter('api-token');
$vinex = new Vinex($adapter);

$vinex->basic();
$vinex->general();
$vinex->account();

Basic API calls

// Retrieve the current server unix timestamp (e.g. `1548690153`)
$vinex->basic()->getServerTime();
// Retrieve an array of Entity\Market instances
$vinex->basic()->getAllMarketInformation();
// Retreive a single Entity\Market instance
$vinex->basic()->getSingleMarketInformation('market');

General API calls

// Retrieve an array of Entity\MarketOrder instances
$vinex->general()->getMarketOrders('order-type', 'market');

Account API calls

// Retrieve an array of Entity\Balance instances
$vinex->account()->getAllBalanceInformation();
// Retrieve a single Entity\Balance instance
$vinex->account()->getSingleBalanceInformation('coin');
// Retrieve an array of Entity\Order instances
$vinex->account()->getMyOrders();
// Retrieve an array of Entity\Trade instances
$vinex->account()->getMyTrading();

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email security@pxgamer.xyz instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.