https://github.com/linx05/bitso-node

A Node.js API Wrapper for the Bitso REST API
https://github.com/linx05/bitso-node

api bitcoin bitso cryptocurrency ethereum exchange ripple wrapper

Last synced: 3 days ago
JSON representation

A Node.js API Wrapper for the Bitso REST API

• Host: GitHub
• URL: https://github.com/linx05/bitso-node
• Owner: linx05
• License: mit
• Created: 2018-01-03T19:41:56.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-07-14T12:22:10.000Z (over 6 years ago)
• Last Synced: 2024-10-12T20:41:19.303Z (about 1 month ago)
• Topics: api, bitcoin, bitso, cryptocurrency, ethereum, exchange, ripple, wrapper
• Language: JavaScript
• Homepage:
• Size: 154 KB
• Stars: 1
• Watchers: 1
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bitso-Node-API

`npm install bitso-node-api`

A Node.js API Wrapper for the [Bitso REST API](https://bitso.com/api_info). Please refer to [their documentation](https://bitso.com/api_info) for the responses and parameters.

```javascript

var BitsoNode = require('bitso-node-api');

// Key and Secret are only necessary if you use the Private REST API

var bitsoClient = new BitsoNode({ 

  key: '1234',

  secret: 'secret',

 });

bitsoClient

  .public

  .availableBooks()

  .then(books => {

    console.log(books.prices);

  });

```

##How to Use

```javascript

const BitsoNode = require('bitso-node-api');

const client = new BitsoNode({

  key: "KEY",

  secret: "SECRET",

});

// Public API

client.public.ticker({

  book: BitsoNode.exchanges.BTC_MXN

})

  .then(res => console.log(res))

  .catch(err => console.log(err));

  

// Private API

client.private.accountStatus()

  .then(res => console.log(res))

  .catch(err => console.log(err));

```

To use private API methods that move any currency or change account

information you need to create the API client with the `authorizeMovements` parameter ser to true.

(REMEMBER TO USE AT YOUR OWN RISK!)

```javascript

const BitsoNode = require('bitso-node-api');

const client = new BitsoNode({

  key: "KEY",

  secret: "SECRET",

  authorizeMovements: true

});

client.private.placeOrder({

  book: BitsoNode.exchanges.BTC_MXN,

  side: 'buy',

  type: 'market',

  minor: '10000',

})

  .then(res => console.log(res))

  .catch(err => console.log(err));

```

# License

The MIT License (MIT)

Copyright (c) 2017 César Laredo

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.