Blockchain

JSON RPC API | Solana Docs

Solana nodes accept HTTP requests using the JSON-RPC 2.0 specification.

To interact with a Solana node inside a JavaScript application, use the solana-web3.js library, which gives a convenient interface for the RPC methods.

Table of Contents

RPC HTTP Endpoint#

Default port: 8899 e.g. http://localhost:8899, http://192.168.1.88:8899

RPC PubSub WebSocket Endpoint#

Default port: 8900 e.g. ws://localhost:8900, http://192.168.1.88:8900

Methods#

  • getAccountInfo
  • getBalance
  • getBlock
  • getBlockHeight
  • getBlockProduction
  • getBlockCommitment
  • getBlocks
  • getBlocksWithLimit
  • getBlockTime
  • getClusterNodes
  • getEpochInfo
  • getEpochSchedule
  • getFeeForMessage
  • getFirstAvailableBlock
  • getGenesisHash
  • getHealth
  • getHighestSnapshotSlot
  • getIdentity
  • getInflationGovernor
  • getInflationRate
  • getInflationReward
  • getLargestAccounts
  • getLatestBlockhash
  • getLeaderSchedule
  • getMaxRetransmitSlot
  • getMaxShredInsertSlot
  • getMinimumBalanceForRentExemption
  • getMultipleAccounts
  • getProgramAccounts
  • getRecentPerformanceSamples
  • getSignaturesForAddress
  • getSignatureStatuses
  • getSlot
  • getSlotLeader
  • getSlotLeaders
  • getStakeActivation
  • getSupply
  • getTokenAccountBalance
  • getTokenAccountsByDelegate
  • getTokenAccountsByOwner
  • getTokenLargestAccounts
  • getTokenSupply
  • getTransaction
  • getTransactionCount
  • getVersion
  • getVoteAccounts
  • isBlockhashValid
  • minimumLedgerSlot
  • requestAirdrop
  • sendTransaction
  • simulateTransaction
  • Subscription Websocket
    • accountSubscribe
    • accountUnsubscribe
    • logsSubscribe
    • logsUnsubscribe
    • programSubscribe
    • programUnsubscribe
    • signatureSubscribe
    • signatureUnsubscribe
    • slotSubscribe
    • slotUnsubscribe

Unstable Methods#

Unstable methods may see breaking changes in patch releases and may not be supported in perpetuity.

  • blockSubscribe
  • blockUnsubscribe
  • slotsUpdatesSubscribe
  • slotsUpdatesUnsubscribe
  • voteSubscribe
  • voteUnsubscribe

Deprecated Methods#

  • getConfirmedBlock
  • getConfirmedBlocks
  • getConfirmedBlocksWithLimit
  • getConfirmedSignaturesForAddress2
  • getConfirmedTransaction
  • getFeeCalculatorForBlockhash
  • getFeeRateGovernor
  • getFees
  • getRecentBlockhash
  • getSnapshotSlot

Request Formatting#

To make a JSON-RPC request, send an HTTP POST request with a Content-Type: application/json header. The JSON request data should contain 4 fields:

  • jsonrpc: <string>, set to “2.0”
  • id: <number>, a unique client-generated identifying integer
  • method: <string>, a string containing the method to be invoked
  • params: <array>, a JSON array of ordered parameter values

Example using curl:

The response output will be a JSON object with the following fields:

  • jsonrpc: <string>, matching the request specification
  • id: <number>, matching the request identifier
  • result: <array|number|object|string>, requested data or success confirmation

Requests can be sent in batches by sending an array of JSON-RPC request objects as the data for a single POST.

Definitions#

  • Hash: A SHA-256 hash of a chunk of data.
  • Pubkey: The public key of a Ed25519 key-pair.
  • Transaction: A list of Solana instructions signed by a client keypair to authorize those actions.
  • Signature: An Ed25519 signature of transaction’s payload data including instructions. This can be used to identify transactions.

Configuring State Commitment#

For preflight checks and transaction processing, Solana nodes choose which bank state to query based on a commitment requirement set by the client. The commitment describes how finalized a block is at that point in time. When querying the ledger state, it’s recommended to use lower levels of commitment to report progress and higher levels to ensure the state will not be rolled back.

In descending order of commitment (most finalized to least finalized), clients may specify:

  • “finalized” – the node will query the most recent block confirmed by supermajority of the cluster as having reached maximum lockout, meaning the cluster has recognized this block as finalized
  • “confirmed” – the node will query the most recent block that has been voted on by supermajority of the cluster.
    • It incorporates votes from gossip and replay.
    • It does not count votes on descendants of a block, only direct votes on that block.
    • This confirmation level also upholds “optimistic confirmation” guarantees in release 1.3 and onwards.
  • “processed” – the node will query its most recent block. Note that the block may still be skipped by the cluster.

For processing many dependent transactions in series, it’s recommended to use “confirmed” commitment, which balances speed with rollback safety. For total safety, it’s recommended to use”finalized” commitment.

Example#

The commitment parameter should be included as the last element in the params array:

Default:#

If commitment configuration is not provided, the node will default to “finalized” commitment

Only methods that query bank state accept the commitment parameter. They are indicated in the API Reference below.

RpcResponse Structure#

Many methods that take a commitment parameter return an RpcResponse JSON object comprised of two parts:

  • context : An RpcResponseContext JSON structure including a slot field at which the operation was evaluated.
  • value : The value returned by the operation itself.

Health Check#

