Class default

BitkubClient is a class that provides methods to interact with the Bitkub API. It allows users to perform various operations such as getting server time, retrieving market symbols, checking balances, placing bids and asks, and canceling orders.

BitkubClient

Example

const client = new BitkubClient(apiKey, apiSecret);
const serverTime = await client.getServerTime();
const symbols = await client.getSymbols();
const balances = await client.getBalances();
const bids = await client.getBids('BTC_THB');
const asks = await client.getAsks('BTC_THB');
const placeBidResponse = await client.placeBid('BTC_THB', 1, 500000);
const placeAskResponse = await client.placeAsk('BTC_THB', 1, 600000);
const cancelOrderResponse = await client.cancelOrder(null, 'BTC_THB', '12345', 'buy');

Param: apiKey

Your API Key

Param: apiSecret

Your API Secret

Param: environment

Environment to call API

Param: baseApiUrl

Base API URL

Param: requestTimeout

Request timeout in milliseconds

Constructors

constructor

new default(apiKey, apiSecret, environment?, baseApiUrl?, requestTimeout?): default
Create a new BitkubClient
Parameters
- apiKey: string
  Your API Key
- apiSecret: string
  Your API Secret
- environment: BitkubEnvironment = BitkubEnvironment.TEST
  Environment to call API
- baseApiUrl: string = SECURE_API_URL
  Base API URL
- requestTimeout: number = 10000
  Request timeout in milliseconds
Returns default
- Defined in BitkubClient.ts:69

Properties

`Private` _apiKey

_apiKey: string

`Private` _apiSecret

_apiSecret: string

`Private` _axiosInstance

_axiosInstance: Axios

`Private` _baseApiUrl

_baseApiUrl: string

`Private` _environment

_environment: BitkubEnvironment

`Private` _requestHeaders

_requestHeaders: BitkubHeaderType

`Private` _requestTimeout

_requestTimeout: number

Accessors

apiKey

set apiKey(key): void
Change the api secret in axios configuration
Parameters
- key: string
Returns void
- Defined in BitkubClient.ts:129

apiSecret

set apiSecret(secret): void
Change the api secret
Parameters
- secret: string
Returns void
- Defined in BitkubClient.ts:139

baseApiUrl

set baseApiUrl(url): void
Change the base url in axios configuration
Parameters
- url: string
Returns void
- Defined in BitkubClient.ts:111

requestTimeout

set requestTimeout(timeout): void
Change the request timeout in axios configuration
Parameters
- timeout: number
Returns void
- Defined in BitkubClient.ts:120

Methods

buildRequestHeaders

buildRequestHeaders(method, apiPath, payload?): Promise<BitkubHeaderType>
Build request header based on Bitkub signature algorithm Ref: https://github.com/bitkub/bitkub-official-api-docs/blob/master/restful-api.md#payload-post
Parameters
- method: "GET" | "POST"
- apiPath: string
- Optional payload: Record<string, undefined | string | number>
Returns Promise<BitkubHeaderType>
A request payload including ts and sig field which are required for any POST APIs.
- Defined in BitkubClient.ts:169

cancelOrder

cancelOrder(hash, symbol?, orderId?, orderSide?): Promise<AxiosResponse<CancelResponse, any, {}>>
Cancel order
Parameters
- hash: null | string
- symbol: undefined | string = undefined
- orderId: undefined | string = undefined
  : Order Id
- orderSide: undefined | OrderSide = undefined
Returns Promise<AxiosResponse<CancelResponse, any, {}>>
Result of cancelling order
- Defined in BitkubClient.ts:330

`Private` createAxiosHeader

createAxiosHeader(): BitkubHeaderType
Create axios headers

Returns BitkubHeaderType
- Defined in BitkubClient.ts:88

`Private` createAxiosInstance

createAxiosInstance(): AxiosInstance
Create an axios instance

Returns AxiosInstance
- Defined in BitkubClient.ts:99

generateSignature

generateSignature(token): string
Parameters
- token: string
Returns string
- Defined in BitkubClient.ts:246

getAsks

getAsks(symbol, limit?): Promise<AxiosResponse<AskResponse, any, {}>>
Get ask list from Bitkub
Parameters
- symbol: string
  Trading Symbol (THB_BNB, THB_BTC)
- limit: number = 1
  Response Limit Size
Returns Promise<AxiosResponse<AskResponse, any, {}>>
A list of ask
- Defined in BitkubClient.ts:233

