1.2.10 • Published 2 months ago

node-api-hitbtc v1.2.10

Weekly downloads
-
License
MIT
Repository
github
Last release
2 months ago

node-api-hitbtc

Non-official implementation of HitBTC'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.

PUBLIC API

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

  const publicAPI=new hitbtc.publicApi();

Market Data

APIDESCRIPTION
getCurrencyhttps://api.hitbtc.com/#currencies
getSymbolhttps://api.hitbtc.com/#symbols
getTickerhttps://api.hitbtc.com/#tickers
getPriceshttps://api.hitbtc.com/#prices
getPricesHistoryhttps://api.hitbtc.com/#prices
getTickerLastPriceshttps://api.hitbtc.com/#prices
getTradeshttps://api.hitbtc.com/#trades
getOrderBookhttps://api.hitbtc.com/#order-books
getCandleshttps://api.hitbtc.com/#candles
getConvertedCandleshttps://api.hitbtc.com/#candles
getFuturesInformationhttps://api.hitbtc.com/#futures-info
getFundingHistoryhttps://api.hitbtc.com/#funding-history
getIndexPriceCandleshttps://api.hitbtc.com/#futures-index-price-candles
getMarkPriceCandleshttps://api.hitbtc.com/#futures-mark-price-candles
getPremiumIndexCandleshttps://api.hitbtc.com/#futures-premium-index-candles
getOpenInterestCandleshttps://api.hitbtc.com/#futures-open-interest-candles

PRIVATE API

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

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

  const privateAPI=new hitbtc.privateApi(auth);

Spot Trading

APIDESCRIPTION
getSpotBalancehttps://api.hitbtc.com/#get-spot-trading-balance
getSpotOrdershttps://api.hitbtc.com/#get-all-active-spot-orders
getSpotOrderhttps://api.hitbtc.com/#get-active-spot-order
createSpotOrderhttps://api.hitbtc.com/#create-new-spot-order
createSpotOrderListhttps://api.hitbtc.com/#create-new-spot-order-list
replaceSpotOrderhttps://api.hitbtc.com/#replace-spot-order
cancelSpotOrdershttps://api.hitbtc.com/#cancel-all-spot-orders
cancelSpotOrderhttps://api.hitbtc.com/#cancel-spot-order
getSpotFeeshttps://api.hitbtc.com/#get-all-trading-commissions
getSpotFeehttps://api.hitbtc.com/#get-trading-commission

Spot Trading History

APIDESCRIPTION
getSpotOrderHistoryhttps://api.hitbtc.com/#spot-orders-history
getSpotTradeHistoryhttps://api.hitbtc.com/#spot-trades-history

Margin Trading

APIDESCRIPTION
getMarginAccountshttps://api.hitbtc.com/#get-all-margin-accounts
getMarginAccounthttps://api.hitbtc.com/#get-isolated-margin-account
getCrossMarginAccounthttps://api.hitbtc.com/#get-cross-margin-account
createUpdateMarginAccounthttps://api.hitbtc.com/#create-update-margin-account
closeMarginPositionshttps://api.hitbtc.com/#close-margin-positions
closeMarginPositionhttps://api.hitbtc.com/#close-margin-position
getMarginOrdershttps://api.hitbtc.com/#get-active-margin-orders
getMarginOrderhttps://api.hitbtc.com/#get-active-margin-order
createMarginOrderhttps://api.hitbtc.com/#create-margin-order
createMarginOrderListhttps://api.hitbtc.com/#create-new-margin-order-list
replaceMarginOrderhttps://api.hitbtc.com/#replace-margin-order
cancelMarginOrdershttps://api.hitbtc.com/#cancel-all-margin-orders
cancelMarginOrderhttps://api.hitbtc.com/#cancel-margin-order
getMarginConfighttps://api.hitbtc.com/#get-margin-position-parameters

Margin Trading History

