bt_getorderbook: Order Book for a Market

In kaneplusplus/bittrex: Client for the Bittrex Exchange

Order Book for a Market

Description

The bt_getorderbook() function returns the order book for a specified market on https://bittrex.com.

Usage

bt_getorderbook(market, type = c("both", "buy", "sell"), depth = 50)

Arguments

market	the market from which the order book will be retrieved.
type	type of orders to retrieve (default is "both")
depth	how deep the returned order book should be (default and maximum are 50). This is the size and price of bids whose price is lower than the highest bid and higher than the lowest ask.

Value

A named list with the following elements:

• success: a boolean indicating whether the request was successful.

• message: a string describing the error if the request was not successful, otherwise and empty string.

• result: A named list with the buy and sell orders (depending on the specified type parameter). If type is "buy" or "both" then the list will contain a element named "buy" with a data.frame of the buy orders.

References

https://bittrex.com/api/v1.1/public/getorderbook

Examples

## Not run: 
head(bt_getorderbook("btc-eth")$result)

## End(Not run)

kaneplusplus/bittrex documentation built on July 6, 2022, 10:02 p.m.