getBalances

getBalances(): Promise<AxiosResponse<BalancesResponse, any, {}>>
Get current balances

Returns Promise<AxiosResponse<BalancesResponse, any, {}>>
A list of current balances
- Defined in BitkubClient.ts:198

getBids

getBids(symbol, limit?): Promise<AxiosResponse<BidResponse, any, {}>>
Get bid list from Bitkub
Parameters
- symbol: string
  Trading Symbol (BNB_THB, BTC_THB)
- limit: number = 1
  Response Limit Size
Returns Promise<AxiosResponse<BidResponse, any, {}>>
A list of bid
- Defined in BitkubClient.ts:213

getServerTime

getServerTime(): Promise<AxiosResponse<number, any, {}>>
Get server time

Returns Promise<AxiosResponse<number, any, {}>>
Bitkub server time
- Defined in BitkubClient.ts:158

getSymbols

getSymbols(): Promise<AxiosResponse<SymbolResponse, any, {}>>
Get market symbols

Returns Promise<AxiosResponse<SymbolResponse, any, {}>>
A list of symbols in Bitkub market.
- Defined in BitkubClient.ts:189

placeAsk

placeAsk(symbol, amount, rate, orderType?, clientId?): Promise<AxiosResponse<PlaceAskResponse, any, {}>>
Place ask
Parameters
- symbol: string
  Trading Symbol (THB_BNB, THB_BTC)
- amount: number
  Sell amount
- rate: number
  Price rate
- orderType: BitkubOrderType = BitkubOrderType.MARKET
  Order type (LIMIT, MARKET)
- clientId: undefined | string = undefined
Returns Promise<AxiosResponse<PlaceAskResponse, any, {}>>
Result of placing ask
- Defined in BitkubClient.ts:298

placeBid

placeBid(symbol, amount, rate, orderType?, clientId?): Promise<AxiosResponse<PlaceBidResponse, any, {}>>
Place bid
Parameters
- symbol: string
  Trading Symbol (THB_BNB, THB_BTC)
- amount: number
  Buy amount
- rate: number
  Price rate
- orderType: BitkubOrderType = BitkubOrderType.MARKET
  Order type (LIMIT, MARKET)
- clientId: undefined | string = undefined
Returns Promise<AxiosResponse<PlaceBidResponse, any, {}>>
Result of placing bid
- Defined in BitkubClient.ts:263

setEnvironment

setEnvironment(environment): void
Change environment to call API It will affect to call place-bid and place-ask api.
Parameters
- environment: BitkubEnvironment
Returns void
- Defined in BitkubClient.ts:149

Class default

Example

Param: apiKey

Param: apiSecret

Param: environment

Param: baseApiUrl

Param: requestTimeout

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns default

Properties

Private _apiKey

Private _apiSecret

Private _axiosInstance

Private _baseApiUrl

Private _environment

Private _requestHeaders

Private _requestTimeout

Accessors

apiKey

Parameters

Returns void

apiSecret

Parameters

Returns void

baseApiUrl

Parameters

Returns void

requestTimeout

Parameters

Returns void

Methods

buildRequestHeaders

Parameters

Returns Promise<BitkubHeaderType>

cancelOrder

Parameters

Returns Promise<AxiosResponse<CancelResponse, any, {}>>

Private createAxiosHeader

Returns BitkubHeaderType

Private createAxiosInstance

Returns AxiosInstance

generateSignature

Parameters

Returns string

getAsks

Parameters

Returns Promise<AxiosResponse<AskResponse, any, {}>>

getBalances

Returns Promise<AxiosResponse<BalancesResponse, any, {}>>

getBids

Parameters

Returns Promise<AxiosResponse<BidResponse, any, {}>>

getServerTime

Returns Promise<AxiosResponse<number, any, {}>>

getSymbols

Returns Promise<AxiosResponse<SymbolResponse, any, {}>>

placeAsk

Parameters

Returns Promise<AxiosResponse<PlaceAskResponse, any, {}>>

placeBid

Parameters

Returns Promise<AxiosResponse<PlaceBidResponse, any, {}>>

setEnvironment

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` _apiKey

`Private` _apiSecret

`Private` _axiosInstance

`Private` _baseApiUrl

`Private` _environment

`Private` _requestHeaders

`Private` _requestTimeout

`Private` createAxiosHeader

`Private` createAxiosInstance