Interface IProvider

Hierarchy

EventEmitter
Hierarchy
- IProvider

Implemented by

Properties

apiKey

apiKey: string

`Optional` apiPassPhrase

apiPassPhrase?: string

apiSecret

apiSecret: string

id

id: string

name

name: string

`Optional` subAccountId

subAccountId?: string | number

`Optional` testnet

testnet?: boolean

Methods

addListener

addListener(event: string | symbol, listener: ((...args: any[]) => void)): IProvider
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns IProvider
Inherited from EventEmitter.addListener
- Defined in node_modules/@types/node/events.d.ts:57

attachStreamAccount

attachStreamAccount(): void
Returns void
- Defined in src/clients/common/interfaces/IProvider.ts:42

attachStreamTicker

attachStreamTicker(baseAsset: string, quoteAsset: string): void
Parameters
- baseAsset: string
- quoteAsset: string
Returns void
- Defined in src/clients/common/interfaces/IProvider.ts:43

cancelOpenOrders

cancelOpenOrders(baseAsset: string, quoteAsset: string): Promise<boolean | IOrder[]>
Parameters
- baseAsset: string
- quoteAsset: string
Returns Promise<boolean | IOrder[]>
- Defined in src/clients/common/interfaces/IProvider.ts:39

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>
- Defined in src/clients/common/interfaces/IProvider.ts:37

createOrderMarket

createOrderMarket(props: IOrderMarketProps): Promise<IOrder>
Parameters
- props: IOrderMarketProps
Returns Promise<IOrder>
- Defined in src/clients/common/interfaces/IProvider.ts:38

emit

emit(event: string | symbol, ...args: any[]): boolean
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/@types/node/events.d.ts:67

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:72

formatSymbol

formatSymbol(baseAsset: string, quoteAsset: string): string
Parameters
- baseAsset: string
- quoteAsset: string
Returns string
- Defined in src/clients/common/interfaces/IProvider.ts:31

getAccountBalances

getAccountBalances(): Promise<IBalance[]>
Returns Promise<IBalance[]>
- Defined in src/clients/common/interfaces/IProvider.ts:32

getActiveOrders

getActiveOrders(baseAsset: string, quoteAsset: string, daysRange?: number): Promise<IOrder[]>
Parameters
- baseAsset: string
- quoteAsset: string
- Optional daysRange: number
Returns Promise<IOrder[]>
- Defined in src/clients/common/interfaces/IProvider.ts:36

getAllOrders

getAllOrders(baseAsset: string, quoteAsset: string, daysRange?: number): Promise<IOrder[]>
Parameters
- baseAsset: string
- quoteAsset: string
- Optional daysRange: number
Returns Promise<IOrder[]>
- Defined in src/clients/common/interfaces/IProvider.ts:35

getApiRatioLimits

getApiRatioLimits(): Promise<any>
Returns Promise<any>
- Defined in src/clients/common/interfaces/IProvider.ts:41

getAssetBalance

getAssetBalance(asset: string): Promise<IBalance>
Parameters
- asset: string
Returns Promise<IBalance>
- Defined in src/clients/common/interfaces/IProvider.ts:34

getExchangeInfo

getExchangeInfo(): Promise<IAsset[]>
Returns Promise<IAsset[]>
- Defined in src/clients/common/interfaces/IProvider.ts:21

getHistory

getHistory(baseAsset: string, quoteAsset: string, intervalType?: ICandleChartIntervalKeys, opts?: { endDate?: Date; limit?: number; startDate?: Date }): Promise<ICandle[]>
Parameters
- baseAsset: string
- quoteAsset: string
- Optional intervalType: ICandleChartIntervalKeys
- Optional opts: { endDate?: Date; limit?: number; startDate?: Date }
  - Optional endDate?: Date
  - Optional limit?: number
  - Optional startDate?: Date
Returns Promise<ICandle[]>
- Defined in src/clients/common/interfaces/IProvider.ts:24

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:64

getPrice

