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

@azerothian/btc-markets-api

v1.2.0

Published

BTC Markets Rest Client

Downloads

13

Readme

BTC Markets Rest Client

This is a node.js wrapper for the private and public methods exposed by the BTC Markets API. You will need have a registered account with BTC Markets and generated API keys to access the private methods.

Please contact [email protected] if you are having trouble opening and account or generating an API key.

For websocket support see btc-markets-ws-api

Requirements

  • Nodejs >= 8.9.4

Install

yarn add @azerothian/btc-markets-api

Documentation

Link to Documentation

Features

  • Single dependency - node-fetch, no need to scan and research multiple dependencies for those with security in mine, (node-fetch has no dependencies)
  • Promises - all functions return promises and can be used with all its glory.
  • Simple API

Examples

import BTCMarkets from "@azerothian/btc-markets-api";
(async() => {
  try {
    const client = new BTCMarkets({key: "", secret: ""});

    const numberConverter = 100000000;    // one hundred million

    // get latest prices
    const tickData = await client.getTick("BTC", "AUD");
    console.log(`bid ${tickData.bestBid} ask ${tickData.bestAsk} last price ${tickData.lastPrice}`);

    // get order book
    const orderBook = await client.getOrderBook("BTC", "AUD");
    console.log(`${orderBook.asks.length} asks with best ask having price ${orderBook.asks[0][0]} and amount ${orderBook.asks[0][1]}`);

    // limit buy order for of 0.01 BTC at 230 AUD
    const createLimitedBuyOrder = await client.createOrder("BTC", "AUD", 230 * numberConverter, 0.01 * numberConverter, 'Bid', 'Limit', "10001");
    console.log(createLimitedBuyOrder);

    // market sell for 0.0001 BTC
    const sellOrder = await client.createOrder("BTC", "AUD", null, 0.0001 * numberConverter, 'Ask', 'Market', null);
    console.log(sellOrder);

    // cancel two limit orders with id's 123456 and 987654
    const cancelOrders = await client.cancelOrder([123456,987654]);
    console.log(`first order was cancelled ${cancelOrders.responses[0].success}`);

    const accountBalances = await client.getAccountBalances();
    accountBalances.forEach((account) => {
      console.log(`${account.currency} balance ${account.balance / numberConverter} pending ${account.pendingFunds / numberConverter}`);
    });

    const tradingFee = client.getTradingFee("BTC", "AUD");
    console.log(tradingFee);
  } catch (err) {
      console.log(err);
  }
})();

Development

  • We use gulp with babel for source transpiling.
  • npm run test or jest to run test the test cases
  • gulp watch to monitor and watch for
  • To run the private test cases you need to set the following keys in your environment variables or create a .env file with the following filled in
BTCMKT_KEY=""
BTCMKT_SECRET=""