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

huobi-api-js

v1.0.0

Published

This is a non-official HuoBi Rest API nodejs module which support for signature version 2.

Downloads

66

Readme

huobi-api-js

npm version Build Codecov branch

dependencies Status devDependencies Status

This is a non-official HuoBi Rest API nodejs module which support for signature version 2.

(這是非官方的火幣REST API nodejs module,支援簽名版本2。)


Install

$ npm i huobi-api-js

Usage

  • calling huobi REST API without handling signature protocol yourself
import { HbApi } from 'huobi-js'

...

const hbApi = new HbApi({
    apiConfig: config.api,
    profileConfig: config.huobi,
})

...

const account = await hbApi.restApi({ path: `/v1/acco3unt/accounts`, method: 'GET' })

API

New service class

Create a new service class which is reusable to call multiple REST APIs

const hbApi = new HbApi({
    apiBaseUrl: config.apiBaseUrl,
    profileConfig: config.huobi,
})

constructor parameters:

{
    apiBaseUrl: string
    profileConfig: {
        accessKey: string
        secretKey: string
    }
    logger?: Logger
    httpClient?: HttpClient
}

| Parameter | Type | Description | Mandatory | |-------------------------|----------|--------------------------------|-----------| | apiBaseUrl | string | API base URL | Y | | profileConfig.accessKey | string | access key | Y | | profileConfig.secretKey | string | secretKey | Y | | logger | object | your logger implementation | N | | httpClient | function | your httpClient implementation | N |


Call huobi Rest API

Call REST API which internally handled the signature protocol and return result as Promise

hbApi.restApi({ path: `/v1/acco3unt/accounts`, method: 'GET' })

Method: restAPI

Parameters:

| Parameter | Type | Description | Mandatory | |-----------|-------------------------|-----------------------------------------------------|-----------| | path | string | REST API path, e.g: "/v1/acco3unt/accounts" | Y | | method | string | either "GET" or "POST" | Y | | query | Record<string, unknown> | query parameters | N | | body | Record<string, unknown> | post body data | N | | timeout | number | HTTP request timeout in ms, default value is 5000ms | N |

Return type: Promise of data


Example

import { HbApi } from 'huobi-js'

const options = {
    apiBaseUrl: 'https://api.huobipro.com',
    profileConfig: {
        accessKey: '<REPLACE_WITH_YOUR_ACCESS_KEY>',
        secretKey: '<REPLACE_WITH_YOUR_SECRET_KEY>',
    },
}

async function run() {
    const hbApi = new HbApi(options)

    const CURRENCY_USDC = 'usdc'

    /*****
     * root user info
     */
    const account = await hbApi.restApi({ path: `/v1/acco3unt/accounts`, method: 'GET' })
    console.log('account:', { account })

    const subUsers = await hbApi.restApi({ path: `/v2/sub-user/user-list`, method: 'GET' })
    console.log('subUsers:', { subUsers })

    /**
     * Get sub account aggregate balance
     */
    const subAccountAggregateBalance = await hbApi.restApi({
        path: `/v1/subuser/aggregate-balance`,
        method: 'GET',
    })
    console.log('subAccountAggregateBalance:', { subAccountAggregateBalance })

    const withdrawQuota = await hbApi.restApi({
        path: `/v2/account/withdraw/quota`,
        method: 'GET',
        query: {
            currency: CURRENCY_USDC,
        },
    })
    console.log(`withdrawQuota:`, {
        withdrawQuota,
    })

    console.log('exit')
}

run()