getorderbook: Order Book for a Market

In kaneplusplus/ccex: Client for the C-Cex Crypto-currency Exchange

Description

The getorderbook function returns the order book for a specified market on the C-Cex crypto-currency exchange https://c-cex.com.

Usage

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 should the returned order book be (default and maximum are 50).

Value

A named list with the following elements:

• success: a boolean indicating if the request 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://c-cex.com/?id=api#getorderbook

Examples

## Not run: 
ob = getorderbook("usd-btc")$result
head(ob$buy)
head(ob$sell)

## End(Not run)

kaneplusplus/ccex documentation built on May 20, 2019, 7:20 a.m.