Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NEAR Protocol Status API

The Status API from NEAR Protocol — 1 operation(s) for status.

NEAR Protocol Status API is one of 60 APIs that NEAR Protocol publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Status. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and rate-limit docs.

This API exposes 1 operation across 1 path, and defines 24 schemas. It is described by OpenAPI 3.0.3, at version 3.0.3.

Requests are made against 2 base URLs: https://api.fastnear.com, https://test.api.fastnear.com.

1 operations 1 paths 24 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.3
Base URL
https://rpc.mainnet.near.org
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Status 1
POST
/status
Requests the status of the connected RPC node. This includes information about sync status, nearcore node version, protocol version, the current set of validators, etc.
status body → 200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are PeerInfoView (15 properties), RpcStatusResponse (14 properties), StatusSyncInfo (10 properties), NetworkInfoView (7 properties). Each schema is shown below with its type and property counts.

JsonRpcRequest_for_status
object
4 properties 4 required
ErrorWrapper_for_RpcStatusError
EpochId
Epoch identifier -- wrapped hash, to make it easier to distinguish. EpochId of epoch T is the hash of last block in T-2 EpochId of first two epochs is 0
AccountId
string
NEAR Account Identifier. This is a unique, syntactically valid, human-readable account identifier on the NEAR network. [See the crate-level docs for informatio…
ValidatorInfo
object
1 property 1 required
CatchupStatusView
object
Status of the [catchup](https://near.github.io/nearcore/architecture/how/sync.htmlcatchup) process
4 properties 4 required
JsonRpcResponse_for_RpcStatusResponse_and_RpcStatusError
object
2 properties 2 required
NetworkInfoView
object
7 properties 7 required
InternalError
RpcStatusError
PeerInfoView
object
15 properties 12 required
StatusSyncInfo
object
10 properties 5 required
ShardId
integer
The shard identifier. It may be an arbitrary number - it does not need to be a number in the range 0..NUMSHARDS. The shard ids do not need to be sequential or…
Tier1ProxyView
object
2 properties 2 required
KnownProducerView
object
Information about a Producer: its account name, peerid and a list of connected peers that the node can use to send message for this producer.
3 properties 2 required
Version
object
Data structure for semver version and github tag or commit.
4 properties 3 required
DetailedDebugStatus
object
6 properties 6 required
PublicKey
string
BlockStatusView
object
Height and hash of a block
2 properties 2 required
CryptoHash
string
RpcStatusResponse
object
14 properties 9 required
AccountDataView
object
AccountData is a piece of global state that a validator signs and broadcasts to the network. It is essentially the data that a validator wants to share with th…
4 properties 4 required
RpcRequestValidationErrorKind
RpcStatusRequest

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

near-status-api-openapi.yml Raw ↑

Other APIs NEAR Protocol publishes across the network.

NEAR Protocol accounts API
NEAR Protocol Block API
NEAR Protocol Block Effects API
NEAR Protocol Broadcast Tx Async API
NEAR Protocol Broadcast Tx Commit API
NEAR Protocol Changes API
NEAR Protocol Chunk API
NEAR Protocol Client Config API
NEAR Protocol EXPERIMENTAL Call Function API
NEAR Protocol EXPERIMENTAL Changes API
NEAR Protocol EXPERIMENTAL Changes In Block API
NEAR Protocol EXPERIMENTAL Congestion Level API