Skip to main content
Use the public API to read additional blockchain addresses. Every request selects a network explicitly, and reads send Cache-Control: no-store. The namespace must have compatible contracts and the owner must enable the requested network.

Read policy and addresses

An example policy response:
Both return { name, network, address }. The second route reads pay.alice.nova. address is a canonical address string or null when no current record exists for that enabled network. The SDK guide lists supported IDs. An unavailable read never returns a substitute address from Stellar, another network or profile text. Stellar’s complete receiving instruction remains available from the payment endpoint.

Prepare a holder record

Send one action per request:
The address above illustrates the format; replace it with your intended destination. Use address: null to remove a record, including while its network is disabled. A successful preparation returns ok, unsigned xdr, holder, signer, namespace, resolverId and network (the Soroban network passphrase). Preparing does not save the record. Review the intended name, destination network, address, Resolver, signing account and transaction costs before the current holder signs. The hosted record and policy preparation routes support G holder/owner authority. A C holder or namespace owner requires a separate contract-wallet integration; these routes do not accept an authorization adapter. Submit the signed transaction with POST /records/submit and { "signedXdr": "..." }. A 202 pending response requires checking the original txHash; see submission handling.

Prepare a namespace policy

Use a wallet session scoped to the namespace. The session account must be its current on-chain owner.
The array replaces the full allowlist. The response includes unsigned xdr, signer, namespace, resolverId, network and ok. After owner approval, use POST /console/tx/submit with { "xdr": "<signed transaction>" } and the same session and namespace headers.

Failure meanings

Inactive names and missing namespaces also produce errors. Preserve those errors separately from a successful address: null.