Class ProviderFtx

Hierarchy

ProviderCommon
Hierarchy
- ProviderFtx

Implements

IProvider

Constructors

constructor

new ProviderFtx(props: IProviderFtx): ProviderFtx
Init the Provider with config.

Memberof
ProviderFtx
Parameters
- props: IProviderFtx
  
  The class properties.
Returns ProviderFtx
Overrides ProviderCommon.constructor
- Defined in src/clients/ftx/lib/index.ts:94

Properties

apiKey

apiKey: string

The API key.

Memberof

ProviderFtx

`Optional` apiPassPhrase

apiPassPhrase?: string

apiSecret

apiSecret: string

The API secret key.

Memberof

ProviderFtx

client

client: RestClient

The client for RESTFUL and WebSocket API.

Memberof

ProviderFtx

`Readonly` id

id: string = 'ftx'

The id of the provider (readonly).

Memberof

ProviderFtx

log

log: Logger

The logger.

Memberof

ProviderFtx

name

name: string = 'ftx'

The name of the provider.

Memberof

ProviderFtx

`Optional` subAccountId

subAccountId?: string | number

subAccountName

subAccountName: string

The subaccount name.

Memberof

ProviderFtx

`Optional` testnet

testnet?: boolean

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

Define the max wheight to avoid banning.

Memberof

ProviderFtx

Methods

addListener

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

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

attachStreamAccount

attachStreamAccount(): void
Returns void
Implementation of IProvider.attachStreamAccount
- Defined in src/clients/ftx/lib/index.ts:274

attachStreamTicker

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

cancelOpenOrders

cancelOpenOrders(baseAsset: string, quoteAsset: string): Promise<boolean | IOrder[]>
Parameters
- baseAsset: string
- quoteAsset: string
Returns Promise<boolean | IOrder[]>
Implementation of IProvider.cancelOpenOrders
- Defined in src/clients/ftx/lib/index.ts:268

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/ftx/lib/index.ts:249

createOrderMarket

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

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
Parameters
- baseAsset: string
- quoteAsset: string
Returns string
Implementation of IProvider.formatSymbol
- Defined in src/clients/ftx/lib/index.ts:215

getAccountBalances

getAccountBalances(): Promise<IBalance[]>
Returns Promise<IBalance[]>
Implementation of IProvider.getAccountBalances
- Defined in src/clients/ftx/lib/index.ts:221

getActiveOrders

getActiveOrders(baseAsset: string, quoteAsset: string, daysRange?: number): Promise<IOrder[]>
Parameters
- baseAsset: string
- quoteAsset: string
- Optional daysRange: number
Returns Promise<IOrder[]>
Implementation of IProvider.getActiveOrders
- Defined in src/clients/ftx/lib/index.ts:241

getAllOrders

getAllOrders(baseAsset: string, quoteAsset: string, daysRange?: number): Promise<IOrder[]>
Parameters
- baseAsset: string
- quoteAsset: string
- Optional daysRange: number
Returns Promise<IOrder[]>
Implementation of IProvider.getAllOrders
- Defined in src/clients/ftx/lib/index.ts:237

getAllOrdersForPairs

getAllOrdersForPairs(pairs?: { baseAsset: string; quoteAsset: string }[], status?: string, daysRange?: number): Promise<IOrder[]>
Parameters
- Optional pairs: { baseAsset: string; quoteAsset: string }[]
- Optional status: string
- Optional daysRange: number
Returns Promise<IOrder[]>
- Defined in src/clients/ftx/lib/index.ts:245

getApiRatioLimits

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

Overrides ProviderCommon.getApiRatioLimits
- Defined in src/clients/ftx/lib/index.ts:125

getAssetBalance

getAssetBalance(asset: string): Promise<IBalance>
Parameters
- asset: string
Returns Promise<IBalance>
Implementation of IProvider.getAssetBalance
- Defined in src/clients/ftx/lib/index.ts:231

getExchangeInfo

getExchangeInfo(): Promise<IAsset[]>
Returns Promise<IAsset[]>
Implementation of IProvider.getExchangeInfo
- Defined in src/clients/ftx/lib/index.ts:130

getHistory

getHistory(baseAsset: string, quoteAsset: string, intervalType?: ICandleChartIntervalKeys, opts?: { endDate?: Date; limit?: number; startDate?: Date }): Promise<ICandle[]>
Parameters
- baseAsset: string
- quoteAsset: string
- 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/ftx/lib/index.ts:156

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>
Parameters
- baseAsset: string
- quoteAsset: string
Returns Promise<number>
Implementation of IProvider.getPrice
- Defined in src/clients/ftx/lib/index.ts:148

getTickerInfo

getTickerInfo(baseAsset: string, quoteAsset: string): Promise<IAsset>
Parameters
- baseAsset: string
- quoteAsset: string
Returns Promise<IAsset>
Implementation of IProvider.getTickerInfo
- Defined in src/clients/ftx/lib/index.ts:141

getTradingBalances

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

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/ftx/lib/index.ts:115

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

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

Class ProviderFtx

Hierarchy

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Memberof

Parameters

props: IProviderFtx

Returns ProviderFtx

Properties

apiKey

Memberof

Optional apiPassPhrase

apiSecret

Memberof

client

Memberof

Readonly id

Memberof

log

Memberof

name

Memberof

Optional subAccountId

subAccountName

Memberof

Optional testnet

weightLimitLevels

Memberof

weightLimitPerMinute

Memberof

Methods

addListener

Type Parameters

Type Parameters

E extends keyof IProviderEvents

Parameters

event: E

listener: IProviderEvents[E]

Returns ProviderFtx

attachStreamAccount

Returns void

attachStreamTicker

Parameters

ticker: 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

Type Parameters

Type Parameters

E extends keyof IProviderEvents

Parameters

event: E

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

Returns boolean

eventNames

Returns (string | symbol)[]

formatSymbol

Parameters

`Optional` apiPassPhrase

`Readonly` id

`Optional` subAccountId

`Optional` testnet

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

`Optional` daysRange: number

`Optional` daysRange: number

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

`Optional` status: string

`Optional` daysRange: number

`Optional` endDate?: Date

`Optional` limit?: number

`Optional` startDate?: Date