All domains returned by this route are available for registration

Get domain availability and owner details for multiple domains using the query string search options. Optionally, use the $expand query string to include additional data in the response (ie. ?$expand=records&$expand=registration).

If the domain is available to be registered it will have a availability.status of AVAILABLE and will include an availability.price object.

If a domain is available, use this route to register it to your account. The domain will be minted or transfered to your custodial wallet where only Unstoppable Domains, on your behalf, will be able to make changes to it.

The price of the domain will be automatically added to your running balance with Unstoppable Domains. The pending balance of your account will be invoiced periodically.

Register to specific owner

If you do not provide an owner in your request, your account's default wallet address will be used as the owner. Use GET /account to confirm your default wallet address.

When providing an owner object in your request, be sure the type aligns with the address. To register to one of your own wallets, the type must be SELF. Use GET /account/wallets to see your list of available wallets.

Subdomains

Registering subdomains requires ownership of the parent domain. There are dedicated routes for subdomain registration:

• Parent domain is held in a custody wallet
• Parent domain is held in a self-custody wallet

Get information about the domain's current owner and availability status. Optionally, use the $expand query string to include additional data in the response (ie. ?$expand=records&$expand=registration).

If the domain is available to be registered it will have a availability.status of AVAILABLE and will include an availability.price object.

Any domains held in the wallets of type SELF can be managed by your account without any signature collection. You can use these SELF wallets to distribute domains in whatever way works best for you.

This route will return both custody (SELF) and self-custody (EXTERNAL) wallets associated with your account. To only list custody wallets, simply include the ?type=SELF query string parameter.

Create an additional custodial wallet in your account.

Get details for a wallet associated with your account. This route supports both custody (SELF) and self-custody (EXTERNAL) wallets.

Include the ?$expand=primaryDomain to include the wallet's Primary Domain (also known as the Reverse Resolution) in the response.

Update details for a specific custody wallet in your account.

This can be used to set (or clear) the Primary Domain (also known as the Reverse Resolution) for a custody wallet.

To clear the Primary Domain for a wallet, pass a null value for the primaryDomain property within the request body.

If a subdomain is available, and the Parent domain in your account's custody, use this route to register it to your account. The domain will be minted or transfered to your custodial wallet where only Unstoppable Domains, on your behalf, will be able to make changes to it.

The price of the domain will be automatically added to your running balance with Unstoppable Domains. The pending balance of your account will be invoiced periodically.

Register to specific owner

If you do not provide an owner in your request, your account's default wallet address will be used as the owner. Use GET /account to confirm your default wallet address.

When providing an owner object in your request, be sure the type aligns with the address. To register to one of your own wallets, the type must be SELF. Use GET /account/wallets to see your list of available wallets.

After Registering

After successfully registering a subdomain to your account, you can use any of the Domain management APIs to manage it just like any other domain.

While registering subdomains uses a different process, in every other way a subdomain is just like a second-level domain.

Perform Domain updates while preserving the existing records.

Change Owner with Records Preserved

{
  "owner": {
    "type": "EXTERNAL",
    "address": "0x123"
  }
}

Changes owner to the new owner address without modifying the domain records.

Owner Types

When changing owner of a domain, you must provide both a type and an address to clearly indicate the intent of the change.

• NONE: Used when changing the owner to a "burn" address, which will result in nobody owning the domain
  • Valid "burn" addresses are 0x0000000000000000000000000000000000000000 and 0x000000000000000000000000000000000000dEaD
• UD: Used when changing the owner to an addressed owned by Unstoppable Domains
• SELF: Used when changing the owner to another address that belongs to your account
• EXTERNAL: Used when changing the owner to address that doesn't qualify as any of the above.
  • WARNING: This will result in the domain belonging to an address outside of the management of Unstoppable Domains and we will have no way to recover it.

Update Records with existing Records Preserved

{
  "records": {
    "key2": "value2"
  }
}

When applied to a domain with existing records, or with an existing key2, will result in only the key2 value being set to the new value.

See our documentation for more information on standardized keys.

Perform Domain updates while doing full resets of the records.

Change Owner with Record Reset

{
  "owner": {
    "type": "EXTERNAL",
    "address": "0x123"
  },
  "records": {}
}

Clears all records from the domain, then changes owner to the new owner address.

NOTE: You must include "records": {} to indicate the intent to clear records.

Owner Types

When changing owner of a domain, you must provide both a type and an address to clearly indicate the intent of the change.

• NONE: Used when changing the owner to a "burn" address, which will result in nobody owning the domain
  • Valid "burn" addresses are 0x0000000000000000000000000000000000000000 and 0x000000000000000000000000000000000000dEaD
• UD: Used when changing the owner to an addressed owned by Unstoppable Domains
• SELF: Used when changing the owner to another address that belongs to your account
• EXTERNAL: Used when changing the owner to address that doesn't qualify as any of the above.
  • WARNING: This will result in the domain belonging to an address outside of the management of Unstoppable Domains and we will have no way to recover it.

Update Records with Record Reset

{
  "records": {
    "key2": "value2"
  }
}

When applied to a domain with existing records, only key2 will remain after the update is complete.

See our documentation for more information on standardized keys.

Return the domain to Unstoppable Domains so it is once again considered available for registering. The amount previously added to your running balance will be removed after successfully returning a domain.

Returns are only allowed within 14 days of the original registration date, per our return policy.

In order to use an self-custody wallet within the API, you must first use it to sign a verification message. This endpoint will provide the specific substring that needs to be signed.

The response message is meant to be included in personal_sign request for the wallet owner to sign. The exact message that is signed simply needs to include the response message, so you can include some human-friendly text, as well.

After signing the verification message, submit the signature to have the self-custody wallet registered as a verified external wallet for management operations.

If the message the owner signed was not the exact message from the verification response, you must also provide the exact message in the request body. It should be the non-hex string used in the personal_sign request.

These wallets are verified EXTERNAL wallets that you can use for initiating self-custody domain operations. Any operation initiated for one of these wallets requires an external signature.

Get details for a single self-custody wallet that has verified for your account.

Include the ?$expand=primaryDomain to include the wallet's Primary Domain (also known as the Reverse Resolution) in the response.

Update details for a specific self-custody wallet in your account.

This can be used to set (or clear) the Primary Domain (also known as the Reverse Resolution) for a domain.

To clear the Primary Domain for a wallet, pass a null value for the primaryDomain property within the request body.

Note: This will create an operation that requires a signature from the self-custody wallet owner.

Perform Self-Custody Domain updates while doing full resets of the records. Usage is the same as the custody variant.

Perform Self-Custody Domain updates while preserving the existing records. Usage is the same as the custody variant.

The parent domain must belong to a wallet that has been verified. Usage is the same as the custody variant.

Get paginated list of past operations, with the ability to filter based on various criteria.

Results ordered with newest operations first.

Use this endpoint to check on the status for any Operation being processed by the API.

Sign operation dependency with status SIGNATURE_REQUIRED so it can continue processing

Unlike the operation list route, this endpoint will return a minimal representation of pending operations for a domain across all activity for a given domain.

Since we only allow a single concurrent operation for a domain (across all accounts), this endpoint should be checked before attempting any domain operations. This is particularly important for self-custody domains, as any account (or even the owner themself) can initiate operations.