Skip to content

Class: WebsocketAPIClient ​

Promise-based Spot and perpetual-futures WebSocket API requests. Connections and authentication are established as needed. Select TestNet with useTestnet: true in constructor options, keeping the normal connection key. Results are in response.data.result.

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 ​

cancelFuturesAllOpenOrders() ​

ts
cancelFuturesAllOpenOrders(params: WSAPIFuturesOrderCancelCPReq, wsKey?: keyof WsAPIWsKeyTopicMap): Promise<WSAPIResponse<WSAPIFuturesOrder[], WSAPITopic>>;

Cancel all open futures orders

Note: without a wsKey, this defaults to the perpFuturesUSDTV4 connection

Parameters ​

ParameterType
paramsWSAPIFuturesOrderCancelCPReq
wsKey?keyof WsAPIWsKeyTopicMap

Returns ​

Promise<WSAPIResponse<WSAPIFuturesOrder[], WSAPITopic>>


cancelFuturesOrder() ​

ts
cancelFuturesOrder(params: WSAPIFuturesOrderCancelReq, wsKey?: keyof WsAPIWsKeyTopicMap): Promise<WSAPIResponse<WSAPIFuturesOrder, WSAPITopic>>;

Cancel a futures order

Note: without a wsKey, this defaults to the perpFuturesUSDTV4 connection

Parameters ​

ParameterType
paramsWSAPIFuturesOrderCancelReq
wsKey?keyof WsAPIWsKeyTopicMap

Returns ​

Promise<WSAPIResponse<WSAPIFuturesOrder, WSAPITopic>>


cancelFuturesOrderById() ​

ts
cancelFuturesOrderById(params: string[], wsKey?: keyof WsAPIWsKeyTopicMap): Promise<WSAPIResponse<WSAPIFuturesOrderCancelIdsRespItem[], WSAPITopic>>;

Cancel futures orders by id list

Note: without a wsKey, this defaults to the perpFuturesUSDTV4 connection

Parameters ​

ParameterType
paramsstring[]
wsKey?keyof WsAPIWsKeyTopicMap

Returns ​

Promise<WSAPIResponse<WSAPIFuturesOrderCancelIdsRespItem[], WSAPITopic>>


cancelSpotOrder() ​

ts
cancelSpotOrder(params: WSAPISpotOrderCancelReq, wsKey?: keyof WsAPIWsKeyTopicMap): Promise<WSAPIResponse<WSAPISpotOrder, WSAPITopic>>;

Cancel a spot order

Parameters ​

ParameterType
paramsWSAPISpotOrderCancelReq
wsKey?keyof WsAPIWsKeyTopicMap

Returns ​

Promise<WSAPIResponse<WSAPISpotOrder, WSAPITopic>>


cancelSpotOrderById() ​

ts
cancelSpotOrderById(params: WSAPISpotOrderCancelIdsReq[], wsKey?: keyof WsAPIWsKeyTopicMap): Promise<WSAPIResponse<WSAPISpotOrderCancelIdsRespItem[], WSAPITopic>>;

Cancel all spot orders with the given id list

Parameters ​

ParameterType
paramsWSAPISpotOrderCancelIdsReq[]
wsKey?keyof WsAPIWsKeyTopicMap

Returns ​

Promise<WSAPIResponse<WSAPISpotOrderCancelIdsRespItem[], WSAPITopic>>


cancelSpotOrderForSymbol() ​

ts
cancelSpotOrderForSymbol(params: WSAPISpotOrderCancelCPReq, wsKey?: keyof WsAPIWsKeyTopicMap): Promise<WSAPIResponse<WSAPISpotOrder[], WSAPITopic>>;

Cancel a spot order for a given symbol

Parameters ​

ParameterType
paramsWSAPISpotOrderCancelCPReq
wsKey?keyof WsAPIWsKeyTopicMap

Returns ​

Promise<WSAPIResponse<WSAPISpotOrder[], WSAPITopic>>


getFuturesOrders() ​

ts
getFuturesOrders(params: WSAPIFuturesOrderListReq, wsKey?: keyof WsAPIWsKeyTopicMap): Promise<WSAPIResponse<WSAPIFuturesOrder[], WSAPITopic>>;

Get all futures orders

Note: without a wsKey, this defaults to the perpFuturesUSDTV4 connection

Parameters ​

ParameterType
paramsWSAPIFuturesOrderListReq
wsKey?keyof WsAPIWsKeyTopicMap

Returns ​

Promise<WSAPIResponse<WSAPIFuturesOrder[], WSAPITopic>>


getFuturesOrderStatus() ​

ts
getFuturesOrderStatus(params: WSAPIFuturesOrderStatusReq, wsKey?: keyof WsAPIWsKeyTopicMap): Promise<WSAPIResponse<WSAPIFuturesOrder, WSAPITopic>>;

Get futures order status

Note: without a wsKey, this defaults to the perpFuturesUSDTV4 connection

Parameters ​

ParameterType
paramsWSAPIFuturesOrderStatusReq
wsKey?keyof WsAPIWsKeyTopicMap

Returns ​

Promise<WSAPIResponse<WSAPIFuturesOrder, WSAPITopic>>


getSpotOrders() ​

