NEAR Protocol Chunk API
The Chunk API from NEAR Protocol — 1 operation(s) for chunk.
NEAR Protocol Chunk 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 Chunk. 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 62 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
62 schemas
1 POST
Metadata
The identity and technical contract details declared by the specification.
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.
Chunk 1
POST
/chunk
Returns details of a specific chunk. You can run a block details query to get a valid chunk hash.
Schemas 62
The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are ChunkHeaderView (21 properties), SignedTransactionView (10 properties), DelegateActionV2 (6 properties), DelegateAction (6 properties). Each schema is shown below with its type and property counts.
TransferToGasKeyAction
object
Transfer NEAR to a gas key's balance
2 properties
2 required
AddKeyAction
object
An action that adds key with public key associated
2 properties
2 required
StakeAction
object
An action which stakes signerid tokens and setup's validator public key
2 properties
2 required
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
AccessKey
object
Access key provides limited access to an account. Each access key belongs to some account and is identified by a unique (within the account) public key. One ac…
2 properties
2 required
DelegateActionV2
object
Delegate action with gas key support: nonce selects either the access key's nonce or one of a gas key's parallel nonces by index, mirroring TransactionV1.
6 properties
6 required
FunctionCallPermission
object
Grants limited permission to make transactions with FunctionCallActions The permission can limit the allowed balance to be spent on the prepaid gas. It also re…
3 properties
2 required
DeleteAccountAction
object
1 property
1 required
ErrorWrapper_for_RpcChunkError
ReceiptEnumView
GlobalContractIdentifierView
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…
NearGas
integer
UseGlobalContractAction
object
Use global contract action
1 property
1 required
GlobalContractDeployMode
CreateAccountAction
object
Create account action
AccessKeyView
object
Describes access key permission scope and nonce.
2 properties
2 required
ValidatorStakeView
DeployContractAction
object
Deploy contract action
1 property
1 required
TransactionNonce
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
TransferAction
object
1 property
1 required
GasKeyInfo
object
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
DeleteKeyAction
object
1 property
1 required
DataReceiverView
object
2 properties
2 required
DeterministicStateInitAction
object
2 properties
2 required
ChunkHash
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…
DelegateAction
object
This action allows to execute the inner actions behalf of the defined sender.
6 properties
6 required
RpcChunkRequest
object
JsonRpcResponse_for_RpcChunkResponse_and_RpcChunkError
object
2 properties
2 required
ChunkHeaderView
object
Contains main info about the chunk.
21 properties
16 required
RpcChunkError
RpcChunkResponse
object
4 properties
4 required
AccessKeyPermission
Defines permissions for AccessKey
NonceMode
Controls how the transaction nonce is validated against the access key nonce.
VersionedDelegateActionPayload
Versions of the delegate action carried by Action::DelegateV2. New versions add a variant here rather than a new Action variant. The variant is part of the sig…
BandwidthRequests
A list of shard's bandwidth requests. Describes how much the shard would like to send to other shards.
PublicKey
string
FunctionCallAction
object
4 properties
4 required
CryptoHash
string
BlockId
AccessKeyPermissionView
Describes the permission scope for an access key. Whether it is a function call or a full access key.
WithdrawFromGasKeyAction
object
Withdraw NEAR from a gas key's balance to the account. This action must only be available via transactions, not via contract execution (there is no correspondi…
2 properties
2 required
SignedTransactionView
object
10 properties
7 required
DeterministicAccountStateInitV1
object
2 properties
2 required
ActionView
BandwidthRequestsV1
object
Version 1 of [BandwidthRequest].
1 property
1 required
RpcRequestValidationErrorKind
DeterministicAccountStateInit
JsonRpcRequest_for_chunk
object
4 properties
4 required
Signature
string
NonDelegateAction
An Action that can be included in a transaction or receipt, excluding delegate actions. This type represents all possible action types except DelegateAction to…
ReceiptView
object
5 properties
4 required
GlobalContractIdentifier
DeployGlobalContractAction
object
Deploy global contract action
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NEAR Protocol 12
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 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
#Chunk