User Data Stream

Endpoint

Download schema

Listing all subscriptions

Note:

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

WSS

session.subscriptions

wss://ws-api.binance.com:443/ws-api/v3

Listing all subscriptions › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight2

Listing all subscriptions › Request Parameters optional

id

string · required

Client-generated request identifier.

Example: 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · required

WebSocket API method name.

Enum values:

session.subscriptions

Example: session.subscriptions

params

object

Listing all subscriptions › Responses

Successful Response

Listing all subscriptions

id

string

Example: d3df5a22-88ea-4fe0-9f4e-0fcea5d418b7

status

integer · int64

Example: 200

object[]

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.

WSS

userDataStream.subscribe

wss://ws-api.binance.com:443/ws-api/v3

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight2

id

string · required

Client-generated request identifier.

Example: 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · required

WebSocket API method name.

Enum values:

userDataStream.subscribe

Example: userDataStream.subscribe

params

object

Successful Response

Subscribe to User Data Stream

id

string

Example: d3df8a21-98ea-4fe0-8f4e-0fcea5d418b7

status

integer · int64

Example: 200

object

WSS

userDataStream.subscribe.signature

wss://ws-api.binance.com:443/ws-api/v3

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight2

id

string · required

Client-generated request identifier.

Example: 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · required

WebSocket API method name.

Enum values:

userDataStream.subscribe.signature

Example: userDataStream.subscribe.signature

object · required

Successful Response

Subscribe to User Data Stream through signature subscription

id

string

Example: d3df8a22-98ea-4fe0-9f4e-0fcea5d418b7

status

integer · int64

Example: 200

object

WebSocket Unsubscribe from User Data Stream

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.

WSS

userDataStream.unsubscribe

wss://ws-api.binance.com:443/ws-api/v3

WebSocket Unsubscribe from User Data Stream › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight2

WebSocket Unsubscribe from User Data Stream › Request Parameters optional

id

string · required

Client-generated request identifier.

Example: 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · required

WebSocket API method name.

Enum values:

userDataStream.unsubscribe

Example: userDataStream.unsubscribe

object

WebSocket Unsubscribe from User Data Stream › Responses

Successful Response

Unsubscribe from User Data Stream

id

string

Example: d3df8a21-98ea-4fe0-8f4e-0fcea5d418b7

status

integer · int64

Example: 200

result

object

Listing all subscriptions

Note:

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

WSS

session.subscriptions

wss://ws-api.binance.com:443/ws-api/v3

Listing all subscriptions › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight2

Listing all subscriptions › Request Parameters optional

id

string · required

Client-generated request identifier.

Example: 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · required

WebSocket API method name.

Enum values:

session.subscriptions

Example: session.subscriptions

params

object

Listing all subscriptions › Responses

Successful Response

Listing all subscriptions

id

string

Example: d3df5a22-88ea-4fe0-9f4e-0fcea5d418b7

status

integer · int64

Example: 200

object[]

Subscribe to User Data Stream

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.

WSS

userDataStream.subscribe

wss://ws-api.binance.com:443/ws-api/v3

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight2

id

string · required

Client-generated request identifier.

Example: 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · required

WebSocket API method name.

Enum values:

userDataStream.subscribe

Example: userDataStream.subscribe

params

object

Successful Response

Subscribe to User Data Stream

id

string

Example: d3df8a21-98ea-4fe0-8f4e-0fcea5d418b7

status

integer · int64

Example: 200

object

Subscribe to User Data Stream through signature subscription

WSS

userDataStream.subscribe.signature

wss://ws-api.binance.com:443/ws-api/v3

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight2

id

string · required

Client-generated request identifier.

Example: 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · required

WebSocket API method name.

Enum values:

userDataStream.subscribe.signature

Example: userDataStream.subscribe.signature

object · required

Successful Response

Subscribe to User Data Stream through signature subscription

id

string

Example: d3df8a22-98ea-4fe0-9f4e-0fcea5d418b7

status

integer · int64

Example: 200

object

WebSocket Unsubscribe from User Data Stream

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.

WSS

userDataStream.unsubscribe

wss://ws-api.binance.com:443/ws-api/v3

WebSocket Unsubscribe from User Data Stream › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight2

WebSocket Unsubscribe from User Data Stream › Request Parameters optional

id

string · required

Client-generated request identifier.

Example: 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · required

WebSocket API method name.

Enum values:

userDataStream.unsubscribe

Example: userDataStream.unsubscribe

object

WebSocket Unsubscribe from User Data Stream › Responses

Successful Response

Unsubscribe from User Data Stream

id

string

Example: d3df8a21-98ea-4fe0-8f4e-0fcea5d418b7

status

integer · int64

Example: 200

result

object

User Data Stream

Listing all subscriptions

Listing all subscriptions › Request Weight

Listing all subscriptions › Request Parameters optional

Listing all subscriptions › Responses

Subscribe to User Data Stream

Subscribe to User Data Stream › Request Weight

Subscribe to User Data Stream › Request Parameters optional

Subscribe to User Data Stream › Responses

Subscribe to User Data Stream through signature subscription

Subscribe to User Data Stream through signature subscription › Authorization

Subscribe to User Data Stream through signature subscription › Request Weight

Subscribe to User Data Stream through signature subscription › Request Parameters optional

Subscribe to User Data Stream through signature subscription › Responses

WebSocket Unsubscribe from User Data Stream

WebSocket Unsubscribe from User Data Stream › Request Weight

WebSocket Unsubscribe from User Data Stream › Request Parameters optional

WebSocket Unsubscribe from User Data Stream › Responses

User Data Stream

Listing all subscriptions

Listing all subscriptions › Request Weight

Listing all subscriptions › Request Parameters optional

Listing all subscriptions › Responses

Subscribe to User Data Stream

Subscribe to User Data Stream › Request Weight

Subscribe to User Data Stream › Request Parameters optional

Subscribe to User Data Stream › Responses

Subscribe to User Data Stream through signature subscription

Subscribe to User Data Stream through signature subscription › Authorization

Subscribe to User Data Stream through signature subscription › Request Weight

Subscribe to User Data Stream through signature subscription › Request Parameters optional

Subscribe to User Data Stream through signature subscription › Responses

WebSocket Unsubscribe from User Data Stream

WebSocket Unsubscribe from User Data Stream › Request Weight

WebSocket Unsubscribe from User Data Stream › Request Parameters optional

WebSocket Unsubscribe from User Data Stream › Responses