Replacement user data streams, listenKey vs WebSocket API

[alisonsilvabt]

Hi everyone, Binance recently disabled userDataStream, so what should we use to replace it? To receive balance updates, orders, etc.

https://developers.binance.com/docs/binance-spot-api-docs#2026-01-21

[tiagosiebler]

Hi @alisonsilvabt - the WS API supports the user data stream without the listenKey mechanic. I've also recently ensured that HMAC and RSA keys are both supported with the WS API, so it should be a smooth transition for anyone dependent on it.

Examples and docs:

• Example: https://siebly.io/examples/Binance/WebSockets/Private(userdata)/ws-userdata-wsapi.ts#L160-L163
• Github: https://github.com/tiagosiebler/binance/blob/master/examples/WebSockets/Private(userdata)/ws-userdata-wsapi.ts#L162-L164
• How it works: https://github.com/tiagosiebler/binance/blob/master/src/websocket-api-client.ts#L1259-L1295

Under the hood, this mechanic in the WS API will automatically call userDataStream.subscribe:
https://developers.binance.com/docs/binance-spot-api-docs/websocket-api/user-data-stream-requests#user-data-stream-subscribe

Everything else should behave as it did before. If you have any issues let us know!

[tiagosiebler]

A convenient integration for the margin user data websocket api workflow will be available shortly, via #645.

[tiagosiebler]

Solution for those looking to use the margin user data stream has been released with v3.4.0, available on npm. Release notes: https://github.com/tiagosiebler/binance/releases/tag/v3.4.0

Example:
https://github.com/tiagosiebler/binance/blob/master/examples/WebSockets/Private(userdata)/ws-userdata-wsapi-margin.ts#L183-L186

[tiagosiebler]

For those wondering about futures/derivatives, Binance have confirmed there are no plans to retire the listenKey subscription for Futures products.

Furthermore, while the futures WebSocket API does have functionality around start/ping/stop for the user data stream, this is only intended for managing the active listen key. It is still required to open a dedicated connection with that listen key, after creating it. I've wired up the WebsocketAPIClient to automatically fallback to the original mechanic found in the WebsocketClient after subscribing to the user data stream for futures. For the curious, here is how the futures portion of this works:
https://github.com/tiagosiebler/binance/blob/master/src/websocket-api-client.ts#L1348-L1382

So if you're working with futures - you can but you also don't need to use WebsocketAPIClient.subscribeUserDataStream(), you can just use WebsocketClient.subscribeUsdFuturesUserDataStream() directly. If you do use the WebsocketAPIClient method for futures, it will automatically use the WebsocketClient method under the hood (and log an info message). I've tried to make this pretty seamless either way.

[tiagosiebler]

For anyone reading this, since this is a common enough question, I've published an article there that goes into this in more detail:
https://siebly.io/blog/binance-user-data-stream-410-gone-listenkey-javascript

Will keep this open for visibility.