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 claimed it will have a availability.status of AVAILABLE and will include an availability.price object.

If a domain is available, use this route to claim 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.

Claim 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 claim to one of your own wallets, the type must be SELF. Use GET /account/wallets to see your list of available wallets.

If a subdomain is available, and the Parent domain in your account's custody, use this route to claim 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.

Claim 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 claim to one of your own wallets, the type must be SELF. Use GET /account/wallets to see your list of available wallets.

After Claiming

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

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

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 claimed it will have a availability.status of AVAILABLE and will include an availability.price object.

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.

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.

Return the domain to Unstoppable Domains so it is once again considered available for claiming. 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 claim date, per our return policy.

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.

Any domains held in these wallets can be managed by your account. You can use these wallets to distribute domains in whatever way works best for you.

Create an additional custodial wallet in your account.

Change your default wallet address, which is used when no wallet address is specified during domain claiming.