ts
getSpotOrders(params: WSAPISpotOrderListReq, wsKey?: keyof WsAPIWsKeyTopicMap): Promise<WSAPIResponse<WSAPISpotOrder[], WSAPITopic>>;

Get all spot orders

Parameters ​

ParameterType
paramsWSAPISpotOrderListReq
wsKey?keyof WsAPIWsKeyTopicMap

Returns ​

Promise<WSAPIResponse<WSAPISpotOrder[], WSAPITopic>>


getSpotOrderStatus() ​

ts
getSpotOrderStatus(params: WSAPISpotOrderStatusReq, wsKey?: keyof WsAPIWsKeyTopicMap): Promise<WSAPIResponse<WSAPISpotOrder, WSAPITopic>>;

Get the status of a spot order

Parameters ​

ParameterType
paramsWSAPISpotOrderStatusReq
wsKey?keyof WsAPIWsKeyTopicMap

Returns ​

Promise<WSAPIResponse<WSAPISpotOrder, WSAPITopic>>

Example ​

ts
import { WebsocketAPIClient } from 'gateio-api';
import { clientOptions, requiredEnv } from './authenticated-client.js';

async function main() {
  const api = new WebsocketAPIClient({
    ...clientOptions,
    attachEventListeners: false,
  });
  api.getWSClient().on('exception', () => {
    console.error('WebSocket API request or connection failed.');
  });
  try {
    const response = await api.getSpotOrderStatus({
      currency_pair: 'BTC_USDT',
      order_id: requiredEnv('GATEIO_ORDER_ID'),
      account: 'spot',
    });
    console.log('Order state:', response.data.result);
  } finally {
    api.getWSClient().closeAll();
  }
}

main().catch(() => {
  console.error(
    'Unable to read the order. Check its ID, credentials and environment.',
  );
  process.exitCode = 1;
});

See ​

Read an order over WebSockets


getWSClient() ​

ts
getWSClient(): WebsocketClient;

Returns ​

WebsocketClient


setTimeOffsetMs() ​

ts
setTimeOffsetMs(newOffset: number): void;

Parameters ​

ParameterType
newOffsetnumber

Returns ​

void


submitNewFuturesBatchOrder() ​

ts
submitNewFuturesBatchOrder(params: WSAPIFuturesOrderPlaceReq[], wsKey?: keyof WsAPIWsKeyTopicMap): Promise<WSAPIResponse<WSAPIFuturesOrderBatchPlaceRespItem[], WSAPITopic>>;

Submit a batch of futures orders

Note: without a wsKey, this defaults to the perpFuturesUSDTV4 connection

Parameters ​

ParameterType
paramsWSAPIFuturesOrderPlaceReq[]
wsKey?keyof WsAPIWsKeyTopicMap

Returns ​

Promise<WSAPIResponse<WSAPIFuturesOrderBatchPlaceRespItem[], WSAPITopic>>


submitNewFuturesOrder() ​

ts
submitNewFuturesOrder(params: WSAPIFuturesOrderPlaceReq, wsKey?: keyof WsAPIWsKeyTopicMap): Promise<WSAPIResponse<WSAPIFuturesOrder, WSAPITopic>>;

Submit a futures order.

Note: without a wsKey, this defaults to the perpFuturesUSDTV4 connection

Parameters ​

ParameterType
paramsWSAPIFuturesOrderPlaceReq
wsKey?keyof WsAPIWsKeyTopicMap

Returns ​

Promise<WSAPIResponse<WSAPIFuturesOrder, WSAPITopic>>


submitNewSpotOrder() ​

ts
submitNewSpotOrder(params: WSAPISpotOrderPlaceReq, wsKey?: keyof WsAPIWsKeyTopicMap): Promise<WSAPIResponse<WSAPISpotOrder, WSAPITopic>>;

Submit a spot order

Parameters ​

ParameterType
paramsWSAPISpotOrderPlaceReq
wsKey?keyof WsAPIWsKeyTopicMap

Returns ​

Promise<WSAPIResponse<WSAPISpotOrder, WSAPITopic>>


updateFuturesOrder() ​

ts
updateFuturesOrder(params: WSAPIFuturesOrderAmendReq, wsKey?: keyof WsAPIWsKeyTopicMap): Promise<WSAPIResponse<WSAPIFuturesOrder, WSAPITopic>>;

Update a futures order

Note: without a wsKey, this defaults to the perpFuturesUSDTV4 connection

Parameters ​

ParameterType
paramsWSAPIFuturesOrderAmendReq
wsKey?keyof WsAPIWsKeyTopicMap

Returns ​

Promise<WSAPIResponse<WSAPIFuturesOrder, WSAPITopic>>


updateSpotOrder() ​

ts
updateSpotOrder(params: WSAPISpotOrderAmendReq, wsKey?: keyof WsAPIWsKeyTopicMap): Promise<WSAPIResponse<WSAPISpotOrder, WSAPITopic>>;

Update a spot order

Parameters ​

ParameterType
paramsWSAPISpotOrderAmendReq
wsKey?keyof WsAPIWsKeyTopicMap

Returns ​

Promise<WSAPIResponse<WSAPISpotOrder, WSAPITopic>>

Built by Siebly. Open source SDKs for exchange APIs.