openclerk/exchanges

There is no license information available for the latest version (0.1.0) of this package.

Definitions and implementations of exchanges in Openclerk

0.1.0 2017-09-11 07:36 UTC

Requires

• php: >=5.4.6
• monolog/monolog: ~1.11
• openclerk/apis: ^0.1
• openclerk/config: ^0.1
• openclerk/currencies: ^0.1

Requires (Dev)

• soundasleep/component-tests: dev-master

Unknown License

README

A library for accessing live exchange market data for many different exchanges, used by Openclerk and live on CryptFolio.

This extends on the abstract currency definitions provided by openclerk/currencies.

Installing

Include openclerk/exchanges as a requirement in your project composer.json, and run composer update to install it into your project:

{
  "require": {
    "openclerk/exchanges": "dev-master"
  }
}

• Exchanges supported

Using

Get the markets supported by an exchanges:

use \Monolog\Logger;

$logger = new Logger("log");

$exchange = new \Exchange\BTCe();
print_r($exchange->fetchMarkets($logger));

Get the current trade values for an exchange market, which will always include at least last_trade, and may include bid, ask, high, low, volume, avg and/or vwap:

$exchange = new \Exchange\BitNZ();
print_r($exchange->fetchRates('nzd', 'btc', $logger));

Tests

Each exchange comes with a suite of tests to check each associated service.

composer install
vendor/bin/phpunit

To run the tests for a single exchange:

vendor/bin/phpunit --bootstrap "vendor/autoload.php" test/CoinbaseTest

To get debug output for the tests (such as CURL requests and decoded output), add the --debug switch to your vendor/bin/phpunit command.

Donate

Donations are appreciated.

Contributing

Pull requests that contribute new exchanges are welcome.

For new currencies, make sure that you also provide an associated CurrencyTest so that the currency is automatically testable.

TODO

1. Generate README list of currencies/services automatically
2. Link to live APIs on CryptFolio
3. CI build server and link to test results