Class: WebsocketAPIClient
REST-style method wrapper around WebsocketClient.sendWSAPIRequest() for the Global Derivatives WebSocket API.
Constructors
Constructor
new WebsocketAPIClient(options?: WSClientConfigurableOptions & Partial<WSAPIClientConfigurableOptions>, logger?: object): WebsocketAPIClient;Parameters
| Parameter | Type |
|---|---|
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()
auth(): Promise<WSAPIResponse<AdvTradeGlobalWSAuthResult>>;public/auth. Generates a fresh CDP JWT automatically.
Returns
Promise<WSAPIResponse<AdvTradeGlobalWSAuthResult>>
cancelAll()
cancelAll(params?: AdvTradeGlobalCancelAllRequest): Promise<WSAPIResponse<number>>;private/cancel_all
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalCancelAllRequest |
Returns
Promise<WSAPIResponse<number>>
cancelAllByCurrency()
cancelAllByCurrency(params: AdvTradeGlobalCancelAllByCurrencyRequest): Promise<WSAPIResponse<number>>;private/cancel_all_by_currency
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalCancelAllByCurrencyRequest |
Returns
Promise<WSAPIResponse<number>>
cancelAllByCurrencyPair()
cancelAllByCurrencyPair(params: AdvTradeGlobalCancelAllByCurrencyPairRequest): Promise<WSAPIResponse<number>>;private/cancel_all_by_currency_pair
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalCancelAllByCurrencyPairRequest |
Returns
Promise<WSAPIResponse<number>>
cancelAllByInstrument()
cancelAllByInstrument(params: AdvTradeGlobalCancelAllByInstrumentRequest): Promise<WSAPIResponse<number>>;private/cancel_all_by_instrument
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalCancelAllByInstrumentRequest |
Returns
Promise<WSAPIResponse<number>>
cancelAllByKindOrType()
cancelAllByKindOrType(params: AdvTradeGlobalCancelAllByKindOrTypeRequest): Promise<WSAPIResponse<number>>;private/cancel_all_by_kind_or_type
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalCancelAllByKindOrTypeRequest |
Returns
Promise<WSAPIResponse<number>>
cancelByLabel()
cancelByLabel(params: AdvTradeGlobalCancelByLabelRequest): Promise<WSAPIResponse<number>>;private/cancel_by_label
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalCancelByLabelRequest |
Returns
Promise<WSAPIResponse<number>>
cancelOrder()
cancelOrder(params: AdvTradeGlobalCancelRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder>>;private/cancel
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalCancelRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalOrder>>
changeMarginModel()
changeMarginModel(params: AdvTradeGlobalChangeMarginModelRequest): Promise<WSAPIResponse<AdvTradeGlobalChangeMarginModelItem[]>>;private/change_margin_model
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalChangeMarginModelRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalChangeMarginModelItem[]>>
closePosition()
closePosition(params: AdvTradeGlobalClosePositionRequest): Promise<WSAPIResponse<AdvTradeGlobalClosePositionResult>>;private/close_position
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalClosePositionRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalClosePositionResult>>
connectWSAPI()
connectWSAPI(): Promise<unknown>;Optional warm-up before making private requests.
Returns
Promise<unknown>
createCombo()
createCombo(params: AdvTradeGlobalCreateComboRequest): Promise<WSAPIResponse<AdvTradeGlobalCombo>>;private/create_combo
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalCreateComboRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalCombo>>
disableCancelOnDisconnect()
disableCancelOnDisconnect(params?: AdvTradeGlobalDisableCancelOnDisconnectRequest): Promise<WSAPIResponse<"ok">>;private/disable_cancel_on_disconnect
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalDisableCancelOnDisconnectRequest |
Returns
Promise<WSAPIResponse<"ok">>
disableHeartbeat()
disableHeartbeat(): Promise<WSAPIResponse<"ok">>;public/disable_heartbeat
Returns
Promise<WSAPIResponse<"ok">>
enableCancelOnDisconnect()
enableCancelOnDisconnect(params?: AdvTradeGlobalEnableCancelOnDisconnectRequest): Promise<WSAPIResponse<"ok">>;private/enable_cancel_on_disconnect
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalEnableCancelOnDisconnectRequest |
Returns
Promise<WSAPIResponse<"ok">>
getAccessLog()
getAccessLog(params?: AdvTradeGlobalGetAccessLogRequest): Promise<WSAPIResponse<AdvTradeGlobalAccessLog[]>>;private/get_access_log
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalGetAccessLogRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalAccessLog[]>>
getAccountSummaries()
getAccountSummaries(params?: AdvTradeGlobalGetAccountSummariesRequest): Promise<WSAPIResponse<AdvTradeGlobalGetAccountSummariesResult>>;private/get_account_summaries
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalGetAccountSummariesRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetAccountSummariesResult>>
getAccountSummary()
getAccountSummary(params: AdvTradeGlobalGetAccountSummaryRequest): Promise<WSAPIResponse<AdvTradeGlobalGetAccountSummaryResult>>;private/get_account_summary
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetAccountSummaryRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetAccountSummaryResult>>
getAnnouncements()
getAnnouncements(params?: AdvTradeGlobalGetAnnouncementsRequest): Promise<WSAPIResponse<AdvTradeGlobalGetAnnouncementsItem[]>>;public/get_announcements
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalGetAnnouncementsRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetAnnouncementsItem[]>>
getBookSummaryByCurrency()
getBookSummaryByCurrency(params: AdvTradeGlobalGetBookSummaryByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalBookSummary[]>>;public/get_book_summary_by_currency
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetBookSummaryByCurrencyRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalBookSummary[]>>
getBookSummaryByInstrument()
getBookSummaryByInstrument(params: AdvTradeGlobalGetBookSummaryByInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalBookSummary[]>>;public/get_book_summary_by_instrument
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetBookSummaryByInstrumentRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalBookSummary[]>>
getCancelOnDisconnect()
getCancelOnDisconnect(params?: AdvTradeGlobalGetCancelOnDisconnectRequest): Promise<WSAPIResponse<AdvTradeGlobalGetCancelOnDisconnectResult>>;private/get_cancel_on_disconnect
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalGetCancelOnDisconnectRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetCancelOnDisconnectResult>>
getComboDetails()
getComboDetails(params: AdvTradeGlobalGetComboDetailsRequest): Promise<WSAPIResponse<AdvTradeGlobalCombo>>;public/get_combo_details
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetComboDetailsRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalCombo>>
getComboIds()
getComboIds(params: AdvTradeGlobalGetComboIdsRequest): Promise<WSAPIResponse<string[]>>;public/get_combo_ids
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetComboIdsRequest |
Returns
Promise<WSAPIResponse<string[]>>
getCombos()
getCombos(params: AdvTradeGlobalGetCombosRequest): Promise<WSAPIResponse<AdvTradeGlobalCombo[]>>;public/get_combos
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetCombosRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalCombo[]>>
getContractSize()
getContractSize(params: AdvTradeGlobalGetContractSizeRequest): Promise<WSAPIResponse<AdvTradeGlobalGetContractSizeResult>>;public/get_contract_size
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetContractSizeRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetContractSizeResult>>
getCurrencies()
getCurrencies(): Promise<WSAPIResponse<AdvTradeGlobalCurrencyWithApr[]>>;public/get_currencies
Returns
Promise<WSAPIResponse<AdvTradeGlobalCurrencyWithApr[]>>
getDeliveryPrices()
getDeliveryPrices(params: AdvTradeGlobalGetDeliveryPricesRequest): Promise<WSAPIResponse<AdvTradeGlobalGetDeliveryPricesResult>>;public/get_delivery_prices
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetDeliveryPricesRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetDeliveryPricesResult>>
getExpirations()
getExpirations(params: AdvTradeGlobalGetExpirationsRequest): Promise<WSAPIResponse<AdvTradeGlobalExpirations[]>>;public/get_expirations
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetExpirationsRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalExpirations[]>>
getFundingChartData()
getFundingChartData(params: AdvTradeGlobalGetFundingChartDataRequest): Promise<WSAPIResponse<AdvTradeGlobalGetFundingChartDataResult>>;public/get_funding_chart_data
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetFundingChartDataRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetFundingChartDataResult>>
getFundingRateHistory()
getFundingRateHistory(params: AdvTradeGlobalGetFundingRateHistoryRequest): Promise<WSAPIResponse<AdvTradeGlobalGetFundingRateHistoryItem[]>>;public/get_funding_rate_history
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetFundingRateHistoryRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetFundingRateHistoryItem[]>>
getFundingRateValue()
getFundingRateValue(params: AdvTradeGlobalGetFundingRateValueRequest): Promise<WSAPIResponse<number>>;public/get_funding_rate_value
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetFundingRateValueRequest |
Returns
Promise<WSAPIResponse<number>>
getHistoricalVolatility()
getHistoricalVolatility(params: AdvTradeGlobalGetHistoricalVolatilityRequest): Promise<WSAPIResponse<AdvTradeGlobalGetHistoricalVolatilityItem[]>>;public/get_historical_volatility
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetHistoricalVolatilityRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetHistoricalVolatilityItem[]>>
getIndexChartData()
getIndexChartData(params: AdvTradeGlobalGetIndexChartDataRequest): Promise<WSAPIResponse<number[][]>>;public/get_index_chart_data
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetIndexChartDataRequest |
Returns
Promise<WSAPIResponse<number[][]>>
getIndexPrice()
getIndexPrice(params: AdvTradeGlobalGetIndexPriceRequest): Promise<WSAPIResponse<AdvTradeGlobalGetIndexPriceResult>>;public/get_index_price
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetIndexPriceRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetIndexPriceResult>>
getIndexPriceNames()
getIndexPriceNames(params?: AdvTradeGlobalGetIndexPriceNamesRequest): Promise<WSAPIResponse<AdvTradeGlobalGetIndexPriceNamesItem[]>>;public/get_index_price_names
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalGetIndexPriceNamesRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetIndexPriceNamesItem[]>>
getInstrument()
getInstrument(params: AdvTradeGlobalGetInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalInstrument>>;public/get_instrument
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetInstrumentRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalInstrument>>
getInstruments()
getInstruments(params: AdvTradeGlobalGetInstrumentsRequest): Promise<WSAPIResponse<AdvTradeGlobalInstrument[]>>;public/get_instruments
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetInstrumentsRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalInstrument[]>>
getLastSettlementsByCurrency()
getLastSettlementsByCurrency(params: AdvTradeGlobalGetLastSettlementsByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalGetLastSettlementsByCurrencyResult>>;public/get_last_settlements_by_currency
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetLastSettlementsByCurrencyRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetLastSettlementsByCurrencyResult>>
getLastSettlementsByInstrument()
getLastSettlementsByInstrument(params: AdvTradeGlobalGetLastSettlementsByInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalGetLastSettlementsByInstrumentResult>>;public/get_last_settlements_by_instrument
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetLastSettlementsByInstrumentRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetLastSettlementsByInstrumentResult>>
getLastTradesByCurrency()
getLastTradesByCurrency(params: AdvTradeGlobalGetLastTradesByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByCurrencyResult>>;public/get_last_trades_by_currency
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetLastTradesByCurrencyRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByCurrencyResult>>
getLastTradesByCurrencyAndTime()
getLastTradesByCurrencyAndTime(params: AdvTradeGlobalGetLastTradesByCurrencyAndTimeRequest): Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByCurrencyAndTimeResult>>;public/get_last_trades_by_currency_and_time
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetLastTradesByCurrencyAndTimeRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByCurrencyAndTimeResult>>
getLastTradesByInstrument()
getLastTradesByInstrument(params: AdvTradeGlobalGetLastTradesByInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByInstrumentResult>>;public/get_last_trades_by_instrument
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetLastTradesByInstrumentRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByInstrumentResult>>
getLastTradesByInstrumentAndTime()
getLastTradesByInstrumentAndTime(params: AdvTradeGlobalGetLastTradesByInstrumentAndTimeRequest): Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByInstrumentAndTimeResult>>;public/get_last_trades_by_instrument_and_time
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetLastTradesByInstrumentAndTimeRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetLastTradesByInstrumentAndTimeResult>>
getLegPrices()
getLegPrices(params: AdvTradeGlobalGetLegPricesRequest): Promise<WSAPIResponse<AdvTradeGlobalGetLegPricesResult>>;private/get_leg_prices
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetLegPricesRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetLegPricesResult>>
getLeverage()
getLeverage(params?: AdvTradeGlobalWSGetLeverageRequest): Promise<WSAPIResponse<AdvTradeGlobalWSGetLeverageResult>>;private/get_leverage
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalWSGetLeverageRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalWSGetLeverageResult>>
getMargins()
getMargins(params: AdvTradeGlobalGetMarginsRequest): Promise<WSAPIResponse<AdvTradeGlobalGetMarginsResult>>;private/get_margins
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetMarginsRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetMarginsResult>>
getMarkPriceHistory()
getMarkPriceHistory(params: AdvTradeGlobalGetMarkPriceHistoryRequest): Promise<WSAPIResponse<number[][]>>;public/get_mark_price_history
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetMarkPriceHistoryRequest |
Returns
Promise<WSAPIResponse<number[][]>>
getMaxOrderSize()
getMaxOrderSize(params: AdvTradeGlobalWSGetMaxOrderSizeRequest): Promise<WSAPIResponse<AdvTradeGlobalWSGetMaxOrderSizeResult>>;private/get_max_order_size
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalWSGetMaxOrderSizeRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalWSGetMaxOrderSizeResult>>
getOpenOrders()
getOpenOrders(params?: AdvTradeGlobalGetOpenOrdersRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>;private/get_open_orders
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalGetOpenOrdersRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>
getOpenOrdersByCurrency()
getOpenOrdersByCurrency(params: AdvTradeGlobalGetOpenOrdersByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>;private/get_open_orders_by_currency
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetOpenOrdersByCurrencyRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>
getOpenOrdersByInstrument()
getOpenOrdersByInstrument(params: AdvTradeGlobalGetOpenOrdersByInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>;private/get_open_orders_by_instrument
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetOpenOrdersByInstrumentRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>
getOpenOrdersByLabel()
getOpenOrdersByLabel(params: AdvTradeGlobalGetOpenOrdersByLabelRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>;private/get_open_orders_by_label
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetOpenOrdersByLabelRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>
getOrderBook()
getOrderBook(params: AdvTradeGlobalGetOrderBookRequest): Promise<WSAPIResponse<AdvTradeGlobalTickerNotificationWithBidsAndAsks>>;public/get_order_book
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetOrderBookRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalTickerNotificationWithBidsAndAsks>>
getOrderBookByInstrumentId()
getOrderBookByInstrumentId(params: AdvTradeGlobalGetOrderBookByInstrumentIdRequest): Promise<WSAPIResponse<AdvTradeGlobalTickerNotificationWithBidsAndAsks>>;public/get_order_book_by_instrument_id
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetOrderBookByInstrumentIdRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalTickerNotificationWithBidsAndAsks>>
getOrderHistoryByCurrency()
getOrderHistoryByCurrency(params: AdvTradeGlobalGetOrderHistoryByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>;private/get_order_history_by_currency
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetOrderHistoryByCurrencyRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>
getOrderHistoryByInstrument()
getOrderHistoryByInstrument(params: AdvTradeGlobalGetOrderHistoryByInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>;private/get_order_history_by_instrument
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetOrderHistoryByInstrumentRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>
getOrderMarginByIds()
getOrderMarginByIds(params: AdvTradeGlobalGetOrderMarginByIdsRequest): Promise<WSAPIResponse<AdvTradeGlobalOrderIdInitialMarginPair[]>>;private/get_order_margin_by_ids
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetOrderMarginByIdsRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalOrderIdInitialMarginPair[]>>
getOrderState()
getOrderState(params: AdvTradeGlobalGetOrderStateRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder>>;private/get_order_state
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetOrderStateRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalOrder>>
getOrderStateByLabel()
getOrderStateByLabel(params: AdvTradeGlobalGetOrderStateByLabelRequest): Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>;private/get_order_state_by_label
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetOrderStateByLabelRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalOrder[]>>
getPmeParams()
getPmeParams(params: AdvTradeGlobalWSGetPmeParamsRequest): Promise<WSAPIResponse<AdvTradeGlobalWSGetPmeParamsResult>>;private/get_pme_params
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalWSGetPmeParamsRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalWSGetPmeParamsResult>>
getPosition()
getPosition(params: AdvTradeGlobalGetPositionRequest): Promise<WSAPIResponse<AdvTradeGlobalPositionWithOpenOrdersMargin>>;private/get_position
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetPositionRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalPositionWithOpenOrdersMargin>>
getPositions()
getPositions(params?: AdvTradeGlobalGetPositionsRequest): Promise<WSAPIResponse<AdvTradeGlobalPositionWithOpenOrdersMargin[]>>;private/get_positions
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalGetPositionsRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalPositionWithOpenOrdersMargin[]>>
getRiskProfile()
getRiskProfile(): Promise<WSAPIResponse<AdvTradeGlobalWSGetRiskProfileResult>>;private/get_risk_profile
Returns
Promise<WSAPIResponse<AdvTradeGlobalWSGetRiskProfileResult>>
getSettlementHistoryByCurrency()
getSettlementHistoryByCurrency(params: AdvTradeGlobalGetSettlementHistoryByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalGetSettlementHistoryByCurrencyResult>>;private/get_settlement_history_by_currency
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetSettlementHistoryByCurrencyRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetSettlementHistoryByCurrencyResult>>
getSettlementHistoryByInstrument()
getSettlementHistoryByInstrument(params: AdvTradeGlobalGetSettlementHistoryByInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalGetSettlementHistoryByInstrumentResult>>;private/get_settlement_history_by_instrument
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetSettlementHistoryByInstrumentRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetSettlementHistoryByInstrumentResult>>
getStatus()
getStatus(): Promise<WSAPIResponse<AdvTradeGlobalGetStatusResult>>;public/status
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetStatusResult>>
getSubaccounts()
getSubaccounts(params?: AdvTradeGlobalWSGetSubaccountsRequest): Promise<WSAPIResponse<AdvTradeGlobalWSGetSubaccountsResult>>;private/get_subaccounts
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalWSGetSubaccountsRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalWSGetSubaccountsResult>>
getSubaccountsDetails()
getSubaccountsDetails(params: AdvTradeGlobalWSGetSubaccountsDetailsRequest): Promise<WSAPIResponse<AdvTradeGlobalWSGetSubaccountsDetailsResult>>;private/get_subaccounts_details
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalWSGetSubaccountsDetailsRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalWSGetSubaccountsDetailsResult>>
getSupportedIndexNames()
getSupportedIndexNames(params?: AdvTradeGlobalGetSupportedIndexNamesRequest): Promise<WSAPIResponse<AdvTradeGlobalGetSupportedIndexNamesItem[]>>;public/get_supported_index_names
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalGetSupportedIndexNamesRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetSupportedIndexNamesItem[]>>
getTicker()
getTicker(params: AdvTradeGlobalGetTickerRequest): Promise<WSAPIResponse<AdvTradeGlobalTickerNotification>>;public/ticker
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetTickerRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalTickerNotification>>
getTickersByCurrency()
getTickersByCurrency(params: AdvTradeGlobalWSGetTickersByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalWSGetTickersByCurrencyResult>>;public/tickers_by_currency
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalWSGetTickersByCurrencyRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalWSGetTickersByCurrencyResult>>
getTime()
getTime(): Promise<WSAPIResponse<number>>;public/get_time
Returns
Promise<WSAPIResponse<number>>
See
Advanced Trade Global WebSocket API
getTradeVolumes()
getTradeVolumes(params?: AdvTradeGlobalGetTradeVolumesRequest): Promise<WSAPIResponse<AdvTradeGlobalTradesVolumes[]>>;public/get_trade_volumes
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalGetTradeVolumesRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalTradesVolumes[]>>
getTradingLimits()
getTradingLimits(params: AdvTradeGlobalWSGetTradingLimitsRequest): Promise<WSAPIResponse<AdvTradeGlobalWSGetTradingLimitsResult>>;private/get_trading_limits
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalWSGetTradingLimitsRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalWSGetTradingLimitsResult>>
getTradingviewChartData()
getTradingviewChartData(params: AdvTradeGlobalGetTradingviewChartDataRequest): Promise<WSAPIResponse<AdvTradeGlobalGetTradingviewChartDataResult>>;public/get_tradingview_chart_data
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetTradingviewChartDataRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetTradingviewChartDataResult>>
getTransactionLog()
getTransactionLog(params: AdvTradeGlobalGetTransactionLogRequest): Promise<WSAPIResponse<AdvTradeGlobalGetTransactionLogResult>>;private/get_transaction_log
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetTransactionLogRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetTransactionLogResult>>
getTriggerOrderHistory()
getTriggerOrderHistory(params: AdvTradeGlobalGetTriggerOrderHistoryRequest): Promise<WSAPIResponse<AdvTradeGlobalGetTriggerOrderHistoryResult>>;private/get_trigger_order_history
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetTriggerOrderHistoryRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetTriggerOrderHistoryResult>>
getUserLocks()
getUserLocks(): Promise<WSAPIResponse<AdvTradeGlobalWSGetUserLocksResult>>;private/get_user_locks
Returns
Promise<WSAPIResponse<AdvTradeGlobalWSGetUserLocksResult>>
getUserTradesByCurrency()
getUserTradesByCurrency(params: AdvTradeGlobalGetUserTradesByCurrencyRequest): Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByCurrencyResult>>;private/get_user_trades_by_currency
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetUserTradesByCurrencyRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByCurrencyResult>>
getUserTradesByCurrencyAndTime()
getUserTradesByCurrencyAndTime(params: AdvTradeGlobalGetUserTradesByCurrencyAndTimeRequest): Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByCurrencyAndTimeResult>>;private/get_user_trades_by_currency_and_time
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetUserTradesByCurrencyAndTimeRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByCurrencyAndTimeResult>>
getUserTradesByInstrument()
getUserTradesByInstrument(params: AdvTradeGlobalGetUserTradesByInstrumentRequest): Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByInstrumentResult>>;private/get_user_trades_by_instrument
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetUserTradesByInstrumentRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByInstrumentResult>>
getUserTradesByInstrumentAndTime()
getUserTradesByInstrumentAndTime(params: AdvTradeGlobalGetUserTradesByInstrumentAndTimeRequest): Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByInstrumentAndTimeResult>>;private/get_user_trades_by_instrument_and_time
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetUserTradesByInstrumentAndTimeRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetUserTradesByInstrumentAndTimeResult>>
getUserTradesByOrder()
getUserTradesByOrder(params: AdvTradeGlobalGetUserTradesByOrderRequest): Promise<WSAPIResponse<AdvTradeGlobalUserTrade[]>>;private/get_user_trades_by_order
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetUserTradesByOrderRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalUserTrade[]>>
getVolatilityIndexData()
getVolatilityIndexData(params: AdvTradeGlobalGetVolatilityIndexDataRequest): Promise<WSAPIResponse<AdvTradeGlobalGetVolatilityIndexDataResult>>;public/get_volatility_index_data
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalGetVolatilityIndexDataRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalGetVolatilityIndexDataResult>>
getWSClient()
getWSClient(): WebsocketClient;Returns
hello()
hello(params: AdvTradeGlobalWSHelloRequest): Promise<WSAPIResponse<AdvTradeGlobalWSHelloResult>>;public/hello
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalWSHelloRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalWSHelloResult>>
logout()
logout(params?: AdvTradeGlobalWSLogoutRequest): Promise<void>;private/logout. Resolves on the server close; prevents automatic reconnect.
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalWSLogoutRequest |
Returns
Promise<void>
setHeartbeat()
setHeartbeat(params: AdvTradeGlobalWSSetHeartbeatRequest): Promise<WSAPIResponse<"ok">>;public/set_heartbeat
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalWSSetHeartbeatRequest |
Returns
Promise<WSAPIResponse<"ok">>
setLeverage()
setLeverage(params: AdvTradeGlobalWSSetLeverageRequest): Promise<WSAPIResponse<AdvTradeGlobalWSSetLeverageResult>>;private/set_leverage
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalWSSetLeverageRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalWSSetLeverageResult>>
simulatePme()
simulatePme(params: AdvTradeGlobalSimulatePmeRequest): Promise<WSAPIResponse<object>>;private/pme/simulate
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalSimulatePmeRequest |
Returns
Promise<WSAPIResponse<object>>
simulatePortfolio()
simulatePortfolio(params: AdvTradeGlobalSimulatePortfolioRequest): Promise<WSAPIResponse<AdvTradeGlobalSimulatePortfolioResult>>;private/simulate_portfolio
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalSimulatePortfolioRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalSimulatePortfolioResult>>
submitBuy()
submitBuy(params: AdvTradeGlobalPlaceOrderRequest): Promise<WSAPIResponse<AdvTradeGlobalBuyResult>>;private/buy
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalPlaceOrderRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalBuyResult>>
submitSell()
submitSell(params: AdvTradeGlobalPlaceOrderRequest): Promise<WSAPIResponse<AdvTradeGlobalSellResult>>;private/sell
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalPlaceOrderRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalSellResult>>
submitTransferBetweenSubaccounts()
submitTransferBetweenSubaccounts(params: AdvTradeGlobalWSSubmitTransferBetweenSubaccountsRequest): Promise<WSAPIResponse<AdvTradeGlobalWSSubmitTransferBetweenSubaccountsResult>>;private/submit_transfer_between_subaccounts
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalWSSubmitTransferBetweenSubaccountsRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalWSSubmitTransferBetweenSubaccountsResult>>
testConnection()
testConnection(params?: AdvTradeGlobalTestRequest): Promise<WSAPIResponse<AdvTradeGlobalTestResult>>;public/test
Parameters
| Parameter | Type |
|---|---|
params? | AdvTradeGlobalTestRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalTestResult>>
updateOrder()
updateOrder(params: AdvTradeGlobalEditRequest): Promise<WSAPIResponse<AdvTradeGlobalEditResult>>;private/edit
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalEditRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalEditResult>>
updateOrderByLabel()
updateOrderByLabel(params: AdvTradeGlobalEditByLabelRequest): Promise<WSAPIResponse<AdvTradeGlobalEditByLabelResult>>;private/edit_by_label
Parameters
| Parameter | Type |
|---|---|
params | AdvTradeGlobalEditByLabelRequest |
Returns
Promise<WSAPIResponse<AdvTradeGlobalEditByLabelResult>>