node-upbit-api

wrapper for upbit API

Installation

$ npm ci

Build

$ npm run build

Lint

$ npm run lint  # Only Check Lint
$ npm run lint:fix  # Fix to Lint Error
$ npm run format  # Check prettier

How to Use

import ApiUpbit from 'node-upbit-api';

new ApiUpbit('accessKey', 'secretKey').getAccounts().then((accounts) => {
  console.log(accounts);
});

Available API List

• Exchange API
  • Assets
    • [x] GET /v1/accounts
      • getAccounts
      • Show List of assets you have.
  • Orders
    • [x] GET /v1/orders/chance
      • getOrdersChance
      • Check the order availability information by market.
    • [x] GET /v1/order
      • getOrder
      • Inquire individual orders through the order UUID.
    • [x] GET /v1/orders
      • getOrders
      • Inquire the order list.
    • [x] DELETE /v1/order
      • cancelOrder
      • Cancel Order
    • [x] POST /v1/orders
      • postOrders
      • Request An Order
  • Withdrawal
    • [x] GET /v1/withdraws
      • getWithdraws
      • Withdraws List
    • [x] GET /v1/withdraw
      • getWithdraw
      • Withdraw Detail
    • [x] GET /v1/withdraws/chance
      • getWithdrawsChance
      • Check the possible withdrawal information of the Currency.
    • [x] POST /v1/withdraws/coin
      • postWithdrawsCoin
      • Request an Withdraw Coin
    • [x] POST /v1/withdraws/krw
      • postWithdrawsKrw
      • Request an Withdraw Krw
  • Deposit
    • [x] GET /v1/deposits
      • getDeposits
      • Deposits List
    • [x] GET /v1/deposit
      • getDeposit
      • Deposit Detail
    • [x] POST /v1/deposit/generate_coin_address
      • postDepositCoinAddress
      • Request an Deposit Address
    • [x] GET /v1/deposits/coin_addresses
      • getDepositCoinAddresses
      • Show The List of Assets You Have.
    • [x] GET /v1/deposits/coin_address
      • getDepositCoinAddress
      • Show The Detail of Assets You Have.
    • [x] POST /v1/deposits/krw
      • postDepositKrw
      • Request a Deposit of KRW.
• Quotation API
  • Coin List
    • [ ] GET /v1/market/all
  • Candle
    • [ ] GET /v1/candles/minute/{unit}
    • [ ] GET /v1/candles/days
    • [ ] GET /v1/candles/weeks
    • [ ] GET /v1/candles/months
  • Conclusion
    • [ ] GET /v1/trades/ticks
  • Ticker
    • [ ] GET /v1/ticker
  • Orderbook
    • [ ] GET /v1/orderbook
• etc
  • [ ] GET /v1/status/wallet
  • [ ] GET /v1/api_keys

Commit-message

• The commit message accurately specifies the work scope.
• The commit message refers to semantic-release
  • Reference

Link

• Semantic-Release
• Upbit API Documents