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

In xlm: A 'Stellar' Client

Description

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

Usage

getOrderbook(selling_asset_type, selling_asset_code = "",
  selling_asset_issuer = "", buying_asset_type, buying_asset_code = "",
  buying_asset_issuer = "", domain = "public")

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
domain	character - signalling to query the testnet or public network. Can be either "testnet" or "public".

Value

list

Note

https://www.stellar.org/developers/horizon/reference/endpoints/orderbook-details.html

Examples

getOrderbook(selling_asset_type = "native", buying_asset_type = "credit_alphanum4")

xlm documentation built on Oct. 23, 2018, 1:04 a.m.