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

bitkub-client

v1.4.3

Published

A client wrapper class for calling the Bitkub APIs

Downloads

49

Readme

A wrapper client class for calling Bitkub APIs.

Installation

By npm

npm install bitkub-client

By yarn

yarn add bitkub-client

How to use

  1. Create the APK key and secret from the Bitkub exchange
  2. Create an BitkubClient object by putting them to the constructor.
import BitkubClient, {BitkubEnvironment} from "bitkub-client"

const client = new BitkubClient (
    "[YOUR_API_KEY]",
    "[YOUR_API_SECRET]",
    BitkubEnvironment.PRODUCTION
);
  1. Now, you can call the Bitkub API through these functions. Please see more details at bitkub-client document.

  2. If you want to call other POST APIs which is not in the list above, you can use buildRequestHeaders() to build your HTTP headers. It includes X-BTK-TIMESTAMP and X-BTK-SIGN to the headers. They're required fields for all secured APIs for version 3.

const uri = `/v3/market/cancel-order`
const requestHeaders = client.buildRequestHeaders('POST',uri,payload)

Notes : If you're using client version 1.3 above, it will call Bitkub API version 3. You must generate a new API key on the Bitkub website.

Contributions

Pull Requests

Feel free to send the PR if you're interested. Thanks!

Test Running

We only create the integration tests which we can make sure that the request are proceeded in the Bitkub servers.

You can run them through yarn test.

To write the test, I suggest to create the mock API by nock library. This will avoid changing the account data. And we can ensure the client will call the API correctly. You can see the example test in BitkubClient.test.ts