Although not a JSON RPC API, a GET /health at the RPC HTTP Endpoint provides a health-check mechanism for use by load balancers or other network infrastructure. This request will always return a HTTP 200 OK response with a body of “ok”, “behind” or “unknown” based on the following conditions:

  1. If one or more -known-validator arguments are provided to solana-validator, “ok” is returned when the node has within HEALTH_CHECK_SLOT_DISTANCE slots of the highest known validator, otherwise “behind”. “unknown” is returned when no slot information from known validators is not yet available.
  2. “ok” is always returned if no known validators are provided.

JSON RPC API Reference#

getAccountInfo#

Returns all information associated with the account of provided Pubkey

Parameters:#

  • <string> – Pubkey of account to query, as base-58 encoded string
  • <object> – (optional) Configuration object containing the following optional fields:
    • (optional) Commitment
    • encoding: <string> – encoding for Account data, either “base58” (slow), “base64”, “base64+zstd”, or “jsonParsed”. “base58” is limited to Account data of less than 129 bytes. “base64” will return base64 encoded data for Account data of any size. “base64+zstd” compresses the Account data using Zstandard and base64-encodes the result. “jsonParsed” encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If “jsonParsed” is requested but a parser cannot be found, the field falls back to “base64” encoding, detectable when the data field is type <string>.
    • (optional) dataSlice: <object> – limit the returned account data using the provided offset: <usize> and length: <usize> fields; only available for “base58”, “base64” or “base64+zstd” encodings.

Results:#

The result will be an RpcResponse JSON object with value equal to:

  • <null> – if the requested account doesn’t exist
  • <object> – otherwise, a JSON object containing:
    • lamports: <u64>, number of lamports assigned to this account, as a u64
    • owner: <string>, base-58 encoded Pubkey of the program this account has been assigned to
    • data: <[string, encoding]|object>, data associated with the account, either as encoded binary data or JSON format {<program>: <state>}, depending on encoding parameter
    • executable: <bool>, boolean indicating if the account contains a program (and is strictly read-only)
    • rentEpoch: <u64>, the epoch at which this account will next owe rent, as u64

Example:#

Request:

Response:

Example:#

Request:

Response:

getBalance#

Returns the balance of the account of provided Pubkey

Parameters:#

  • <string> – Pubkey of account to query, as base-58 encoded string
  • <object> – (optional) Commitment

Results:#

  • RpcResponse<u64> – RpcResponse JSON object with value field set to the balance

Example:#

Request:

Result:

getBlock#

Returns identity and transaction information about a confirmed block in the ledger

Parameters:#

  • <u64> – slot, as u64 integer
  • <object> – (optional) Configuration object containing the following optional fields:
    • (optional) encoding: <string> – encoding for each returned Transaction, either “json”, “jsonParsed”, “base58” (slow), “base64”. If parameter not provided, the default encoding is “json”. “jsonParsed” encoding attempts to use program-specific instruction parsers to return more human-readable and explicit data in the transaction.message.instructions list. If “jsonParsed” is requested but a parser cannot be found, the instruction falls back to regular JSON encoding (accounts, data, and programIdIndex fields).
    • (optional) transactionDetails: <string> – level of transaction detail to return, either “full”, “signatures”, or “none”. If parameter not provided, the default detail level is “full”.
    • (optional) rewards: bool – whether to populate the rewards array. If parameter not provided, the default includes rewards.
    • (optional) Commitment; “processed” is not supported. If parameter not provided, the default is “finalized”.
    • (optional) maxSupportedTransactionVersion: <number> – set the max transaction version to return in responses. If the requested block contains a transaction with a higher version, an error will be returned.

Results:#

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 string
    • previousBlockhash: <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 parent
    • transactions: <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 parameter
      • meta: <object> – transaction status metadata object, containing null or:
        • err: <object | null> – Error if transaction failed, null if transaction succeeded. TransactionError definitions
        • fee: <u64> – fee this transaction was charged, as u64 integer
        • preBalances: <array> – array of u64 account balances from before the transaction was processed
        • postBalances: <array> – array of u64 account balances after the transaction was processed
        • innerInstructions: <array|null> – List of inner instructions or null if inner instruction recording was not enabled during this transaction
        • preTokenBalances: <array|undefined> – List of token balances from before the transaction was processed or omitted if token balance recording was not yet enabled during this transaction
        • postTokenBalances: <array|undefined> – List of token balances from after the transaction was processed or omitted if token balance recording was not yet enabled during this transaction
        • logMessages: <array|null> – array of string log messages or null if log message recording was not enabled during this transaction
        • 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 if maxSupportedTransactionVersion is not set in request params.
          • writable: <array[string]> – Ordered list of base-58 encoded addresses for writable loaded accounts
          • readonly: <array[string]> – Ordered list of base-58 encoded addresses for readonly loaded accounts
      • version: <“legacy”|number|undefined> – Transaction version. Undefined if maxSupportedTransactionVersion is 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 block
    • rewards: <array> – 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 reward
      • lamports: <i64>- number of reward lamports credited or debited by the account, as a i64
      • postBalance: <u64> – account balance in lamports after the reward was applied
      • rewardType: <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 available
    • blockHeight: <u64 | null> – the number of blocks beneath this block

Example:#

Request:

Result:

Example:#

Request:

Result:

Transaction Structure#

Transactions are quite different from those on other blockchains. Be sure to review Anatomy of a Transaction to learn about transactions on Solana.

