Skip to main content

z_getsubtreesbyindex RPC Method

Returns information about a range of Sapling or Orchard note commitment subtrees.

Updated on
Apr 29, 2026

Parameters

pool
string
REQUIRED

The shielded pool to query: "sapling" or "orchard"

start_index
integer
REQUIRED

The index of the first subtree to return

limit
integer

The maximum number of subtrees to return (optional)

Returns

pool
string

The shielded pool (sapling or orchard)

start_index
integer

The index of the first returned subtree

subtrees
array

An array of subtree information

root
string

The root hash of the subtree

end_height
integer

The block height at which the subtree was completed

error
string

(Optional) The error message, if any

Request
Response
1
{
2
"jsonrpc": "2.0",
3
"id": 1,
4
"result": {
5
"pool": "sapling",
6
"start_index": 0,
7
"subtrees": [
8
{
9
"root": "754bb593ea42d231a7ddf367640f09bbf59dc00f2c1d2003cc340e0c016b5b13",
10
"end_height": 558822
11
},
12
{
13
"root": "03654c3eacbb9b93e122cf6d77b606eae29610f4f38a477985368197fd68e02d",
14
"end_height": 670209
15
},
16
{
17
"root": "e2bf698f5ac10b44da560d11a5e1d5c191a82a968a2be0a6948aa8748b545160",
18
"end_height": 780364
19
},
20
{
21
"root": "e71be1fd3963a2d700ed374d01fdd4a70d8dda8189a8f6602e5fe66c2c66a11d",
22
"end_height": 839994
23
},
24
{
25
"root": "f1c57245fff8dbc2d3efe5a0953eafdedeb06e18a3ad4f1e4042ee76623f8032",
26
"end_height": 916404
27
}
28
]
29
}
30
}
1
{
2
"jsonrpc": "2.0",
3
"id": 1,
4
"result": {
5
"pool": "sapling",
6
"start_index": 0,
7
"subtrees": [
8
{
9
"root": "754bb593ea42d231a7ddf367640f09bbf59dc00f2c1d2003cc340e0c016b5b13",
10
"end_height": 558822
11
},
12
{
13
"root": "03654c3eacbb9b93e122cf6d77b606eae29610f4f38a477985368197fd68e02d",
14
"end_height": 670209
15
},
16
{
17
"root": "e2bf698f5ac10b44da560d11a5e1d5c191a82a968a2be0a6948aa8748b545160",
18
"end_height": 780364
19
},
20
{
21
"root": "e71be1fd3963a2d700ed374d01fdd4a70d8dda8189a8f6602e5fe66c2c66a11d",
22
"end_height": 839994
23
},
24
{
25
"root": "f1c57245fff8dbc2d3efe5a0953eafdedeb06e18a3ad4f1e4042ee76623f8032",
26
"end_height": 916404
27
}
28
]
29
}
30
}
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free