BitShares-Core  6.1.0
BitShares blockchain implementation and command-line interface software
Classes | Public Member Functions | List of all members
graphene::app::orders_api Class Reference

the orders_api class exposes access to data processed with grouped orders plugin. More...

#include <api.hpp>

Classes

struct  limit_order_group
 summary data of a group of limit orders More...
 

Public Member Functions

 orders_api (application &app)
 
flat_set< uint16_t > get_tracked_groups () const
 Get tracked groups configured by the server. More...
 
vector< limit_order_groupget_grouped_limit_orders (const std::string &base_asset, const std::string &quote_asset, uint16_t group, const optional< price > &start, uint32_t limit) const
 Get grouped limit orders in given market. More...
 

Detailed Description

the orders_api class exposes access to data processed with grouped orders plugin.

Definition at line 597 of file api.hpp.

Constructor & Destructor Documentation

◆ orders_api()

graphene::app::orders_api::orders_api ( application app)
explicit

Definition at line 970 of file api.cpp.

Member Function Documentation

◆ get_grouped_limit_orders()

vector< orders_api::limit_order_group > graphene::app::orders_api::get_grouped_limit_orders ( const std::string &  base_asset,
const std::string &  quote_asset,
uint16_t  group,
const optional< price > &  start,
uint32_t  limit 
) const

Get grouped limit orders in given market.

Parameters
base_assetsymbol or ID of asset being sold
quote_assetsymbol or ID of asset being purchased
groupMaximum price diff within each order group, have to be one of configured values
startOptional price to indicate the first order group to retrieve
limitMaximum number of order groups to retrieve, must not exceed the configured value of api_limit_get_grouped_limit_orders
Returns
The grouped limit orders, ordered from best offered price to worst

Definition at line 982 of file api.cpp.

◆ get_tracked_groups()

flat_set< uint16_t > graphene::app::orders_api::get_tracked_groups ( ) const

Get tracked groups configured by the server.

Returns
A list of numbers which indicate configured groups, of those, 1 means 0.01% diff on price.

Definition at line 975 of file api.cpp.


The documentation for this class was generated from the following files: