View Source Aptos.RestClient (Aptos v0.2.2)
JSON endpoints to read data from the network
Link to this section Summary
Functions
Retrieves estimated gas price from node.
Retrieves a collection of account modules' bytecode for a given account.
Retrieves a collection of account resources for a given account.
Retrieves on-chain committed transactions from an account.
Retrieves all account modules' bytecode for a given account, automatically running through pagination.
Retrieves all account resources for a given account, automatically running through pagination.
Fetches events by creation number.
Fetches events by event handle.
Retrieves on-chain committed transactions.
Fetches the authentication key and the sequence number for an account address.
Retrieves an individual module from a given account.
Retrieves an individual resource from a given account.
Fetches a block by its height.
Fetches a block by a version in the block.
Retrieves a table item.
Looks up a transaction by its hash.
Retrieves a transaction by a given version.
Link to this section Functions
@spec estimate_gas_price() :: Aptos.Client.Result.from_tesla()
Retrieves estimated gas price from node.
@spec list_account_modules( binary(), keyword() ) :: Aptos.Client.Result.from_tesla()
Retrieves a collection of account modules' bytecode for a given account.
Available options are:
{:ledger_version, pos_integer()}
{:limit, pos_integer()}
{:start, String.t()}
@spec list_account_resources( binary(), keyword() ) :: Aptos.Client.Result.from_tesla()
Retrieves a collection of account resources for a given account.
Available options are:
{:ledger_version, pos_integer()}
{:limit, pos_integer()}
{:start, String.t()}
@spec list_account_tx( binary(), keyword() ) :: Aptos.Client.Result.from_tesla()
Retrieves on-chain committed transactions from an account.
Available options are:
{:limit, pos_integer()}
{:start, pos_integer()}
@spec list_all_account_modules( binary(), keyword() ) :: Aptos.Client.Result.from_tesla()
Retrieves all account modules' bytecode for a given account, automatically running through pagination.
Available options are:
{:ledger_version, pos_integer()}
@spec list_all_account_resources( binary(), keyword() ) :: Aptos.Client.Result.from_tesla()
Retrieves all account resources for a given account, automatically running through pagination.
Available options are:
{:ledger_version, pos_integer()}
list_events_by_creation_number(address, creation_number, opts \\ [])
View Source@spec list_events_by_creation_number(binary(), pos_integer(), keyword()) :: Aptos.Client.Result.from_tesla()
Fetches events by creation number.
Available options are:
{:limit, pos_integer()}
{:start, pos_integer()}
@spec list_events_by_handle(binary(), String.t(), String.t(), keyword()) :: Aptos.Client.Result.from_tesla()
Fetches events by event handle.
Available options are:
{:limit, pos_integer()}
{:start, pos_integer()}
@spec list_tx(keyword()) :: Aptos.Client.Result.from_tesla()
Retrieves on-chain committed transactions.
Available options are:
{:limit, pos_integer()}
{:start, pos_integer()}
@spec show_account( binary(), keyword() ) :: Aptos.Client.Result.from_tesla()
Fetches the authentication key and the sequence number for an account address.
Available options are:
{:ledger_version, pos_integer()}
@spec show_account_module(binary(), String.t(), keyword()) :: Aptos.Client.Result.from_tesla()
Retrieves an individual module from a given account.
Available options are:
{:ledger_version, pos_integer()}
@spec show_account_resource(binary(), String.t(), keyword()) :: Aptos.Client.Result.from_tesla()
Retrieves an individual resource from a given account.
Available options are:
{:ledger_version, pos_integer()}
@spec show_block_by_height( non_neg_integer(), keyword() ) :: Aptos.Client.Result.from_tesla()
Fetches a block by its height.
@spec show_block_by_version( non_neg_integer(), keyword() ) :: Aptos.Client.Result.from_tesla()
Fetches a block by a version in the block.
Retrieves a table item.
Available options are:
{:ledger_version, pos_integer()}
@spec show_tx_by_hash(String.t()) :: Aptos.Client.Result.from_tesla()
Looks up a transaction by its hash.
@spec show_tx_by_version(pos_integer()) :: Aptos.Client.Result.from_tesla()
Retrieves a transaction by a given version.