get_board_state: Orderbook status

In teramonagi/bitflyer: R Wrapper for bitFlyer Lightning API

Description

Get orderbook status

Usage

get_board_state(product_code = "BTC_JPY")

Arguments

product_code

A product_code or alias, as obtained from the Market List. If omitted, the value is set to "BTC_JPY". Only "BTC_USD" is available for U.S. accounts, and only "BTC_EUR" is available for European accounts.

Value

status: one of the following levels will be displayed

• NORMAL: The exchange is operating.

• BUSY: The exchange is experiencing high traffic.

• VERY BUSY: The exchange is experiencing very heavy traffic.

• SUPER BUSY: The exchange is experiencing extremely heavy traffic. There is a possibility that orders will fail or be processed after a delay.

• STOP: The exchange has been stopped. Orders will not be accepted.

Examples

## Not run: 
  get_board_state(product_code = "BTC_JPY")

## End(Not run)

teramonagi/bitflyer documentation built on Jan. 12, 2021, 1:02 p.m.