stellaRbase (version 0.1.0)

getOrderbook: Returns details on the current state of the order book

Description

Return a summary of assets bought and sold on the ledger.

Usage

getOrderbook(selling_asset_type, selling_asset_code = NULL,
  selling_asset_issuer = NULL, buying_asset_type, buying_asset_code = NULL,
  buying_asset_issuer = NULL, limit = 10)

Arguments

selling_asset_type

required, character - Type of the Asset being sold native

selling_asset_code

optional, character - code of the Asset being sold USD

selling_asset_issuer

optional, character - account ID of the issuer of the Asset being sold GA2HGBJIJKI6O4XEM7CZWY5PS6GKSXL6D34ERAJYQSPYA6X6AI7HYW36

buying_asset_type

required, character - type of the Asset being bought credit_alphanum4

buying_asset_code

optional, character - code of the Asset being bought BTC

buying_asset_issuer

optional, character - account ID of the issuer of the Asset being bought

limit

optional, numeric - the number of records to return.

Value

list

Examples

# NOT RUN {
getOrderbook(selling_asset_type = "native", buying_asset_type = "credit_alphanum4")
# }