Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "src/Api/socket"

Index

Enumerations

Classes

Type aliases

Type aliases

ChartAssetParameters

ChartAssetParameters: { o: string; s: string }

Type declaration

  • o: string

    Oracle id

  • s: string

    Candle size, values: 1$m/30$m/1$h/2$h/4$d/12$h/1$d/3$d/5$d/1$w/all

ChartAssetReturns

ChartAssetReturns: { a: "set"; ch: CHART_ASSET; d: Array<{ c: number; h: number; l: number; o: number; t: number; v: number }>; p: ChartAssetParameters }

Type declaration

ChartDerivParameters

ChartDerivParameters: { c: string; s: string; t: string }

Type declaration

  • c: string

    currency

  • s: string

    candle size 1$m/30$m/1$h/2$h/4$d/12$h/1$d/3$d/5$d/1$w/all

  • t: string

    ticker hash

ChartDerivReturns

ChartDerivReturns: { a: "set"; ch: CHART_DERIV; d: Array<{ c: number; h: number; l: number; o: number; t: number; v: number }>; p: ChartDerivParameters }

Type declaration

DerivativeStatsParameters

DerivativeStatsParameters: { c: string; t: string }

Type declaration

  • c: string

    currency

  • t: string

    ticker hash

DerivativeStatsReturns

DerivativeStatsReturns: { a: "set"; ch: DERIVATIVE_STATS; d: Array<{ h: number; l: number; v: number }>; p: DerivativeStatsParameters }

Type declaration

OrderbookOrdersMakerAddressParameters

OrderbookOrdersMakerAddressParameters: { addr: string; c: string; sig: string; t: string }

Type declaration

  • addr: string

    maker address to fetch orders for,

  • c: string

    currency

  • sig: string

    Signature (access token)

  • t: string

    ticker hash

OrderbookOrdersMakerAddressReturns

OrderbookOrdersMakerAddressReturns: { a: "set"; ch: ORDERBOOK_ORDERS_MAKER_ADDRESS; d: Array<{ a: ORDER_ACTION; cT: number; eT: number; f: number; i: string; m: boolean; p: number; q: number }>; p: OrderbookOrdersMakerAddressParameters }

Type declaration

OrderbookOrdersTickerParameters

OrderbookOrdersTickerParameters: { c: string; t: string }

Type declaration

  • c: string

    currency

  • t: string

    ticker hash

OrderbookOrdersTickerReturns

OrderbookOrdersTickerReturns: { a: "set"; ch: ORDERBOOK_ORDERS_TICKER; d: Array<{ a: string; c: number; p: number; v: number }>; p: OrderbookOrdersTickerParameters }

Type declaration

ParamsByChannel

ParamsByChannel<TChannel>: TChannel extends CHART_ASSET ? ChartAssetParameters : TChannel extends CHART_DERIV ? ChartDerivParameters : TChannel extends ORDERBOOK_ORDERS_TICKER ? OrderbookOrdersTickerParameters : TChannel extends ORDERBOOK_ORDERS_MAKER_ADDRESS ? OrderbookOrdersMakerAddressParameters : TChannel extends TRADES_TICKER_ALL ? TradesTickerAllParameters : TChannel extends TRADES_TICKER_ALL ? TradesTickerAddressParameters : TChannel extends DERIVATIVE_STATS ? DerivativeStatsParameters : TChannel extends POSITION_ADDRESS ? PositionAddressParameters : {}

Type parameters

PositionAddressParameters

PositionAddressParameters: { addr: string; sig: string }

Type declaration

  • addr: string

    public key to fetch positions for

  • sig: string

    Signature (access token)

PositionAddressReturns

PositionAddressReturns: { a: "set"; ch: POSITION_ADDRESS; d: { por: Array<{ pos: Array<{ ca: boolean; r: number; th: string; ti: string; tt: string; ty: "LONG" | "SHORT" }>; q: number; ti: string }>; pos: Array<{ ca: boolean; ex: boolean; hd: boolean; q: number; th: string; ti: string; tt: string; ty: "LONG" | "SHORT" }> }; p: PositionAddressParameters }

Type declaration

  • a: "set"
  • ch: POSITION_ADDRESS
  • d: { por: Array<{ pos: Array<{ ca: boolean; r: number; th: string; ti: string; tt: string; ty: "LONG" | "SHORT" }>; q: number; ti: string }>; pos: Array<{ ca: boolean; ex: boolean; hd: boolean; q: number; th: string; ti: string; tt: string; ty: "LONG" | "SHORT" }> }
    • por: Array<{ pos: Array<{ ca: boolean; r: number; th: string; ti: string; tt: string; ty: "LONG" | "SHORT" }>; q: number; ti: string }>

      portfolios

    • pos: Array<{ ca: boolean; ex: boolean; hd: boolean; q: number; th: string; ti: string; tt: string; ty: "LONG" | "SHORT" }>

      positions

  • p: PositionAddressParameters

ResponseByChannel

ResponseByChannel<TChannel>: TChannel extends CHART_ASSET ? ChartAssetReturns : TChannel extends CHART_DERIV ? ChartDerivReturns : TChannel extends ORDERBOOK_ORDERS_TICKER ? OrderbookOrdersTickerReturns : TChannel extends ORDERBOOK_ORDERS_MAKER_ADDRESS ? OrderbookOrdersMakerAddressReturns : TChannel extends TRADES_TICKER_ALL ? TradesTickerAllReturns : TChannel extends TRADES_TICKER_ALL ? TradesTickerAddressReturns : TChannel extends DERIVATIVE_STATS ? DerivativeStatsReturns : TChannel extends POSITION_ADDRESS ? PositionAddressReturns : {}

Type parameters

TradesTickerAddressParameters

TradesTickerAddressParameters: { addr: string; c: string; sig: string; t: string }

Type declaration

  • addr: string

    maker address to fetch orders for,

  • c: string

    currency

  • sig: string

    Signature (access token)

  • t: string

    ticker hash

TradesTickerAddressReturns

TradesTickerAddressReturns: { a: "set"; ch: TRADES_TICKER_ADDRESS; d: Array<{ a: string; p: number; q: number; t: string; tx: string }>; p: TradesTickerAddressParameters }

Type declaration

TradesTickerAllParameters

TradesTickerAllParameters: { c: string; t: string }

Type declaration

  • c: string

    currency

  • t: string

    ticker hash

TradesTickerAllReturns

TradesTickerAllReturns: { a: "set"; ch: TRADES_TICKER_ALL; d: Array<{ a: string; p: number; q: number; t: string; tx: string }>; p: TradesTickerAllParameters }

Type declaration

Generated using TypeDoc