Class ApiWithSocket

Socket.io API

Hierarchy

Api
- ApiWithSocket

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ApiWithSocket(options?: ApiOptions): ApiWithSocket

Overrides Api.constructor
- Defined in src/Api/index.ts:27
Parameters
- Optional options: ApiOptions
Returns ApiWithSocket

Properties

Protected _authAddress

_authAddress: string | null = null

Protected Readonly _endpoint

_endpoint: string

Protected _signature

_signature: string | null = null

Protected Readonly _socket

_socket: SocketClient

Accessors

authAddress

set authAddress(authAddress: string): void

Inherited from Api.authAddress
- Defined in src/Api/api.ts:109
Parameters
- authAddress: string
Returns void

signature

set signature(signature: string): void

Inherited from Api.signature
- Defined in src/Api/api.ts:113
Parameters
- signature: string
Returns void

Methods

getAuthLoginData

getAuthLoginData(): Promise<EIP712Message>

Inherited from Api.getAuthLoginData
- Defined in src/Api/api.ts:51
Returns Promise<EIP712Message>

getOrderPreSubmit

getOrderPreSubmit(query: RequestQuery, authAddress?: string, signature?: string): Promise<ResponseBody>

Inherited from Api.getOrderPreSubmit
- Defined in src/Api/api.ts:95
Parameters
- query: RequestQuery
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns Promise<ResponseBody>

metaConfig

metaConfig(): Promise<ResponseBody>

Inherited from Api.metaConfig
- Defined in src/Api/api.ts:118
Returns Promise<ResponseBody>

metaTickersSearch

metaTickersSearch(query: Partial<RequestQuery>): Promise<ResponseBody>

Inherited from Api.metaTickersSearch
- Defined in src/Api/api.ts:122
Parameters
- query: Partial<RequestQuery>
Returns Promise<ResponseBody>

offChartsAsset

offChartsAsset(fn: (response: socket.ChartAssetReturns) => unknown): void

- Defined in src/Api/index.ts:64
Parameters
- fn: (response: socket.ChartAssetReturns) => unknown
  - - (response: socket.ChartAssetReturns): unknown
    - Parameters
      - response: socket.ChartAssetReturns
      Returns unknown
Returns void

onChartsAsset

onChartsAsset(fn: (response: socket.ChartAssetReturns) => unknown): void

- Defined in src/Api/index.ts:58
Parameters
- fn: (response: socket.ChartAssetReturns) => unknown
  - - (response: socket.ChartAssetReturns): unknown
    - Parameters
      - response: socket.ChartAssetReturns
      Returns unknown
Returns void

onChartsDeriv

onChartsDeriv(fn: (response: socket.ChartDerivReturns) => unknown): void

- Defined in src/Api/index.ts:79
Parameters
- fn: (response: socket.ChartDerivReturns) => unknown
  - - (response: socket.ChartDerivReturns): unknown
    - Parameters
      - response: socket.ChartDerivReturns
      Returns unknown
Returns void

onDerivativeStats

onDerivativeStats(fn: (response: socket.DerivativeStatsReturns) => unknown): void

- Defined in src/Api/index.ts:225
Parameters
- fn: (response: socket.DerivativeStatsReturns) => unknown
  - - (response: socket.DerivativeStatsReturns): unknown
    - Parameters
      - response: socket.DerivativeStatsReturns
      Returns unknown
Returns void

onError

onError(fn: Function): void

- Defined in src/Api/index.ts:41
Parameters
- fn: Function
Returns void

onOrderbookOrdersMakerAddress

onOrderbookOrdersMakerAddress(fn: (response: socket.OrderbookOrdersMakerAddressReturns) => unknown): void

- Defined in src/Api/index.ts:133
Parameters
- fn: (response: socket.OrderbookOrdersMakerAddressReturns) => unknown
  - - (response: socket.OrderbookOrdersMakerAddressReturns): unknown
    - Parameters
      - response: socket.OrderbookOrdersMakerAddressReturns
      Returns unknown
Returns void

onOrderbookOrdersTicker

onOrderbookOrdersTicker(fn: (response: socket.OrderbookOrdersTickerReturns) => unknown): void

