Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

bittrex-api-wrapper

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

bittrex-api-wrapper

A simple wrapper around bittrex api

  • 1.1.0
  • latest
  • npm
  • Socket score

Version published
Weekly downloads
1
Maintainers
1
Weekly downloads
 
Created
Source

Bittrex API Wrapper

This is a simple Bittrex API wrapper. It gives you the ability to send any request to Bittrex's API, or to send known requests via a simple class.

I recommend to read the official API in order to better understand and use this module.

Installation

npm install bittrex-api-wrapper

Instanciation

const bittrex = require('bittrex-api-wrapper')('<API_KEY>', '<API_SECRET>');

API

This wrapper provides the entire Bittrex API. It follows a very simple nomenclature:

bittrex.<public|market|account>.<methodCamelCase>(parameters);

Each method returns a promise. Bittrex responses are pre-treated, meaning that any method will throw an error if the response does not contain success:true

As an example:

const bittrex = require('bittrex-api-wrapper')('<API_KEY>', '<API_SECRET>');

bittrex.account.getBalance('ETH').then(res=>{
	console.log(res)
}).catch(e=>{
	console.error(e)
});

Every parameter is in the order the API documentation gives it

Request

You can also use #request to perform manual requests:

bittrex.request('/path', {currency: 'ETH', quantity: 0.45});

Which will also return a Promise

Testing

In the test/test.js file you will find some simple tests. You can just enter your api_key and api_secret to be able to launch them.

Keywords

FAQs

Package last updated on 05 Aug 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc