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 Client Config API

The Client Config API from NEAR Protocol — 1 operation(s) for client config.

NEAR Protocol Client Config 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 Client Config. 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 29 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 29 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.

Client Config 1
POST
/client_config
Queries client node configuration
client_config body → 200

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are RpcClientConfigResponse (72 properties), JsonRpcRequest_for_client_config (4 properties), StateSyncConfig (4 properties), Version (4 properties). Each schema is shown below with its type and property counts.

TrackedShardsConfig
Describes the expected behavior of the node regarding shard tracking. If the node is an active validator, it will also track the shards it is responsible for a…
DurationAsStdSchemaProvider
object
2 properties 2 required
RpcClientConfigError
NearGas
integer
LogSummaryStyle
string
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…
ExternalStorageLocation
Supported external storage backends and their minimal config.
EpochSyncConfig
object
2 properties
ProtocolVersionCheckConfig
string
Configures whether the node checks the next or the next next epoch for network version compatibility.
DumpConfig
object
Configures how to dump state to external storage.
4 properties
ChunkDistributionUris
object
URIs for the Chunk Distribution Network feature.
2 properties
StateSyncConfig
object
4 properties
ErrorWrapper_for_RpcClientConfigError
InternalError
CloudArchivalWriterConfig
object
Configuration for a cloud-based archival writer. If this config is present, the writer is enabled and writes chunk-related data based on the tracked shards. Th…
3 properties
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…
GCConfig
object
Configuration for garbage collection.
4 properties
JsonRpcResponse_for_RpcClientConfigResponse_and_RpcClientConfigError
object
2 properties 2 required
Version
object
Data structure for semver version and github tag or commit.
4 properties 3 required
ShardUId
object
ShardUId is a unique representation for shards from different shard layouts. Comparing to ShardId, which is just an ordinal number ranging from 0 to NUMSHARDS-…
2 properties 2 required
MutableConfigValue
string
RpcClientConfigResponse
object
ClientConfig where some fields can be updated at runtime.
72 properties
SyncConcurrency
object
4 properties
ExternalStorageConfig
object
4 properties
SyncConfig
Configures how to fetch state parts during state sync.
RpcRequestValidationErrorKind
RpcClientConfigRequest
JsonRpcRequest_for_client_config
object
4 properties 4 required
ChunkDistributionNetworkConfig
object
Config for the Chunk Distribution Network feature. This allows nodes to push and pull chunks from a central stream. The two benefits of this approach are: (1)…
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

near-client-config-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 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