Account History API¶
The history API is available from the full node via websockets.
If you have not set up your websockets connection, please read this article.
Table of Contents
Account History¶
get_account_history¶
-
vector<operation_history_object>
graphene::app::history_api
::
get_account_history
(const std::string &account_name_or_id, operation_history_id_type stop = operation_history_id_type(), uint32_t limit = application_options::get_default().api_limit_get_account_history, operation_history_id_type start = operation_history_id_type()) const¶ Get the history of operations related to the specified account.
- Return
A list of operations related to the specified account, ordered from most recent to oldest.
- Parameters
account_name_or_id
: The account name or ID whose history should be queriedstop
: ID of the earliest operation to retrievelimit
: Maximum number of operations to retrieve, must not exceed the configured value of api_limit_get_account_historystart
: ID of the most recent operation to retrieve
get_account_history_operations¶
-
vector<operation_history_object>
graphene::app::history_api
::
get_account_history_operations
(const std::string &account_name_or_id, int64_t operation_type, operation_history_id_type start = operation_history_id_type(), operation_history_id_type stop = operation_history_id_type(), uint32_t limit = application_options::get_default().api_limit_get_account_history_operations) const¶ Get the history of operations related to the specified account filtering by operation type.
- Return
A list of operations related to the specified account, ordered from most recent to oldest.
- Parameters
account_name_or_id
: The account name or ID 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 the configured value of api_limit_get_account_history_operationsstart
: ID of the most recent operation to retrieve
get_relative_account_history¶
-
vector<operation_history_object>
graphene::app::history_api
::
get_relative_account_history
(const std::string &account_name_or_id, uint64_t stop = 0, uint32_t limit = application_options::get_default().api_limit_get_relative_account_history, uint64_t start = 0) const¶ Get the history of operations related 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).
- Return
A list of operations related to the specified account, ordered from most recent to oldest.
- Parameters
account_name_or_id
: The account name or ID 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 the configured value of api_limit_get_relative_account_historystart
: Sequence number of the most recent operation to retrieve. 0 is default, which will start querying from the most recent operation.
Market History¶
get_fill_order_history¶
-
vector<order_history_object>
graphene::app::history_api
::
get_fill_order_history
(const std::string &a, const std::string &b, uint32_t limit) const¶ Get details of order executions occurred most recently in a trading pair.
- Return
a list of order_history objects, in “most recent first” order
- Parameters
a
: Asset symbol or ID in a trading pairb
: The other asset symbol or ID in the trading pairlimit
: Maximum records to return
get_market_history¶
-
vector<bucket_object>
graphene::app::history_api
::
get_market_history
(const std::string &a, const std::string &b, uint32_t bucket_seconds, const fc::time_point_sec &start, const fc::time_point_sec &end) const¶ Get OHLCV data of a trading pair in a time range.
- Return
A list of OHLCV data, in “least recent first” order. If there are more records in the specified time range than the configured value of api_limit_get_market_history, only the first records will be returned.
- Parameters
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 need to be within result of get_market_history_buckets() API, otherwise no data will be returnedstart
: The start of a time range, E.G. “2018-01-01T00:00:00”end
: The end of the time range
get_market_history_buckets¶
-
flat_set<uint32_t>
graphene::app::history_api
::
get_market_history_buckets
() const¶ Get OHLCV time bucket lengths supported (configured) by this API server.
- Return
A list of time bucket lengths in seconds. E.G. if the result contains a number “300”, it means this API server supports OHLCV data aggregated in 5-minute buckets.