getPrice(baseAsset: string, quoteAsset: string): Promise<number>
Parameters
- baseAsset: string
- quoteAsset: string
Returns Promise<number>
- Defined in src/clients/common/interfaces/IProvider.ts:22

getTickerInfo

getTickerInfo(baseAsset: string, quoteAsset: string): Promise<IAsset>
Parameters
- baseAsset: string
- quoteAsset: string
Returns Promise<IAsset>
- Defined in src/clients/common/interfaces/IProvider.ts:23

getTradingBalances

getTradingBalances(): Promise<IBalance[]>
Returns Promise<IBalance[]>
- Defined in src/clients/common/interfaces/IProvider.ts:33

getVolatility

getVolatility(candles: ICandle[]): [low: number, high: number, variation: number]
Parameters
- candles: ICandle[]
Returns [low: number, high: number, variation: number]
- Defined in src/clients/common/interfaces/IProvider.ts:30

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>
- Defined in src/clients/common/interfaces/IProvider.ts:40

listenerCount

listenerCount(event: string | symbol): number
Parameters
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:68

listeners

listeners(event: string | symbol): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:65

off

off(event: string | symbol, listener: ((...args: any[]) => void)): IProvider
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns IProvider
Inherited from EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:61

on

on(event: string | symbol, listener: ((...args: any[]) => void)): IProvider
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns IProvider
Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:58

once

once(event: string | symbol, listener: ((...args: any[]) => void)): IProvider
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns IProvider
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:59

prependListener

prependListener(event: string | symbol, listener: ((...args: any[]) => void)): IProvider
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns IProvider
Inherited from EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:70

prependOnceListener

prependOnceListener(event: string | symbol, listener: ((...args: any[]) => void)): IProvider
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns IProvider
Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:71

rawListeners

rawListeners(event: string | symbol): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:66

removeAllListeners

removeAllListeners(event?: string | symbol): IProvider
Parameters
- Optional event: string | symbol
Returns IProvider
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:62

removeListener

removeListener(event: string | symbol, listener: ((...args: any[]) => void)): IProvider
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns IProvider
Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:60

setMaxListeners

setMaxListeners(n: number): IProvider
Parameters
- n: number
Returns IProvider
Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:63

Interface IProvider

Hierarchy

Hierarchy

Implemented by

Index

Properties

Methods

Properties

apiKey

Optional apiPassPhrase

apiSecret

id

name

Optional subAccountId

Optional testnet

Methods

addListener

Parameters

event: string | symbol

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns IProvider

attachStreamAccount

Returns void

attachStreamTicker

Parameters

baseAsset: string

quoteAsset: string

Returns void

cancelOpenOrders

Parameters

baseAsset: string

quoteAsset: string

Returns Promise<boolean | IOrder[]>

createOrderLimit

Parameters

side: "BUY" | "SELL"

quantity: number

price: number

baseAsset: string

quoteAsset: string

Returns Promise<IOrder>

createOrderMarket

Parameters

props: IOrderMarketProps

Returns Promise<IOrder>

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

formatSymbol

Parameters

baseAsset: string

quoteAsset: string

Returns string

getAccountBalances

Returns Promise<IBalance[]>

getActiveOrders

Parameters

baseAsset: string

quoteAsset: string

Optional daysRange: number

Returns Promise<IOrder[]>

getAllOrders

Parameters

baseAsset: string

quoteAsset: string

Optional daysRange: number

Returns Promise<IOrder[]>

getApiRatioLimits

Returns Promise<any>

getAssetBalance

Parameters

asset: string

Returns Promise<IBalance>

`Optional` apiPassPhrase

`Optional` subAccountId

`Optional` testnet

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` daysRange: number

`Optional` daysRange: number

`Optional` intervalType: ICandleChartIntervalKeys

`Optional` opts: { endDate?: Date; limit?: number; startDate?: Date }

`Optional` endDate?: Date

`Optional` limit?: number

`Optional` startDate?: Date

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]