The JSON structure of a transaction is defined as follows:

  • signatures: <array[string]> – A list of base-58 encoded signatures applied to the transaction. The list is always of length message.header.numRequiredSignatures and not empty. The signature at index i corresponds to the public key at index i in message.account_keys. The first one is used as the transaction id.
  • message: <object> – Defines the content of the transaction.
    • accountKeys: <array[string]> – List of base-58 encoded public keys used by the transaction, including by the instructions and for signatures. The first message.header.numRequiredSignatures public keys must sign the transaction.
    • header: <object> – Details the account types and signatures required by the transaction.
      • numRequiredSignatures: <number> – The total number of signatures required to make the transaction valid. The signatures must match the first numRequiredSignatures of message.account_keys.
      • numReadonlySignedAccounts: <number> – The last numReadonlySignedAccounts of the signed keys are read-only accounts. Programs may process multiple transactions that load read-only accounts within a single PoH entry, but are not permitted to credit or debit lamports or modify account data. Transactions targeting the same read-write account are evaluated sequentially.
      • numReadonlyUnsignedAccounts: <number> – The last numReadonlyUnsignedAccounts of the unsigned keys are read-only accounts.
    • recentBlockhash: <string> – A base-58 encoded hash of a recent block in the ledger used to prevent transaction duplication and to give transactions lifetimes.
    • instructions: <array[object]> – List of program instructions that will be executed in sequence and committed in one atomic transaction if all succeed.
      • programIdIndex: <number> – Index into the message.accountKeys array indicating the program account that executes this instruction.
      • accounts: <array[number]> – List of ordered indices into the message.accountKeys array indicating which accounts to pass to the program.
      • data: <string> – The program input data encoded in a base-58 string.
    • addressTableLookups: <array[object]|undefined> – List of address table lookups used by a transaction to dynamically load addresses from on-chain address lookup tables. Undefined if maxSupportedTransactionVersion is not set.
      • accountKey: <string> – base-58 encoded public key for an address lookup table account.
      • writableIndexes: <array[number]> – List of indices used to load addresses of writable accounts from a lookup table.
      • readonlyIndexes: <array[number]> – List of indices used to load addresses of readonly accounts from a lookup table.

Inner Instructions Structure#

The Solana runtime records the cross-program instructions that are invoked during transaction processing and makes these available for greater transparency of what was executed on-chain per transaction instruction. Invoked instructions are grouped by the originating transaction instruction and are listed in order of processing.

The JSON structure of inner instructions is defined as a list of objects in the following structure:

  • index: number – Index of the transaction instruction from which the inner instruction(s) originated
  • instructions: <array[object]> – Ordered list of inner program instructions that were invoked during a single transaction instruction.
    • programIdIndex: <number> – Index into the message.accountKeys array indicating the program account that executes this instruction.
    • accounts: <array[number]> – List of ordered indices into the message.accountKeys array indicating which accounts to pass to the program.
    • data: <string> – The program input data encoded in a base-58 string.

Token Balances Structure#

The JSON structure of token balances is defined as a list of objects in the following structure:

  • accountIndex: <number> – Index of the account in which the token balance is provided for.
  • mint: <string> – Pubkey of the token’s mint.
  • owner: <string | undefined> – Pubkey of token balance’s owner.
  • uiTokenAmount: <object> –
    • amount: <string> – Raw amount of tokens as a string, ignoring decimals.
    • decimals: <number> – Number of decimals configured for token’s mint.
    • uiAmount: <number | null> – Token amount as a float, accounting for decimals. DEPRECATED
    • uiAmountString: <string> – Token amount as a string, accounting for decimals.

getBlockHeight#

Returns the current block height of the node

Parameters:#

  • <object> – (optional) Commitment

Results:#

  • <u64> – Current block height

Example:#

Request:

Result:

getBlockProduction#

Returns recent block production information from the current or previous epoch.

Parameters:#

  • <object> – (optional) Configuration object containing the following optional fields:
    • (optional) Commitment
    • (optional) range: <object> – Slot range to return block production for. If parameter not provided, defaults to current epoch.
      • firstSlot: <u64> – first slot to return block production information for (inclusive)
      • (optional) lastSlot: <u64> – last slot to return block production information for (inclusive). If parameter not provided, defaults to the highest slot
    • (optional) identity: <string> – Only return results for this validator identity (base-58 encoded)

Results:#

The result will be an RpcResponse JSON object with value equal to:

  • <object>
    • byIdentity: <object> – a dictionary of validator identities, as base-58 encoded strings. Value is a two element array containing the number of leader slots and the number of blocks produced.
    • range: <object> – Block production slot range
      • firstSlot: <u64> – first slot of the block production information (inclusive)
      • lastSlot: <u64> – last slot of block production information (inclusive)

Example:#

Request:

Result:

Example:#

Request:

Result:

getBlockCommitment#

Returns commitment for particular block

Parameters:#

  • <u64> – block, identified by Slot

Results:#

The result field will be a JSON object containing:

  • commitment – commitment, comprising either:
    • <null> – Unknown block
    • <array> – commitment, array of u64 integers logging the amount of cluster stake in lamports that has voted on the block at each depth from 0 to MAX_LOCKOUT_HISTORY + 1
  • totalStake – total active stake, in lamports, of the current epoch

Example:#

Request:

Result:

getBlocks#

Returns a list of confirmed blocks between two slots

Parameters:#

  • <u64> – start_slot, as u64 integer
  • <u64> – (optional) end_slot, as u64 integer
  • (optional) Commitment; “processed” is not supported. If parameter not provided, the default is “finalized”.

Results:#

The result field will be an array of u64 integers listing confirmed blocks between start_slot and either end_slot, if provided, or latest confirmed block, inclusive. Max range allowed is 500,000 slots.

Example:#

