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

The Block API from NEAR Protocol — 1 operation(s) for block.

NEAR Protocol Block 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 Block. 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 31 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 31 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.

Block 1
POST
/block
Returns block details for given height or hash
block body → 200

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are BlockHeaderView (37 properties), ChunkHeaderView (21 properties), CongestionInfoView (4 properties), JsonRpcRequest_for_block (4 properties). Each schema is shown below with its type and property counts.

BandwidthRequestBitmap
object
Bitmap which describes which values from the predefined list are being requested. The nth bit is set to 1 when the nth value from the list is being requested.
1 property 1 required
NearToken
string
ValidatorStakeViewV1
object
3 properties 3 required
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
Finality
string
Different types of finality.
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…
NearGas
integer
JsonRpcResponse_for_RpcBlockResponse_and_RpcBlockError
object
2 properties 2 required
SlashedValidator
object
2 properties 2 required
ValidatorStakeView
BandwidthRequest
object
BandwidthRequest describes the size of receipts that a shard would like to send to another shard. When a shard wants to send a lot of receipts to another shard…
2 properties 2 required
TrieSplit
object
The result of splitting a memtrie into two possibly even parts, according to memoryusage stored in the trie nodes. NOTE: This is an artificial value calculated…
3 properties 3 required
CongestionInfoView
object
Stores the congestion level of a shard. More info about congestion [here](https://near.github.io/nearcore/architecture/how/receipt-congestion.html?highlight=co…
4 properties 4 required
InternalError
SyncCheckpoint
string
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…
JsonRpcRequest_for_block
object
4 properties 4 required
ChunkHeaderView
object
Contains main info about the chunk.
21 properties 16 required
SpiceChunkEndorsementStats
object
Per-validator chunk endorsement stats accumulated over a spice epoch, indexed by the current epoch's validator id. Carried on the last block of the epoch (see…
2 properties 2 required
BandwidthRequests
A list of shard's bandwidth requests. Describes how much the shard would like to send to other shards.
ErrorWrapper_for_RpcBlockError
PublicKey
string
BlockHeaderView
object
Contains main info about the block.
37 properties 27 required
RpcBlockError
CryptoHash
string
BlockId
BandwidthRequestsV1
object
Version 1 of [BandwidthRequest].
1 property 1 required
RpcRequestValidationErrorKind
Signature
string
RpcBlockRequest
object
RpcBlockResponse
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

near-block-api-openapi.yml Raw ↑

Other APIs NEAR Protocol publishes across the network.

NEAR Protocol accounts 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
NEAR Protocol EXPERIMENTAL Genesis Config API