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

The Query API from NEAR Protocol — 1 operation(s) for query.

NEAR Protocol Query 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 Query. 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 38 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 38 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.

Query 1
POST
/query
This module allows you to make generic requests to the network. The RpcQueryRequest struct takes in a [BlockReference](https://docs.rs/near-primitives/0.12.0/nearprimitives/types/enum.BlockReference.…
query body → 200

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are AccountView (7 properties), JsonRpcRequest_for_query (4 properties), ViewStateResult (3 properties), StateItem (2 properties). Each schema is shown below with its type and property counts.

PrepareError
Error that can occur while preparing or executing Wasm smart-contract.
NearToken
string
AccessKeyList
object
Lists access keys
1 property 1 required
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…
Finality
string
Different types of finality.
FunctionArgs
string
This type is used to mark function arguments. NOTE: The main reason for this to exist (except the type-safety) is that the value is transparently serialized an…
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…
HostError
ContractCodeView
object
A view of the contract code.
2 properties 2 required
JsonRpcResponse_for_RpcQueryResponse_and_RpcQueryError
object
2 properties 2 required
AccessKeyView
object
Describes access key permission scope and nonce.
2 properties 2 required
CompilationError
ErrorWrapper_for_RpcQueryError
InternalError
SyncCheckpoint
string
BlockReference
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…
CallResult
object
A result returned by contract method
2 properties 2 required
PublicKeyHandle
string
AccountView
object
A view of the account
7 properties 4 required
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…
WasmTrap
A kind of a trap happened during execution of a binary
FunctionCallError
Serializable version of near-vm-runner::FunctionCallError. Must never reorder/remove elements, can only add new variants at the end (but do that very carefully…
AccessKeyInfoView
object
Describes information about an access key including its on-trie identifier. For ed25519/secp256k1 access keys the publickey field is the full public key (strin…
2 properties 2 required
PublicKey
string
JsonRpcRequest_for_query
object
4 properties 4 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
ViewStateResult
object
Resulting state values for a view state query request
3 properties 1 required
CryptoHash
string
BlockId
AccessKeyPermissionView
Describes the permission scope for an access key. Whether it is a function call or a full access key.
RpcQueryResponse
object
2 properties 2 required
GasKeyNoncesView
object
Gas key nonces view returned by the viewgaskeynonces RPC query.
1 property 1 required
MethodResolveError
string
RpcRequestValidationErrorKind
RpcQueryRequest
object
RpcQueryError
GlobalContractIdentifier

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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