Get Network Status

200

Expected response to a valid request

Response body

object

current_block_identifier

object

required

The block_identifier uniquely identifies a block in a particular network.

index

int64

required

This is also known as the block height.

hash

string

required

This should be normalized according to the case specified in the block_hash_case network options.

current_block_timestamp

int64

required

≥ 0

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

required

The block_identifier uniquely identifies a block in a particular network.

index

int64

required

This is also known as the block height.

hash

string

required

This should be normalized according to the case specified in the block_hash_case network options.

oldest_block_identifier

object

The block_identifier uniquely identifies a block in a particular network.

index

int64

required

This is also known as the block height.

hash

string

required

This should be normalized according to the case specified in the block_hash_case network options.

sync_status

object

SyncStatus is used to provide additional context about an implementation's sync status. This object is often used by implementations to indicate healthiness when block data cannot be queried until some sync phase completes or cannot be determined by comparing the timestamp of the most recent block with the current time.

current_index

int64

CurrentIndex is the index of the last synced block in the current stage. This is a separate field from current_block_identifier in NetworkStatusResponse because blocks with indices up to and including the current_index may not yet be queryable by the caller. To reiterate, all indices up to and including current_block_identifier in NetworkStatusResponse must be queryable via the /block endpoint (excluding indices less than oldest_block_identifier).

target_index

int64

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

stage

string

Stage is the phase of the sync process.

synced

boolean

synced is a boolean that indicates if an implementation has synced up to the most recent block. If this field is not populated, the caller should rely on a traditional tip timestamp comparison to determine if an implementation is synced. This field is particularly useful for quiescent blockchains (blocks only produced when there are pending transactions). In these blockchains, the most recent block could have a timestamp far behind the current time but the node could be healthy and at tip.

peers

array of objects

peers

object

peer_id

string

required

metadata

object

Has additional fields

500

unexpected error

Description allows the implementer to optionally provide additional information about an error. In many cases, the content of this field will be a copy-and-paste from existing developer documentation. Description can ONLY be populated with generic information about a particular type of error. It MUST NOT be populated with information about a particular instantiation of an error (use details for this). Whereas the content of Error.Message should stay stable across releases, the content of Error.Description will likely change across releases (as implementers improve error documentation). For this reason, the content in this field is not part of any type assertion (unlike Error.Message).

xxxxxxxxxx
curl --request POST \
     --url https://rpc.chain49.com/cardano/network/status \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "network_identifier": {
    "blockchain": "cardano",
    "network": "mainnet"
  }
}
'

200Expected response to a valid request

500unexpected error