APIDESCRIPTION
getMarginOrderHistoryhttps://api.hitbtc.com/#margin-orders-history
getMarginTradeHistoryhttps://api.hitbtc.com/#margin-trades-history
getMarginPositionsHistoryhttps://api.hitbtc.com/#margin-positions-history
getMarginClearingDetailshttps://api.hitbtc.com/#margin-clearing-details

Futures Trading

APIDESCRIPTION
getFuturesBalancehttps://api.hitbtc.com/#get-trading-balance
getFuturesAccountshttps://api.hitbtc.com/#get-futures-margin-accounts
getFuturesAccounthttps://api.hitbtc.com/#get-futures-margin-account
getFuturesCrossAccounthttps://api.hitbtc.com/#get-futures-cross-margin-account
createUpdateFuturesAccounthttps://api.hitbtc.com/#create-update-margin-account-2
closeFuturesPositionshttps://api.hitbtc.com/#close-all-futures-margin-positions
closeFuturesPositionhttps://api.hitbtc.com/#close-futures-margin-position
getFuturesOrdershttps://api.hitbtc.com/#get-active-futures-orders
getFuturesOrderhttps://api.hitbtc.com/#get-active-futures-order
createFuturesOrderhttps://api.hitbtc.com/#create-futures-order
createFuturesOrderListhttps://api.hitbtc.com/#create-new-futures-order-list
replaceFuturesOrderhttps://api.hitbtc.com/#replace-futures-order
cancelFuturesOrdershttps://api.hitbtc.com/#cancel-futures-orders
cancelFuturesOrderhttps://api.hitbtc.com/#cancel-futures-order
getFuturesConfighttps://api.hitbtc.com/#get-futures-position-parameters
getFuturesFeeshttps://api.hitbtc.com/#get-all-trading-commissions-2
getFuturesFeehttps://api.hitbtc.com/#get-trading-commission-2

Futures Trading History

APIDESCRIPTION
getFuturesOrderHistoryhttps://api.hitbtc.com/#futures-orders-history
getFuturesTradeHistoryhttps://api.hitbtc.com/#futures-trades-history
getFuturesPositionsHistoryhttps://api.hitbtc.com/#futures-positions-history
getFuturesClearingDetailshttps://api.hitbtc.com/#futures-clearing-details

Wallet Management

APIDESCRIPTION
getWalletBalancehttps://api.hitbtc.com/#wallet-balance
getDepositAddresshttps://api.hitbtc.com/#get-deposit-crypto-address
createDepositAddresshttps://api.hitbtc.com/#generate-deposit-crypto-address
getRecentDepositAddresseshttps://api.hitbtc.com/#last-10-deposit-crypto-addresses
getRecentWithdrawAddresseshttps://api.hitbtc.com/#last-10-withdrawal-crypto-addresses
withdrawCryptohttps://api.hitbtc.com/#withdraw-crypto
convertCryptohttps://api.hitbtc.com/#convert-between-currencies
withdrawCommithttps://api.hitbtc.com/#withdraw-crypto-commit-or-rollback
withdrawRollbackhttps://api.hitbtc.com/#withdraw-crypto-commit-or-rollback
checkMinehttps://api.hitbtc.com/#check-if-crypto-address-belongs-to-current-account
transferExchangehttps://api.hitbtc.com/#transfer-between-wallet-and-exchange
transferInternalhttps://api.hitbtc.com/#transfer-money-to-another-user
getTransactionshttps://api.hitbtc.com/#get-transactions-history
getTransactionhttps://api.hitbtc.com/#get-transactions-history
checkOffchainAvailablehttps://api.hitbtc.com/#check-if-offchain-is-available
getWithdrawFeeshttps://api.hitbtc.com/#estimate-withdrawal-fees
getWithdrawFeehttps://api.hitbtc.com/#estimate-withdrawal-fee
getAirdropshttps://api.hitbtc.com/#airdrops
getAmountLockshttps://api.hitbtc.com/#get-amount-locks

Sub-accounts

