Skip to main content

Get Network Status

Retrieves the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here.

Request Body REQUIRED
network_identifier object REQUIRED

The network_identifier specifies which network a particular object is associated with.

blockchain string REQUIRED

Blockchain name

network string REQUIRED

If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet.

sub_network_identifier object

In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.

network string REQUIRED

Network name

metadata object

Meta data from subnetwork identifier

producer string REQUIRED

producer

metadata object
Responses
200

Success

Schema OPTIONAL
current_block_identifier object

The block_identifier uniquely identifies a block in a particular network.

hash string

This is also known as the block hash.

index integer

This is also known as the block height.

current_block_timestamp integer

The timestamp of the block in milliseconds since the Unix Epoch. The timestamp is stored in milliseconds because some blockchains produce blocks more often than once a second.

genesis_block_identifier object

The block_identifier uniquely identifies a block in a particular network.

index integer

This is also known as the block height.

hash string

Block hash

oldest_block_identifier object OPTIONAL

The block_identifier uniquely identifies a block in a particular network.

index integer

This is also known as the block height.

hash string

Block hash

sync_status object OPTIONAL

SyncStatus is used to provide additional context about an implementation's sync status. It is often used to indicate that an implementation is healthy when it cannot be queried until some sync phase occurs. If an implementation is immediately queryable, this model is often not populated.

current_index integer

CurrentIndex is the index of the last synced block in the current stage.

target_index integer OPTIONAL

TargetIndex is the index of the block that the implementation is attempting to sync to in the current stage.

stage string OPTIONAL

Stage is the phase of the sync process.

synced boolean OPTIONAL

Synced indicates if an implementation has synced up to the most recent block.

peers object[]

Peers information

peer_id string

peer id

metadata object OPTIONAL

meta data

current_burn_block_height integer

The latest burn block height

400

Error

Schema OPTIONAL
code integer

Code is a network-specific error code. If desired, this code can be equivalent to an HTTP status code.

message string

Message is a network-specific error message. The message MUST NOT change for a given code. In particular, this means that any contextual information should be included in the details field.

retriable boolean

An error is retriable if the same request may succeed if submitted again.

details object OPTIONAL

Often times it is useful to return context specific to the request that caused the error (i.e. a sample of the stack trace or impacted account) in addition to the standard error message.

address string OPTIONAL
error string OPTIONAL