Options
All
  • Public
  • Public/Protected
  • All
Menu

bittrex-v3-node

bittrex-v3-node

wercker status codecov npm version

This project is based on Andrew Barba bittrex-node. It is mainly developed for personal use, but feel free to fork, notify issues or pull request contributions.

Assumptions

  • This project is written in TypeScript. Params and responses will be strictly typed according to official docs.
  • Endpoint details will be documented with the official bittrex API V3 documentation.
  • This project won't be compatible with any v1.1 API version. Use bittrex-node for that purpose.
  • Libraries will be updated to latest version, specially axios, to avoid the latest well-known security issues with old versions.
  • Tests + coverage will be provided.

General overview

  • V3 Authenticated requests
  • Rate Limits control
  • Pagination support
  • Error codes
  • Parse number and Date response fields
  • Websockets support
  • Unit tests (safe to run with real API keys)

API Endpoints

  • Account
  • Addresses
  • Balances
  • Batch
  • ConditionalOrders
  • Currencies
  • Deposits
  • Executions
  • FundsTransferMethods
  • Markets
  • Orders
  • Ping
  • Subaccounts (:warning: only for partners)
  • Transfers
  • Withdrawals

A full-featured Bittrex API client for Node.js

  • Supports all documented v3 endpoints
  • 100% unit-test coverage
  • Heavily documented
  • Promise based with async/await

Get started

If you're using the Bittrex REST API, I can assure you this is the only library worth using. Here's why:

  • It doesn't make you parse the Bittrex response and look for errors
  • It properly parses all timestamps to JavaScript Date objects (:warning: work in progress)
  • It uses proper JavaScript and Node conventions
  • It throws proper errors when parameters are missing (:warning: work in progress)
  • It uses a single https client with Keep-Alive enabled
  • It's faster than every other node Bittrex library

Documentation

Initialize Client

const { BittrexClient } = require('bittrex-v3-node')

let client = new BittrexClient({
apiKey: '12345',
apiSecret: 'abcde'
})

Docs

Package docs here.

Generated using TypeDoc