Accounts
Get account balances
get/v1/domains/{domainId}/accounts/{accountId}/balances
Request
- Base URLhttps://docs.ripple.com (the document declares no server; this is the origin it was published from)
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
domainIdstring uuid required
Unique identifier for the domain.
accountIdstring uuid required
Query parameters
limitinteger
The number of entities to return.
startingAfterstring uuid
Ticker id used to the determine beginning of query results.
sortBy'id' | 'tickerId' | 'totalAmount' | 'reservedAmount' | 'quarantinedAmount' | 'lastUpdatedAt'
Property name used to sort the query results.
sortOrder'ASC' | 'DESC'
Sort order applied to the query results.
ticker.idstring[]
Return balances of tickers with this id for the account.
ticker.namestring[]
Return balances of tickers with this name for the account.
ticker.symbolstring[]
Return balances of tickers with this symbol for the account.
ticker.ledgerIdstring[]
Return balances matching given ledger ids.
ticker.validationStatus'Validated' | 'NonValidated'
Return transfers with ticker matching the requested validation status
ticker.lockCore
Return transfers with ticker matching given lock status.
Response
Changes
No recorded changes to this operation across all 3 revisions of this API.