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

The asset_api class allows query of info about asset holders. More...

#include <api.hpp>

Classes

struct  account_asset_balance
 
struct  asset_holders
 

Public Member Functions

 asset_api (graphene::app::application &app)
 
vector< account_asset_balanceget_asset_holders (const std::string &asset_symbol_or_id, uint32_t start, uint32_t limit) const
 Get asset holders for a specific asset. More...
 
int64_t get_asset_holders_count (const std::string &asset_symbol_or_id) const
 Get asset holders count for a specific asset. More...
 
vector< asset_holdersget_all_asset_holders () const
 Get all asset holders. More...
 

Detailed Description

The asset_api class allows query of info about asset holders.

Definition at line 548 of file api.hpp.

Constructor & Destructor Documentation

◆ asset_api()

graphene::app::asset_api::asset_api ( graphene::app::application app)
explicit

Definition at line 887 of file api.cpp.

Member Function Documentation

◆ get_all_asset_holders()

vector< asset_api::asset_holders > graphene::app::asset_api::get_all_asset_holders ( ) const

Get all asset holders.

Returns
A list of all asset holders

Definition at line 944 of file api.cpp.

◆ get_asset_holders()

vector< asset_api::account_asset_balance > graphene::app::asset_api::get_asset_holders ( const std::string &  asset_symbol_or_id,
uint32_t  start,
uint32_t  limit 
) const

Get asset holders for a specific asset.

Parameters
asset_symbol_or_idThe specific asset symbol or ID
startThe start index
limitMaximum number of accounts to retrieve, must not exceed the configured value of api_limit_get_asset_holders
Returns
A list of asset holders for the specified asset

Definition at line 893 of file api.cpp.

◆ get_asset_holders_count()

int64_t graphene::app::asset_api::get_asset_holders_count ( const std::string &  asset_symbol_or_id) const

Get asset holders count for a specific asset.

Parameters
asset_symbol_or_idThe specific asset symbol or id
Returns
Holders count for the specified asset

Definition at line 933 of file api.cpp.


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