Skip to content

Class: WebsocketAPIClient ​

REST-style method wrapper around WebsocketClient.sendWSAPIRequest() for the Global Derivatives WebSocket API.

Constructors ​

Constructor ​

ts
new WebsocketAPIClient(options?: WSClientConfigurableOptions & Partial<WSAPIClientConfigurableOptions>, logger?: object): WebsocketAPIClient;

Parameters ​

ParameterType
options?WSClientConfigurableOptions & Partial<WSAPIClientConfigurableOptions>
logger?{ error: (...params: any) => void; info: (...params: any) => void; trace: (..._params: any) => void; }
logger.error?(...params: any) => void
logger.info?(...params: any) => void
logger.trace?(..._params: any) => void

Returns ​

WebsocketAPIClient

Methods ​

auth() ​

ts
auth(): Promise<WSAPIResponse<AdvTradeGlobalWSAuthResult>>;

public/auth. Generates a fresh CDP JWT automatically.

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalWSAuthResult>>


cancelAll() ​

ts
cancelAll(params?: AdvTradeGlobalCancelAllRequest): Promise<WSAPIResponse<number>>;

private/cancel_all

Parameters ​

ParameterType
params?AdvTradeGlobalCancelAllRequest

Returns ​

Promise<WSAPIResponse<number>>


cancelAllByCurrency() ​

ts
cancelAllByCurrency(params: AdvTradeGlobalCancelAllByCurrencyRequest): Promise<WSAPIResponse<number>>;

private/cancel_all_by_currency

Parameters ​

ParameterType
paramsAdvTradeGlobalCancelAllByCurrencyRequest

Returns ​

Promise<WSAPIResponse<number>>


cancelAllByCurrencyPair() ​

ts
cancelAllByCurrencyPair(params: AdvTradeGlobalCancelAllByCurrencyPairRequest): Promise<WSAPIResponse<number>>;

private/cancel_all_by_currency_pair

Parameters ​

ParameterType
paramsAdvTradeGlobalCancelAllByCurrencyPairRequest

Returns ​

Promise<WSAPIResponse<number>>


cancelAllByInstrument() ​

ts
cancelAllByInstrument(params: AdvTradeGlobalCancelAllByInstrumentRequest): Promise<WSAPIResponse<number>>;

private/cancel_all_by_instrument

Parameters ​

ParameterType
paramsAdvTradeGlobalCancelAllByInstrumentRequest

Returns ​

Promise<WSAPIResponse<number>>


cancelAllByKindOrType() ​

ts
cancelAllByKindOrType(params: AdvTradeGlobalCancelAllByKindOrTypeRequest): Promise<WSAPIResponse<number>>;

private/cancel_all_by_kind_or_type

Parameters ​

ParameterType
paramsAdvTradeGlobalCancelAllByKindOrTypeRequest

Returns ​

Promise<WSAPIResponse<number>>


cancelByLabel() ​

ts
cancelByLabel(params: AdvTradeGlobalCancelByLabelRequest): Promise<WSAPIResponse<number>>;

private/cancel_by_label

Parameters ​

ParameterType
paramsAdvTradeGlobalCancelByLabelRequest

Returns ​

Promise<WSAPIResponse<number>>


cancelOrder() ​

ts
cancelOrder(params: AdvTradeGlobalCancelRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder>>;

private/cancel

Parameters ​

ParameterType
paramsAdvTradeGlobalCancelRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalOrder>>


changeMarginModel() ​

ts
changeMarginModel(params: AdvTradeGlobalChangeMarginModelRequest): Promise<WSAPIResponse<AdvTradeGlobalChangeMarginModelItem[]>>;

private/change_margin_model

Parameters ​

ParameterType
paramsAdvTradeGlobalChangeMarginModelRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalChangeMarginModelItem[]>>


closePosition() ​

ts
closePosition(params: AdvTradeGlobalClosePositionRequest): Promise<WSAPIResponse<AdvTradeGlobalClosePositionResult>>;

private/close_position

Parameters ​

ParameterType
paramsAdvTradeGlobalClosePositionRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalClosePositionResult>>


connectWSAPI() ​

ts
connectWSAPI(): Promise<unknown>;

Optional warm-up before making private requests.

Returns ​

Promise<unknown>


createCombo() ​

ts
createCombo(params: AdvTradeGlobalCreateComboRequest): Promise<WSAPIResponse<AdvTradeGlobalCombo>>;

private/create_combo

Parameters ​

ParameterType
paramsAdvTradeGlobalCreateComboRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalCombo>>


disableCancelOnDisconnect() ​

ts
disableCancelOnDisconnect(params?: AdvTradeGlobalDisableCancelOnDisconnectRequest): Promise<WSAPIResponse<"ok">>;

private/disable_cancel_on_disconnect

Parameters ​

ParameterType
params?AdvTradeGlobalDisableCancelOnDisconnectRequest

Returns ​

Promise<WSAPIResponse<"ok">>


disableHeartbeat() ​

ts
disableHeartbeat(): Promise<WSAPIResponse<"ok">>;

public/disable_heartbeat

Returns ​

Promise<WSAPIResponse<"ok">>


enableCancelOnDisconnect() ​

ts
enableCancelOnDisconnect(params?: AdvTradeGlobalEnableCancelOnDisconnectRequest): Promise<WSAPIResponse<"ok">>;

private/enable_cancel_on_disconnect

Parameters ​

ParameterType
params?AdvTradeGlobalEnableCancelOnDisconnectRequest

Returns ​

Promise<WSAPIResponse<"ok">>


getAccessLog() ​

ts
getAccessLog(params?: AdvTradeGlobalGetAccessLogRequest): Promise<WSAPIResponse<AdvTradeGlobalAccessLog[]>>;

private/get_access_log

Parameters ​

ParameterType
params?AdvTradeGlobalGetAccessLogRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalAccessLog[]>>


getAccountSummaries() ​

ts
getAccountSummaries(params?: AdvTradeGlobalGetAccountSummariesRequest): Promise<WSAPIResponse<AdvTradeGlobalGetAccountSummariesResult>>;

private/get_account_summaries

Parameters ​

ParameterType
params?AdvTradeGlobalGetAccountSummariesRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetAccountSummariesResult>>


getAccountSummary() ​

ts
getAccountSummary(params: AdvTradeGlobalGetAccountSummaryRequest): Promise<WSAPIResponse<AdvTradeGlobalGetAccountSummaryResult>>;

private/get_account_summary

Parameters ​

ParameterType
paramsAdvTradeGlobalGetAccountSummaryRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetAccountSummaryResult>>


getAnnouncements() ​

ts
getAnnouncements(params?: AdvTradeGlobalGetAnnouncementsRequest): Promise<WSAPIResponse<AdvTradeGlobalGetAnnouncementsItem[]>>;

public/get_announcements

Parameters ​

ParameterType
params?AdvTradeGlobalGetAnnouncementsRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetAnnouncementsItem[]>>


getBookSummaryByCurrency() ​

ts
getBookSummaryByCurrency(params: AdvTradeGlobalGetBookSummaryByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalBookSummary[]>>;

public/get_book_summary_by_currency

Parameters ​

ParameterType
paramsAdvTradeGlobalGetBookSummaryByCurrencyRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalBookSummary[]>>


getBookSummaryByInstrument() ​

ts
getBookSummaryByInstrument(params: AdvTradeGlobalGetBookSummaryByInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalBookSummary[]>>;

public/get_book_summary_by_instrument

Parameters ​

ParameterType
paramsAdvTradeGlobalGetBookSummaryByInstrumentRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalBookSummary[]>>


getCancelOnDisconnect() ​

ts
getCancelOnDisconnect(params?: AdvTradeGlobalGetCancelOnDisconnectRequest): Promise<WSAPIResponse<AdvTradeGlobalGetCancelOnDisconnectResult>>;

private/get_cancel_on_disconnect

Parameters ​

ParameterType
params?AdvTradeGlobalGetCancelOnDisconnectRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetCancelOnDisconnectResult>>


getComboDetails() ​

ts
getComboDetails(params: AdvTradeGlobalGetComboDetailsRequest): Promise<WSAPIResponse<AdvTradeGlobalCombo>>;

public/get_combo_details

Parameters ​

ParameterType
paramsAdvTradeGlobalGetComboDetailsRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalCombo>>


getComboIds() ​

ts
getComboIds(params: AdvTradeGlobalGetComboIdsRequest): Promise<WSAPIResponse<string[]>>;

public/get_combo_ids

Parameters ​

ParameterType
paramsAdvTradeGlobalGetComboIdsRequest

Returns ​

Promise<WSAPIResponse<string[]>>


getCombos() ​

ts
getCombos(params: AdvTradeGlobalGetCombosRequest): Promise<WSAPIResponse<AdvTradeGlobalCombo[]>>;

public/get_combos

Parameters ​

ParameterType
paramsAdvTradeGlobalGetCombosRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalCombo[]>>


getContractSize() ​

ts
getContractSize(params: AdvTradeGlobalGetContractSizeRequest): Promise<WSAPIResponse<AdvTradeGlobalGetContractSizeResult>>;

public/get_contract_size

Parameters ​

ParameterType
paramsAdvTradeGlobalGetContractSizeRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetContractSizeResult>>


getCurrencies() ​

ts
getCurrencies(): Promise<WSAPIResponse<AdvTradeGlobalCurrencyWithApr[]>>;

public/get_currencies

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalCurrencyWithApr[]>>


getDeliveryPrices() ​

ts
getDeliveryPrices(params: AdvTradeGlobalGetDeliveryPricesRequest): Promise<WSAPIResponse<AdvTradeGlobalGetDeliveryPricesResult>>;

public/get_delivery_prices

Parameters ​

ParameterType
paramsAdvTradeGlobalGetDeliveryPricesRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetDeliveryPricesResult>>


getExpirations() ​

ts
getExpirations(params: AdvTradeGlobalGetExpirationsRequest): Promise<WSAPIResponse<AdvTradeGlobalExpirations[]>>;

public/get_expirations

Parameters ​

ParameterType
paramsAdvTradeGlobalGetExpirationsRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalExpirations[]>>


getFundingChartData() ​

ts
getFundingChartData(params: AdvTradeGlobalGetFundingChartDataRequest): Promise<WSAPIResponse<AdvTradeGlobalGetFundingChartDataResult>>;

public/get_funding_chart_data

Parameters ​

ParameterType
paramsAdvTradeGlobalGetFundingChartDataRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetFundingChartDataResult>>


getFundingRateHistory() ​

ts
getFundingRateHistory(params: AdvTradeGlobalGetFundingRateHistoryRequest): Promise<WSAPIResponse<AdvTradeGlobalGetFundingRateHistoryItem[]>>;

public/get_funding_rate_history

Parameters ​

ParameterType
paramsAdvTradeGlobalGetFundingRateHistoryRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetFundingRateHistoryItem[]>>


getFundingRateValue() ​

ts
getFundingRateValue(params: AdvTradeGlobalGetFundingRateValueRequest): Promise<WSAPIResponse<number>>;

public/get_funding_rate_value

Parameters ​

ParameterType
paramsAdvTradeGlobalGetFundingRateValueRequest

Returns ​

Promise<WSAPIResponse<number>>


getHistoricalVolatility() ​

ts
getHistoricalVolatility(params: AdvTradeGlobalGetHistoricalVolatilityRequest): Promise<WSAPIResponse<AdvTradeGlobalGetHistoricalVolatilityItem[]>>;

public/get_historical_volatility

Parameters ​

ParameterType
paramsAdvTradeGlobalGetHistoricalVolatilityRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetHistoricalVolatilityItem[]>>


getIndexChartData() ​

ts
getIndexChartData(params: AdvTradeGlobalGetIndexChartDataRequest): Promise<WSAPIResponse<number[][]>>;

public/get_index_chart_data

Parameters ​

ParameterType
paramsAdvTradeGlobalGetIndexChartDataRequest

Returns ​

Promise<WSAPIResponse<number[][]>>


getIndexPrice() ​

ts
getIndexPrice(params: AdvTradeGlobalGetIndexPriceRequest): Promise<WSAPIResponse<AdvTradeGlobalGetIndexPriceResult>>;

public/get_index_price

Parameters ​

ParameterType
paramsAdvTradeGlobalGetIndexPriceRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetIndexPriceResult>>


getIndexPriceNames() ​

ts
getIndexPriceNames(params?: AdvTradeGlobalGetIndexPriceNamesRequest): Promise<WSAPIResponse<AdvTradeGlobalGetIndexPriceNamesItem[]>>;

public/get_index_price_names

Parameters ​

ParameterType
params?AdvTradeGlobalGetIndexPriceNamesRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetIndexPriceNamesItem[]>>


getInstrument() ​

ts
getInstrument(params: AdvTradeGlobalGetInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalInstrument>>;

public/get_instrument

Parameters ​

ParameterType
paramsAdvTradeGlobalGetInstrumentRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalInstrument>>


getInstruments() ​

ts
getInstruments(params: AdvTradeGlobalGetInstrumentsRequest): Promise<WSAPIResponse<AdvTradeGlobalInstrument[]>>;

public/get_instruments

Parameters ​

ParameterType
paramsAdvTradeGlobalGetInstrumentsRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalInstrument[]>>


getLastSettlementsByCurrency() ​

ts
getLastSettlementsByCurrency(params: AdvTradeGlobalGetLastSettlementsByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalGetLastSettlementsByCurrencyResult>>;

public/get_last_settlements_by_currency

Parameters ​

ParameterType
paramsAdvTradeGlobalGetLastSettlementsByCurrencyRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetLastSettlementsByCurrencyResult>>


getLastSettlementsByInstrument() ​

ts
getLastSettlementsByInstrument(params: AdvTradeGlobalGetLastSettlementsByInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalGetLastSettlementsByInstrumentResult>>;

public/get_last_settlements_by_instrument

Parameters ​

ParameterType
paramsAdvTradeGlobalGetLastSettlementsByInstrumentRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetLastSettlementsByInstrumentResult>>


getLastTradesByCurrency() ​

ts
getLastTradesByCurrency(params: AdvTradeGlobalGetLastTradesByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByCurrencyResult>>;

public/get_last_trades_by_currency

Parameters ​

ParameterType
paramsAdvTradeGlobalGetLastTradesByCurrencyRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByCurrencyResult>>


getLastTradesByCurrencyAndTime() ​

ts
getLastTradesByCurrencyAndTime(params: AdvTradeGlobalGetLastTradesByCurrencyAndTimeRequest): Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByCurrencyAndTimeResult>>;

public/get_last_trades_by_currency_and_time

Parameters ​

ParameterType
paramsAdvTradeGlobalGetLastTradesByCurrencyAndTimeRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByCurrencyAndTimeResult>>


getLastTradesByInstrument() ​

ts
getLastTradesByInstrument(params: AdvTradeGlobalGetLastTradesByInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByInstrumentResult>>;

public/get_last_trades_by_instrument

Parameters ​

ParameterType
paramsAdvTradeGlobalGetLastTradesByInstrumentRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByInstrumentResult>>


getLastTradesByInstrumentAndTime() ​

ts
getLastTradesByInstrumentAndTime(params: AdvTradeGlobalGetLastTradesByInstrumentAndTimeRequest): Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByInstrumentAndTimeResult>>;

public/get_last_trades_by_instrument_and_time

Parameters ​

ParameterType
paramsAdvTradeGlobalGetLastTradesByInstrumentAndTimeRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByInstrumentAndTimeResult>>


getLegPrices() ​

ts
getLegPrices(params: AdvTradeGlobalGetLegPricesRequest): Promise<WSAPIResponse<AdvTradeGlobalGetLegPricesResult>>;

private/get_leg_prices

Parameters ​

ParameterType
paramsAdvTradeGlobalGetLegPricesRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetLegPricesResult>>


getLeverage() ​

ts
getLeverage(params?: AdvTradeGlobalWSGetLeverageRequest): Promise<WSAPIResponse<AdvTradeGlobalWSGetLeverageResult>>;

private/get_leverage

Parameters ​

ParameterType
params?AdvTradeGlobalWSGetLeverageRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalWSGetLeverageResult>>


getMargins() ​

ts
getMargins(params: AdvTradeGlobalGetMarginsRequest): Promise<WSAPIResponse<AdvTradeGlobalGetMarginsResult>>;

private/get_margins

Parameters ​

ParameterType
paramsAdvTradeGlobalGetMarginsRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetMarginsResult>>


getMarkPriceHistory() ​

ts
getMarkPriceHistory(params: AdvTradeGlobalGetMarkPriceHistoryRequest): Promise<WSAPIResponse<number[][]>>;

public/get_mark_price_history

Parameters ​

ParameterType
paramsAdvTradeGlobalGetMarkPriceHistoryRequest

Returns ​

Promise<WSAPIResponse<number[][]>>


getMaxOrderSize() ​

ts
getMaxOrderSize(params: AdvTradeGlobalWSGetMaxOrderSizeRequest): Promise<WSAPIResponse<AdvTradeGlobalWSGetMaxOrderSizeResult>>;

private/get_max_order_size

Parameters ​

ParameterType
paramsAdvTradeGlobalWSGetMaxOrderSizeRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalWSGetMaxOrderSizeResult>>


getOpenOrders() ​

ts
getOpenOrders(params?: AdvTradeGlobalGetOpenOrdersRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>;

private/get_open_orders

Parameters ​

ParameterType
params?AdvTradeGlobalGetOpenOrdersRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>


getOpenOrdersByCurrency() ​

ts
getOpenOrdersByCurrency(params: AdvTradeGlobalGetOpenOrdersByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>;

private/get_open_orders_by_currency

Parameters ​

ParameterType
paramsAdvTradeGlobalGetOpenOrdersByCurrencyRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>


getOpenOrdersByInstrument() ​

ts
getOpenOrdersByInstrument(params: AdvTradeGlobalGetOpenOrdersByInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>;

private/get_open_orders_by_instrument

Parameters ​

ParameterType
paramsAdvTradeGlobalGetOpenOrdersByInstrumentRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>


getOpenOrdersByLabel() ​

ts
getOpenOrdersByLabel(params: AdvTradeGlobalGetOpenOrdersByLabelRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>;

private/get_open_orders_by_label

Parameters ​

ParameterType
paramsAdvTradeGlobalGetOpenOrdersByLabelRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>


getOrderBook() ​

ts
getOrderBook(params: AdvTradeGlobalGetOrderBookRequest): Promise<WSAPIResponse<AdvTradeGlobalTickerNotificationWithBidsAndAsks>>;

public/get_order_book

Parameters ​

ParameterType
paramsAdvTradeGlobalGetOrderBookRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalTickerNotificationWithBidsAndAsks>>


getOrderBookByInstrumentId() ​

ts
getOrderBookByInstrumentId(params: AdvTradeGlobalGetOrderBookByInstrumentIdRequest): Promise<WSAPIResponse<AdvTradeGlobalTickerNotificationWithBidsAndAsks>>;

public/get_order_book_by_instrument_id

Parameters ​

ParameterType
paramsAdvTradeGlobalGetOrderBookByInstrumentIdRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalTickerNotificationWithBidsAndAsks>>


getOrderHistoryByCurrency() ​

ts
getOrderHistoryByCurrency(params: AdvTradeGlobalGetOrderHistoryByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>;

private/get_order_history_by_currency

Parameters ​

ParameterType
paramsAdvTradeGlobalGetOrderHistoryByCurrencyRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>


getOrderHistoryByInstrument() ​

ts
getOrderHistoryByInstrument(params: AdvTradeGlobalGetOrderHistoryByInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>;

private/get_order_history_by_instrument

Parameters ​

ParameterType
paramsAdvTradeGlobalGetOrderHistoryByInstrumentRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>


getOrderMarginByIds() ​

ts
getOrderMarginByIds(params: AdvTradeGlobalGetOrderMarginByIdsRequest): Promise<WSAPIResponse<AdvTradeGlobalOrderIdInitialMarginPair[]>>;

private/get_order_margin_by_ids

Parameters ​

ParameterType
paramsAdvTradeGlobalGetOrderMarginByIdsRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalOrderIdInitialMarginPair[]>>


getOrderState() ​

ts
getOrderState(params: AdvTradeGlobalGetOrderStateRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder>>;

private/get_order_state

Parameters ​

ParameterType
paramsAdvTradeGlobalGetOrderStateRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalOrder>>


getOrderStateByLabel() ​

ts
getOrderStateByLabel(params: AdvTradeGlobalGetOrderStateByLabelRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>;

private/get_order_state_by_label

Parameters ​

ParameterType
paramsAdvTradeGlobalGetOrderStateByLabelRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>


getPmeParams() ​

ts
getPmeParams(params: AdvTradeGlobalWSGetPmeParamsRequest): Promise<WSAPIResponse<AdvTradeGlobalWSGetPmeParamsResult>>;

private/get_pme_params

Parameters ​

ParameterType
paramsAdvTradeGlobalWSGetPmeParamsRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalWSGetPmeParamsResult>>


getPosition() ​

ts
getPosition(params: AdvTradeGlobalGetPositionRequest): Promise<WSAPIResponse<AdvTradeGlobalPositionWithOpenOrdersMargin>>;

private/get_position

Parameters ​

ParameterType
paramsAdvTradeGlobalGetPositionRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalPositionWithOpenOrdersMargin>>


getPositions() ​

ts
getPositions(params?: AdvTradeGlobalGetPositionsRequest): Promise<WSAPIResponse<AdvTradeGlobalPositionWithOpenOrdersMargin[]>>;

private/get_positions

Parameters ​

ParameterType
params?AdvTradeGlobalGetPositionsRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalPositionWithOpenOrdersMargin[]>>


getRiskProfile() ​

ts
getRiskProfile(): Promise<WSAPIResponse<AdvTradeGlobalWSGetRiskProfileResult>>;

private/get_risk_profile

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalWSGetRiskProfileResult>>


getSettlementHistoryByCurrency() ​

ts
getSettlementHistoryByCurrency(params: AdvTradeGlobalGetSettlementHistoryByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalGetSettlementHistoryByCurrencyResult>>;

private/get_settlement_history_by_currency

Parameters ​

ParameterType
paramsAdvTradeGlobalGetSettlementHistoryByCurrencyRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetSettlementHistoryByCurrencyResult>>


getSettlementHistoryByInstrument() ​

ts
getSettlementHistoryByInstrument(params: AdvTradeGlobalGetSettlementHistoryByInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalGetSettlementHistoryByInstrumentResult>>;

private/get_settlement_history_by_instrument

Parameters ​

ParameterType
paramsAdvTradeGlobalGetSettlementHistoryByInstrumentRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetSettlementHistoryByInstrumentResult>>


getStatus() ​

ts
getStatus(): Promise<WSAPIResponse<AdvTradeGlobalGetStatusResult>>;

public/status

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetStatusResult>>


getSubaccounts() ​

ts
getSubaccounts(params?: AdvTradeGlobalWSGetSubaccountsRequest): Promise<WSAPIResponse<AdvTradeGlobalWSGetSubaccountsResult>>;

private/get_subaccounts

Parameters ​

ParameterType
params?AdvTradeGlobalWSGetSubaccountsRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalWSGetSubaccountsResult>>


getSubaccountsDetails() ​

ts
getSubaccountsDetails(params: AdvTradeGlobalWSGetSubaccountsDetailsRequest): Promise<WSAPIResponse<AdvTradeGlobalWSGetSubaccountsDetailsResult>>;

private/get_subaccounts_details

Parameters ​

ParameterType
paramsAdvTradeGlobalWSGetSubaccountsDetailsRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalWSGetSubaccountsDetailsResult>>


getSupportedIndexNames() ​

ts
getSupportedIndexNames(params?: AdvTradeGlobalGetSupportedIndexNamesRequest): Promise<WSAPIResponse<AdvTradeGlobalGetSupportedIndexNamesItem[]>>;

public/get_supported_index_names

Parameters ​

ParameterType
params?AdvTradeGlobalGetSupportedIndexNamesRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetSupportedIndexNamesItem[]>>


getTicker() ​

ts
getTicker(params: AdvTradeGlobalGetTickerRequest): Promise<WSAPIResponse<AdvTradeGlobalTickerNotification>>;

public/ticker

Parameters ​

ParameterType
paramsAdvTradeGlobalGetTickerRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalTickerNotification>>


getTickersByCurrency() ​

ts
getTickersByCurrency(params: AdvTradeGlobalWSGetTickersByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalWSGetTickersByCurrencyResult>>;

public/tickers_by_currency

Parameters ​

ParameterType
paramsAdvTradeGlobalWSGetTickersByCurrencyRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalWSGetTickersByCurrencyResult>>


getTime() ​

ts
getTime(): Promise<WSAPIResponse<number>>;

public/get_time

Returns ​

Promise<WSAPIResponse<number>>

See ​

Advanced Trade Global WebSocket API


getTradeVolumes() ​

ts
getTradeVolumes(params?: AdvTradeGlobalGetTradeVolumesRequest): Promise<WSAPIResponse<AdvTradeGlobalTradesVolumes[]>>;

public/get_trade_volumes

Parameters ​

ParameterType
params?AdvTradeGlobalGetTradeVolumesRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalTradesVolumes[]>>


getTradingLimits() ​

ts
getTradingLimits(params: AdvTradeGlobalWSGetTradingLimitsRequest): Promise<WSAPIResponse<AdvTradeGlobalWSGetTradingLimitsResult>>;

private/get_trading_limits

Parameters ​

ParameterType
paramsAdvTradeGlobalWSGetTradingLimitsRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalWSGetTradingLimitsResult>>


getTradingviewChartData() ​

ts
getTradingviewChartData(params: AdvTradeGlobalGetTradingviewChartDataRequest): Promise<WSAPIResponse<AdvTradeGlobalGetTradingviewChartDataResult>>;

public/get_tradingview_chart_data

Parameters ​

ParameterType
paramsAdvTradeGlobalGetTradingviewChartDataRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetTradingviewChartDataResult>>


getTransactionLog() ​

ts
getTransactionLog(params: AdvTradeGlobalGetTransactionLogRequest): Promise<WSAPIResponse<AdvTradeGlobalGetTransactionLogResult>>;

private/get_transaction_log

Parameters ​

ParameterType
paramsAdvTradeGlobalGetTransactionLogRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetTransactionLogResult>>


getTriggerOrderHistory() ​

ts
getTriggerOrderHistory(params: AdvTradeGlobalGetTriggerOrderHistoryRequest): Promise<WSAPIResponse<AdvTradeGlobalGetTriggerOrderHistoryResult>>;

private/get_trigger_order_history

Parameters ​

ParameterType
paramsAdvTradeGlobalGetTriggerOrderHistoryRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetTriggerOrderHistoryResult>>


getUserLocks() ​

ts
getUserLocks(): Promise<WSAPIResponse<AdvTradeGlobalWSGetUserLocksResult>>;

private/get_user_locks

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalWSGetUserLocksResult>>


getUserTradesByCurrency() ​

ts
getUserTradesByCurrency(params: AdvTradeGlobalGetUserTradesByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByCurrencyResult>>;

private/get_user_trades_by_currency

Parameters ​

ParameterType
paramsAdvTradeGlobalGetUserTradesByCurrencyRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByCurrencyResult>>


getUserTradesByCurrencyAndTime() ​

ts
getUserTradesByCurrencyAndTime(params: AdvTradeGlobalGetUserTradesByCurrencyAndTimeRequest): Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByCurrencyAndTimeResult>>;

private/get_user_trades_by_currency_and_time

Parameters ​

ParameterType
paramsAdvTradeGlobalGetUserTradesByCurrencyAndTimeRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByCurrencyAndTimeResult>>


getUserTradesByInstrument() ​

ts
getUserTradesByInstrument(params: AdvTradeGlobalGetUserTradesByInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByInstrumentResult>>;

private/get_user_trades_by_instrument

Parameters ​

ParameterType
paramsAdvTradeGlobalGetUserTradesByInstrumentRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByInstrumentResult>>


getUserTradesByInstrumentAndTime() ​

ts
getUserTradesByInstrumentAndTime(params: AdvTradeGlobalGetUserTradesByInstrumentAndTimeRequest): Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByInstrumentAndTimeResult>>;

private/get_user_trades_by_instrument_and_time

Parameters ​

ParameterType
paramsAdvTradeGlobalGetUserTradesByInstrumentAndTimeRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByInstrumentAndTimeResult>>


getUserTradesByOrder() ​

ts
getUserTradesByOrder(params: AdvTradeGlobalGetUserTradesByOrderRequest): Promise<WSAPIResponse<AdvTradeGlobalUserTrade[]>>;

private/get_user_trades_by_order

Parameters ​

ParameterType
paramsAdvTradeGlobalGetUserTradesByOrderRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalUserTrade[]>>


getVolatilityIndexData() ​

ts
getVolatilityIndexData(params: AdvTradeGlobalGetVolatilityIndexDataRequest): Promise<WSAPIResponse<AdvTradeGlobalGetVolatilityIndexDataResult>>;

public/get_volatility_index_data

Parameters ​

ParameterType
paramsAdvTradeGlobalGetVolatilityIndexDataRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalGetVolatilityIndexDataResult>>


getWSClient() ​

ts
getWSClient(): WebsocketClient;

Returns ​

WebsocketClient


hello() ​

ts
hello(params: AdvTradeGlobalWSHelloRequest): Promise<WSAPIResponse<AdvTradeGlobalWSHelloResult>>;

public/hello

Parameters ​

ParameterType
paramsAdvTradeGlobalWSHelloRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalWSHelloResult>>


logout() ​

ts
logout(params?: AdvTradeGlobalWSLogoutRequest): Promise<void>;

private/logout. Resolves on the server close; prevents automatic reconnect.

Parameters ​

ParameterType
params?AdvTradeGlobalWSLogoutRequest

Returns ​

Promise<void>


setHeartbeat() ​

ts
setHeartbeat(params: AdvTradeGlobalWSSetHeartbeatRequest): Promise<WSAPIResponse<"ok">>;

public/set_heartbeat

Parameters ​

ParameterType
paramsAdvTradeGlobalWSSetHeartbeatRequest

Returns ​

Promise<WSAPIResponse<"ok">>


setLeverage() ​

ts
setLeverage(params: AdvTradeGlobalWSSetLeverageRequest): Promise<WSAPIResponse<AdvTradeGlobalWSSetLeverageResult>>;

private/set_leverage

Parameters ​

ParameterType
paramsAdvTradeGlobalWSSetLeverageRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalWSSetLeverageResult>>


simulatePme() ​

ts
simulatePme(params: AdvTradeGlobalSimulatePmeRequest): Promise<WSAPIResponse<object>>;

private/pme/simulate

Parameters ​

ParameterType
paramsAdvTradeGlobalSimulatePmeRequest

Returns ​

Promise<WSAPIResponse<object>>


simulatePortfolio() ​

ts
simulatePortfolio(params: AdvTradeGlobalSimulatePortfolioRequest): Promise<WSAPIResponse<AdvTradeGlobalSimulatePortfolioResult>>;

private/simulate_portfolio

Parameters ​

ParameterType
paramsAdvTradeGlobalSimulatePortfolioRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalSimulatePortfolioResult>>


submitBuy() ​

ts
submitBuy(params: AdvTradeGlobalPlaceOrderRequest): Promise<WSAPIResponse<AdvTradeGlobalBuyResult>>;

private/buy

Parameters ​

ParameterType
paramsAdvTradeGlobalPlaceOrderRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalBuyResult>>


submitSell() ​

ts
submitSell(params: AdvTradeGlobalPlaceOrderRequest): Promise<WSAPIResponse<AdvTradeGlobalSellResult>>;

private/sell

Parameters ​

ParameterType
paramsAdvTradeGlobalPlaceOrderRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalSellResult>>


submitTransferBetweenSubaccounts() ​

ts
submitTransferBetweenSubaccounts(params: AdvTradeGlobalWSSubmitTransferBetweenSubaccountsRequest): Promise<WSAPIResponse<AdvTradeGlobalWSSubmitTransferBetweenSubaccountsResult>>;

private/submit_transfer_between_subaccounts

Parameters ​

ParameterType
paramsAdvTradeGlobalWSSubmitTransferBetweenSubaccountsRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalWSSubmitTransferBetweenSubaccountsResult>>


testConnection() ​

ts
testConnection(params?: AdvTradeGlobalTestRequest): Promise<WSAPIResponse<AdvTradeGlobalTestResult>>;

public/test

Parameters ​

ParameterType
params?AdvTradeGlobalTestRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalTestResult>>


updateOrder() ​

ts
updateOrder(params: AdvTradeGlobalEditRequest): Promise<WSAPIResponse<AdvTradeGlobalEditResult>>;

private/edit

Parameters ​

ParameterType
paramsAdvTradeGlobalEditRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalEditResult>>


updateOrderByLabel() ​

ts
updateOrderByLabel(params: AdvTradeGlobalEditByLabelRequest): Promise<WSAPIResponse<AdvTradeGlobalEditByLabelResult>>;

private/edit_by_label

Parameters ​

ParameterType
paramsAdvTradeGlobalEditByLabelRequest

Returns ​

Promise<WSAPIResponse<AdvTradeGlobalEditByLabelResult>>

Built by Siebly. Open source SDKs for exchange APIs.