Request:

Result:

getBlocksWithLimit#

Returns a list of confirmed blocks starting at the given slot

Parameters:#

  • <u64> – start_slot, as u64 integer
  • <u64> – limit, as u64 integer
  • (optional) Commitment; “processed” is not supported. If parameter not provided, the default is “finalized”.

Results:#

The result field will be an array of u64 integers listing confirmed blocks starting at start_slot for up to limit blocks, inclusive.

Example:#

Request:

Result:

getBlockTime#

Returns the estimated production time of a block.

Each validator reports their UTC time to the ledger on a regular interval by intermittently adding a timestamp to a Vote for a particular block. A requested block’s time is calculated from the stake-weighted mean of the Vote timestamps in a set of recent blocks recorded on the ledger.

Parameters:#

  • <u64> – block, identified by Slot

Results:#

  • <i64> – estimated production time, as Unix timestamp (seconds since the Unix epoch)
  • <null> – timestamp is not available for this block

Example:#

Request:

Result:

getClusterNodes#

Returns information about all the nodes participating in the cluster

Parameters:#

None

Results:#

The result field will be an array of JSON objects, each with the following sub fields:

  • pubkey: <string> – Node public key, as base-58 encoded string
  • gossip: <string | null> – Gossip network address for the node
  • tpu: <string | null> – TPU network address for the node
  • rpc: <string | null> – JSON RPC network address for the node, or null if the JSON RPC service is not enabled
  • version: <string | null> – The software version of the node, or null if the version information is not available
  • featureSet: <u32 | null > – The unique identifier of the node’s feature set
  • shredVersion: <u16 | null> – The shred version the node has been configured to use

Example:#

Request:

Result:

getEpochInfo#

Returns information about the current epoch

Parameters:#

  • <object> – (optional) Commitment

Results:#

The result field will be an object with the following fields:

  • absoluteSlot: <u64>, the current slot
  • blockHeight: <u64>, the current block height
  • epoch: <u64>, the current epoch
  • slotIndex: <u64>, the current slot relative to the start of the current epoch
  • slotsInEpoch: <u64>, the number of slots in this epoch
  • transactionCount: <u64 | null>, total number of transactions processed without error since genesis

Example:#

Request:

Result:

getEpochSchedule#

Returns epoch schedule information from this cluster’s genesis config

Parameters:#

None

Results:#

The result field will be an object with the following fields:

  • slotsPerEpoch: <u64>, the maximum number of slots in each epoch
  • leaderScheduleSlotOffset: <u64>, the number of slots before beginning of an epoch to calculate a leader schedule for that epoch
  • warmup: <bool>, whether epochs start short and grow
  • firstNormalEpoch: <u64>, first normal-length epoch, log2(slotsPerEpoch) – log2(MINIMUM_SLOTS_PER_EPOCH)
  • firstNormalSlot: <u64>, MINIMUM_SLOTS_PER_EPOCH * (2.pow(firstNormalEpoch) – 1)

Example:#

Request:

Result:

getFeeForMessage#

NEW: This method is only available in solana-core v1.9 or newer. Please use getFees for solana-core v1.8

Get the fee the network will charge for a particular Message

Parameters:#

  • message: <string> – Base-64 encoded Message
  • <object> – (optional) Commitment (used for retrieving blockhash)

Results:#

  • <u64 | null> – Fee corresponding to the message at the specified blockhash

Example:#

Request:

Result:

getFirstAvailableBlock#

Returns the slot of the lowest confirmed block that has not been purged from the ledger

Parameters:#

None

Results:#

  • <u64> – Slot

Example:#

Request:

Result:

getGenesisHash#

Returns the genesis hash

Parameters:#

None

Results:#

  • <string> – a Hash as base-58 encoded string

Example:#

Request:

Result:

getHealth#

Returns the current health of the node.

If one or more -known-validator arguments are provided to solana-validator, “ok” is returned when the node has within HEALTH_CHECK_SLOT_DISTANCE slots of the highest known validator, otherwise an error is returned. “ok” is always returned if no known validators are provided.

Parameters:#

None

Results:#

If the node is healthy: “ok” If the node is unhealthy, a JSON RPC error response is returned. The specifics of the error response are UNSTABLE and may change in the future

Example:#

Request:

Healthy Result:

Unhealthy Result (generic):

Unhealthy Result (if additional information is available)

getHighestSnapshotSlot#

NEW: This method is only available in solana-core v1.9 or newer. Please use getSnapshotSlot for solana-core v1.8

Returns the highest slot information that the node has snapshots for.

This will find the highest full snapshot slot, and the highest incremental snapshot slot based on the full snapshot slot, if there is one.

Parameters:#

None

Results:#

  • <object>
    • full: <u64> – Highest full snapshot slot
    • incremental: <u64 | undefined> – Highest incremental snapshot slot based on full

Example:#

Request:

Result:

Result when the node has no snapshot:

getIdentity#

Returns the identity pubkey for the current node

Parameters:#

None

Results:#

The result field will be a JSON object with the following fields:

  • identity, the identity pubkey of the current node (as a base-58 encoded string)

Example:#

Request:

Result:

getInflationGovernor#

Returns the current inflation governor

Parameters:#

  • <object> – (optional) Commitment

Results:#

The result field will be a JSON object with the following fields:

  • initial: <f64>, the initial inflation percentage from time 0
  • terminal: <f64>, terminal inflation percentage
  • taper: <f64>, rate per year at which inflation is lowered. Rate reduction is derived using the target slot time in genesis config
  • foundation: <f64>, percentage of total inflation allocated to the foundation
  • foundationTerm: <f64>, duration of foundation pool inflation in years

