README.md

changelly

A PHP wrapper for the Changelly API.

Install

Via Composer

$ composer require pxgamer/changelly

Usage

Creating instances

use pxgamer\Changelly\{Currencies,Transactions,Message};

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

Retrieve an array of currency names

Retrieve an array of strings stating the name of the currency.

$currencies->get();

Retrieve an array of currency stdClass instances

These contain the following information:

• name
• fullName
• enabled

$currencies->getFull();

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
• createdAt
• payinConfirmations
• status
• currencyFrom
• currencyTo

$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 security@pxgamer.xyz instead of using the issue tracker.

Credits

• pxgamer
• All Contributors

License

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