APIDESCRIPTION
getSubaccountshttps://api.hitbtc.com/#sub-accounts
freezeSubaccounthttps://api.hitbtc.com/#freeze-sub-account
activateSubaccounthttps://api.hitbtc.com/#activate-sub-account
transferFundshttps://api.hitbtc.com/#transfer-funds
getACLhttps://api.hitbtc.com/#get-acl-settings
changeACLhttps://api.hitbtc.com/#change-acl-settings
getSubaccountBalancehttps://api.hitbtc.com/#get-sub-account-balance
getSubaccountAddresshttps://api.hitbtc.com/#get-sub-account-crypto-address

WEBSOCKET API

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

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

  const marketAPI=new hitbtc.sockets.marketApi();
  marketAPI.socket._ws.on('initialized', async () => {
    // do your own initialization
  });

  const tradingAPI=new hitbtc.sockets.tradingApi(auth);
  tradingAPI.setHandler('orders', (symbol,method,data,option) => { updateOrder(symbol,method,data); });

  tradingAPI.socket._ws.on('authenticated', async () => {
    const res=await tradingAPI.subscribeOrderUpdates();
  });

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

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

Socket Market Data

APIHANDLERDESCRIPTION
subscribeTrades unsubscribeTradestrades_snapshot trades_update
subscribeCandles unsubscribeCandlescandles_snapshot candles_update
subscribePriceRates unsubscribePriceRatesprice
subscribePriceRatesBatch unsubscribePriceRatesBatchprice_batch
subscribeMiniTicker unsubscribeMiniTickerticker_price
subscribeMiniTickerBatch unsubscribeMiniTickerBatchticker_price_batch
subscribeTicker unsubscribeTickerticker
subscribeTickerBatch unsubscribeTickerBatchticker_batch
subscribeFullOrderbook unsubscribeFullOrderbookorderbook_snapshot orderbook_update
subscribePartialOrderbook unsubscribePartialOrderbookorderbook
subscribePartialOrderbookBatch unsubscribePartialOrderbookBatchorderbook_batch
subscribeTopOrderbook unsubscribeTopOrderbookorderbook_top
subscribeTopOrderbookBatch unsubscribeTopOrderbookBatchorderbook_top_batch
subscribeFuturesInformation unsubscribeFuturesInformationfutures

Socket Authentication

APIDESCRIPTION
loginhttps://api.hitbtc.com/#socket-authentication
getSubscriptionshttps://api.hitbtc.com/#get-active-subscriptions
setHandler
clearHandler
clearHandlers

Socket Spot Trading

APIHANDLERDESCRIPTION
subscribeSpotReports unsubscribeSpotReportsspot_ordershttps://api.hitbtc.com/#subscribe-to-reports
subscribeSpotBalances unsubscribeSpotBalancesspot_balancehttps://api.hitbtc.com/#subscribe-to-spot-balances
APIDESCRIPTION
getSpotOrdershttps://api.hitbtc.com/#get-active-spot-orders
createSpotOrderhttps://api.hitbtc.com/#place-new-spot-order
createSpotOrderListhttps://api.hitbtc.com/#create-new-spot-order-list-2
cancelSpotOrderhttps://api.hitbtc.com/#cancel-spot-order-2
cancelSpotOrdershttps://api.hitbtc.com/#cancel-replace-spot-order
replaceSpotOrderhttps://api.hitbtc.com/#cancel-spot-orders
getSpotBalanceshttps://api.hitbtc.com/#get-spot-trading-balances
getSpotBalancehttps://api.hitbtc.com/#get-spot-trading-balance-2
getSpotFeeshttps://api.hitbtc.com/#get-spot-fees
getSpotFeehttps://api.hitbtc.com/#get-spot-fee

Socket Margin Trading

APIHANDLERDESCRIPTION
subscribeMarginReports unsubscribeMarginReportsmargin_ordershttps://api.hitbtc.com/#subscribe-to-reports-2
APIDESCRIPTION
getMarginOrdershttps://api.hitbtc.com/#get-margin-orders
createMarginOrderhttps://api.hitbtc.com/#place-new-margin-order
createMarginOrderListhttps://api.hitbtc.com/#create-new-margin-order-list-2
cancelMarginOrderhttps://api.hitbtc.com/#cancel-margin-order-2
replaceMarginOrderhttps://api.hitbtc.com/#cancel-replace-margin-order
getMarginAccountshttps://api.hitbtc.com/#get-margin-accounts
createUpdateMarginAccounthttps://api.hitbtc.com/#create-update-margin-account-3
closeMarginPositionhttps://api.hitbtc.com/#close-margin-position-2