Example:#

Request:

Result:

getInflationRate#

Returns the specific inflation values for the current epoch

Parameters:#

None

Results:#

The result field will be a JSON object with the following fields:

  • total: <f64>, total inflation
  • validator: <f64>, inflation allocated to validators
  • foundation: <f64>, inflation allocated to the foundation
  • epoch: <u64>, epoch for which these values are valid

Example:#

Request:

Result:

getInflationReward#

Returns the inflation / staking reward for a list of addresses for an epoch

Parameters:#

  • <array> – An array of addresses to query, as base-58 encoded strings
  • <object> – (optional) Configuration object containing the following optional fields:
    • (optional) Commitment
    • (optional) epoch: <u64> – An epoch for which the reward occurs. If omitted, the previous epoch will be used

Results#

The result field will be a JSON array with the following fields:

  • epoch: <u64>, epoch for which reward occured
  • effectiveSlot: <u64>, the slot in which the rewards are effective
  • amount: <u64>, reward amount in lamports
  • postBalance: <u64>, post balance of the account in lamports
  • commission: <u8|undefined> – vote account commission when the reward was credited

Example#

Request:

Response:

getLargestAccounts#

Returns the 20 largest accounts, by lamport balance (results may be cached up to two hours)

Parameters:#

  • <object> – (optional) Configuration object containing the following optional fields:
    • (optional) Commitment
    • (optional) filter: <string> – filter results by account type; currently supported: circulating|nonCirculating

Results:#

The result will be an RpcResponse JSON object with value equal to an array of:

  • <object> – otherwise, a JSON object containing:
    • address: <string>, base-58 encoded address of the account
    • lamports: <u64>, number of lamports in the account, as a u64

Example:#

Request:

Result:

getLatestBlockhash#

NEW: This method is only available in solana-core v1.9 or newer. Please use getRecentBlockhash for solana-core v1.8

Returns the latest blockhash

Parameters:#

  • <object> – (optional) Commitment (used for retrieving blockhash)

Results:#

  • RpcResponse<object> – RpcResponse JSON object with value field set to a JSON object including:
  • blockhash: <string> – a Hash as base-58 encoded string
  • lastValidBlockHeight: <u64> – last block height at which the blockhash will be valid

Example:#

Request:

Result:

getLeaderSchedule#

Returns the leader schedule for an epoch

Parameters:#

  • <u64> – (optional) Fetch the leader schedule for the epoch that corresponds to the provided slot. If unspecified, the leader schedule for the current epoch is fetched
  • <object> – (optional) Configuration object containing the following field:
    • (optional) Commitment
    • (optional) identity: <string> – Only return results for this validator identity (base-58 encoded)

Results:#

  • <null> – if requested epoch is not found
  • <object> – otherwise, the result field will be a dictionary of validator identities, as base-58 encoded strings, and their corresponding leader slot indices as values (indices are relative to the first slot in the requested epoch)

Example:#

Request:

Result:

Example:#

Request:

Result:

getMaxRetransmitSlot#

Get the max slot seen from retransmit stage.

Results:#

  • <u64> – Slot

Example:#

Request:

Result:

getMaxShredInsertSlot#

Get the max slot seen from after shred insert.

Results:#

  • <u64> – Slot

Example:#

Request:

Result:

getMinimumBalanceForRentExemption#

Returns minimum balance required to make account rent exempt.

Parameters:#

  • <usize> – account data length
  • <object> – (optional) Commitment

Results:#

  • <u64> – minimum lamports required in account

Example:#

Request:

Result:

getMultipleAccounts#

Returns the account information for a list of Pubkeys

Parameters:#

  • <array> – An array of Pubkeys to query, as base-58 encoded strings
  • <object> – (optional) Configuration object containing the following optional fields:
    • (optional) Commitment
    • encoding: <string> – encoding for Account data, either “base58” (slow), “base64”, “base64+zstd”, or “jsonParsed”. “base58” is limited to Account data of less than 129 bytes. “base64” will return base64 encoded data for Account data of any size. “base64+zstd” compresses the Account data using Zstandard and base64-encodes the result. “jsonParsed” encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If “jsonParsed” is requested but a parser cannot be found, the field falls back to “base64” encoding, detectable when the data field is type <string>.
    • (optional) dataSlice: <object> – limit the returned account data using the provided offset: <usize> and length: <usize> fields; only available for “base58”, “base64” or “base64+zstd” encodings.

Results:#

The result will be an RpcResponse JSON object with value equal to:

An array of:

  • <null> – if the account at that Pubkey doesn’t exist
  • <object> – otherwise, a JSON object containing:
    • lamports: <u64>, number of lamports assigned to this account, as a u64
    • owner: <string>, base-58 encoded Pubkey of the program this account has been assigned to
    • data: <[string, encoding]|object>, data associated with the account, either as encoded binary data or JSON format {<program>: <state>}, depending on encoding parameter
    • executable: <bool>, boolean indicating if the account contains a program (and is strictly read-only)
    • rentEpoch: <u64>, the epoch at which this account will next owe rent, as u64

Example:#

Request:

Result:

Example:#

Request:

Result:

getProgramAccounts#

Returns all accounts owned by the provided program Pubkey

