Skip to content

domain.retrieve()

[Source]

Retrieve a permissioned domain by id (point-in-time).

Signature

domain.retrieve(
  params: DomainRetrieveParams,
): Promise<DomainRetrieveResult>

Parameters

ParameterTypeRequiredDescription
domainIDstringYesThe domain id to fetch.

Returns

Resolves to a DomainRetrieveResult:

FieldTypeDescription
domainIDstringThe queried domain id.
dataDomainData | undefinedThe domain snapshot, or undefined if no such domain exists.

DomainData

FieldTypeDescription
domainIDstringThe domain's on-chain id.
ownerstringThe owning account's r-address.
credListreadonly AcceptedCredential[]The credentials the domain accepts (each { issuer, credType }, credential types decoded from hex).

Underlying XRPL request

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

Example

const { data } = await client.domain.retrieve({
  domainID: 'A1B2...',
})

console.log(data?.owner)