Skip to content

domain.list()

[Source]

List every permissioned domain owned by an account.

Signature

domain.list(
  params?: DomainListParams
): Promise<DomainListResult>

Parameters

ParameterTypeRequiredDescription
accountstringNoThe owner whose domains to list. Defaults to the primary signer's account.

Returns

Resolves to a DomainListResult, where domains[i] corresponds to data[i]:

FieldTypeDescription
domainsreadonly string[]The domain id of each owned domain.
datareadonly DomainData[]The shaped domains. See domain.retrieve for DomainData.

Underlying XRPL request

Read-only — no signer is required and nothing is submitted. Queries the ledger with account_objects.

Example

const { data } = await client.domain.list()

for (const domain of data) {
  console.log(domain.domainID)
}