User Data Streams

Endpoint

Download schema

Close User Data Stream (USER_STREAM)

Close out a user data stream.

WSS

userDataStream.stop

wss://ws-fapi.binance.com/ws-fapi/v1

Close User Data Stream (USER_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 Weight1

Close User Data Stream (USER_STREAM) › Request Parameters

id

string · required

Id.

Example: e9d6b4349871b40611412680b3445fac

method

string · enum · required

WebSocket API method name.

Enum values:

userDataStream.stop

Example: userDataStream.stop

object · required

apiKey

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Close User Data Stream (USER_STREAM) › Responses

Successful Response

Close User Data Stream

id

string

Example: 819e1b1b-8c06-485b-a13e-131326c69599

status

integer · int64

Example: 200

result

object

object[]

rateLimitType

string

Example: REQUEST_WEIGHT

interval

string

Example: MINUTE

intervalNum

integer · int64

Example: 1

limit

integer · int64

Example: 2400

count

integer · int64

Example: 2

Keepalive User Data Stream (USER_STREAM)

Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 60 minutes.

WSS

userDataStream.ping

wss://ws-fapi.binance.com/ws-fapi/v1

Keepalive User Data Stream (USER_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 Weight1

Keepalive User Data Stream (USER_STREAM) › Request Parameters

id

string · required

Id.

Example: e9d6b4349871b40611412680b3445fac

method

string · enum · required

WebSocket API method name.

Enum values:

userDataStream.ping

Example: userDataStream.ping

object · required

apiKey

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Keepalive User Data Stream (USER_STREAM) › Responses

Successful Response

Keepalive User Data Stream

id

string

Example: 815d5fce-0880-4287-a567-80badf004c74

status

integer · int64

Example: 200

object

listenKey

string

Example: 3HBntNTepshgEdjIwSUIBgB9keLyOCg5qv3n6bYAtktG8ejcaW5HXz9Vx1JgIieg

object[]

rateLimitType

string

Example: REQUEST_WEIGHT

interval

string

Example: MINUTE

intervalNum

integer · int64

Example: 1

limit

integer · int64

Example: 2400

count

integer · int64

Example: 2

Start User Data Stream (USER_STREAM)

Start a new user data stream. The stream will close after 60 minutes unless a keepalive is sent. If the account has an active listenKey, that listenKey will be returned and its validity will be extended for 60 minutes.

WSS

userDataStream.start

wss://ws-fapi.binance.com/ws-fapi/v1

Start User Data Stream (USER_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 Weight1

Start User Data Stream (USER_STREAM) › Request Parameters

id

string · required

Id.

Example: e9d6b4349871b40611412680b3445fac

method

string · enum · required

WebSocket API method name.

Enum values:

userDataStream.start

Example: userDataStream.start

object · required

apiKey

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Start User Data Stream (USER_STREAM) › Responses

Successful Response

Start User Data Stream

id

string

Example: d3df8a61-98ea-4fe0-8f4e-0fcea5d418b0

status

integer · int64

Example: 200

object

listenKey

string

Example: xs0mRXdAKlIPDRFrlPcw0qI41Eh3ixNntmymGyhrhgqo7L6FuLaWArTD7RLP

object[]

rateLimitType

string

Example: REQUEST_WEIGHT

interval

string

Example: MINUTE

intervalNum

integer · int64

Example: 1

limit

integer · int64

Example: 2400

count

integer · int64

Example: 2

Close User Data Stream (USER_STREAM)

Close out a user data stream.

WSS

userDataStream.stop

wss://ws-fapi.binance.com/ws-fapi/v1

Close User Data Stream (USER_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 Weight1

Close User Data Stream (USER_STREAM) › Request Parameters

id

string · required

Id.

Example: e9d6b4349871b40611412680b3445fac

method

string · enum · required

WebSocket API method name.

Enum values:

userDataStream.stop

Example: userDataStream.stop

object · required

apiKey

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Close User Data Stream (USER_STREAM) › Responses

Successful Response

Close User Data Stream

id

string

Example: 819e1b1b-8c06-485b-a13e-131326c69599

status

integer · int64

Example: 200

result

object

object[]

rateLimitType

string

Example: REQUEST_WEIGHT

interval

string

Example: MINUTE

intervalNum

integer · int64

Example: 1

limit

integer · int64

Example: 2400

count

integer · int64

Example: 2

Keepalive User Data Stream (USER_STREAM)

Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 60 minutes.

WSS

userDataStream.ping

wss://ws-fapi.binance.com/ws-fapi/v1

Keepalive User Data Stream (USER_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 Weight1

Keepalive User Data Stream (USER_STREAM) › Request Parameters

id

string · required

Id.

Example: e9d6b4349871b40611412680b3445fac

method

string · enum · required

WebSocket API method name.

Enum values:

userDataStream.ping

Example: userDataStream.ping

object · required

apiKey

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Keepalive User Data Stream (USER_STREAM) › Responses

Successful Response

Keepalive User Data Stream

id

string

Example: 815d5fce-0880-4287-a567-80badf004c74

status

integer · int64

Example: 200

object

listenKey

string

Example: 3HBntNTepshgEdjIwSUIBgB9keLyOCg5qv3n6bYAtktG8ejcaW5HXz9Vx1JgIieg

object[]

rateLimitType

string

Example: REQUEST_WEIGHT

interval

string

Example: MINUTE

intervalNum

integer · int64

Example: 1

limit

integer · int64

Example: 2400

count

integer · int64

Example: 2

Start User Data Stream (USER_STREAM)

WSS

userDataStream.start

wss://ws-fapi.binance.com/ws-fapi/v1

Start User Data Stream (USER_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 Weight1

Start User Data Stream (USER_STREAM) › Request Parameters

id

string · required

Id.

Example: e9d6b4349871b40611412680b3445fac

method

string · enum · required

WebSocket API method name.

Enum values:

userDataStream.start

Example: userDataStream.start

object · required

apiKey

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Start User Data Stream (USER_STREAM) › Responses

Successful Response

Start User Data Stream

id

string

Example: d3df8a61-98ea-4fe0-8f4e-0fcea5d418b0

status

integer · int64

Example: 200

object

listenKey

string

Example: xs0mRXdAKlIPDRFrlPcw0qI41Eh3ixNntmymGyhrhgqo7L6FuLaWArTD7RLP

object[]

rateLimitType

string

Example: REQUEST_WEIGHT

interval

string

Example: MINUTE

intervalNum

integer · int64

Example: 1

limit

integer · int64

Example: 2400

count

integer · int64

Example: 2