Parameters:#

  • <string> – Pubkey of program, as base-58 encoded string
  • <object> – (optional) Configuration object containing the following optional fields:
    • (optional) Commitment
    • encoding: <string> – encoding for Account data, either “base58” (slow), “base64”, “base64+zstd”, or “jsonParsed”. “base58” is limited to Account data of less than 129 bytes. “base64” will return base64 encoded data for Account data of any size. “base64+zstd” compresses the Account data using Zstandard and base64-encodes the result. “jsonParsed” encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If “jsonParsed” is requested but a parser cannot be found, the field falls back to “base64” encoding, detectable when the data field is type <string>.
    • (optional) dataSlice: <object> – limit the returned account data using the provided offset: <usize> and length: <usize> fields; only available for “base58”, “base64” or “base64+zstd” encodings.
    • (optional) filters: <array> – filter results using various filter objects; account must meet all filter criteria to be included in results
    • (optional) withContext: bool – wrap the result in an RpcResponse JSON object.
Filters:#
  • memcmp: <object> – compares a provided series of bytes with program account data at a particular offset. Fields:

    • offset: <usize> – offset into program account data to start comparison
    • bytes: <string> – data to match, as base-58 encoded string and limited to less than 129 bytes
  • dataSize: <u64> – compares the program account data length with the provided data size

Results:#

By default the result field will be an array of JSON objects. If withContext flag is set the array will be wrapped in an RpcResponse JSON object.

The array will contain:

  • pubkey: <string> – the account Pubkey as base-58 encoded string
  • account: <object> – a JSON object, with the following sub fields:
    • lamports: <u64>, number of lamports assigned to this account, as a u64
    • owner: <string>, base-58 encoded Pubkey of the program this account has been assigned to
    • data: <[string,encoding]|object>, data associated with the account, either as encoded binary data or JSON format {<program>: <state>}, depending on encoding parameter
    • executable: <bool>, boolean indicating if the account contains a program (and is strictly read-only)
    • rentEpoch: <u64>, the epoch at which this account will next owe rent, as u64

Example:#

Request:

Result:

Example:#

Request:

Result:

getRecentPerformanceSamples#

Returns a list of recent performance samples, in reverse slot order. Performance samples are taken every 60 seconds and include the number of transactions and slots that occur in a given time window.

Parameters:#

  • limit: <usize> – (optional) number of samples to return (maximum 720)

Results:#

An array of:

  • RpcPerfSample<object>
    • slot: <u64> – Slot in which sample was taken at
    • numTransactions: <u64> – Number of transactions in sample
    • numSlots: <u64> – Number of slots in sample
    • samplePeriodSecs: <u16> – Number of seconds in a sample window

Example:#

Request:

Result:

getSignaturesForAddress#

Returns signatures for confirmed transactions that include the given address in their accountKeys list. Returns signatures backwards in time from the provided signature or most recent confirmed block

Parameters:#

  • <string> – account address as base-58 encoded string
  • <object> – (optional) Configuration object containing the following fields:
    • limit: <number> – (optional) maximum transaction signatures to return (between 1 and 1,000, default: 1,000).
    • before: <string> – (optional) start searching backwards from this transaction signature. If not provided the search starts from the top of the highest max confirmed block.
    • until: <string> – (optional) search until this transaction signature, if found before limit reached.
    • (optional) Commitment; “processed” is not supported. If parameter not provided, the default is “finalized”.

Results:#

The result field will be an array of transaction signature information, ordered from newest to oldest transaction:

  • <object>
    • signature: <string> – transaction signature as base-58 encoded string
    • slot: <u64> – The slot that contains the block with the transaction
    • err: <object | null> – Error if transaction failed, null if transaction succeeded. TransactionError definitions
    • memo: <string |null> – Memo associated with the transaction, null if no memo is present
    • blockTime: <i64 | null> – estimated production time, as Unix timestamp (seconds since the Unix epoch) of when transaction was processed. null if not available.

Example:#

Request:

Result:

getSignatureStatuses#

Returns the statuses of a list of signatures. Unless the searchTransactionHistory configuration parameter is included, this method only searches the recent status cache of signatures, which retains statuses for all active slots plus MAX_RECENT_BLOCKHASHES rooted slots.

Parameters:#

  • <array> – An array of transaction signatures to confirm, as base-58 encoded strings
  • <object> – (optional) Configuration object containing the following field:
    • searchTransactionHistory: <bool> – if true, a Solana node will search its ledger cache for any signatures not found in the recent status cache

Results:#

An RpcResponse containing a JSON object consisting of an array of TransactionStatus objects.

  • RpcResponse<object> – RpcResponse JSON object with value field:

An array of:

  • <null> – Unknown transaction
  • <object>
    • slot: <u64> – The slot the transaction was processed
    • confirmations: <usize | null> – Number of blocks since signature confirmation, null if rooted, as well as finalized by a supermajority of the cluster
    • err: <object | null> – Error if transaction failed, null if transaction succeeded. TransactionError definitions
    • confirmationStatus: <string | null> – The transaction’s cluster confirmation status; either processed, confirmed, or finalized. See Commitment for more on optimistic confirmation.
    • DEPRECATED: status: <object> – Transaction status
      • “Ok”: <null> – Transaction was successful
      • “Err”: <ERR> – Transaction failed with TransactionError

Example:#

Request:

Result:

Example:#

Request:

Result:

getSlot#

Returns the slot that has reached the given or default commitment level

Parameters:#

  • <object> – (optional) Commitment

Results:#

  • <u64> – Current slot

Example:#

Request:

Result:

getSlotLeader#

Returns the current slot leader

Parameters:#

  • <object> – (optional) Commitment

Results:#

  • <string> – Node identity Pubkey as base-58 encoded string

Example:#

Request:

Result:

getSlotLeaders#

