V5 API WebSocket Subscription Parameters and Channel URL Updates Announcement

Dear Valued Users,

To enhance the stability of our V5 API WebSocket service, we're implementing adjustments to subscription parameters and select channel URLs.

Key Timeline Update

Originally scheduled for late May 2023, these changes will now take effect on June 20, 2023, 5:10 PM - 5:50 PM (UTC+8) to minimize disruption to your trading activities.

Part 1: Subscription Parameter Changes

Currently, the uly parameter processes subscriptions as instFamily. Post-update:

The uly parameter will return errors and cease instFamily processing
Action Required: Replace all instances of uly with instFamily before the update date

Part 2: Channel URL Migrations

Selected channels (see Table 1) will migrate to a new endpoint (/business). Legacy URLs (/private and /public) will become unsupported for these channels post-update. This affects both live and demo environments.

Migration Sequence:

Complete instFamily parameter updates
Transition to new /business URLs

Table 1: Affected Channels

Only these channels require endpoint updates:

Channel Category	Specific Channels
Block Trading	RFQs (`rfqs`), Quotes (`quotes`), Structured Block Trades (`struc-block-trades`)
	Public Block Trades (`public-struc-block-trades`, `public-block-trades`)
	Block Tickers (`block-tickers`)
Strategy Orders	Algo Orders (`orders-algo`), Advanced Algos (`algo-advance`)
Grid Strategies	Spot Grids (`grid-orders-spot`), Contract Grids (`grid-orders-contract`)
	Moon Grids (`grid-orders-moon`), Grid Positions (`grid-positions`)
	Grid Sub-Orders (`grid-sub-orders`), Recurring Buys (`algo-recurring-buy`)
Candlesticks	Regular (`candle`), Mark Price (`mark-price-candle`), Index (`index-candle`)

URL Reference Tables

Live Environment Updates

Environment	Legacy URLs	New Unified URL
Public	`wss://ws.okx.com:8443/ws/v5/public` `wss://wsaws.okx.com:8443/ws/v5/public`	`wss://ws.okx.com:8443/ws/v5/business` `wss://wsaws.okx.com:8443/ws/v5/business`
Private	`wss://ws.okx.com:8443/ws/v5/private` `wss://wsaws.okx.com:8443/ws/v5/private`

Demo Environment Updates

Environment	Legacy URLs	New Unified URL
Public	`wss://wspap.okx.com:8443/ws/v5/public?brokerId=9999`	`wss://wspap.okx.com:8443/ws/v5/business?brokerId=9999`
Private	`wss://wspap.okx.com:8443/ws/v5/private?brokerId=9999`

FAQs

Q: Will historical WebSocket connections break after the update?

A: Yes - all connections using legacy parameters/URLs for affected channels will require reconnection to the new endpoints.

Q: Is there a version deprecation schedule?

A: The V5 API remains fully supported. Only specific channel URLs and parameters are being optimized.

Q: How can I test these changes beforehand?

A: Utilize our 👉 demo environment to validate updates without live trading impact.

OKX Team
April 24, 2023