Node

The node resource is useful for service discovery, health checks, and obtaining network configurations, such as fees, API, and token information.

Note that these parameters are returned by the specific Node and that other nodes might adhere to a different set of parameters.

Endpoints

Retrieve the configuration

Used to access a Node’s configuration and the network it is attached to (identified by the nethash).

Endpoint

GET

Retrieve the Cryptography Configuration

Used to access a Node’s configuration for the @arkecosystem/crypto package that handles all cryptography operations.

Endpoint

GET

Retrieve the Fee Statistics

Used to access a Node’s fee statistics. By default, this endpoint returns calculations based on the 20 most-recent transactions for each type. Also note while using the days query that statistics may not be available for all transaction-types over a given period of time.

Endpoint

GET

Query Parameters

Name days
Description
The number of days [1-30] to search.
Required No
Example

Retrieve the status

The status allows for health checking, showing if the node is in sync with the network.

Endpoint

GET

Retrieve the Syncing Status

The syncing resource is very much alike node/status, providing information on the syncing progress. If a node is not syncing but significantly behind in blocks, it might be time to perform a check.

Endpoint

GET
Last updated 4 years ago
Edit Page
Share: