Order book

Exposes the GET /api/v3/depth endpoint.

market_order_book(symbol, side = NULL, limit = 100)

Arguments

symbol

Symbol.

side

Side of the trade: "BUY" or "SELL".

limit

Maximum number of records in result. Default is 100 and maximum is 5000.

Value

A data frame.

Examples

market_order_book("BTCUSDT")
#> # A tibble: 1 × 4
#>   symbol  last_update_id bids               asks              
#>   <chr>            <int> <list>             <list>            
#> 1 BTCUSDT        8026413 <tibble [100 × 2]> <tibble [100 × 2]>
market_order_book(c("BTCUSDT", "TRXUSDT"))
#> # A tibble: 2 × 4
#>   symbol  last_update_id bids               asks              
#>   <chr>            <int> <list>             <list>            
#> 1 BTCUSDT        8026414 <tibble [100 × 2]> <tibble [100 × 2]>
#> 2 TRXUSDT        1095642 <tibble [0 × 2]>   <tibble [0 × 2]>