getBlock RPC Method
Returns identity and transaction information about a confirmed block in the ledger
Parameters
u64 required
slot number, as u64 integer
object optional Configuration object containing the following fields:
-
commitment
stringoptional- Default:
finalizedprocessedis not supported.
- Default:
-
encoding
stringoptional-
Default:
jsonencoding format for each returned transaction -
json``jsonParsed``base58``base64jsonParsedattempts to use program-specific instruction parsers to return more human-readable and explicit data in thetransaction.message.instructionslist.- If
jsonParsedis requested but a parser cannot be found, the instruction falls back to regular JSON encoding (accounts,data, andprogramIdIndexfields).
-
-
transactionDetails
stringoptional Default:fulllevel of transaction detail to return Values:fullaccountssignaturesnone- If
accountsare requested, transaction details only include signatures and an annotated list of accounts in each transaction. - Transaction metadata is limited to only: fee, err, pre_balances, post_balances, pre_token_balances, and post_token_balances.
- If
-
maxSupportedTransactionVersion
numberoptional the max transaction version to return in responses.- If the requested block contains a transaction with a higher version, an error will be returned.
- If this parameter is omitted, only legacy transactions will be returned, and a block containing any versioned transaction will prompt the error.
-
rewards
booloptional whether to populate therewardsarray. If parameter not provided, the default includes rewards.
Result
The result field will be an object with the following fields:
<null>- if specified block is not confirmed<object>- if block is confirmed, an object with the following fields:blockhash: <string>- the blockhash of this block, as base-58 encoded stringpreviousBlockhash: <string>- the blockhash of this block's parent, as base-58 encoded string; if the parent block is not available due to ledger cleanup, this field will return "11111111111111111111111111111111"parentSlot: <u64>- the slot index of this block's parenttransactions: <array>- present if "full" transaction details are requested; an array of JSON objects containing:transaction: <object|[string,encoding]>- Transaction object, either in JSON format or encoded binary data, depending on encoding parametermeta: <object>- transaction status metadata object, containingnullor:err: <object|null>- Error if transaction failed, null if transaction succeeded.fee: <u64>- fee this transaction was charged, as u64 integerpreBalances: <array>- array of u64 account balances from before the transaction was processedpostBalances: <array>- array of u64 account balances after the transaction was processedinnerInstructions: <array|null>- List of inner instructions ornullif inner instruction recording was not enabled during this transactionpreTokenBalances: <array|undefined>- List of token balances from before the transaction was processed or omitted if token balance recording was not yet enabled during this transactionpostTokenBalances: <array|undefined>- List of token balances from after the transaction was processed or omitted if token balance recording was not yet enabled during this transactionlogMessages: <array|null>- array of string log messages ornullif log message recording was not enabled during this transactionrewards: <array|null>- transaction-level rewards, populated if rewards are requested; an array of JSON objects containing:pubkey: <string>- The public key, as base-58 encoded string, of the account that received the rewardlamports: <i64>- number of reward lamports credited or debited by the account, as a i64postBalance: <u64>- account balance in lamports after the reward was appliedrewardType: <string|undefined>- type of reward: "fee", "rent", "voting", "staking"commission: <u8|undefined>- vote account commission when the reward was credited, only present for voting and staking rewards
- DEPRECATED:
status: <object>- Transaction status"Ok": <null>- Transaction was successful"Err": <ERR>- Transaction failed with TransactionError
loadedAddresses: <object|undefined>- Transaction addresses loaded from address lookup tables. Undefined ifmaxSupportedTransactionVersionis not set in request params, or ifjsonParsedencoding is set in request params.writable: <array[string]>- Ordered list of base-58 encoded addresses for writable loaded accountsreadonly: <array[string]>- Ordered list of base-58 encoded addresses for readonly loaded accounts
returnData: <object|undefined>- the most-recent return data generated by an instruction in the transaction, with the following fields:programId: <string>- the program that generated the return data, as base-58 encoded Pubkeydata: <[string, encoding]>- the return data itself, as base-64 encoded binary data
computeUnitsConsumed: <u64|undefined>- number of compute units consumed by the transaction
version: <"legacy"|number|undefined>- Transaction version. Undefined ifmaxSupportedTransactionVersionis not set in request params.
signatures: <array>- present if "signatures" are requested for transaction details; an array of signatures strings, corresponding to the transaction order in the blockrewards: <array|undefined>- block-level rewards, present if rewards are requested; an array of JSON objects containing:pubkey: <string>- The public key, as base-58 encoded string, of the account that received the rewardlamports: <i64>- number of reward lamports credited or debited by the account, as a i64postBalance: <u64>- account balance in lamports after the reward was appliedrewardType: <string|undefined>- type of reward: "fee", "rent", "voting", "staking"commission: <u8|undefined>- vote account commission when the reward was credited, only present for voting and staking rewards
blockTime: <i64|null>- estimated production time, as Unix timestamp (seconds since the Unix epoch). null if not availableblockHeight: <u64|null>- the number of blocks beneath this block
Code sample
curl https://mainnet.koii.network -X POST -H "Content-Type: application/json" -d '
{
"jsonrpc": "2.0","id":1,
"method":"getBlock",
"params": [
430,
{
"encoding": "json",
"maxSupportedTransactionVersion":0,
"transactionDetails":"full",
"rewards":false
}
]
}
'
Response
{
"jsonrpc": "2.0",
"result": {
"blockHeight": 428,
"blockTime": null,
"blockhash": "3Eq21vXNB5s86c62bVuUfTeaMif1N2kUqRPBmGRJhyTA",
"parentSlot": 429,
"previousBlockhash": "mfcyqEXB3DnHXki6KjjmZck6YjmZLvpAByy2fj4nh6B",
"transactions": [
{
"meta": {
"err": null,
"fee": 5000,
"innerInstructions": [],
"logMessages": [],
"postBalances": [499998932500, 26858640, 1, 1, 1],
"postTokenBalances": [],
"preBalances": [499998937500, 26858640, 1, 1, 1],
"preTokenBalances": [],
"rewards": null,
"status": {
"Ok": null
}
},
"transaction": {
"message": {
"accountKeys": [
"3UVYmECPPMZSCqWKfENfuoTv51fTDTWicX9xmBD2euKe",
"AjozzgE83A3x1sHNUR64hfH7zaEBWeMaFuAN9kQgujrc",
"SysvarS1otHashes111111111111111111111111111",
"SysvarC1ock11111111111111111111111111111111",
"Vote111111111111111111111111111111111111111"
],
"header": {
"numReadonlySignedAccounts": 0,
"numReadonlyUnsignedAccounts": 3,
"numRequiredSignatures": 1
},
"instructions": [
{
"accounts": [1, 2, 3, 0],
"data": "37u9WtQpcm6ULa3WRQHmj49EPs4if7o9f1jSRVZpm2dvihR9C8jY4NqEwXUbLwx15HBSNcP1",
"programIdIndex": 4
}
],
"recentBlockhash": "mfcyqEXB3DnHXki6KjjmZck6YjmZLvpAByy2fj4nh6B"
},
"signatures": [
"2nBhEBYYvfaAe16UMNqRHre4YNSskvuYgx3M6E4JP1oDYvZEJHvoPzyUidNgNX5r9sTyN1J9UxtbCXy2rqYcuyuv"
]
}
}
]
},
"id": 1
}