Socket Futures Trading

APIHANDLERDESCRIPTION
subscribeFuturesReports unsubscribeFuturesReportsfutures_ordershttps://api.hitbtc.com/#subscribe-to-reports-3
subscribeFuturesBalances unsubscribeFuturesBalancesfutures_balancehttps://api.hitbtc.com/#subscribe-to-futures-balances
APIDESCRIPTION
getFuturesOrdershttps://api.hitbtc.com/#get-active-futures-orders-2
createFuturesOrderhttps://api.hitbtc.com/#place-new-futures-order
createFuturesOrderListhttps://api.hitbtc.com/#create-new-futures-order-list-2
replaceFuturesOrderhttps://api.hitbtc.com/#cancel-futures-order-2
cancelFuturesOrderhttps://api.hitbtc.com/#cancel-replace-a-futures-order
getFuturesAccountshttps://api.hitbtc.com/#get-futures-accounts
createUpdateFuturesAccounthttps://api.hitbtc.com/#create-update-futures-account
closeFuturesPositionhttps://api.hitbtc.com/#close-futures-position
getFuturesBalancehttps://api.hitbtc.com/#get-futures-trading-balances https://api.hitbtc.com/#get-futures-trading-balance
getFuturesFeeshttps://api.hitbtc.com/#get-futures-fees
getFuturesFeehttps://api.hitbtc.com/#get-futures-fee

Socket Wallet Management

APIHANDLERDESCRIPTION
subscribeTransactions unsubscribeTransactionstransaction_updatehttps://api.hitbtc.com/#subscribe-to-transactions
subscribeWalletBalances unsubscribeWalletBalanceswallet_balanceshttps://api.hitbtc.com/#subscribe-to-wallet-balances
APIDESCRIPTION
getTransactionshttps://api.hitbtc.com/#get-transactions
getWalletBalanceshttps://api.hitbtc.com/#request-wallet-balance
getWalletBalancehttps://api.hitbtc.com/#request-wallet-balance
1.2.10

2 months ago

1.2.9

2 months ago

1.2.8

2 months ago

1.2.7

3 months ago

1.2.0

7 months ago

1.2.6

5 months ago

1.2.5

5 months ago

1.2.4

6 months ago

1.2.3

6 months ago

1.2.2

6 months ago

1.2.1

7 months ago

1.0.33

7 months ago

1.0.36

7 months ago

1.0.35

7 months ago

1.0.34

7 months ago

1.0.39

7 months ago

1.0.38

7 months ago

1.0.32

9 months ago

1.0.31

9 months ago

1.0.30

9 months ago

1.0.26

2 years ago

1.0.25

2 years ago

1.0.29

2 years ago

1.0.28

2 years ago

1.0.27

2 years ago

1.0.22

2 years ago

1.0.24

2 years ago

1.0.21

3 years ago

1.0.19

3 years ago

1.0.18

3 years ago

1.0.17

3 years ago

1.0.20

3 years ago

1.0.16

3 years ago

1.0.15

3 years ago

1.0.14

3 years ago

1.0.13

3 years ago

1.1.9

3 years ago

1.1.8

3 years ago

1.1.7

3 years ago

1.1.6

3 years ago

1.1.5

3 years ago

1.1.4

3 years ago

1.1.1

3 years ago

1.1.0

3 years ago

1.0.0

3 years ago

1.1.3

3 years ago

1.1.2

3 years ago

1.0.12

3 years ago

1.0.11

3 years ago

1.0.10

3 years ago

1.0.9

3 years ago

1.0.8

3 years ago

1.0.7

3 years ago

1.0.6

3 years ago

1.0.5

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago