Skip to content

Latest commit

 

History

History
88 lines (68 loc) · 3.07 KB

Readme.md

File metadata and controls

88 lines (68 loc) · 3.07 KB
Raw

bit2c

A node.js module for accessing bit2c's (the Israeli bitcoin exchange) API.

Installing


npm install bit2c

Overview

The bit2c module provides a way to work with bit2c: the Israeli bitcoin exchange (www.bit2c.co.il). The API is documented at: http://www.bit2c.co.il/home/api

Usage

This is an example of accessing the public API

var bit2c = require('bit2c');

// getting current ticker
bit2c.getTicker('BtcNis', function(error, ticker) {
   console.log(ticker);
});

This is an example of accessing the private API

var bit2c = require('bit2c'),
   // the key and secret are taken from your bit2c account:
   // login->api tab-> generate new
   // always keep them safe - the best practice is to put them in env variables
   credentials = { 
      key: your-bit2c-key,
      secret: your-bit2c-secret-key
   };

// getting your current balance
bit2c.getBalance(credentials, function(error, balance) {
   console.log(balance);
});

Full Documentation

API reference

Contributions Welcome

We welcome contributions from the community and are pleased to have them. For bugs, enhancement requests and comments please open us issues. For code contribution please fork and ask for pull request: Please make sure you follow our coding style and that the tests are green. Make sure not to include your bit2c credentials in the source code.

Running Tests

If you want to run the tests that require access to the private API you should define 2 environment variables:

  • BIT2C_KEY - your bit2c key
  • BIT2C_SECRET - your bit2c secret

These keys can be taken from your bit2c account. Just login -> API tab -> generate new.

Warning! - these keys grant access to your bit2c account! keep them safe! During the test an order of 15 bitcoin for 15 Nis will be created and deleted for you, so maybe you will get lucky... If you don't want this to happen, just remove the environment variables.

For running the tests just clone the repository and then:


npm install
npm test

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.