skylinezum / node-coinigy

Node wrapper for Coinigy's REST API
MIT License
18 stars 7 forks source link

node-coinigy

Promise based Node wrapper for Coinigy's REST API

Coinigy API Documentation

Coinigy API doesn't support application/json body for certain endpoints and requires application/x-www-form-urlencoded Known endpoints to fail - addOrder, cancelOrder, newsFeed. I support them still, but change it back to json in the future.

Install

npm install node-coinigy --save

Use

var Coinigy = require('node-coinigy');
var coinigy = new Coinigy('your-api-key', 'your-api-secret', 'api-root'); // 'https://api.coinigy.com/api/v1' is default for api-root

coinigy.activity()
.then(function (body) {
  console.log(body.data);
  console.log(body.notifications);
})
.catch(function (err) {
  console.log(err);
});

API

? means optional

Test

Test coverage is very small, so there are no guarantees that all endpoints work.

To run tests, create test-config.json using test-config-example.json.

npm test

Contributing

I made this very quickly so if anyone would like to help, please feel free to make a PR

TODO:

  1. Increase test coverage
  2. Documentation