Struct UserStream 

pub struct UserStream { /* private fields */ }

User data stream API client.

Provides endpoints for managing user data streams. A listen key is required to connect to the user data WebSocket stream for real-time account updates.

Listen Key Lifecycle

1. Start a stream with start() to get a listen key
2. Send keepalive every 30 minutes with keepalive() to prevent expiration
3. Close the stream with close() when done

Listen keys expire after 60 minutes without a keepalive.

Implementations

impl UserStream

pub async fn start(&self) -> Result<String>

Start a new user data stream.

Returns a listen key that can be used to connect to the user data WebSocket stream.

Example

let client = Binance::new("api_key", "secret_key")?;
let listen_key = client.user_stream().start().await?;
println!("Listen key: {}", listen_key);

// Connect to WebSocket using: wss://stream.binance.com:9443/ws/{listen_key}

pub async fn keepalive(&self, listen_key: &str) -> Result<()>

Send a keepalive for a user data stream.

This should be called every 30 minutes to prevent the listen key from expiring. Listen keys expire after 60 minutes without a keepalive.

Arguments

• listen_key - The listen key to keep alive

Example

let client = Binance::new("api_key", "secret_key")?;
let listen_key = client.user_stream().start().await?;

// Every 30 minutes:
client.user_stream().keepalive(&listen_key).await?;

pub async fn close(&self, listen_key: &str) -> Result<()>

Close a user data stream.

This invalidates the listen key and closes any WebSocket connections using it.

Arguments

• listen_key - The listen key to close

Example

let client = Binance::new("api_key", "secret_key")?;
let listen_key = client.user_stream().start().await?;

// When done:
client.user_stream().close(&listen_key).await?;

Trait Implementations

impl Clone for UserStream

fn clone(&self) -> UserStream

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.