Binance.UserDataStream (binance v2.0.1)

Summary

Functions

Close a ListenKey (USER_STREAM)

Create a ListenKey (USER_STREAM)

Generate a Listen Key (USER_STREAM)

Ping/Keep-alive a ListenKey (USER_STREAM)

Ping/Keep-alive a Listen Key (USER_STREAM)

Functions

Link to this function

delete_user_data_stream(listenKey, opts \\ [])

@spec delete_user_data_stream(
  any(),
  []
) :: {:ok, any()} | {:error, any()}

Close a ListenKey (USER_STREAM)

Close out a user data stream.

Weight: 1

Details:

  • METHOD: delete
  • URL: /sapi/v1/userDataStream

Mandatory params:

  • listenKey - User websocket listen key

Optional params:

Link to this function

delete_user_data_stream_isolated(symbol, listenKey, opts \\ [])

@spec delete_user_data_stream_isolated(any(), any(), []) ::
  {:ok, any()} | {:error, any()}

Close a ListenKey (USER_STREAM)

Close out a user data stream.

Weight: 1

Details:

  • METHOD: delete
  • URL: /sapi/v1/userDataStream/isolated

Mandatory params:

  • symbol -
  • listenKey - User websocket listen key

Optional params:

Link to this function

post_user_data_stream(opts \\ [])

@spec post_user_data_stream([]) :: {:ok, any()} | {:error, any()}

Create a ListenKey (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.

Weight: 1

Details:

  • METHOD: post
  • URL: /sapi/v1/userDataStream

Mandatory params:

Optional params:

Link to this function

post_user_data_stream_isolated(symbol, opts \\ [])

@spec post_user_data_stream_isolated(
  any(),
  []
) :: {:ok, any()} | {:error, any()}

Generate a Listen Key (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.

Weight: 1

Details:

  • METHOD: post
  • URL: /sapi/v1/userDataStream/isolated

Mandatory params:

  • symbol -

Optional params:

Link to this function

put_user_data_stream(listenKey, opts \\ [])

@spec put_user_data_stream(
  any(),
  []
) :: {:ok, any()} | {:error, any()}

Ping/Keep-alive a ListenKey (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 30 minutes.

Weight: 1

Details:

  • METHOD: put
  • URL: /sapi/v1/userDataStream

Mandatory params:

  • listenKey - User websocket listen key

Optional params:

Link to this function

put_user_data_stream_isolated(symbol, listenKey, opts \\ [])

@spec put_user_data_stream_isolated(any(), any(), []) ::
  {:ok, any()} | {:error, any()}

Ping/Keep-alive a Listen Key (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 30 minutes.

Weight: 1

Details:

  • METHOD: put
  • URL: /sapi/v1/userDataStream/isolated

Mandatory params:

  • symbol -
  • listenKey - User websocket listen key

Optional params: