User data stream endpoints (Deprecated)
[!IMPORTANT] These requests have been deprecated, which means we will remove them in the future. Please subscribe to the User Data Stream through the WebSocket API instead.
The following requests manage User Data Stream subscriptions.
Start user data stream (USER_STREAM) (Deprecated)
POST /api/v3/userDataStream
Start a new user data stream. The stream will close after 60 minutes unless a keepalive is sent.
Weight: 2
Parameters: NONE
Data Source: Memory
Response:
{
"listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}
Keepalive user data stream (USER_STREAM) (Deprecated)
PUT /api/v3/userDataStream
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 30 minutes.
Weight: 2
Data Source: Memory
Parameters:
| Name | Type | Mandatory | Description |
|---|---|---|---|
| listenKey | STRING | YES |
Response:
{}
Close user data stream (USER_STREAM) (Deprecated)
DELETE /api/v3/userDataStream
Close out a user data stream.
Weight: 2
Parameters:
| Name | Type | Mandatory | Description |
|---|---|---|---|
| listenKey | STRING | YES |
Data Source: Memory
Response:
{}