API Reference
Peerplays API Libraries
Development Guides
The Cookbook
Tools and Integrations
Supporting & Reference Docs
Development Workflow Docs
Other Documentation
Account History
The history API is available from the full node via websockets.
Account History
get_account_history
Get operations relevant to the specified account.
1
vector<operation_history_object> graphene::app::history_api::get_account_history(
2
const std::string account_id_or_name,
3
operation_history_id_type stop = operation_history_id_type(),
4
unsigned limit = 100,
5
operation_history_id_type start = operation_history_id_type())const
Copied!
Parameters
Return
account_id_or_name: The account ID or name whose history should be queriedstop: ID of the earliest operation to retrievelimit: Maximum number of operations to retrieve (must not exceed 100)start: ID of the most recent operation to retrieve
A list of operations performed by account, ordered from most recent to oldest.
get_account_history_operations
Get only asked operations relevant to the specified account.
1
vector<operation_history_object> graphene::app::history_api::get_account_history_operations(
2
const std::string account_id_or_name,
3
int operation_type,
4
operation_history_id_type start = operation_history_id_type(),
5
operation_history_id_type stop = operation_history_id_type(),
6
unsigned limit = 100)const
Copied!
Parameters
Return
account_id_or_name: The account ID or name whose history should be queriedoperation_type: The type of the operation we want to get operations in the account ( 0 = transfer , 1 = limit order create, …)stop: ID of the earliest operation to retrievelimit: Maximum number of operations to retrieve (must not exceed 100)start: ID of the most recent operation to retrieve
A list of operations performed by account, ordered from most recent to oldest.
get_relative_account_history
Get operations relevant to the specified account referenced by an event numbering specific to the account. The current number of operations for the account can be found in the account statistics (or use 0 for start).
1
vector<operation_history_object> graphene::app::history_api::get_relative_account_history(
2
const std::string account_id_or_name,
3
uint64_t stop = 0,
4
unsigned limit = 100,
5
uint64_t start = 0)const
Copied!
Parameters
Return
account_id_or_name: The account ID or name whose history should be queriedstop: Sequence number of earliest operation. 0 is default and will query ‘limit’ number of operations.limit: Maximum number of operations to retrieve (must not exceed 100)start: Sequence number of the most recent operation to retrieve. 0 is default, which will start querying from the most recent operation.
A list of operations performed by account, ordered from most recent to oldest.
Market History
get_fill_order_history
Get details of order executions occurred most recently in a trading pair.
1
vector<order_history_object> graphene::app::history_api::get_fill_order_history(
2
std::string a,
3
std::string b,
4
uint32_t limit)const
Copied!
Parameters
Return
a: Asset symbol or ID in a trading pairb: The other asset symbol or ID in the trading pairlimit: Maximum records to return
a list of order_history objects, in most recent first order
get_market_history
Get OHLCV data of a trading pair in a time range.
1
vector<bucket_object> graphene::app::history_api::get_market_history(
2
std::string a,
3
std::string b,
4
uint32_t bucket_seconds,
5
fc::time_point_sec start,
6
fc::time_point_sec end)const
Copied!
Parameters
Return
a: Asset symbol or ID in a trading pairb: The other asset symbol or ID in the trading pairbucket_seconds: Length of each time bucket in seconds.
Note: It needs to be within result of get_market_history_buckets(), otherwise no data will be returned
start: The start of a time range, E.G. “2018-01-01T00:00:00”end: The end of the time range
A list of OHLCV data, in least recent first order.
If there are more than 200 records in the specified time range, the first 200 records will be returned.
get_market_history_buckets
Get OHLCV time bucket lengths supported (configured) by this API server.
1
flat_set<uint32_t> graphene::app::history_api::get_market_history_buckets()const
Copied!
Return
A list of time bucket lengths in seconds.
For example, if the result contains a number “300” it means this API server supports OHLCV data aggregated in 5-minute buckets.