Class ProviderBinance

Hierarchy

ProviderCommon
Hierarchy
- ProviderBinance

Implements

IProvider

Constructors

constructor

new ProviderBinance(props: IProviderBinance): ProviderBinance
Init the Provider with config.

Memberof
ProviderBinance
Parameters
- props: IProviderBinance
  
  The class properties.
Returns ProviderBinance
Overrides ProviderCommon.constructor
- Defined in src/clients/binance/lib/index.ts:116

Properties

apiKey

apiKey: string

The API key (https://www.binance.com/userCenter/createApi.html).

Memberof

ProviderBinance

`Optional` apiPassPhrase

apiPassPhrase?: string

apiSecret

apiSecret: string

The API secret key.

Memberof

ProviderBinance

client

client: Binance

The client for RESTFUL and WebSocket API.

Memberof

ProviderBinance

httpBase

httpBase: string = 'https://api.binance.com'

The API url.

Memberof

ProviderBinance

`Readonly` httpBaseTestnet

httpBaseTestnet: string = 'https://testnet.binance.vision'

The testnet API url.

Memberof

ProviderBinance

`Readonly` id

id: string = 'binance'

The id of the provider (readonly).

Memberof

ProviderBinance

log

log: Logger

The logger.

Memberof

ProviderBinance

name

name: string = 'binance'

The name of the provider.

Memberof

ProviderBinance

recvWindow

recvWindow: number = 60000

Receive window prop (recvWindow).

Memberof

ProviderBinance

`Optional` subAccountId

subAccountId?: string | number

testnet

testnet: boolean = false

Use testnet.

Memberof

ProviderBinance

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 = 1200

Define the max wheight to avoid banning.

Memberof

ProviderBinance

Methods

addListener

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

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

attachStreamAccount

attachStreamAccount(): Promise<ReconnectingWebSocketHandler>
Attach websocket account events to emit updates.

Returns
- The websocket instance
Returns Promise<ReconnectingWebSocketHandler>
Implementation of IProvider.attachStreamAccount
- Defined in src/clients/binance/lib/index.ts:420

attachStreamTicker

attachStreamTicker(ticker: string): void
Parameters
- ticker: string
Returns void
Implementation of IProvider.attachStreamTicker
- Defined in src/clients/binance/lib/index.ts:147

cancelOpenOrders

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

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

createOrderLimit

createOrderLimit(side: OrderSide, quantity: number, price: number, baseAsset: string, quoteAsset: string): Promise<IOrder>
Create a LIMIT order.

Returns
- The created order.
Memberof
ProviderBinance
Parameters
- side: OrderSide
  
  Side of the order (BUY | SELL)
- quantity: number
  
  The amount of the token concerned.
- price: number
  
  The price of the limit order.
- baseAsset: string
  
  The base asset.
- quoteAsset: string
  
  The quote asset.
Returns Promise<IOrder>
Implementation of IProvider.createOrderLimit
- Defined in src/clients/binance/lib/index.ts:370

createOrderMarket

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

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
ProviderBinance
Parameters
- baseAsset: string
  
  The base asset.
- quoteAsset: string
  
  The quote asset.
Returns string
Implementation of IProvider.formatSymbol
- Defined in src/clients/binance/lib/index.ts:279

getAccountBalances

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

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

getActiveOrders

getActiveOrders(baseAsset: string, quoteAsset: string): Promise<IOrder[]>
Get active orders only.

Returns
- All orders list.
Memberof
ProviderBinance
Parameters
- baseAsset: string
  
  The base asset.
- quoteAsset: string
  
  The quote asset.
Returns Promise<IOrder[]>
Implementation of IProvider.getActiveOrders
- Defined in src/clients/binance/lib/index.ts:352

getAllOrders

getAllOrders(baseAsset: string, quoteAsset: string, orderId?: number): Promise<IOrder[]>
Get all orders (filled or active).

Returns
- All orders list.
Memberof
ProviderBinance
Parameters
- baseAsset: string
  
  The base asset.
- quoteAsset: string
  
  The quote asset.
- Optional orderId: number
  
  If set, it will get orders >= that orderId. Otherwise most recent orders are returned.
Returns Promise<IOrder[]>
Implementation of IProvider.getAllOrders
- Defined in src/clients/binance/lib/index.ts:334

getAllOrdersForPairs

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

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

getAssetBalance

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

Returns
- The quote asset balance.
Memberof
ProviderBinance
Parameters
- asset: string
  
  The asset to request.
Returns Promise<IBalance>
Implementation of IProvider.getAssetBalance
- Defined in src/clients/binance/lib/index.ts:308

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.
- Optional intervalType: ICandleChartIntervalKeys = ICandleChartIntervalKeys.ONE_DAY
  
  The type of interval.
- 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/binance/lib/index.ts:195

getMaxListeners

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

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

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/binance/lib/index.ts:264

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/binance/lib/index.ts:178

getTradingBalances

getTradingBalances(): Promise<IBalance[]>
Returns Promise<IBalance[]>
Implementation of IProvider.getTradingBalances
- Defined in src/clients/binance/lib/index.ts:297

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>
Parameters
- clientOid: string
- baseAsset: string
- amount: number
- transferType: "FUNDING_TRADE" | "TRADE_FUNDING"
Returns Promise<string>
Implementation of IProvider.innerTransfer
- Defined in src/clients/binance/lib/index.ts:143

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]): ProviderBinance
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
- listener: IProviderEvents[E]
Returns ProviderBinance
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]): ProviderBinance
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
- listener: IProviderEvents[E]
Returns ProviderBinance
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]): ProviderBinance
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
- listener: IProviderEvents[E]
Returns ProviderBinance
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]): ProviderBinance
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
- listener: IProviderEvents[E]
Returns ProviderBinance
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]): ProviderBinance
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
- listener: IProviderEvents[E]
Returns ProviderBinance
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): ProviderBinance
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- Optional event: E
Returns ProviderBinance
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]): ProviderBinance
Type Parameters
Type Parameters
- E extends keyof IProviderEvents
Parameters
- event: E
- listener: IProviderEvents[E]
Returns ProviderBinance
Implementation of IProvider.removeListener

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

