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{
"accounts": [
{
"address": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"meta": {
"version": 123,
"flags": {
"isProgram": true,
"isPrivileged": true,
"isUncompressable": true,
"isEphemeral": true,
"isDeleted": true,
"isNew": true,
"isCompressed": true
},
"dataSize": 123,
"seq": "<string>",
"owner": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"balance": "<string>",
"nonce": "<string>"
},
"data": {
"data": "aSDinaTvuI8gbWludGxpZnk=",
"compressed": true,
"compressionAlgorithm": "<string>"
},
"versionContext": {
"slot": "<string>",
"blockTimestamp": "2023-11-07T05:31:56Z"
},
"consensusStatus": "CONSENSUS_STATUS_UNSPECIFIED"
}
],
"page": {
"nextPageToken": "<string>",
"totalSize": "<string>"
}
}QueryService
List accounts using CEL-based filtering.
GET
/
v1
/
accounts
Error
A valid request URL is required to generate request examples{
"accounts": [
{
"address": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"meta": {
"version": 123,
"flags": {
"isProgram": true,
"isPrivileged": true,
"isUncompressable": true,
"isEphemeral": true,
"isDeleted": true,
"isNew": true,
"isCompressed": true
},
"dataSize": 123,
"seq": "<string>",
"owner": {
"value": "aSDinaTvuI8gbWludGxpZnk="
},
"balance": "<string>",
"nonce": "<string>"
},
"data": {
"data": "aSDinaTvuI8gbWludGxpZnk=",
"compressed": true,
"compressionAlgorithm": "<string>"
},
"versionContext": {
"slot": "<string>",
"blockTimestamp": "2023-11-07T05:31:56Z"
},
"consensusStatus": "CONSENSUS_STATUS_UNSPECIFIED"
}
],
"page": {
"nextPageToken": "<string>",
"totalSize": "<string>"
}
}Query Parameters
- ACCOUNT_VIEW_UNSPECIFIED: ACCOUNT_VIEW_UNSPECIFIED uses service defaults.
- ACCOUNT_VIEW_PUBKEY_ONLY: ACCOUNT_VIEW_PUBKEY_ONLY returns only the account address.
- ACCOUNT_VIEW_META_ONLY: ACCOUNT_VIEW_META_ONLY returns only account metadata.
- ACCOUNT_VIEW_DATA_ONLY: ACCOUNT_VIEW_DATA_ONLY returns only account data.
- ACCOUNT_VIEW_FULL: ACCOUNT_VIEW_FULL returns address, metadata, and data.
Available options:
ACCOUNT_VIEW_UNSPECIFIED, ACCOUNT_VIEW_PUBKEY_ONLY, ACCOUNT_VIEW_META_ONLY, ACCOUNT_VIEW_DATA_ONLY, ACCOUNT_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.
CEL expression applied server-side. Empty expressions are treated as no-op.
Maximum number of items to return in a single response.
Token identifying the position to resume from.
Optional ordering specification in "field [asc|desc]" form.
- 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 Was this page helpful?
⌘I
Assistant
Responses are generated using AI and may contain mistakes.