Changes to V5 API WebSocket subscription parameter and URL

Dear OKX users,

To ensure the stability of V5 API WebSocket, V5 API WebSocket will adjust subscription parameter and the service address of certain channels.
Meanwhile, in order to secure our users' interests and minimize impact on trading functions, the adjustment originally scheduled for the end of May 2023 has been postponed. The updated schedule is from 9:10 am to 9:50 am UTC on June 20, 2023.

1. Adjustment to V5 API WebSocket subscription parameter

Currently the websocket subscription parameter uly is mapped to the parameter instFamily. After the adjustment, the subscription parameter uly will return error and no longer be processed. In API requests, please stop using the subscription parameter "uly" and use the subscription parameter "instFamily" instead.

2. V5 API WebSocket adjusts the service address of some channels.

The WebSocket channels below (see Table 1 for details) are now available from "/business" URL. The current URL ("/private" or "/public") will no longer service the WebSocket channels listed below from 20 June 2023. The changes apply to both demo and live trading. Please change the URL as soon as possible.

Please complete the "instFamily" change listed above first, then switch to the new "/business" URL.

Table 1: The channels affected

Only the channels listed below are required to switch to the new "/business" URL.

Table 2: Production service address details

Only the channels listed on Table 1 are required to switch to the new "/business" URL.

Table 3: Demo trading service address details

Only the channels listed on Table 1 are required to switch to the new "/business" URL.

OKX
April 24, 2023