30 lines
1.1 KiB
R
30 lines
1.1 KiB
R
|
% Generated by roxygen2: do not edit by hand
|
||
|
|
% Please edit documentation in R/indicators.R
|
||
|
|
\name{BinanceFeed}
|
||
|
|
\alias{BinanceFeed}
|
||
|
|
\title{Connect to a live Binance kline feed}
|
||
|
|
\usage{
|
||
|
|
BinanceFeed(symbols, interval, base_url = NULL)
|
||
|
|
}
|
||
|
|
\arguments{
|
||
|
|
\item{symbols}{Comma-separated trading symbols (case-insensitive), e.g.
|
||
|
|
\code{"btcusdt,ethusdt"}.}
|
||
|
|
|
||
|
|
\item{interval}{Integer interval code \code{0:15} (\code{0} = 1s, \code{1} = 1m, ...,
|
||
|
|
\code{12} = 1d, \code{13} = 3d, \code{14} = 1w, \code{15} = 1M).}
|
||
|
|
|
||
|
|
\item{base_url}{Optional endpoint override; \code{NULL} uses production.}
|
||
|
|
}
|
||
|
|
\value{
|
||
|
|
A \code{wickra_binance_feed}; poll it with \code{\link[=binance_next]{binance_next()}} and close it
|
||
|
|
with \code{\link[=binance_close]{binance_close()}}.
|
||
|
|
}
|
||
|
|
\description{
|
||
|
|
Opens a live Binance kline stream for one or more comma-separated \code{symbols}
|
||
|
|
(case-insensitive) at the given \code{interval} code (an integer \code{0:15}, the same
|
||
|
|
order as the other bindings: 0 = 1s, 1 = 1m, ... 12 = 1d, 13 = 3d, 14 = 1w,
|
||
|
|
15 = 1M). \code{base_url} overrides the endpoint (\code{NULL} = production). Not
|
||
|
|
available in the wasm (r-universe/webR) build, which has no raw sockets.
|
||
|
|
}
|
||
|
|
\keyword{internal}
|