Class ProviderKucoin

Hierarchy

ProviderCommon
Hierarchy
- ProviderKucoin

Implements

IProvider

Constructors

constructor

new ProviderKucoin(props: IProviderKucoin): ProviderKucoin
Init the Provider with config.

Memberof
ProviderKucoin
Parameters
- props: IProviderKucoin
  
  The class properties.
Returns ProviderKucoin
Overrides ProviderCommon.constructor
- Defined in src/clients/kucoin/lib/index.ts:153

Properties

apiKey

apiKey: string

The API key (https://kucoin.com/account/api).

Memberof

ProviderKucoin

apiPassPhrase

apiPassPhrase: string

The API passphrase.

Memberof

ProviderKucoin

apiSecret

apiSecret: string

The API secret key.

Memberof

ProviderKucoin

client

client: any = ClientKucoin

The client for RESTFUL and WebSocket API.

Memberof

ProviderKucoin

httpBase

httpBase: string = 'https://openapi-v2.kucoin.com'

The API url.

Memberof

ProviderKucoin

`Readonly` httpBaseTestnet

httpBaseTestnet: string = 'https://openapi-sandbox.kucoin.com'

The testnet API url.

Memberof

ProviderKucoin

`Readonly` id

id: string = 'kucoin'

The id of the provider (readonly).

Memberof

ProviderKucoin

log

log: Logger

The logger.

Memberof

ProviderKucoin

name

name: string = 'kucoin'

The name of the provider.

Memberof

ProviderKucoin

testnet

testnet: boolean = false

Use testnet.

Memberof

ProviderKucoin

weightLimitLevels

weightLimitLevels: { ratio: number; type: string; waitTimeMS: number }[] = ...

Define API Ratio limit levels behaviors : will pause request if weight API ratio is too high, to avoid IP ban.

Memberof

ProviderCommon

weightLimitPerMinute

weightLimitPerMinute: number = 180

Define the max wheight to avoid banning.

Memberof

ProviderKucoin

Methods

__getAllOrdersPerPage

__getAllOrdersPerPage(obj: any, currentPage?: number, pageSize?: number): Promise<{ currentPage: number; orders: IOrder[]; pageSize: number; totalNum: number; totalPage: number }>
Get orders with paginated results.

Returns
- The list of orders and pagination states.
Parameters
- obj: any
  
  The metas used to request.
- currentPage: number = 1
  
  The currentPage to request (start at 1).
- pageSize: number = 500
  
  The count of orders by page.
Returns Promise<{ currentPage: number; orders: IOrder[]; pageSize: number; totalNum: number; totalPage: number }>
- Defined in src/clients/kucoin/lib/index.ts:904

addListener

addListener<E>(event: E, listener: IProviderEvents[E]): ProviderKucoin
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
- listener: IProviderEvents[E]
Returns ProviderKucoin
Implementation of IProvider.addListener

Inherited from ProviderCommon.addListener
- Defined in node_modules/typed-emitter/index.d.ts:24

attachStreamAccount

attachStreamAccount(): Promise<void>
Open a private websocket events listener.

Member Of
ProviderKucoin

Returns Promise<void>
Implementation of IProvider.attachStreamAccount
- Defined in src/clients/kucoin/lib/index.ts:557

attachStreamTicker

attachStreamTicker(baseAsset: string, quoteAsset: string): Promise<any>
Parameters
- baseAsset: string
- quoteAsset: string
Returns Promise<any>
Implementation of IProvider.attachStreamTicker
- Defined in src/clients/kucoin/lib/index.ts:586

cancelOpenOrders

cancelOpenOrders(baseAsset: string, quoteAsset: string): Promise<IOrder[]>
Cancel Open Orders.

Returns
- The closed orders.
Memberof
ProviderBinance
Parameters
- baseAsset: string
  
  The base asset.
- quoteAsset: string
  
  The quote asset.
Returns Promise<IOrder[]>
Implementation of IProvider.cancelOpenOrders
- Defined in src/clients/kucoin/lib/index.ts:497

createOrderLimit

createOrderLimit(side: "BUY" | "SELL", quantity: number, price: number, baseAsset: string, quoteAsset: string): Promise<IOrder>
Parameters
- side: "BUY" | "SELL"
- quantity: number
- price: number
- baseAsset: string
- quoteAsset: string
Returns Promise<IOrder>
Implementation of IProvider.createOrderLimit
- Defined in src/clients/kucoin/lib/index.ts:515

createOrderMarket

createOrderMarket(props: IOrderMarketProps): Promise<IOrder>
Parameters
- props: IOrderMarketProps
Returns Promise<IOrder>
Implementation of IProvider.createOrderMarket
- Defined in src/clients/kucoin/lib/index.ts:520

emit

emit<E>(event: E, ...args: Arguments<IProviderEvents[E]>): boolean
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
- Rest ...args: Arguments<IProviderEvents[E]>
Returns boolean
Implementation of IProvider.emit

Inherited from ProviderCommon.emit
- Defined in node_modules/typed-emitter/index.d.ts:34

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Implementation of IProvider.eventNames

Inherited from ProviderCommon.eventNames
- Defined in node_modules/typed-emitter/index.d.ts:35

formatSymbol

formatSymbol(baseAsset: string, quoteAsset: string): string
Build the symbol pair name from base and quote assets.

Returns
- The symbol pair name.
Memberof
ProviderKucoin
Parameters
- baseAsset: string
  
  The base asset.
- quoteAsset: string
  
  The quote asset.
Returns string
Implementation of IProvider.formatSymbol
- Defined in src/clients/kucoin/lib/index.ts:382

getAccountBalances

getAccountBalances(): Promise<IBalance[]>
Get account balances.

Returns
- Array of balances.
Memberof
ProviderKucoin
Returns Promise<IBalance[]>
Implementation of IProvider.getAccountBalances
- Defined in src/clients/kucoin/lib/index.ts:394

getActiveOrders

getActiveOrders(baseAsset: string, quoteAsset: string, daysRange?: number): Promise<IOrder[]>
Get All 'active' orders for a symbol.

Returns
- The list of orders.
Memberof
ProviderKucoin
Parameters
- baseAsset: string
  
  The base asset.
- quoteAsset: string
  
  The quote asset.
- Optional daysRange: number
  
  The number of days to request (default: 365).
Returns Promise<IOrder[]>
Implementation of IProvider.getActiveOrders
- Defined in src/clients/kucoin/lib/index.ts:485

getAllOrders

getAllOrders(baseAsset: string, quoteAsset: string, daysRange?: number): Promise<IOrder[]>
Get All 'done' orders for a symbol.

Returns
- The list of orders.
Memberof
ProviderKucoin
Parameters
- baseAsset: string
  
  The base asset.
- quoteAsset: string
  
  The quote asset.
- Optional daysRange: number
  
  The number of days to request (default: 365).
Returns Promise<IOrder[]>
Implementation of IProvider.getAllOrders
- Defined in src/clients/kucoin/lib/index.ts:472

getAllOrdersForPairs

getAllOrdersForPairs(pairs?: { baseAsset: string; quoteAsset: string }[], status?: "active" | "done", daysRange?: number): Promise<IOrder[]>
Grouping order request for an array of pairs.

Returns
- The list of orders.
Parameters
- Optional pairs: { baseAsset: string; quoteAsset: string }[]
  
  Pairs of asssets to filter.
- Optional status: "active" | "done"
  
  The orders status.
- Optional daysRange: number
  
  The number of days to request (default: 365).
Returns Promise<IOrder[]>
- Defined in src/clients/kucoin/lib/index.ts:450

getApiRatioLimits

getApiRatioLimits(): Promise<any>
Returns Promise<any>
Implementation of IProvider.getApiRatioLimits

Overrides ProviderCommon.getApiRatioLimits
- Defined in src/clients/kucoin/lib/index.ts:186

getAssetBalance

getAssetBalance(asset: string): Promise<IBalance>
Get asset balance.

Returns
- Asset balance.
Parameters
- asset: string
Returns Promise<IBalance>
Implementation of IProvider.getAssetBalance
- Defined in src/clients/kucoin/lib/index.ts:418

getHistory

getHistory(baseAsset: string, quoteAsset: string, intervalType?: ICandleChartIntervalKeys, opts?: { endDate?: Date; limit?: number; startDate?: Date }): Promise<ICandle[]>
Get candles history for a pair.

Returns

Memberof
ProviderBinance
Parameters
- baseAsset: string
  
  The base asset.
- quoteAsset: string
  
  The quote asset.
- intervalType: ICandleChartIntervalKeys = ICandleChartIntervalKeys.ONE_DAY
- opts: { endDate?: Date; limit?: number; startDate?: Date } = ...
  - Optional endDate?: Date
  - Optional limit?: number
  - Optional startDate?: Date
Returns Promise<ICandle[]>
Implementation of IProvider.getHistory
- Defined in src/clients/kucoin/lib/index.ts:277

getMaxListeners

getMaxListeners(): number
Returns number
Implementation of IProvider.getMaxListeners

Inherited from ProviderCommon.getMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:40

getOrderById

getOrderById(orderId: string): Promise<IOrder>
Get an order with its ID.

Returns

Member Of
ProviderKucoin
Parameters
- orderId: string
Returns Promise<IOrder>
- Defined in src/clients/kucoin/lib/index.ts:431

getPrice

getPrice(baseAsset: string, quoteAsset: string): Promise<number>
Get the price of a pair.

Returns
- The last price.
Memberof
ProviderBinance
Parameters
- baseAsset: string
  
  The base asset.
- quoteAsset: string
  
  The quote asset.
Returns Promise<number>
Implementation of IProvider.getPrice
- Defined in src/clients/kucoin/lib/index.ts:244

getTickerInfo

getTickerInfo(baseAsset: string, quoteAsset: string): Promise<IAsset>
Get the asset details from exchangeInfo.

Returns
- The formated asset.
Memberof
ProviderBinance
Parameters
- baseAsset: string
  
  The base asset.
- quoteAsset: string
  
  The quote asset.
Returns Promise<IAsset>
Implementation of IProvider.getTickerInfo
- Defined in src/clients/kucoin/lib/index.ts:260

getTradingBalances

getTradingBalances(): Promise<IBalance[]>
Get Trading balances.

Returns
- Array of balances.
Memberof
ProviderKucoin
Returns Promise<IBalance[]>
Implementation of IProvider.getTradingBalances
- Defined in src/clients/kucoin/lib/index.ts:406

getVolatility

getVolatility(candles: ICandle[]): [low: number, high: number, variation: number]
Calculate volatility from candles.

Returns
- The volatility params.
Memberof
ProviderCommon
Parameters
- candles: ICandle[]
  
  The candles formatted.
Returns [low: number, high: number, variation: number]
Implementation of IProvider.getVolatility

Inherited from ProviderCommon.getVolatility
- Defined in src/clients/common/lib/index.ts:67

innerTransfer

innerTransfer(clientOid: string, baseAsset: string, amount: number, transferType: "FUNDING_TRADE" | "TRADE_FUNDING"): Promise<string>
Transfer currencies between internal accounts (TRADE <-> MAIN).
Parameters
- clientOid: string
  
  Transfer Order ID (eg UUID).
- baseAsset: string
  
  Currency (eg USDT).
- amount: number
  
  A positive number of currency to transfer.
- transferType: "FUNDING_TRADE" | "TRADE_FUNDING"
  
  The type of trasnfer (TRADE_FUNDING | FUNDING_TRADE).
Returns Promise<string>
Implementation of IProvider.innerTransfer
- Defined in src/clients/kucoin/lib/index.ts:599

listenerCount

listenerCount<E>(event: E): number
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
Returns number
Implementation of IProvider.listenerCount

Inherited from ProviderCommon.listenerCount
- Defined in node_modules/typed-emitter/index.d.ts:38

listeners

listeners<E>(event: E): Function[]
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
Returns Function[]
Implementation of IProvider.listeners

Inherited from ProviderCommon.listeners
- Defined in node_modules/typed-emitter/index.d.ts:37

off

off<E>(event: E, listener: IProviderEvents[E]): ProviderKucoin
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
- listener: IProviderEvents[E]
Returns ProviderKucoin
Implementation of IProvider.off

Inherited from ProviderCommon.off
- Defined in node_modules/typed-emitter/index.d.ts:30

on

on<E>(event: E, listener: IProviderEvents[E]): ProviderKucoin
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
- listener: IProviderEvents[E]
Returns ProviderKucoin
Implementation of IProvider.on

Inherited from ProviderCommon.on
- Defined in node_modules/typed-emitter/index.d.ts:25

once

once<E>(event: E, listener: IProviderEvents[E]): ProviderKucoin
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
- listener: IProviderEvents[E]
Returns ProviderKucoin
Implementation of IProvider.once

Inherited from ProviderCommon.once
- Defined in node_modules/typed-emitter/index.d.ts:26

prependListener

prependListener<E>(event: E, listener: IProviderEvents[E]): ProviderKucoin
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
- listener: IProviderEvents[E]
Returns ProviderKucoin
Implementation of IProvider.prependListener

Inherited from ProviderCommon.prependListener
- Defined in node_modules/typed-emitter/index.d.ts:27

prependOnceListener

prependOnceListener<E>(event: E, listener: IProviderEvents[E]): ProviderKucoin
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
- listener: IProviderEvents[E]
Returns ProviderKucoin
Implementation of IProvider.prependOnceListener

Inherited from ProviderCommon.prependOnceListener
- Defined in node_modules/typed-emitter/index.d.ts:28

rawListeners

rawListeners<E>(event: E): Function[]
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
Returns Function[]
Implementation of IProvider.rawListeners

Inherited from ProviderCommon.rawListeners
- Defined in node_modules/typed-emitter/index.d.ts:36

removeAllListeners

removeAllListeners<E>(event?: E): ProviderKucoin
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- Optional event: E
Returns ProviderKucoin
Implementation of IProvider.removeAllListeners

Inherited from ProviderCommon.removeAllListeners
- Defined in node_modules/typed-emitter/index.d.ts:31

removeListener

removeListener<E>(event: E, listener: IProviderEvents[E]): ProviderKucoin
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
- listener: IProviderEvents[E]
Returns ProviderKucoin
Implementation of IProvider.removeListener

Inherited from ProviderCommon.removeListener
- Defined in node_modules/typed-emitter/index.d.ts:32

respectApiRatioLimits

respectApiRatioLimits(): Promise<void>
Returns Promise<void>
Overrides ProviderCommon.respectApiRatioLimits
- Defined in src/clients/kucoin/lib/index.ts:201

setMaxListeners

setMaxListeners(maxListeners: number): ProviderKucoin
Parameters
- maxListeners: number
Returns ProviderKucoin
Implementation of IProvider.setMaxListeners

Inherited from ProviderCommon.setMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:41

Class ProviderKucoin

Hierarchy

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Memberof

Parameters

props: IProviderKucoin

Returns ProviderKucoin

Properties

apiKey

Memberof

apiPassPhrase

Memberof

apiSecret

Memberof

client

Memberof

httpBase

Memberof

Readonly httpBaseTestnet

Memberof

Readonly id

Memberof

log

Memberof

name

Memberof

testnet

Memberof

weightLimitLevels

Memberof

weightLimitPerMinute

Memberof

Methods

__getAllOrdersPerPage

Returns

Parameters

obj: any

currentPage: number = 1

pageSize: number = 500

Returns Promise<{ currentPage: number; orders: IOrder[]; pageSize: number; totalNum: number; totalPage: number }>

addListener

Type Parameters

Type Parameters

E extends keyof IProviderEvents

Parameters

event: E

listener: IProviderEvents[E]

Returns ProviderKucoin

attachStreamAccount

Member Of

Returns Promise<void>

attachStreamTicker

Parameters

baseAsset: string

quoteAsset: string

Returns Promise<any>

cancelOpenOrders

Returns

Memberof

Parameters

baseAsset: string

quoteAsset: string

Returns Promise<IOrder[]>

createOrderLimit

Parameters

side: "BUY" | "SELL"

quantity: number

price: number

baseAsset: string

quoteAsset: string

Returns Promise<IOrder>

createOrderMarket

Parameters

`Readonly` httpBaseTestnet

`Readonly` id

`Rest` ...args: Arguments<IProviderEvents[E]>

`Optional` daysRange: number

`Optional` daysRange: number

`Optional` pairs: { baseAsset: string; quoteAsset: string }[]

`Optional` status: "active" | "done"

`Optional` daysRange: number

`Optional` endDate?: Date

`Optional` limit?: number

`Optional` startDate?: Date