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
new WebsocketAPIClient(options?: WSClientConfigurableOptions & Partial<WSAPIClientConfigurableOptions>, logger?: object): WebsocketAPIClient;Parameters
| Parameter | Type | Description |
|---|---|---|
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 | Ping/pong events and other raw messages that might be noisy. Enable this while troubleshooting. |
Returns
WebsocketAPIClient
Methods
batchUpdateOrders()
batchUpdateOrders(category: BitgetInstTypeV3, params: ModifyOrderRequestV3[]): Promise<WSAPIResponse<ModifyOrderResponseV3[], "batch-modify">>;Parameters
| Parameter | Type |
|---|---|
category | BitgetInstTypeV3 |
params | ModifyOrderRequestV3[] |
Returns
Promise<WSAPIResponse<ModifyOrderResponseV3[], "batch-modify">>
cancelBatchOrders()
cancelBatchOrders(category: BitgetInstTypeV3, params: CancelOrderRequestV3[]): Promise<WSAPIResponse<CancelOrderResponseV3[], "batch-cancel">>;Cancel a batch of orders using the batch-cancel WebSocket operation.
Parameters
| Parameter | Type |
|---|---|
category | BitgetInstTypeV3 |
params | CancelOrderRequestV3[] |
Returns
Promise<WSAPIResponse<CancelOrderResponseV3[], "batch-cancel">>
cancelOrder()
cancelOrder(category: BitgetInstTypeV3, params: CancelOrderRequestV3): Promise<WSAPIResponse<[CancelOrderResponseV3], "cancel-order">>;Cancel an order. See Cancel Order Channel.
Parameters
| Parameter | Type |
|---|---|
category | BitgetInstTypeV3 |
params | CancelOrderRequestV3 |
Returns
Promise<WSAPIResponse<[CancelOrderResponseV3], "cancel-order">>
getWSClient()
getWSClient(): WebsocketClientV3;Returns
placeBatchOrders()
placeBatchOrders(category: BitgetInstTypeV3, params: WSAPIPlaceOrderRequestV3[]): Promise<WSAPIResponse<WSAPIPlaceOrderResponseV3[], "batch-place">>;Submit a batch of orders. See Batch Place Order Channel.
Parameters
| Parameter | Type |
|---|---|
category | BitgetInstTypeV3 |
params | WSAPIPlaceOrderRequestV3[] |
Returns
Promise<WSAPIResponse<WSAPIPlaceOrderResponseV3[], "batch-place">>
setTimeOffsetMs()
setTimeOffsetMs(newOffset: number): void;Parameters
| Parameter | Type |
|---|---|
newOffset | number |
Returns
void
submitNewOrder()
submitNewOrder(category: BitgetInstTypeV3, params: WSAPIPlaceOrderRequestV3): Promise<WSAPIResponse<[WSAPIPlaceOrderResponseV3], "place-order">>;Submit an order. See Place Order Channel.
Parameters
| Parameter | Type |
|---|---|
category | BitgetInstTypeV3 |
params | WSAPIPlaceOrderRequestV3 |
Returns
Promise<WSAPIResponse<[WSAPIPlaceOrderResponseV3], "place-order">>
See
updateOrder()
updateOrder(category: BitgetInstTypeV3, params: ModifyOrderRequestV3): Promise<WSAPIResponse<[ModifyOrderResponseV3], "modify-order">>;Parameters
| Parameter | Type |
|---|---|
category | BitgetInstTypeV3 |
params | ModifyOrderRequestV3 |
Returns
Promise<WSAPIResponse<[ModifyOrderResponseV3], "modify-order">>