openclerk/exchanges

Definitions and implementations of exchanges in Openclerk

openclerk/exchanges

A library for accessing live exchange market data for many different exchanges, used by Openclerk and live on CryptFolio., _(*1)

This extends on the abstract currency definitions provided by openclerk/currencies., _(*2)

Installing

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

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

• Exchanges supported

Using

Get the markets supported by an exchanges:, _(*4)

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:, _(*5)

$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., _(*6)

composer install
vendor/bin/phpunit

To run the tests for a single exchange:, _(*7)

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., _(*8)

Donate

Donations are appreciated., _(*9)

Contributing

Pull requests that contribute new exchanges are welcome., _(*10)

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

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