StreamApi: Stream operations

In grahamjwhite/binanceRapi: R Package Client for Binance Public Spot API

Stream operations

Description

binanceRapi.Stream

Format

An R6Class generator object

Methods

ApiV3UserDataStreamDelete Close a ListenKey (USER_STREAM) Close out a user data stream. Weight: 1

• @param listen.key character

• status code : 200 | OK

• return type : object

• response headers :

• status code : 400 | Bad Request

• return type : Error

• response headers :

ApiV3UserDataStreamPost 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

• @returnType InlineResponse20080
  

• status code : 200 | Listen key

• return type : InlineResponse20080

• response headers :

ApiV3UserDataStreamPut 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

• @param listen.key character

• status code : 200 | OK

• return type : object

• response headers :

• status code : 400 | Bad Request

• return type : Error

• response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• StreamApi$new()

• StreamApi$ApiV3UserDataStreamDelete()

• StreamApi$ApiV3UserDataStreamDeleteWithHttpInfo()

• StreamApi$ApiV3UserDataStreamPost()

• StreamApi$ApiV3UserDataStreamPostWithHttpInfo()

• StreamApi$ApiV3UserDataStreamPut()

• StreamApi$ApiV3UserDataStreamPutWithHttpInfo()

• StreamApi$clone()

---

Method new()

Usage

StreamApi$new(apiClient)

---

Method ApiV3UserDataStreamDelete()

Usage

StreamApi$ApiV3UserDataStreamDelete(listen.key = NULL, ...)

---

Method ApiV3UserDataStreamDeleteWithHttpInfo()

Usage

StreamApi$ApiV3UserDataStreamDeleteWithHttpInfo(listen.key = NULL, ...)

---

Method ApiV3UserDataStreamPost()

Usage

StreamApi$ApiV3UserDataStreamPost(...)

---

Method ApiV3UserDataStreamPostWithHttpInfo()

Usage

StreamApi$ApiV3UserDataStreamPostWithHttpInfo(...)

---

Method ApiV3UserDataStreamPut()

Usage

StreamApi$ApiV3UserDataStreamPut(listen.key = NULL, ...)

---

Method ApiV3UserDataStreamPutWithHttpInfo()

Usage

StreamApi$ApiV3UserDataStreamPutWithHttpInfo(listen.key = NULL, ...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

StreamApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
####################  ApiV3UserDataStreamDelete  ####################

library(binanceRapi)
var.listen.key <- 'pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1' # character | User websocket listen key

#Close a ListenKey (USER_STREAM)
api.instance <- StreamApi$new()

result <- api.instance$ApiV3UserDataStreamDelete(listen.key=var.listen.key)


####################  ApiV3UserDataStreamPost  ####################

library(binanceRapi)

#Create a ListenKey (USER_STREAM)
api.instance <- StreamApi$new()

result <- api.instance$ApiV3UserDataStreamPost()


####################  ApiV3UserDataStreamPut  ####################

library(binanceRapi)
var.listen.key <- 'pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1' # character | User websocket listen key

#Ping/Keep-alive a ListenKey (USER_STREAM)
api.instance <- StreamApi$new()

result <- api.instance$ApiV3UserDataStreamPut(listen.key=var.listen.key)



## End(Not run)

grahamjwhite/binanceRapi documentation built on Nov. 22, 2022, 9:37 p.m.