Options
All
  • Public
  • Public/Protected
  • All
Menu

Bitkub API javascript library

Here come a Bitkub js library for browser and nodejs

Installing

Using npm

npm install bitkub

Using yarn

yarn add bitkub

Example

var Bitkub = require('bitkub')
var client = new Bitkub({
  api_key: 'my_api_key',
  api_secret: 'my_api_secret',
})

client.server_time().then(server_time => {
  console.log(server_time)
})

Documents

Read more API at the documents

Index

Classes

Type aliases

Variables

Object literals

Type aliases

allData

allData: object

Data for API endpoints

Type declaration

  • [key: string]: object
    • auth: boolean
    • parameters: object
      • [key: string]: boolean
    • path: string

credentials

credentials: object

Type declaration

  • api_key: string
  • api_secret: string

endPointData

endPointData: object

Type declaration

  • auth: boolean
  • parameters: object
    • [key: string]: boolean
  • path: string

Variables

Const DEFAULT_SERVER_URL

DEFAULT_SERVER_URL: "https://api.bitkub.com/api/" = "https://api.bitkub.com/api/"

Object literals

Const api_data

api_data: object

market_asks

market_asks: object

auth

auth: false = false

path

path: string = "market/asks"

parameters

parameters: object

lmt

lmt: true = true

sym

sym: true = true

market_balances

market_balances: object

auth

auth: true = true

parameters

parameters: object

Type declaration

path

path: string = "market/balances"

market_bids

market_bids: object

auth

auth: false = false

path

path: string = "market/bids"

parameters

parameters: object

lmt

lmt: true = true

sym

sym: true = true

market_books

market_books: object

auth

auth: false = false

path

path: string = "market/books"

parameters

parameters: object

lmt

lmt: true = true

sym

sym: true = true

market_cancel_order

market_cancel_order: object

auth

auth: true = true

path

path: string = "market/cancel-order"

parameters

parameters: object

id

id: true = true

sd

sd: true = true

sym

sym: true = true

market_my_open_orders

market_my_open_orders: object

auth

auth: true = true

path

path: string = "market/my-open-orders"

parameters

parameters: object

sym

sym: true = true

market_my_order_history

market_my_order_history: object

auth

auth: true = true

path

path: string = "market/my-order-history"

parameters

parameters: object

lmt

lmt: false = false

p

p: false = false

sym

sym: true = true

market_order_info

market_order_info: object

auth

auth: true = true

path

path: string = "market/order-info"

parameters

parameters: object

id

id: true = true

sd

sd: true = true

sym

sym: true = true

market_place_ask

market_place_ask: object

auth

auth: true = true

path

path: string = "market/place-ask"

parameters

parameters: object

amt

amt: true = true

rat

rat: true = true

sym

sym: true = true

typ

typ: true = true

market_place_bid

market_place_bid: object

auth

auth: true = true

path

path: string = "market/place-bid"

parameters

parameters: object

amt

amt: true = true

rat

rat: true = true

sym

sym: true = true

typ

typ: true = true

market_symbols

market_symbols: object

auth

auth: false = false

parameters

parameters: object

Type declaration

path

path: string = "market/symbols"

market_ticker

market_ticker: object

auth

auth: false = false

parameters

parameters: object

Type declaration

path

path: string = "market/ticker"

market_trades

market_trades: object

auth

auth: false = false

path

path: string = "market/trades"

parameters

parameters: object

lmt

lmt: true = true

sym

sym: true = true

market_trading_view

market_trading_view: object

auth

auth: false = false

path

path: string = "market/tradingview"

parameters

parameters: object

from

from: true = true

int

int: true = true

sym

sym: true = true

to

to: true = true

market_wallet

market_wallet: object

auth

auth: true = true

parameters

parameters: object

Type declaration

path

path: string = "market/wallet"

server_time

server_time: object

auth

auth: false = false

parameters

parameters: object

Type declaration

path

path: string = "servertime"

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc