The database API is available from the full node via web-sockets.
Get the objects corresponding to the provided IDs.
If any of the provided IDs does not map to an object, a null variant is returned in its position.
fc::variants graphene::app::database_api::get_objects(
const vector<object_id_type> &ids,
optional<bool> subscribe = optional<bool>())const
{% tabs %} {% tab title="Parameters" %}
ids
: IDs of the objects to retrievesubscribe
: true to subscribe to the queried objects; false to not subscribe; null to subscribe or not subscribe according to current auto-subscription setting (see set_auto_subscription) {% endtab %}
{% tab title="Return" %} The objects retrieved, in the order they are mentioned in ids. {% endtab %} {% endtabs %}
Register a callback handle which then can be used to subscribe to object database changes.
{% hint style="warning" %} Note: auto-subscription is enabled by default and can be disabled with set_auto_subscription {% endhint %}
void graphene::app::database_api::set_subscribe_callback(
std::function<void(const variant&)> cb,
bool notify_remove_create, )
{% tabs %} {% tab title="Parameters" %}
cb
: The callback handle to registernotify_remove_create
: Whether subscribe to universal object creation and removal events. If this is set to true, the API server will notify all newly created objects and ID of all newly removed objects to the client, no matter whether client subscribed to the objects. By default, API servers don’t allow subscribing to universal events, which can be changed on server startup. {% endtab %} {% endtabs %}
Register a callback handle which will get notified when a transaction is pushed to database.
{% hint style="warning" %} Note: A transaction can be pushed to the database and be popped from the database several times while processing, before and after,, included in a block. Every time a push is done, the client will be notified. {% endhint %}
void graphene::app::database_api::set_pending_transaction_callback(
std::function<void(const variant &signed_transaction_object)> cb)
{% tabs %} {% tab title="Parameters" %}
cb
: The callback handle to register {% endtab %} {% endtabs %}
Register a callback handle which will get notified when a block is pushed to database.
void graphene::app::database_api::set_block_applied_callback(
std::function<void(const variant &block_id)> cb)
{% tabs %} {% tab title="Parameters" %}
cb
: The callback handle to register {% endtab %} {% endtabs %}
Stop receiving any notifications.
This unsubscribes from all subscribed markets and objects.
void graphene::app::database_api::cancel_all_subscriptions()
Retrieve a block header.
optional<block_header> graphene::app::database_api::get_block_header(
uint32_t block_num)const
{% tabs %} {% tab title="Parameters" %}
block_num
: Height of the block whose header should be returned {% endtab %}
{% tab title="Return" %}
- The header of the referenced block, or null if no matching block was foun {% endtab %} {% endtabs %}
Retrieve a full, signed block.
optional<signed_block> graphene::app::database_api::get_block(
uint32_t block_num)const
{% tabs %} {% tab title="Parameters" %}
block_num
: Height of the block to be returned {% endtab %}
{% tab title="Return" %} The referenced block, or null if no matching block was found. {% endtab %} {% endtabs %}
Fetch an individual transaction.
processed_transaction graphene::app::database_api::get_transaction(
uint32_t block_num, uint32_t trx_in_block)const
{% tabs %} {% tab title="Parameters" %}
block_num
: height of the block to fetchtrx_in_block
: the index (sequence number) of the transaction in the block, starts from 0 {% endtab %}
{% tab title="Return" %} The transaction at the given position. {% endtab %} {% endtabs %}
optional<signed_transaction> graphene::app::database_api::get_recent_transaction_by_id(
const transaction_id_type &txid)const
{% tabs %} {% tab title="Parameters" %}
txid
: hash of the transaction {% endtab %}
{% tab title="Return" %} The corresponding transaction if found, or null if not found. {% endtab %} {% endtabs %}
If the transaction has not expired, this method will return the transaction for the given ID or it will return NULL if it is not known. Just because it is not known does not mean it wasn’t included in the blockchain.
Retrieve the graphene::chain::chain_property_object associated with the chain.
chain_property_object graphene::app::database_api::get_chain_properties()const
Retrieve the current graphene::chain::global_property_object.
global_property_object graphene::app::database_api::get_global_properties()const
Retrieve compile-time constants.
fc::variant_object graphene::app::database_api::get_config()const
Get the chain ID.
chain_id_type graphene::app::database_api::get_chain_id()cons
Retrieve the current graphene::chain::dynamic_global_property_object.
dynamic_global_property_object graphene::app::database_api::get_dynamic_global_properties()const
Get all accounts that refer to the specified public keys in their owner authority, active authorities or memo key.
vector<flat_set<account_id_type>> graphene::app::database_api::get_key_references(
vector<public_key_type> keys)const
{% tabs %} {% tab title="Parameters" %}
keys
: a list of public keys to query {% endtab %}
{% tab title="Return" %} ID of all accounts that refer to the specified keys. {% endtab %} {% endtabs %}
Get a list of accounts by names or IDs.
This function has semantics identical to get_objects****
vector<optional<account_object>> graphene::app::database_api::get_accounts(
const vector<std::string> &account_names_or_ids,
optional<bool> subscribe = optional<bool>())const
{% tabs %} {% tab title="Parameters" %}
account_names_or_ids
: names or IDs of the accounts to retrievesubscribe
: true to subscribe to the queried account objects; false to not subscribe; null to subscribe or not subscribe according to current auto-subscription setting (see set_auto_subscription) {% endtab %}
{% tab title="Return" %} The accounts corresponding to the provided names or IDs. {% endtab %} {% endtabs %}
Fetch all objects relevant to the specified accounts and optionally subscribe to updates.
This function fetches all relevant objects for the given accounts, and subscribes to updates to the given accounts. If any of the strings innames_or_ids
cannot be tied to an account, that input will be ignored. All other accounts will be retrieved and subscribed.
std::map<string, full_account> graphene::app::database_api::get_full_accounts(
const vector<string> &names_or_ids,
optional<bool> subscribe = optional<bool>())
{% tabs %} {% tab title="Parameters" %}
names_or_ids
: Each item must be the name or ID of an account to retrievesubscribe
: true to subscribe to the queried full account objects; false to not subscribe; null to subscribe or not subscribe according to current auto-subscription setting (see set_auto_subscription) {% endtab %}
{% tab title="Return" %}
Map of string from names_or_ids
to the corresponding account.
{% endtab %}
{% endtabs %}
Get info of an account by name.
optional<account_object> graphene::app::database_api::get_account_by_name(
string name)const
{% tabs %} {% tab title="Parameters" %}
name
: Name of the account to retrieve {% endtab %}
{% tab title="Return" %} The account holding the provided name. {% endtab %} {% endtabs %}
Get all accounts that refer to the specified account in their owner or active authorities.
vector<account_id_type> graphene::app::database_api::get_account_references(
const std::string account_name_or_id)const
{% tabs %} {% tab title="Parameters" %}
account_name_or_id
: Account name or ID to query {% endtab %}
{% tab title="Return" %} All accounts that refer to the specified account in their owner or active authorities {% endtab %} {% endtabs %}
Get a list of accounts by name.
This function has semantics identical to get_objects, but doesn’t subscribe
vector<optional<account_object>> graphene::app::database_api::lookup_account_names(
const vector<string> &account_names)const
{% tabs %} {% tab title="Parameters" %}
account_names
: Names of the accounts to retrieve {% endtab %}
{% tab title="Return" %} The accounts holding the provided names. {% endtab %} {% endtabs %}
Get names and IDs for registered accounts.
{% hint style="warning" %}
Note: In addition to the common auto-subscription rules, this API will subscribe to the returned account only if limit
is 1.
{% endhint %}
map<string, account_id_type> graphene::app::database_api::lookup_accounts(
const string &lower_bound_name,
uint32_t limit,
optional<bool> subscribe = optional<bool>())const
{% tabs %} {% tab title="Parameters" %}
lower_bound_name
: Lower bound of the first name to returnlimit
: Maximum number of results to return must not exceed 1000subscribe
: true to subscribe to the queried account objects; false to not subscribe; null to subscribe or not subscribe according to current auto-subscription setting (see set_auto_subscription). {% endtab %}
{% tab title="Return" %} Map of account names to corresponding IDs. {% endtab %} {% endtabs %}
Get the total number of accounts registered with the blockchain.
uint64_t graphene::app::database_api::get_account_count()const
Get an account’s balances in various assets.
vector<asset> graphene::app::database_api::get_account_balances(
const std::string &account_name_or_id,
const flat_set<asset_id_type> &assets)const
{% tabs %} {% tab title="Parameters" %}
account_name_or_id
: name or ID of the account to get balances for.assets
: IDs of the assets to get balances of; if empty, get all assets account has a balance in. {% endtab %}
{% tab title="Return" %} Balances of the account. {% endtab %} {% endtabs %}
Semantically equivalent to get_account_balances.
vector<asset> graphene::app::database_api::get_named_account_balances(
const std::string &name,
const flat_set<asset_id_type> &assets)const
{% tabs %} {% tab title="Parameters" %}
account_name_or_id
: name or ID of the account to get balances for.assets
: IDs of the assets to get balances of; if empty, get all assets account has a balance in. {% endtab %}
{% tab title="Return" %} Balances of the account. {% endtab %} {% endtabs %}
vector<balance_object> graphene::app::database_api::get_balance_objects(
const vector<address> &addrs)const
{% tabs %} {% tab title="Parameters" %}
addrs
: a list of addresses {% endtab %}
{% tab title="Return" %} All unclaimed balance objects for the addresses. {% endtab %} {% endtabs %}
Calculate how much assets in the given balance objects are able to be claimed at current head block time.
vector<asset> graphene::app::database_api::get_vested_balances(
const vector<balance_id_type> &objs)const
{% tabs %} {% tab title="Parameters" %}
objs
: a list of balance object IDs {% endtab %}
{% tab title="Return" %} A list indicating how much asset in each balance object is available to be claimed. {% endtab %} {% endtabs %}
Return all vesting balance objects owned by an account.
vector<vesting_balance_object> graphene::app::database_api::get_vesting_balances(
const std::string account_name_or_id)const
{% tabs %} {% tab title="Parameters" %}
account_name_or_id
: name or ID of an account {% endtab %}
{% tab title="Return" %} All vesting balance objects owned by the account. {% endtab %} {% endtabs %}
Get a list of assets by symbol names or IDs.
Semantically equivalent to get_objects.
vector<optional<extended_asset_object>> graphene::app::database_api::get_assets(
const vector<std::string> &asset_symbols_or_ids,
optional<bool> subscribe = optional<bool>())const
{% tabs %} {% tab title="Parameters" %}
asset_symbols_or_ids
: symbol names or IDs of the assets to retrievesubscribe
: true to subscribe to the queried asset objects; false to not subscribe; null to subscribe or not subscribe according to current auto-subscription setting (see set_auto_subscription) {% endtab %}
{% tab title="Return" %} The assets corresponding to the provided symbol names or IDs. {% endtab %} {% endtabs %}
Get assets alphabetically by symbol name.
vector<extended_asset_object> graphene::app::database_api::list_assets(
const string &lower_bound_symbol,
uint32_t limit)const
{% tabs %} {% tab title="Parameters" %}
lower_bound_symbol
: Lower bound of symbol names to retrievelimit
: Maximum number of assets to fetch (must not exceed 101) {% endtab %}
{% tab title="Return" %} The assets found. {% endtab %} {% endtabs %}
Get a list of assets by symbol names or IDs.
Semantically equivalent to get_objects, but doesn’t subscribe.
vector<optional<extended_asset_object>> graphene::app::database_api::lookup_asset_symbols(
const vector<string> &symbols_or_ids)const
{% tabs %} {% tab title="Parameters" %}
symbols_or_ids
: symbol names or IDs of the assets to retrieve {% endtab %}
{% tab title="Return" %} The assets corresponding to the provided symbols or IDs {% endtab %} {% endtabs %}
Returns the order book for the market base
order_book graphene::app::database_api::get_order_book(
const string &base,
const string "e,
unsigned limit = 50)const
{% tabs %} {% tab title="Parameters" %}
base
: symbol name or ID of the base assetquote
: symbol name or ID of the quote assetlimit
: depth of the order book to retrieve, for bids and asks each, capped at 50 {% endtab %}
{% tab title="Return" %} Order book of the market. {% endtab %} {% endtabs %}
Get limit orders in a given market.
vector<limit_order_object> graphene::app::database_api::get_limit_orders(
std::string a,
std::string b,
uint32_t limit)const
{% tabs %} {% tab title="Parameters" %}
a
: symbol or ID of asset being soldb
: symbol or ID of asset being purchasedlimit
: Maximum number of orders to retrieve {% endtab %}
{% tab title="Return" %} The limit orders, ordered from least price to greatest. {% endtab %} {% endtabs %}
Get call orders (aka margin positions) for a given asset.
vector<call_order_object> graphene::app::database_api::get_call_orders(
const std::string &a,
uint32_t limit)const
{% tabs %} {% tab title="Parameters" %}
a
: symbol name or ID of the debt assetlimit
: Maximum number of orders to retrieve {% endtab %}
{% tab title="Return" %} The call orders, ordered from earliest to be called to latest {% endtab %} {% endtabs %}
Get forced settlement orders in a given asset.
vector<force_settlement_object> graphene::app::database_api::get_settle_orders(
const std::string &a,
uint32_t limit)const
{% tabs %} {% tab title="Parameters" %}
a
: Symbol or ID of asset being settledlimit
: Maximum number of orders to retrieve {% endtab %}
{% tab title="Return" %} The settle orders, ordered from earliest settlement date to latest. {% endtab %} {% endtabs %}
Get all open margin positions of a given account.
Similar to get_call_orders_by_account, but without pagination.
vector<call_order_object> graphene::app::database_api::get_margin_positions(
const std::string account_name_or_id)const
{% tabs %} {% tab title="Parameters" %}
account_name_or_id
: name or ID of an account {% endtab %}
{% tab title="Return" %} All open margin positions of the account. {% endtab %} {% endtabs %}
Request notification when the active orders in the market between two assets changes.
Callback will be passed a variant containing a vector<pair<operation, operation_result>>.
The vector will contain, in order, the operations which changed the market, and their results
void graphene::app::database_api::subscribe_to_market(std::function<void(
const variant&)> callback,
const std::string &a,
const std::string &b, )
{% tabs %} {% tab title="Parameters" %}
callback
: Callback method which is called when the market changesa
: symbol name or ID of the first assetb
: symbol name or ID of the second asset {% endtab %} {% endtabs %}
Unsubscribe from updates to a given market.
void graphene::app::database_api::unsubscribe_from_market(
const std::string &a,
const std::string &b)
{% tabs %} {% tab title="Parameters" %}
a
: symbol name or ID of the first assetb
: symbol name or ID of the second asset {% endtab %} {% endtabs %}
Returns the ticker for the market assetA:assetB.
market_ticker graphene::app::database_api::get_ticker(
const string &base,
const string "e)const
{% tabs %} {% tab title="Parameters" %}
base
: symbol name or ID of the base assetquote
: symbol name or ID of the quote asset {% endtab %}
{% tab title="Return" %} The market ticker for the past 24 hours. {% endtab %} {% endtabs %}
Returns the 24 hour volume for the market assetA:assetB.
market_volume graphene::app::database_api::get_24_volume(
const string &base,
const string "e)const
{% tabs %} {% tab title="Parameters" %}
base
: symbol name or ID of the base assetquote
: symbol name or ID of the quote asset {% endtab %}
{% tab title="Return" %} The market volume over the past 24 hours. {% endtab %} {% endtabs %}
Returns recent trades for the market base:quote, ordered by time, most recent first.
{% hint style="warning" %} Note: Currently, timezone offsets are not supported. The time must be UTC. {% endhint %}
The range is [stop, start). In case there are more than 100 trades occurring in the same second, this API only returns the first 100 records; use get_trade_history_by_sequence to query for the rest.
vector<market_trade> graphene::app::database_api::get_trade_history(
const string &base,
const string "e,
fc::time_point_sec start,
fc::time_point_sec stop,
unsigned limit = 100)const
{% tabs %} {% tab title="Parameters" %}
base
: symbol or ID of the base assetquote
: symbol or ID of the quote assetstart
: Start time as a UNIX timestamp, the latest trade to retrievestop
: Stop time as a UNIX timestamp, the earliest trade to retrievelimit
: Number of transactions to retrieve, capped at 100. {% endtab %}
{% tab title="Return" %} Recent transactions in the market {% endtab %} {% endtabs %}
Get a list of witnesses by ID.
Semantically equivalent to get_objects, but doesn’t subscribe.
vector<optional<witness_object>> graphene::app::database_api::get_witnesses(
const vector<witness_id_type> &witness_ids)const
{% tabs %} {% tab title="Parameters" %}
witness_ids
: IDs of the witnesses to retrieve {% endtab %}
{% tab title="Return" %} The witnesses corresponding to the provided IDs. {% endtab %} {% endtabs %}
Get the witness owned by a given account.
fc::optional<witness_object> graphene::app::database_api::get_witness_by_account(
const std::string account_name_or_id)const
{% tabs %} {% tab title="Parameters" %}
account_name_or_id
: The name or ID of the account whose witness should be retrieved {% endtab %}
{% tab title="Return" %} The witness object, or null if the account does not have a witness. {% endtab %} {% endtabs %}
Get names and IDs for registered witnesses.
map<string, witness_id_type> graphene::app::database_api::lookup_witness_accounts(
const string &lower_bound_name, uint32_t limit)const
{% tabs %} {% tab title="Parameters" %}
lower_bound_name
: Lower bound of the first name to returnlimit
: Maximum number of results to return must not exceed 1000 {% endtab %}
{% tab title="Return" %} Map of witness names to corresponding IDs**.** {% endtab %} {% endtabs %}
Get the total number of witnesses registered with the blockchain.
uint64_t graphene::app::database_api::get_witness_count()const
Get a list of committee_members by ID.
Semantically equivalent to get_objects, but doesn’t subscribe.
vector<optional<committee_member_object>> graphene::app::database_api::get_committee_members(
const vector<committee_member_id_type> &committee_member_ids)const
{% tabs %} {% tab title="Parameters" %}
committee_member_ids
: IDs of the committee_members to retrieve {% endtab %}
{% tab title="Return" %} The committee_members corresponding to the provided IDs. {% endtab %} {% endtabs %}
Get the committee_member owned by a given account.
fc::optional<committee_member_object> graphene::app::database_api::get_committee_member_by_account(
const string account_name_or_id)const
{% tabs %} {% tab title="Parameters" %}
account_name_or_id
: The name or ID of the account whose committee_member should be retrieved {% endtab %}
{% tab title="Return" %} The committee_member object, or null if the account does not have a committee_member**.** {% endtab %} {% endtabs %}
Get names and IDs for registered committee_members.
map<string, committee_member_id_type> graphene::app::database_api::lookup_committee_member_accounts(
const string &lower_bound_name,
uint32_t limit)const
{% tabs %} {% tab title="Parameters" %}
lower_bound_name
: Lower bound of the first name to returnlimit
: Maximum number of results to return must not exceed 1000 {% endtab %}
{% tab title="Return" %} Map of committee_member names to corresponding IDs {% endtab %} {% endtabs %}
Get the workers owned by a given account.
vector<optional<worker_object>> graphene::app::database_api::get_workers_by_account(
const std::string account_name_or_id)const
{% tabs %} {% tab title="Parameters" %}
account_name_or_id
: The name or ID of the account whose worker should be retrieved {% endtab %}
{% tab title="Return" %} A list of worker objects owned by the account. {% endtab %} {% endtabs %}
Given a set of votes, returns the objects they are voting for.
This will be a mixture of committee_member_objects
, witness_objects
, and worker_objects
vector<variant> graphene::app::database_api::lookup_vote_ids(
const vector<vote_id_type> &votes)const
{% tabs %} {% tab title="Parameters" %}
votes
: a list of vote IDs {% endtab %}
{% tab title="Return" %} The referenced objects
The results will be in the same order as the votes. Null will be returned for any vote IDs that are not found. {% endtab %} {% endtabs %}
Get a hexdump of the serialized binary form of a transaction.
std::string graphene::app::database_api::get_transaction_hex(
const signed_transaction &trx)const
{% tabs %} {% tab title="Parameters" %}
trx
: a transaction to get hexdump from {% endtab %}
{% tab title="Return" %} The hexdump of the transaction. {% endtab %} {% endtabs %}
This API will take a partially signed transaction and a set of public keys that the owner has the ability to sign for and return the minimal subset of public keys that should add signatures to the transaction.
set<public_key_type> graphene::app::database_api::get_required_signatures(
const signed_transaction &trx,
const flat_set<public_key_type> &available_keys)const
{% tabs %} {% tab title="Parameters" %}
trx
: the transaction to be signedavailable_keys
: a set of public keys {% endtab %}
{% tab title="Return" %}
A subset of available_keys
that could sign for the given transaction.
{% endtab %}
{% endtabs %}
This method will return the set of all public keys that could possibly sign for a given transaction. This call can be used by wallets to filter their set of public keys to just the relevant subset prior to calling get_required_signatures to get the minimum subset.
set<public_key_type> graphene::app::database_api::get_potential_signatures(
const signed_transaction &trx)const
{% tabs %} {% tab title="Parameters" %}
trx
: the transaction to be signed {% endtab %}
{% tab title="Return" %} A set of public keys that could possibly sign for the given transaction. {% endtab %} {% endtabs %}
This method will return the set of all addresses that could possibly sign for a given transaction.
set<address> graphene::app::database_api::get_potential_address_signatures(
const signed_transaction &trx)const
{% tabs %} {% tab title="Parameters" %}
trx
: the transaction to be signed {% endtab %}
{% tab title="Return" %} A set of addresses that could possibly sign for the given transaction. {% endtab %} {% endtabs %}
Check whether a transaction has all of the required signatures
bool graphene::app::database_api::verify_authority(
const signed_transaction &trx)const
{% tabs %} {% tab title="Parameters" %}
trx
: a transaction to be verified {% endtab %}
{% tab title="Return" %}
true if the trx
has all of the required signatures, otherwise throws an exception**.**
{% endtab %}
{% endtabs %}
Verify that the public keys have enough authority to approve an operation for this account.
bool graphene::app::database_api::verify_account_authority(
const string &account_name_or_id,
const flat_set<public_key_type> &signers)const
{% tabs %} {% tab title="Parameters" %}
account_name_or_id
: name or ID of an account to checksigners
: the public keys {% endtab %}
{% tab title="Return" %} true if the passed in keys have enough authority to approve an operation for this account**.** {% endtab %} {% endtabs %}
Validates a transaction against the current state without broadcasting it on the network.
processed_transaction graphene::app::database_api::validate_transaction(
const signed_transaction &trx)const
{% tabs %} {% tab title="Parameters" %}
trx
: a transaction to be validated {% endtab %}
{% tab title="Return" %} A processed_transaction object if the transaction passes the validation, otherwise an exception will be thrown. {% endtab %} {% endtabs %}
For each operation calculate the required fee in the specified asset type.
vector<fc::variant> graphene::app::database_api::get_required_fees(
const vector<operation> &ops,
const std::string &asset_symbol_or_id)const
{% tabs %} {% tab title="Parameters" %}
ops
: a list of operations to be query for required feesasset_symbol_or_id
: symbol name or ID of an asset that to be used to pay the fees {% endtab %}
{% tab title="Return" %} A _**_list of objects which indicates required fees of each operation {% endtab %} {% endtabs %}
Gets a set of proposed transactions (proposals) that the specified account can add approval to or remove approval from.
vector<proposal_object> graphene::app::database_api::get_proposed_transactions(
const std::string account_name_or_id)const
{% tabs %} {% tab title="Parameters" %}
account_name_or_id
: The name or ID of an account {% endtab %}
{% tab title="Return" %} A set of proposed transactions that the specified account can act on. {% endtab %} {% endtabs %}
Gets the set of blinded balance objects by commitment ID.
vector<blinded_balance_object> graphene::app::database_api::get_blinded_balances(
const flat_set<commitment_type> &commitments)const
{% tabs %} {% tab title="Parameters" %}
commitments
: a set of commitments to query for {% endtab %}
{% tab title="Return" %} The set of blinded balance objects by commitment ID. {% endtab %} {% endtabs %}