npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

node-api-bitrue

v0.6.21

Published

Non-official implementation of Bitrue's API's. Developed for personal use.

Downloads

19

Readme

node-api-bitrue

WARNING: Due to lack of funds on Bitrue, only market data is available.

Non-official implementation of Bitrue's API's. Developed for personal use.

For support on using the API's or development issues, please refer to the official API documentation. For questions regarding this package, please consult the code first.

Ping and pong messages are built-in to the API. No user action required. When required, and if not set, timestamp parameters are automatically set by the API.

PUBLIC API

  const bitrue=require('node-api-bitrue');

  const publicAPI=new bitrue.publicApi();

Market Data

| API | DESCRIPTION | | :---- | :---- | | getSymbols | Derivative from getExchangeInfo() | | getCurrencies | Derivative from getExchangeInfo() | | getKlines | | | getOrderBook | | | getRecentTrades | | | getHistTrades | | | getAggregatedTrades | | | getTicker | | | getLastPrice | | | getBookTicker | |

Other

| API | DESCRIPTION | | :---- | :---- | | getExchangeInfo | | | getServerTime | | | sendPing | |

PRIVATE API

  const bitrue=require('node-api-bitrue');

  const auth = {
    apikey: 'MY_API_KEY',
    secret: 'MY_API_SECRET'
  };

  const privateAPI=new bitrue.privateApi(auth);

Account

| API | DESCRIPTION | | :---- | :---- | | getAccountInfo | | | getBalances | Derivative from getAccountInfo() } | getFees | Derivative from getAccountInfo() } | getETFNetValue | |

Orders

| API | DESCRIPTION | | :---- | :---- | | createOrder | May or may not work. Needs funding to finalize. | | getOrder | May or may not work. Needs funding to finalize. | | cancelOrder | May or may not work. Needs funding to finalize. | | getActiveOrders | May or may not work. Needs funding to finalize. | | getOrders | May or may not work. Needs funding to finalize. | | getAccountTrades | May or may not work. Needs funding to finalize. |

Deposit & Withdraw

| API | DESCRIPTION | | :---- | :---- | | withdrawCommit | May or may not work. Needs funding to finalize. | | getWithdrawals | | | getDeposits | |

WEBSOCKET API

  const bitrue=require('node-api-bitrue');

  const auth = {
    apikey: 'MY_API_KEY',
    secret: 'MY_API_SECRET'
  };

  const marketAPI=new bitrue.sockets.marketApi();
  marketAPI.setHandler('market.simple.depth.step0', (method,data,symbol,stamp) => { snapshotOrderBook(symbol,method,data,handler); });

  marketAPI.socket._ws.on('initialized', async () => {
    // do your own initialization, e.g. subscribe to orderbook
  });

  function snapshotOrderBook(symbol,method,data,handler) {
    // do something
  };

  const streamAPI=new bitrue.sockets.streamApi(auth);
  var res=await streamAPI.createListenKey();
  const token=res.data.listenKey;

  const accountAPI=new bitrue.sockets.userApi(auth,token);
  accountAPI.setHandler('executionReport', (symbol,method,data,option) => { updateOrder(symbol,method,data); });
  accountAPI.setHandler('BALANCE', (symbol,method,data,option) => { updateBalance(symbol,method,data); });

  accountAPI.socket._ws.on('authenticated', async () => {
    // do your own initialization, e.g. subscribe to updates
  });

  accountAPI.socket._ws.on('closed', async () => {
    // do something, like clean-up and reconnect
  });

  function updateOrder(symbol,method,data) {
    // do something
  };

  function updateBalance(symbol,method,data) {
    // do something
  };

| API | HANDLER | DESCRIPTION | | :---- | :---- | :---- | | subscribeOrderBook unsubscribeOrderBook | market.simple.depth.step0 | Uses marketApi | | createListenKey | | Uses streamAPI, calls renewListenKey at 20min intervals | | renewListenKey | | Uses streamAPI | | deleteListenKey | | Uses streamAPI | | subscribeOrderUpdates unsubscribeOrderUpdates | executionReport | Uses accountApi | | subscribeBalanceUpdates unsubscribeBalanceUpdates | BALANCE | Uses accountApi |