Skip to content

Class: WebsocketAPIClient ​

Promise-based wrapper around WebsocketClientV3 for UTA V3 trading requests. Use its methods to send a request and await the response, or use WebsocketClientV3.sendWSAPIRequest() directly.

Constructors ​

Constructor ​

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

Parameters ​

ParameterTypeDescription
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) => voidPing/pong events and other raw messages that might be noisy. Enable this while troubleshooting.

Returns ​

WebsocketAPIClient

Methods ​

batchUpdateOrders() ​

ts
batchUpdateOrders(category: BitgetInstTypeV3, params: ModifyOrderRequestV3[]): Promise<WSAPIResponse<ModifyOrderResponseV3[], "batch-modify">>;

Parameters ​

ParameterType
categoryBitgetInstTypeV3
paramsModifyOrderRequestV3[]

Returns ​

Promise<WSAPIResponse<ModifyOrderResponseV3[], "batch-modify">>


cancelBatchOrders() ​

ts
cancelBatchOrders(category: BitgetInstTypeV3, params: CancelOrderRequestV3[]): Promise<WSAPIResponse<CancelOrderResponseV3[], "batch-cancel">>;

Cancel a batch of orders using the batch-cancel WebSocket operation.

Parameters ​

ParameterType
categoryBitgetInstTypeV3
paramsCancelOrderRequestV3[]

Returns ​

Promise<WSAPIResponse<CancelOrderResponseV3[], "batch-cancel">>


cancelOrder() ​

ts
cancelOrder(category: BitgetInstTypeV3, params: CancelOrderRequestV3): Promise<WSAPIResponse<[CancelOrderResponseV3], "cancel-order">>;

Cancel an order. See Cancel Order Channel.

Parameters ​

ParameterType
categoryBitgetInstTypeV3
paramsCancelOrderRequestV3

Returns ​

Promise<WSAPIResponse<[CancelOrderResponseV3], "cancel-order">>


getWSClient() ​

ts
getWSClient(): WebsocketClientV3;

Returns ​

WebsocketClientV3


placeBatchOrders() ​

ts
placeBatchOrders(category: BitgetInstTypeV3, params: WSAPIPlaceOrderRequestV3[]): Promise<WSAPIResponse<WSAPIPlaceOrderResponseV3[], "batch-place">>;

Submit a batch of orders. See Batch Place Order Channel.

Parameters ​

ParameterType
categoryBitgetInstTypeV3
paramsWSAPIPlaceOrderRequestV3[]

Returns ​

Promise<WSAPIResponse<WSAPIPlaceOrderResponseV3[], "batch-place">>


setTimeOffsetMs() ​

ts
setTimeOffsetMs(newOffset: number): void;

Parameters ​

ParameterType
newOffsetnumber

Returns ​

void


submitNewOrder() ​

ts
submitNewOrder(category: BitgetInstTypeV3, params: WSAPIPlaceOrderRequestV3): Promise<WSAPIResponse<[WSAPIPlaceOrderResponseV3], "place-order">>;

Submit an order. See Place Order Channel.

Parameters ​

ParameterType
categoryBitgetInstTypeV3
paramsWSAPIPlaceOrderRequestV3

Returns ​

Promise<WSAPIResponse<[WSAPIPlaceOrderResponseV3], "place-order">>

See ​

WebSocket API requests


updateOrder() ​

ts
updateOrder(category: BitgetInstTypeV3, params: ModifyOrderRequestV3): Promise<WSAPIResponse<[ModifyOrderResponseV3], "modify-order">>;

Parameters ​

ParameterType
categoryBitgetInstTypeV3
paramsModifyOrderRequestV3

Returns ​

Promise<WSAPIResponse<[ModifyOrderResponseV3], "modify-order">>

Built by Siebly. Open source SDKs for exchange APIs.