SpotApi

final case class SpotApi[F[_]](config: SpotConfig, client: HttpClient[F], exchangeInfo: ExchangeInformation, rateLimiters: RateLimiters[F])(implicit F: Async[F]) extends BinanceApi[F]
Companion:
object
trait Serializable
trait Product
trait Equals
trait BinanceApi[F]
class Object
trait Matchable
class Any

Type members

Types

override type Config = SpotConfig

Value members

Concrete methods

def aggregateTradeStreams(symbol: String): Stream[F, AggregateTradeStream]

The Aggregate Trade Streams push trade information that is aggregated for a single taker order every 100 milliseconds.

The Aggregate Trade Streams push trade information that is aggregated for a single taker order every 100 milliseconds.

Value parameters:
symbol

the symbol

Returns:

a stream of aggregate trade events

Pushes any update to the best bid or ask's price or quantity in real-time for all symbols.

Pushes any update to the best bid or ask's price or quantity in real-time for all symbols.

Returns:

a stream of best bid or ask's price or quantity for all symbols

def cancelAllOrders(orderCancel: SpotOrderCancelAllParams): F[Unit]

Cancels all orders of a symbol.

Cancels all orders of a symbol.

Value parameters:
orderCancel

the parameters required to cancel all the orders

Returns:

currently nothing

def cancelOrder(orderCancel: SpotOrderCancelParams): F[Unit]

Cancels an order.

Cancels an order.

Value parameters:
orderCancel

the parameters required to cancel the order

Returns:

currently nothing

Creates an order.

Creates an order.

Value parameters:
orderCreate

the parameters required to define the order

Returns:

The id of the order created

def diffDepthStream(symbol: String): Stream[F, DiffDepthStream]

Order book price and quantity depth updates used to locally manage an order book.

Order book price and quantity depth updates used to locally manage an order book.

Value parameters:
symbol

the symbol

Returns:

a stream of order book price and quantity depth updates

Returns the current balance, at the time the query is executed.

Returns the current balance, at the time the query is executed.

Returns:

The account information including the balance (free and locked) for each asset

Returns the depth of the orderbook.

Returns the depth of the orderbook.

Value parameters:
query

an Depth object containing the query parameters

Returns:

the orderbook depth

def getKLines(query: KLines): Stream[F, KLine]

Returns a stream of Kline objects. It recursively and lazily invokes the endpoint in case the result set doesn't fit in a single page.

Returns a stream of Kline objects. It recursively and lazily invokes the endpoint in case the result set doesn't fit in a single page.

Value parameters:
query

an KLines object containing the query parameters

Returns:

the stream of Kline objects

def getPrices(): F[Seq[Price]]

Returns a snapshot of the prices at the time the query is executed.

Returns a snapshot of the prices at the time the query is executed.

Returns:

A sequence of prices (one for each symbol)

def kLineStreams(symbol: String, interval: Interval): Stream[F, KLineStream]

The Kline/Candlestick Stream push updates to the current klines/candlestick periodically. In an actively traded symbol, the stream seems to push updates every two seconds. In a less actively traded symbol, there may be longer gaps of 10 secs or more between updates, and updates intervals will not be regularly spaced.

The Kline/Candlestick Stream push updates to the current klines/candlestick periodically. In an actively traded symbol, the stream seems to push updates every two seconds. In a less actively traded symbol, there may be longer gaps of 10 secs or more between updates, and updates intervals will not be regularly spaced.

Value parameters:
interval

the interval

symbol

the symbol

Returns:

a stream of klines

def partialBookDepthStream(symbol: String, level: Level): Stream[F, PartialDepthStream]

Top bids and asks

Top bids and asks

Value parameters:
level

the level

symbol

the symbol

Returns:

a stream of top bids and asks

Queries the status and fill price of an existing order.

Queries the status and fill price of an existing order.

Value parameters:
orderQuery

The order must be identified by Symbol plus one of OrderId or ClientOrderId

Returns:

Attributes of the order including status, fill amount and filled price.

def tradeStreams(symbol: String): Stream[F, TradeStream]

The Trade Streams push raw trade information; each trade has a unique buyer and seller.

The Trade Streams push raw trade information; each trade has a unique buyer and seller.

Value parameters:
symbol

the symbol

Returns:

a stream of trades

Inherited methods

def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product