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 Health API

The Health API from NEAR Protocol — 1 operation(s) for health.

NEAR Protocol Health 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 Health. 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 10 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 10 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.

Health 1
POST
/health
Returns the current health status of the RPC node the client connects to.
health body → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are JsonRpcRequest_for_health (4 properties), JsonRpcResponse_for_Nullable_RpcHealthResponse_and_RpcStatusError (2 properties). Each schema is shown below with its type and property counts.

CryptoHash
string
JsonRpcRequest_for_health
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
RpcHealthResponse
InternalError
RpcHealthRequest
RpcRequestValidationErrorKind
RpcStatusError
JsonRpcResponse_for_Nullable_RpcHealthResponse_and_RpcStatusError
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

near-health-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