Git Product home page Git Product logo

coinutjs's Introduction

CoinutJS

CircleCI Coverage Status

This is an unofficial API for coinut.com, sponsored by CoinRoster

Work In Progress!

Please note that this repository is a work in progress. The API is unstable and should not be considered production ready.

Getting Started

Setup

Install node.js, preferably with nvm.

Installation

npm install coinut - to install all dependencies

Usage

  • All functions return promises that resolve to the raw JSON objects returned by the Coinut API
  • The Coinut API uses snake_case. These values are returned as-is and are not converted to camelCase

See examples for code snippets that can be run directly from the terminal.

Instantiation

const coinut = new Coinut(username, apiKey);

Balance

coinut.getBalance()
  .then(responseData => {
    console.log('Balance:', responseData.balance);
    console.log('Free Margin:', responseData.free_margin);
    console.log('Margin:', responseData.margin);
  })
  .catch(error => {
    console.error('Error connecting to Coinut:', error.message);
  });

Retrieve Open Orders

coinut.getOrders()
  .then(orders => {
    console.log('Orders:', orders);
  })
  .catch(error => {
    console.error('Error connecting to Coinut:', error.message);
  });
);

Development

The following npm scripts have been configured:

  • npm build - compiles the src folder (ES6 code) into the dist folder (ES5 code, including source maps)
  • npm test - lints the code, runs all unit tests and creates code coverage reports
  • npm run lint - only lints the code (no message displayed on success, as per Unix standard)
  • npm run clean - deletes the dist and coverage folders

Contributors

License

See the LICENSE file for license rights and limitations (MIT).

coinutjs's People

Contributors

abmohan avatar sarmilan avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.