Account Query Message
Account query messages return current information on one or more accounts in the ledger. Account queries support paginated access.
Account Query Message Properties
Property | Type | Description |
---|---|---|
after |
EntityRef |
For pagination, a reference to the last account in the previous page. |
codes |
Code Selectors | See Query Selectors |
domain |
EntityRef |
Ledger domain. If not provided the default is used. |
limit |
int | The maximum number of accounts to return. |
names |
Name Selectors | See Query Selectors |
range |
string | The code for the first account. |
rangeEnding |
string | The code for the last account. |
All properties are optional. A query request with no properties will return all accounts.
Note that the value of limit
is capped by the Ledger configuration.