Returns the slot leaders for a given slot range

Parameters:#

  • <u64> – Start slot, as u64 integer
  • <u64> – Limit, as u64 integer

Results:#

  • <array[string]> – Node identity public keys as base-58 encoded strings

Example:#

If the current slot is #99, query the next 10 leaders with the following request:

Request:

Result:

The first leader returned is the leader for slot #100:

getStakeActivation#

Returns epoch activation information for a stake account

Parameters:#

  • <string> – Pubkey of stake account to query, as base-58 encoded string
  • <object> – (optional) Configuration object containing the following optional fields:
    • (optional) Commitment
    • (optional) epoch: <u64> – epoch for which to calculate activation details. If parameter not provided, defaults to current epoch.

Results:#

The result will be a JSON object with the following fields:

  • state: <string – the stake account’s activation state, one of: active, inactive, activating, deactivating
  • active: <u64> – stake active during the epoch
  • inactive: <u64> – stake inactive during the epoch

Example:#

Request:

Result:

Example:#

Request:

Result:

getSupply#

Returns information about the current supply.

Parameters:#

  • <object> – (optional) Configuration object containing the following optional fields:
    • (optional) Commitment
    • (optional) excludeNonCirculatingAccountsList: <bool> – exclude non circulating accounts list from response

Results:#

The result will be an RpcResponse JSON object with value equal to a JSON object containing:

  • total: <u64> – Total supply in lamports
  • circulating: <u64> – Circulating supply in lamports
  • nonCirculating: <u64> – Non-circulating supply in lamports
  • nonCirculatingAccounts: <array> – an array of account addresses of non-circulating accounts, as strings. If excludeNonCirculatingAccountsList is enabled, the returned array will be empty.

Example:#

Request:

Result:

getTokenAccountBalance#

Returns the token balance of an SPL Token account.

Parameters:#

  • <string> – Pubkey of Token account to query, as base-58 encoded string
  • <object> – (optional) Commitment

Results:#

The result will be an RpcResponse JSON object with value equal to a JSON object containing:

  • amount: <string> – the raw balance without decimals, a string representation of u64
  • decimals: <u8> – number of base 10 digits to the right of the decimal place
  • uiAmount: <number | null> – the balance, using mint-prescribed decimals DEPRECATED
  • uiAmountString: <string> – the balance as a string, using mint-prescribed decimals

For more details on returned data: The Token Balances Structure response from getBlock follows a similar structure.

Example:#

Request:

Result:

getTokenAccountsByDelegate#

Returns all SPL Token accounts by approved Delegate.

Parameters:#

  • <string> – Pubkey of account delegate to query, as base-58 encoded string
  • <object> – Either:
    • mint: <string> – Pubkey of the specific token Mint to limit accounts to, as base-58 encoded string; or
    • programId: <string> – Pubkey of the Token program ID that owns the accounts, as base-58 encoded string
  • <object> – (optional) Configuration object containing the following optional fields:
    • (optional) Commitment
    • encoding: <string> – encoding for Account data, either “base58” (slow), “base64”, “base64+zstd” or “jsonParsed”. “jsonParsed” encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If “jsonParsed” is requested but a valid mint cannot be found for a particular account, that account will be filtered out from results.
    • (optional) dataSlice: <object> – limit the returned account data using the provided offset: <usize> and length: <usize> fields; only available for “base58”, “base64” or “base64+zstd” encodings.

Results:#

The result will be an RpcResponse JSON object with value equal to an array of JSON objects, which will contain:

  • pubkey: <string> – the account Pubkey as base-58 encoded string
  • account: <object> – a JSON object, with the following sub fields:
    • lamports: <u64>, number of lamports assigned to this account, as a u64
    • owner: <string>, base-58 encoded Pubkey of the program this account has been assigned to
    • data: <object>, Token state data associated with the account, either as encoded binary data or in JSON format {<program>: <state>}
    • executable: <bool>, boolean indicating if the account contains a program (and is strictly read-only)
    • rentEpoch: <u64>, the epoch at which this account will next owe rent, as u64

When the data is requested with the jsonParsed encoding a format similar to that of the Token Balances Structure can be expected inside the structure, both for the tokenAmount and the delegatedAmount, with the latter being an optional object.

Example:#

Result:

getTokenAccountsByOwner#

Returns all SPL Token accounts by token owner.

Parameters:#

  • <string> – Pubkey of account owner to query, as base-58 encoded string
  • <object> – Either:
    • mint: <string> – Pubkey of the specific token Mint to limit accounts to, as base-58 encoded string; or
    • programId: <string> – Pubkey of the Token program ID that owns the accounts, as base-58 encoded string
  • <object> – (optional) Configuration object containing the following optional fields:
    • (optional) Commitment
    • encoding: <string> – encoding for Account data, either “base58” (slow), “base64”, “base64+zstd” or “jsonParsed”. “jsonParsed” encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If “jsonParsed” is requested but a valid mint cannot be found for a particular account, that account will be filtered out from results.
    • (optional) dataSlice: <object> – limit the returned account data using the provided offset: <usize> and length: <usize> fields; only available for “base58”, “base64” or “base64+zstd” encodings.

Results:#

The result will be an RpcResponse JSON object with value equal to an array of JSON objects, which will contain:

  • pubkey: <string> – the account Pubkey as base-58 encoded string
  • account: <object> – a JSON object, with the following sub fields:
    • lamports: <u64>, number of lamports assigned to this account, as a u64
    • owner: <string>, base-58 encoded Pubkey of the program this account has been assigned to
    • data: <object>, Token state data associated with the account, either as encoded binary data or in JSON format {<program>: <state>}
    • executable: <bool>, boolean indicating if the account contains a program (and is strictly read-only)
    • rentEpoch: <u64>, the epoch at which this account will next owe rent, as u64

