v2

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-12308185.7 KB
domain_registration

Register a domain

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.

post/domains

Query parameters

$previewboolean

Allows simulating the operation creation (when set to true), without actually starting any processing. This can be used to validate the operation will be permitted and get a preview of the initial outcome.

When used, the operation in the response will have PREVIEW for all id and status values.

Request body

namestring required
recordsUpdateDomainRecords

Example request

{
  "name": "matt.crypto",
  "records": {
    "crypto.ETH.address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e4321",
    "crypto.MATIC.version.MATIC.address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e5678",
    "crypto.MATIC.version.ERC20.address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e0921"
  }
}

Response

@type'unstoppabledomains.com/partner.v3.DomainOperationResult' required

Example response

{
  "operation": {
    "id": "op-4abb409c-9283-4589-bd36-d27a757a2165",
    "domain": "matt.crypto",
    "lastUpdatedTimestamp": 1684356429790,
    "dependencies": [
      {
        "id": "bc-2db427bd-5613-40c7-85b1-ab38beed0ed0",
        "parameters": {
          "initialRecords": {
            "crypto.ETH.address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e4321",
            "crypto.MATIC.version.MATIC.address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e5678",
            "crypto.MATIC.version.ERC20.address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e0921"
          },
          "toAddress": "0xb4783AeF93923a2d4eEA29C84f347F26E62e4321"
        }
      }
    ]
  }
}