respectApiRatioLimits

respectApiRatioLimits(): Promise<void>
Pause request if API Ratio Limits are too high. Should be called before each client request.

Memberof
ProviderCommon

Returns Promise<void>
Inherited from ProviderCommon.respectApiRatioLimits
- Defined in src/clients/common/lib/index.ts:92

setMaxListeners

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

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

wsPing

wsPing(): Promise<boolean>
Returns Promise<boolean>
- Defined in src/clients/binance/lib/index.ts:460

Class ProviderBinance

Hierarchy

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Memberof

Parameters

props: IProviderBinance

Returns ProviderBinance

Properties

apiKey

Memberof

Optional apiPassPhrase

apiSecret

Memberof

client

Memberof

httpBase

Memberof

Readonly httpBaseTestnet

Memberof

Readonly id

Memberof

log

Memberof

name

Memberof

recvWindow

Memberof

Optional subAccountId

testnet

Memberof

weightLimitLevels

Memberof

weightLimitPerMinute

Memberof

Methods

addListener

Type Parameters

Type Parameters

E extends keyof IProviderEvents

Parameters

event: E

listener: IProviderEvents[E]

Returns ProviderBinance

attachStreamAccount

Returns

Returns Promise<ReconnectingWebSocketHandler>

attachStreamTicker

Parameters

ticker: string

Returns void

cancelOpenOrders

Returns

Memberof

Parameters

baseAsset: string

quoteAsset: string

Returns Promise<boolean | IOrder[]>

createOrderLimit

Returns

Memberof

Parameters

side: OrderSide

quantity: number

price: number

baseAsset: string

quoteAsset: string

Returns Promise<IOrder>

createOrderMarket

Parameters

props: IOrderMarketProps

Returns Promise<IOrder>

emit

Type Parameters

`Optional` apiPassPhrase

`Readonly` httpBaseTestnet

`Readonly` id

`Optional` subAccountId

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

`Optional` orderId: number

`Optional` status: string

`Optional` daysRange: number

`Optional` intervalType: ICandleChartIntervalKeys = ICandleChartIntervalKeys.ONE_DAY

`Optional` endDate?: Date

`Optional` limit?: number

`Optional` startDate?: Date