pxgamer/changenow

A PHP wrapper for the ChangeNOW API.

v1.0.0 2018-03-30 15:20 UTC

README

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

A PHP wrapper for the ChangeNOW API.

Install

Via Composer

$ composer require pxgamer/changenow

Usage

Creating instances

use pxgamer\ChangeNow\{Currencies,Transactions};

$currencies = new Currencies();
$transactions = new Transactions();

Retrieve an array of currency stdClass instances

These contain the following information:

  • ticker
  • name
  • image
$currencies->get();

Retrieve the minimum amount required to convert between 2 currencies

$currencies->minimumAmount('btc', 'etc');

Retrieve the estimated exchange value between 2 currencies

$currencies->exchangeAmount('btc', 'etc', 1.0);

Retrieve an array of transactions

Returns an array of transaction stdClass instances containing the following values:

  • id
  • status
  • payinConfirmations
  • hash
  • payinHash
  • payoutHash
  • payinAddress
  • payoutAddress
  • payinExtraId
  • payoutExtraId
  • fromCurrency
  • toCurrency
  • amountSend
  • amountReceive
  • networkFee
  • updatedAt
$transactions->get();

Retrieve a single transaction's status by ID

Returns a transaction status string.

$transactions->status('id');

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 owzie123@gmail.com instead of using the issue tracker.

Credits

License

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