- Defined in src/Api/index.ts:104
Parameters
- fn: (response: socket.OrderbookOrdersTickerReturns) => unknown
  - - (response: socket.OrderbookOrdersTickerReturns): unknown
    - Parameters
      - response: socket.OrderbookOrdersTickerReturns
      Returns unknown
Returns void

onPositions

onPositions(fn: (response: socket.PositionAddressReturns) => unknown): void

- Defined in src/Api/index.ts:160
Parameters
- fn: (response: socket.PositionAddressReturns) => unknown
  - - (response: socket.PositionAddressReturns): unknown
    - Parameters
      - response: socket.PositionAddressReturns
      Returns unknown
Returns void

onTradesTickerAddress

onTradesTickerAddress(fn: (response: Partial<socket.TradesTickerAddressReturns>) => unknown): void

- Defined in src/Api/index.ts:208
Parameters
- fn: (response: Partial<socket.TradesTickerAddressReturns>) => unknown
  - - (response: Partial<socket.TradesTickerAddressReturns>): unknown
    - Parameters
      - response: Partial<socket.TradesTickerAddressReturns>
      Returns unknown
Returns void

onTradesTickerAll

onTradesTickerAll(fn: (response: socket.TradesTickerAllReturns) => unknown): void

- Defined in src/Api/index.ts:177
Parameters
- fn: (response: socket.TradesTickerAllReturns) => unknown
  - - (response: socket.TradesTickerAllReturns): unknown
    - Parameters
      - response: socket.TradesTickerAllReturns
      Returns unknown
Returns void

ordersGetAllOrdersByAddress

ordersGetAllOrdersByAddress(authAddress?: string, signature?: string): Promise<ResponseBody>

Inherited from Api.ordersGetAllOrdersByAddress
- Defined in src/Api/api.ts:164
Parameters
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns Promise<ResponseBody>

postOrderForm

postOrderForm(order: RequestBody, authAddress?: string, signature?: string): Promise<ResponseBody>

Inherited from Api.postOrderForm
- Defined in src/Api/api.ts:56
Parameters
- order: RequestBody
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns Promise<ResponseBody>

postOrderSign

postOrderSign(order: RequestBody, authAddress?: string, signature?: string): Promise<unknown>

Inherited from Api.postOrderSign
- Defined in src/Api/api.ts:69
Parameters
- order: RequestBody
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns Promise<unknown>

putOrdersCancel

putOrdersCancel(query: RequestQuery, authAddress?: string, signature?: string): Promise<unknown>

Inherited from Api.putOrdersCancel
- Defined in src/Api/api.ts:82
Parameters
- query: RequestQuery
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns Promise<unknown>

socketShutdown

socketShutdown(): void

- Defined in src/Api/index.ts:45
Returns void

subscribeOnChartsAsset

subscribeOnChartsAsset(params: socket.ChartAssetParameters): void

- Defined in src/Api/index.ts:50
Parameters
- params: socket.ChartAssetParameters
Returns void

subscribeOnChartsDeriv

subscribeOnChartsDeriv(payload: ChartDerivParameters): void

- Defined in src/Api/index.ts:71
Parameters
- payload: ChartDerivParameters
Returns void

subscribeOnDerivativeStats

subscribeOnDerivativeStats(payload: DerivativeStatsParameters): void

- Defined in src/Api/index.ts:215
Parameters
- payload: DerivativeStatsParameters
Returns void

subscribeOnOrderbookOrdersMakerAddress

subscribeOnOrderbookOrdersMakerAddress(payload: Omit<OrderbookOrdersMakerAddressParameters, "addr" | "sig">, authAddress?: string, signature?: string): void

- Defined in src/Api/index.ts:111
Parameters
- payload: Omit<OrderbookOrdersMakerAddressParameters, "addr" | "sig">
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns void

subscribeOnOrderbookOrdersTicker

subscribeOnOrderbookOrdersTicker(payload: OrderbookOrdersTickerParameters): void

- Defined in src/Api/index.ts:86
Parameters
- payload: OrderbookOrdersTickerParameters
Returns void

subscribeOnTradesTickerAddress

subscribeOnTradesTickerAddress(payload: Omit<TradesTickerAddressParameters, "addr" | "sig">, authAddress?: null | string, signature?: null | string): void

