Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/owenvoke/vinex-php
A PHP wrapper for the Vinex API.
https://github.com/owenvoke/vinex-php
api composer php vinex wrapper
Last synced: about 1 month ago
JSON representation
A PHP wrapper for the Vinex API.
- Host: GitHub
- URL: https://github.com/owenvoke/vinex-php
- Owner: owenvoke
- License: mit
- Created: 2019-01-23T22:58:30.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-14T09:40:59.000Z (about 5 years ago)
- Last Synced: 2024-05-03T04:02:24.306Z (8 months ago)
- Topics: api, composer, php, vinex, wrapper
- Language: PHP
- Size: 49.8 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# VINEX PHP
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-travis]][link-travis]
[![Style CI][ico-styleci]][link-styleci]
[![Code Coverage][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]
A PHP wrapper for the VINEX API.
## Install
Via Composer
```bash
$ composer require pxgamer/vinex
```
## Usage
**Create an instance of the API**
```php
$adapter = new HttpAdapter('api-token');
$vinex = new Vinex($adapter);
$vinex->basic();
$vinex->general();
$vinex->account();
```
**Basic API calls**
```php
// 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**
```php
// Retrieve an array of Entity\MarketOrder instances
$vinex->general()->getMarketOrders('order-type', 'market');
```
**Account API calls**
```php
// 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](CHANGELOG.md) for more information on what has changed recently.
## Testing
```bash
$ composer test
```
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) and [CODE_OF_CONDUCT](.github/CODE_OF_CONDUCT.md) for details.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [pxgamer][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/pxgamer/vinex.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/pxgamer/vinex-php/master.svg?style=flat-square
[ico-styleci]: https://styleci.io/repos/167267153/shield
[ico-code-quality]: https://img.shields.io/codecov/c/github/pxgamer/vinex-php.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/pxgamer/vinex.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/pxgamer/vinex
[link-travis]: https://travis-ci.com/pxgamer/vinex-php
[link-styleci]: https://styleci.io/repos/167267153
[link-code-quality]: https://codecov.io/gh/pxgamer/vinex-php
[link-downloads]: https://packagist.org/packages/pxgamer/vinex
[link-author]: https://github.com/pxgamer
[link-contributors]: ../../contributors