public_orderbook: Get bids and asks for provided currency-pair (products) by...

Description Usage Arguments Value Examples

Description

This function is a public function and will fetch all bids/asks for provided currency pair (product_id). User should change the level to get the best bid/ask or to fetch all bids/asks.

Usage

1
public_orderbook(product_id = "LTC-USD", level = 1)

Arguments

product_id

Optional character parameter. This is a case insensitive value of the product id for which the order book is desired. Default to 'LTC-USD'. For all valid product ids, refer to public_info.

level

Optional parameter. Integer value of level denoting level of detail. Valid user values of 1, 2, 3. Default to 1.

Value

A named list with bids and asks for the provided currency pair.

Examples

1
2
3
4
5
6
## Not run: 
public_orderbook()
public_orderbook(product_id = "BCH-USD", level = 3)
public_orderbook(product_id = "BTC-EUR", level = 2)

## End(Not run)

rgdax documentation built on May 2, 2019, 3:42 a.m.