- Defined in src/Api/index.ts:184
Parameters
- payload: Omit<TradesTickerAddressParameters, "addr" | "sig">
- Default value authAddress: null | string = this._authAddress
- Default value signature: null | string = this._signature
Returns void

subscribeOnTradesTickerAll

subscribeOnTradesTickerAll(payload: TradesTickerAllParameters): void

- Defined in src/Api/index.ts:167
Parameters
- payload: TradesTickerAllParameters
Returns void

subscribePositions

subscribePositions(authAddress?: string, signature?: string): void

- Defined in src/Api/index.ts:140
Parameters
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns void

tickersGetAll

tickersGetAll(query: Partial<RequestQuery>): Promise<ResponseBody>

Inherited from Api.tickersGetAll
- Defined in src/Api/api.ts:137
Parameters
- query: Partial<RequestQuery>
Returns Promise<ResponseBody>

tickersGetData

tickersGetData(hash: string): Promise<ResponseBody>

Inherited from Api.tickersGetData
- Defined in src/Api/api.ts:143
Parameters
- hash: string
Returns Promise<ResponseBody>

tickersGetDerivatives

tickersGetDerivatives(query: Partial<RequestQuery>): Promise<unknown>

Inherited from Api.tickersGetDerivatives
- Defined in src/Api/api.ts:149
Parameters
- query: Partial<RequestQuery>
Returns Promise<unknown>

tradesGetAllTradesByAddress

tradesGetAllTradesByAddress(authAddress?: string, signature?: string): Promise<ResponseBody>

Inherited from Api.tradesGetAllTradesByAddress
- Defined in src/Api/api.ts:156
Parameters
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns Promise<ResponseBody>

unsubscribeOnChartsAsset

unsubscribeOnChartsAsset(payload: socket.ChartAssetParameters): void

- Defined in src/Api/index.ts:54
Parameters
- payload: socket.ChartAssetParameters
Returns void

unsubscribeOnChartsDeriv

unsubscribeOnChartsDeriv(payload: ChartDerivParameters): void

- Defined in src/Api/index.ts:75
Parameters
- payload: ChartDerivParameters
Returns void

unsubscribeOnDerivativeStats

unsubscribeOnDerivativeStats(payload: DerivativeStatsParameters): void

- Defined in src/Api/index.ts:219
Parameters
- payload: DerivativeStatsParameters
Returns void

unsubscribeOnOrderbookOrdersMakerAddress

unsubscribeOnOrderbookOrdersMakerAddress(payload: Omit<OrderbookOrdersMakerAddressParameters, "addr" | "sig">, authAddress?: string, signature?: string): void

- Defined in src/Api/index.ts:122
Parameters
- payload: Omit<OrderbookOrdersMakerAddressParameters, "addr" | "sig">
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns void

unsubscribeOnOrderbookOrdersTicker

unsubscribeOnOrderbookOrdersTicker(payload: OrderbookOrdersTickerParameters): void

- Defined in src/Api/index.ts:95
Parameters
- payload: OrderbookOrdersTickerParameters
Returns void

unsubscribeOnTradesTickerAddress

unsubscribeOnTradesTickerAddress(payload: Omit<TradesTickerAddressParameters, "addr" | "sig">, authAddress?: null | string, signature?: null | string): void

- Defined in src/Api/index.ts:196
Parameters
- payload: Omit<TradesTickerAddressParameters, "addr" | "sig">
- Default value authAddress: null | string = this._authAddress
- Default value signature: null | string = this._signature
Returns void

unsubscribeOnTradesTickerAll

unsubscribeOnTradesTickerAll(payload: TradesTickerAllParameters): void

- Defined in src/Api/index.ts:171
Parameters
- payload: TradesTickerAllParameters
Returns void

unsubscribePositions

unsubscribePositions(authAddress?: string, signature?: string): void

- Defined in src/Api/index.ts:150
Parameters
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns void

walletTokenBalance

walletTokenBalance(authAddress?: string, signature?: string): Promise<ResponseBody>

Inherited from Api.walletTokenBalance
- Defined in src/Api/api.ts:129
Parameters
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns Promise<ResponseBody>

Generated using TypeDoc