When the data is requested with the jsonParsed encoding a format similar to that of the Token Balances Structure can be expected inside the structure, both for the tokenAmount and the delegatedAmount, with the latter being an optional object.

Example:#

Result:

getTokenLargestAccounts#

Returns the 20 largest accounts of a particular SPL Token type.

Parameters:#

  • <string> – Pubkey of token Mint to query, as base-58 encoded string
  • <object> – (optional) Commitment

Results:#

The result will be an RpcResponse JSON object with value equal to an array of JSON objects containing:

  • address: <string> – the address of the token account
  • amount: <string> – the raw token account balance without decimals, a string representation of u64
  • decimals: <u8> – number of base 10 digits to the right of the decimal place
  • uiAmount: <number | null> – the token account balance, using mint-prescribed decimals DEPRECATED
  • uiAmountString: <string> – the token account balance as a string, using mint-prescribed decimals

Example:#

Result:

getTokenSupply#

Returns the total supply of an SPL Token type.

Parameters:#

  • <string> – Pubkey of token Mint to query, as base-58 encoded string
  • <object> – (optional) Commitment

Results:#

The result will be an RpcResponse JSON object with value equal to a JSON object containing:

  • amount: <string> – the raw total token supply without decimals, a string representation of u64
  • decimals: <u8> – number of base 10 digits to the right of the decimal place
  • uiAmount: <number | null> – the total token supply, using mint-prescribed decimals DEPRECATED
  • uiAmountString: <string> – the total token supply as a string, using mint-prescribed decimals

Example:#

Result:

getTransaction#

Returns transaction details for a confirmed transaction

Parameters:#

  • <string> – transaction signature as base-58 encoded string
  • <object> – (optional) Configuration object containing the following optional fields:
    • (optional) encoding: <string> – encoding for each returned Transaction, either “json”, “jsonParsed”, “base58” (slow), “base64”. If parameter not provided, the default encoding is “json”. “jsonParsed” encoding attempts to use program-specific instruction parsers to return more human-readable and explicit data in the transaction.message.instructions list. If “jsonParsed” is requested but a parser cannot be found, the instruction falls back to regular JSON encoding (accounts, data, and programIdIndex fields).
    • (optional) Commitment; “processed” is not supported. If parameter not provided, the default is “finalized”.
    • (optional) maxSupportedTransactionVersion: <number> – set the max transaction version to return in responses. If the requested transaction is a higher version, an error will be returned.

Results:#

  • <null> – if transaction is not found or not confirmed
  • <object> – if transaction is confirmed, an object with the following fields:
    • slot: <u64> – the slot this transaction was processed in
    • transaction: <object|[string,encoding]> – Transaction object, either in JSON format or encoded binary data, depending on encoding parameter
    • blockTime: <i64 | null> – estimated production time, as Unix timestamp (seconds since the Unix epoch) of when the transaction was processed. null if not available
    • meta: <object | null> – transaction status metadata object:
      • err: <object | null> – Error if transaction failed, null if transaction succeeded. TransactionError definitions
      • fee: <u64> – fee this transaction was charged, as u64 integer
      • preBalances: <array> – array of u64 account balances from before the transaction was processed
      • postBalances: <array> – array of u64 account balances after the transaction was processed
      • innerInstructions: <array|null> – List of inner instructions or null if inner instruction recording was not enabled during this transaction
      • preTokenBalances: <array|undefined> – List of token balances from before the transaction was processed or omitted if token balance recording was not yet enabled during this transaction
      • postTokenBalances: <array|undefined> – List of token balances from after the transaction was processed or omitted if token balance recording was not yet enabled during this transaction
      • logMessages: <array|null> – array of string log messages or null if log message recording was not enabled during this transaction
      • DEPRECATED: status: <object> – Transaction status
        • “Ok”: <null> – Transaction was successful
        • “Err”: <ERR> – Transaction failed with TransactionError
      • rewards: <array> – 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 reward
        • lamports: <i64>- number of reward lamports credited or debited by the account, as a i64
        • postBalance: <u64> – account balance in lamports after the reward was applied
        • rewardType: <string> – type of reward: currently only “rent”, other types may be added in the future
        • commission: <u8|undefined> – vote account commission when the reward was credited, only present for voting and staking rewards
      • loadedAddresses: <object|undefined> – Transaction addresses loaded from address lookup tables. Undefined if maxSupportedTransactionVersion is not set in request params.
        • writable: <array[string]> – Ordered list of base-58 encoded addresses for writable loaded accounts
        • readonly: <array[string]> – Ordered list of base-58 encoded addresses for readonly loaded accounts
    • version: <“legacy”|number|undefined> – Transaction version. Undefined if maxSupportedTransactionVersion is not set in request params.

Example:#

Request:

Result:

Example:#

Request:

Result:

getTransactionCount#

Returns the current Transaction count from the ledger

Parameters:#

  • <object> – (optional) Commitment

Results:#

  • <u64> – count

Example:#

Result:

getVersion#

Returns the current solana versions running on the node

Parameters:#

None

Results:#

The result field will be a JSON object with the following fields:

  • solana-core, software version of solana-core
  • feature-set, unique identifier of the current software’s feature set

Example:#

Request:

Result:

Related Articles

Back to top button

Adblock Detected

Please consider supporting us by disabling your ad blocker