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 EXPERIMENTAL View State API

The EXPERIMENTAL View State API from NEAR Protocol — 1 operation(s) for experimental view state.

NEAR Protocol EXPERIMENTAL View State 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 EXPERIMENTAL View State. 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 17 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 17 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.

EXPERIMENTAL View State 1
POST
/EXPERIMENTAL_view_state
Returns the state (key-value pairs) of a contract based on the key prefix.
EXPERIMENTAL_view_state body → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are RpcViewStateRequest (5 properties), RpcViewStateResponse (5 properties), JsonRpcRequest_for_EXPERIMENTAL_view_state (4 properties), StateItem (2 properties). Each schema is shown below with its type and property counts.

CryptoHash
string
BlockId
StoreValue
string
This type is used to mark values returned from store (arrays of bytes). NOTE: Currently, this type is only used in the viewclient and RPC to be able to transpa…
RpcViewStateResponse
object
Resulting state values for a view state query request
5 properties 3 required
JsonRpcRequest_for_EXPERIMENTAL_view_state
object
4 properties 4 required
SyncCheckpoint
string
RpcViewStateError
InternalError
Finality
string
Different types of finality.
RpcRequestValidationErrorKind
ErrorWrapper_for_RpcViewStateError
JsonRpcResponse_for_RpcViewStateResponse_and_RpcViewStateError
object
2 properties 2 required
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…
StoreKey
string
This type is used to mark keys (arrays of bytes) that are queried from store. NOTE: Currently, this type is only used in the viewclient and RPC to be able to t…
BlockReference
RpcViewStateRequest
object
5 properties 2 required
StateItem
object
Item of the state, key and value are serialized in base64 and proof for inclusion of given state item.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

near-experimental-view-state-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