Pre-release documentation. Content subject to change, or may be inaccurate.
Overview
SDKs
CLI Reference
Explorer MCP
gRPC API
REST API
- Overview
- GETList accounts using CEL-based filtering.
- GETList executed transaction signatures involving an account.
- GETGet account information.
- GETGet account raw bytes.
- GETList blocks using pagination and filtering. By default returns blocks ordered from latest slot to the first one.
- GETGet block by slot or hash.
- GETGet raw block bytes.
- GETGet block by slot or hash.
- GETGet raw block bytes.
- GETList events with CEL filtering and pagination. Returns events ordered from most recent to older.
- GETGet a specific event by ID.
- GETGet block heights
- POSTGenerate an account state proof snapshot.
- GETList executed transactions with CEL filtering and pagination. Returns transactions ordered from most recent to older.
- GETGet transaction by signature.
- GETGet raw transaction by signature.
- GETGet derived transaction status metadata.
- GETGet component version strings.
Error
A valid request URL is required to generate request examples{
"signature": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"header": {
"feePayerSignature": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"version": 123,
"flags": 123,
"readwriteAccountsCount": 123,
"readonlyAccountsCount": 123,
"instructionDataSize": 123,
"requestedComputeUnits": 123,
"requestedStateUnits": 123,
"requestedMemoryUnits": 123,
"expiryAfter": 123,
"fee": "<string>",
"nonce": "<string>",
"startSlot": "<string>",
"feePayerPubkey": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"programPubkey": {
"value": "aSDinaTvuI8gbWludGxpZnk="
}
},
"body": "aSDinaTvuI8gbWludGxpZnk=",
"executionResult": {
"consumedComputeUnits": 123,
"consumedMemoryUnits": 123,
"consumedStateUnits": 123,
"userErrorCode": "<string>",
"vmError": "TRANSACTION_VM_EXECUTE_SUCCESS",
"executionResult": "<string>",
"pagesUsed": 123,
"eventsCount": 123,
"eventsSize": 123,
"readwriteAccounts": [
{
"value": "aSDinaTvuI8gbWludGxpZnk="
}
],
"readonlyAccounts": [
{
"value": "aSDinaTvuI8gbWludGxpZnk="
}
],
"events": [
{
"eventId": "<string>",
"callIdx": 123,
"programIdx": 123,
"program": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"payload": "aSDinaTvuI8gbWludGxpZnk="
}
],
"errorProgramAccIdx": 123
},
"slot": "<string>",
"blockOffset": 123
}QueryService
Get transaction by signature.
GET
/
v1
/
transactions
/
{signature.value}
Error
A valid request URL is required to generate request examples{
"signature": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"header": {
"feePayerSignature": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"version": 123,
"flags": 123,
"readwriteAccountsCount": 123,
"readonlyAccountsCount": 123,
"instructionDataSize": 123,
"requestedComputeUnits": 123,
"requestedStateUnits": 123,
"requestedMemoryUnits": 123,
"expiryAfter": 123,
"fee": "<string>",
"nonce": "<string>",
"startSlot": "<string>",
"feePayerPubkey": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"programPubkey": {
"value": "aSDinaTvuI8gbWludGxpZnk="
}
},
"body": "aSDinaTvuI8gbWludGxpZnk=",
"executionResult": {
"consumedComputeUnits": 123,
"consumedMemoryUnits": 123,
"consumedStateUnits": 123,
"userErrorCode": "<string>",
"vmError": "TRANSACTION_VM_EXECUTE_SUCCESS",
"executionResult": "<string>",
"pagesUsed": 123,
"eventsCount": 123,
"eventsSize": 123,
"readwriteAccounts": [
{
"value": "aSDinaTvuI8gbWludGxpZnk="
}
],
"readonlyAccounts": [
{
"value": "aSDinaTvuI8gbWludGxpZnk="
}
],
"events": [
{
"eventId": "<string>",
"callIdx": 123,
"programIdx": 123,
"program": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"payload": "aSDinaTvuI8gbWludGxpZnk="
}
],
"errorProgramAccIdx": 123
},
"slot": "<string>",
"blockOffset": 123
}Path Parameters
64-byte signature buffer.
Query Parameters
Available options:
TRANSACTION_VIEW_UNSPECIFIED, TRANSACTION_VIEW_SIGNATURE_ONLY, TRANSACTION_VIEW_HEADER_ONLY, TRANSACTION_VIEW_HEADER_AND_BODY, TRANSACTION_VIEW_FULL Request the version for a specific slot number.
Request the version nearest to the provided block timestamp.
Request the version for a specific seq number. Relevant only for GetAccount and GetRawAccount requests.
- CONSENSUS_STATUS_UNSPECIFIED: CONSENSUS_STATUS_UNSPECIFIED indicates the consensus status is unknown.
- CONSENSUS_STATUS_OBSERVED: CONSENSUS_STATUS_OBSERVED indicates the resource has been observed but not yet confirmed in a finalized block.
- CONSENSUS_STATUS_INCLUDED: CONSENSUS_STATUS_INCLUDED indicates the resource has been included in the ledger but may not be finalized.
- CONSENSUS_STATUS_FINALIZED: CONSENSUS_STATUS_FINALIZED indicates the resource is finalized for a slot.
- CONSENSUS_STATUS_LOCALLY_EXECUTED: CONSENSUS_STATUS_LOCALLY_EXECUTED indicates the local node executed the resource but broader cluster finality may not have been achieved.
- CONSENSUS_STATUS_CLUSTER_EXECUTED: CONSENSUS_STATUS_CLUSTER_EXECUTED indicates the entire cluster has executed and agreed on the resource.
Available options:
CONSENSUS_STATUS_UNSPECIFIED, CONSENSUS_STATUS_OBSERVED, CONSENSUS_STATUS_INCLUDED, CONSENSUS_STATUS_FINALIZED, CONSENSUS_STATUS_LOCALLY_EXECUTED, CONSENSUS_STATUS_CLUSTER_EXECUTED Response
A successful response.
Transaction describes a fully decoded transaction resource.
Signature represents a 64-byte signature value.
Show child attributes
Show child attributes
TransactionHeader carries structured metadata for a transaction.
Show child attributes
Show child attributes
Pattern:
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$TransactionExecutionResult captures execution outcomes.
Show child attributes
Show child attributes
Was this page helpful?
List executed transactions with CEL filtering and pagination. Returns transactions ordered from most recent to older.
Previous
Get raw transaction by signature.
Next
⌘I
Assistant
Responses are generated using AI and may contain mistakes.