Documentation Index Fetch the complete documentation index at: https://docs.near.org/llms.txt
Use this file to discover all available pages before exploring further.
The RPC API enables you to query the network and get details about specific blocks or chunks.
Quick Reference Method Description Parameters blockGet block details by height, hash, or finality finality OR block_idblock_effectsGet changes in a specific block finality OR block_idchunkGet chunk details by chunk_id or block_id + shard_id chunk_id OR block_id + shard_id
Block Details Queries network and returns block for given height or hash. You can also use finality param to return latest block details.
Note : You may choose to search by a specific block or finality, you cannot choose both.
method : blockparams : finality OR block_id
by finality
by block height
by block hash
{ "jsonrpc" : "2.0" , "id" : "dontcare" , "method" : "block" , "params" : { "finality" : "final" } }
import { JsonRpcProvider } from "near-api-js" ; const provider = new JsonRpcProvider ({ url: "https://test.rpc.fastnear.com" , }); const response = await provider. block ({ finality: 'final' , });
http POST https://rpc.testnet.near.org \ jsonrpc= 2.0 \ id=dontcare \ method=block \ params:='{"finality": "final"}'
{ "jsonrpc" : "2.0" , "id" : "dontcare" , "method" : "block" , "params" : { "block_id" : 187310138 } }
import { JsonRpcProvider } from "near-api-js" ; const provider = new JsonRpcProvider ({ url: "https://archival-rpc.testnet.near.org" , }); const response = await provider. block ({ blockId: 187310138 , });
http POST https://archival-rpc.testnet.near.org \ jsonrpc= 2.0 \ id=dontcare \ method=block \ params:='{"block_id": 187310138}'
{ "jsonrpc" : "2.0" , "id" : "dontcare" , "method" : "block" , "params" : { "block_id" : "6RWmTYhXCzjMjoY3Mz1rfFcnBm8E6XeDDbFEPUA4sv1w" } }
import { JsonRpcProvider } from "near-api-js" ; const provider = new JsonRpcProvider ({ url: "https://archival-rpc.testnet.near.org" , }); const response = await provider. block ({ blockId: '6RWmTYhXCzjMjoY3Mz1rfFcnBm8E6XeDDbFEPUA4sv1w' , });
http POST https://archival-rpc.testnet.near.org \ jsonrpc= 2.0 \ id=dontcare \ method=block \ params:='{"block_id": "6RWmTYhXCzjMjoY3Mz1rfFcnBm8E6XeDDbFEPUA4sv1w"}'
{ "jsonrpc" : "2.0" , "result" : { "author" : "node2" , "chunks" : [ { "chunk_hash" : "CzPafxtJmM1FnRoasKWAVhceJzZzkz9RKUBQQ4kY9V1v" , "shard_id" : 0 , "gas_limit" : 1000000000000000 , "gas_used" : 0 , "height_created" : 187310138 , "height_included" : 187310138 } ], "header" : { "hash" : "6RWmTYhXCzjMjoY3Mz1rfFcnBm8E6XeDDbFEPUA4sv1w" , "height" : 187310138 , "timestamp" : 1739254177539033760 , "gas_price" : "100000000" , "latest_protocol_version" : 73 } }, "id" : "dontcare" }
Block Effects Returns changes in a block for given block height or hash. Includes changes like account_touched, access_key_touched, data_touched, contract_code_touched.
method : block_effectsparams : finality OR block_id
by finality
by block height
by block hash
{ "jsonrpc" : "2.0" , "id" : "dontcare" , "method" : "block_effects" , "params" : { "finality" : "final" } }
import { JsonRpcProvider } from "near-api-js" ; const provider = new JsonRpcProvider ({ url: "https://test.rpc.fastnear.com" , }); const response = await provider. blockChanges ({ finality: 'final' , });
http POST https://rpc.testnet.near.org \ jsonrpc= 2.0 \ id=dontcare \ method=block_effects \ params:='{"finality": "final"}'
{ "jsonrpc" : "2.0" , "id" : "dontcare" , "method" : "block_effects" , "params" : { "block_id" : 187310138 } }
import { JsonRpcProvider } from "near-api-js" ; const provider = new JsonRpcProvider ({ url: "https://archival-rpc.testnet.near.org" , }); const response = await provider. blockChanges ({ blockId: 187310138 , });
http POST https://archival-rpc.testnet.near.org \ jsonrpc= 2.0 \ id=dontcare \ method=block_effects \ params:='{"block_id": 187310138}'
{ "jsonrpc" : "2.0" , "id" : "dontcare" , "method" : "block_effects" , "params" : { "block_id" : "6RWmTYhXCzjMjoY3Mz1rfFcnBm8E6XeDDbFEPUA4sv1w" } }
import { JsonRpcProvider } from "near-api-js" ; const provider = new JsonRpcProvider ({ url: "https://archival-rpc.testnet.near.org" , }); const response = await provider. blockChanges ({ blockId: '6RWmTYhXCzjMjoY3Mz1rfFcnBm8E6XeDDbFEPUA4sv1w' , });
http POST https://archival-rpc.testnet.near.org \ jsonrpc= 2.0 \ id=dontcare \ method=block_effects \ params:='{"block_id": "6RWmTYhXCzjMjoY3Mz1rfFcnBm8E6XeDDbFEPUA4sv1w"}'
{ "jsonrpc" : "2.0" , "result" : { "block_hash" : "6RWmTYhXCzjMjoY3Mz1rfFcnBm8E6XeDDbFEPUA4sv1w" , "block_effects" : [ { "account_id" : "account.rpc-examples.testnet" , "type" : "account_touched" }, { "account_id" : "ping-account.testnet" , "type" : "account_touched" }, { "account_id" : "account.rpc-examples.testnet" , "type" : "access_key_touched" }, { "account_id" : "dev2-nsp.testnet" , "type" : "data_touched" } ] }, "id" : "dontcare" }
Chunk Details Returns details of a specific chunk. You can run a block details query to get a valid chunk hash.
method : chunkparams : chunk_id OR block_id + shard_id
by chunk_id
by block_id + shard_id
{ "jsonrpc" : "2.0" , "id" : "dontcare" , "method" : "chunk" , "params" : { "chunk_id" : "CzPafxtJmM1FnRoasKWAVhceJzZzkz9RKUBQQ4kY9V1v" } }
import { JsonRpcProvider } from "near-api-js" ; const provider = new JsonRpcProvider ({ url: "https://archival-rpc.testnet.near.org" , }); const response = await provider. chunk ( 'CzPafxtJmM1FnRoasKWAVhceJzZzkz9RKUBQQ4kY9V1v' , );
http POST https://archival-rpc.testnet.near.org \ jsonrpc= 2.0 \ id=dontcare \ method=chunk \ params:='{"chunk_id": "CzPafxtJmM1FnRoasKWAVhceJzZzkz9RKUBQQ4kY9V1v"}'
{ "jsonrpc" : "2.0" , "id" : "dontcare" , "method" : "chunk" , "params" : { "block_id" : 187310138 , "shard_id" : 0 } }
import { JsonRpcProvider } from "near-api-js" ; const provider = new JsonRpcProvider ({ url: "https://archival-rpc.testnet.near.org" , }); const response = await provider. chunk ([ 187310138 , 0 ]);
http POST https://archival-rpc.testnet.near.org \ jsonrpc= 2.0 \ id=dontcare \ method=chunk \ params:='{"block_id": 187310138, "shard_id": 0}'
{ "jsonrpc" : "2.0" , "result" : { "author" : "kiln.pool.f863973.m0" , "header" : { "chunk_hash" : "CzPafxtJmM1FnRoasKWAVhceJzZzkz9RKUBQQ4kY9V1v" , "shard_id" : 0 , "gas_limit" : 1000000000000000 , "gas_used" : 0 , "height_created" : 187310138 , "height_included" : 187310138 }, "receipts" : [], "transactions" : [ { "hash" : "J3KbUXF9YPu2eGnbDCACxGvmMDZMdP7acGYhVLHGu9y2" , "signer_id" : "account.rpc-examples.testnet" , "receiver_id" : "contract.rpc-examples.testnet" } ] }, "id" : "dontcare" }
Error Handling Error Code Description Solution UNKNOWN_BLOCKBlock not found or garbage-collected Check block validity; use archival node for old blocks UNKNOWN_CHUNKChunk not found in database Verify chunk ID; use archival node for old chunks INVALID_SHARD_IDShard ID does not exist Provide valid shard ID for existing shard NOT_SYNCED_YETNode still syncing Wait for sync completion or use different node PARSE_ERRORInvalid request parameters Check parameter format and completeness INTERNAL_ERRORServer-side issue Retry request or try different RPC endpoint
