Class UserDataStreamApi

Note:

Users should track the corresponding subscription status of related accounts as needed.

Weight(IP): 2

Security Type: NONE

Notes: Data Source:* Memory

Subscribe to the User Data Stream in the current WebSocket connection.

Notes:*

• This method requires an authenticated WebSocket connection using Ed25519 keys. Please refer to session.logon.
• To check the subscription status, use session.status, see the userDataStream flag indicating you have have an active subscription.
• User Data Stream events are available in both JSON and SBE sessions.
• Please refer to User Data Streams for the event format details.
• For SBE, only SBE schema 2:1 or later is supported.

Weight(IP): 2

Security Type: NONE

Weight(IP): 2

Security Type: USER_STREAM

Notes: Data Source:* Memory

Stop listening to the User Data Stream in the current WebSocket connection.

Note that session.logout will only close the subscription created with userDataStream.subscribe but not subscriptions opened with userDataStream.subscribe.signature.

Weight(IP): 2