Bitkub | bitkub

Hierarchy

Bitkub

Index

Constructors

constructor

Properties

_api_client

Methods

Constructors

constructor

new Bitkub(options: object): Bitkub

- Defined in bitkub/index.ts:8
Client class for Bitkub API

Parameters
- options: object
  
  An options for Bitkub API authentication
  - api_key: string
  - api_secret: string
  - Optional server_url?: undefined | string
Returns Bitkub

Properties

Private _api_client

_api_client: API

Methods

asks

asks(parameters: object): Promise<any>

- Defined in bitkub/index.ts:68
List open sell orders

Parameters
- parameters: object
  
  = A query parameters
  - lmt: number
  - sym: string
Returns Promise<any>

balances

balances(): Promise<any>

- Defined in bitkub/index.ts:109
Get balances info: this includes both available and reserved balances

Returns Promise<any>

bids

bids(parameters: object): Promise<any>

- Defined in bitkub/index.ts:58
List open buy orders

Parameters
- parameters: object
  
  = A query parameters
Returns Promise<any>

books

books(parameters: object): Promise<any>

- Defined in bitkub/index.ts:78
List all open orders

Parameters
- parameters: object
  
  = A query parameters
  - lmt: number
  - sym: string
Returns Promise<any>

cancel_order

cancel_order(parameters: object): Promise<any>

- Defined in bitkub/index.ts:154
Cancel an open order

Parameters
- parameters: object
  
  = A query parameters
  - id: number
  - sd: string
  - sym: string
Returns Promise<any>

my_open_orders

my_open_orders(parameters: object): Promise<any>

- Defined in bitkub/index.ts:163
List all open orders of the given symbol

Parameters
- parameters: object
  
  = A query parameters
  - sym: string
Returns Promise<any>

my_order_history

my_order_history(parameters: object): Promise<any>

- Defined in bitkub/index.ts:174
List all orders that have already matched

Parameters
- parameters: object
  
  = A query parameters
  - Optional lmt?: undefined | string
  - Optional p?: undefined | string
  - sym: string
Returns Promise<any>

order_info

order_info(parameters: object): Promise<any>

- Defined in bitkub/index.ts:189
Get information regarding the specified order

Parameters
- parameters: object
  
  = A query parameters
  - id: number
  - sd: string
  - sym: string
Returns Promise<any>

place_ask

place_ask(parameters: object): Promise<any>

- Defined in bitkub/index.ts:138
Create a sell order

Parameters
- parameters: object
  
  = A query parameters
  - amt: number
  - rat: number
  - sym: string
  - typ: string
Returns Promise<any>

place_bid

place_bid(parameters: object): Promise<any>

- Defined in bitkub/index.ts:121
Create a buy order

Parameters
- parameters: object
  
  = A query parameters
  - amt: number
  - rat: number
  - sym: string
  - typ: string
Returns Promise<any>

server_time

server_time(): Promise<any>

- Defined in bitkub/index.ts:24
Get server timestamp

Returns Promise<any>

symbols

symbols(): Promise<any>

- Defined in bitkub/index.ts:31
List all available symbols

Returns Promise<any>

ticker

ticker(): Promise<any>

- Defined in bitkub/index.ts:38
Get ticker information

Returns Promise<any>

trades

trades(parameters: object): Promise<any>

- Defined in bitkub/index.ts:48
List recent trades

Parameters
- parameters: object
  
  = A query parameters
  - lmt: number
  - sym: string
Returns Promise<any>

trading_view

trading_view(parameters: object): Promise<any>

- Defined in bitkub/index.ts:90
Get tradingview data for displaying tradingview graph

Parameters
- parameters: object
  
  = A query parameters
  - frm: number
  - int: number
  - sym: string
  - to: number
Returns Promise<any>

wallet

wallet(): Promise<any>

- Defined in bitkub/index.ts:102
Get user wallet info

Returns Promise<any>

Generated using TypeDoc