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

The EXPERIMENTAL Protocol Config API from NEAR Protocol — 1 operation(s) for experimental protocol config.

NEAR Protocol EXPERIMENTAL Protocol 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 EXPERIMENTAL Protocol 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 37 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 37 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 Protocol Config 1
POST
/EXPERIMENTAL_protocol_config
A configuration that defines the protocol-level parameters such as gas/storage costs, limits, feature flags, other settings
EXPERIMENTAL_protocol_config body → 200

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are ExtCostsConfigView (90 properties), LimitConfig (39 properties), RpcProtocolConfigResponse (31 properties), VMConfigView (21 properties). Each schema is shown below with its type and property counts.

AccountIdValidityRulesVersion
integer
NearToken
string
ActionCreationConfigView
object
Describes the cost of creating a specific action, Action. Includes all variants.
11 properties
AccountCreationConfigView
object
The structure describes configuration for creation of new accounts.
2 properties
ShardLayoutV2
object
Counterpart to ShardLayoutV2 composed of maps with string keys to aid serde serialization.
7 properties 5 required
Finality
string
Different types of finality.
ShardLayoutV3
object
Counterpart to ShardLayoutV3 composed of maps with string keys to aid serde serialization.
5 properties 5 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…
NearGas
integer
ShardLayout
A versioned struct that contains all information needed to assign accounts to shards. Because of re-sharding, the chain may use different shard layout to split…
RpcProtocolConfigRequest
object
CongestionControlConfigView
object
The configuration for congestion control. More info about congestion [here](https://near.github.io/nearcore/architecture/how/receipt-congestion.html?highlight=…
12 properties
ShardLayoutV0
object
A shard layout that maps accounts evenly across all shards -- by calculate the hash of account id and mod number of shards. This is added to capture the old ac…
2 properties 2 required
RpcProtocolConfigError
AccessKeyCreationConfigView
object
Describes the cost of creating an access key.
3 properties 3 required
ShardLayoutV1
object
4 properties 2 required
RpcProtocolConfigResponse
object
31 properties
DataReceiptCreationConfigView
object
The fees settings for a data receipt creation
2 properties
InternalError
SyncCheckpoint
string
VMKind
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…
JsonRpcResponse_for_RpcProtocolConfigResponse_and_RpcProtocolConfigError
object
2 properties 2 required
VMConfigView
object
21 properties
Fee
object
Costs associated with an object that can only be sent over the network (and executed by the receiver). NOTE: sendsir or sendnotsir fees are usually burned when…
3 properties 3 required
LimitConfig
object
Describes limits for VM and Runtime. TODO 4139: consider switching to strongly-typed wrappers instead of raw quantities
39 properties
WitnessConfigView
object
Configuration specific to ChunkStateWitness.
3 properties
RuntimeConfigView
object
View that preserves JSON format of the runtime config.
6 properties
CryptoHash
string
BlockId
ExtCostsConfigView
object
Typed view of ExtCostsConfig to preserve JSON output field names in protocol config RPC output.
90 properties
JsonRpcRequest_for_EXPERIMENTAL_protocol_config
object
4 properties 4 required
RuntimeFeesConfigView
object
Describes different fees for the runtime
7 properties
StorageUsageConfigView
object
Describes cost of storage per block
2 properties
StorageGetMode
string
This enum represents if a storageget call will be performed through flat storage or trie
RpcRequestValidationErrorKind
ErrorWrapper_for_RpcProtocolConfigError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

near-experimental-protocol-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 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