Skip to content
Partner/
/
Get domain details and av...

Partner API v3 (3.0.0)

Feature Overview

The Partner API v3 provides you with the ability to lookup, register and manage Web3 domains. The API exposes a RESTful interface for interacting with Web3 domains and the Unstoppable Domains registry.

  • Lookup Domains: Search for specific domains or find suggested alternatives, to determine pricing, availability and on-chain details
  • Registering Domains: Secure domains into your dedicated Custody wallets to maintain the domains on the blockchain
  • Manage Domains: Update records on the blockchain or transfer the domain to external owners, all through a simple API interface

Custody Solution

The API takes the hassle of Web3 out of the equation. Unstoppable Domains will handle all blockchain interactions and concepts, while Partners simply use a RESTful API for managing domains.

Since the domains will be in custody of the Partner, through Unstoppable Domains, the Partner is empowered to make any and all changes to the domains on behalf of their users.

Under the hood, Unstoppable Domains will manage dedicated custodial wallets for Partner-owned domains. These wallets are not shared between Partners and will uniquely identify the Partner on the various supported blockchains.

Should the need arise to remove domains from custody, this is supported by changing the owner of domains to external owners.

Payments

The API will keep track of a running balance of charges and Unstoppable Domains will periodically invoice Partners to settle that balance. This empowers Partners to build payment processing in a way that works best for them.

Blockchain Support

Domain details can be viewed across all of our supported blockchains:

  • Ethereum (ETH)
  • Polygon PoS (MATIC)
  • Base (BASE)

Domains can only be managed on Polygon PoS (MATIC) and Base (BASE). Domains on Ethereum (ETH) are readonly, but management support is coming soon.

Important Concepts

The API has some important concepts, in addition to Web3 Domains, that provide added utility, consistency and information.

Domain Ownership Type

Web3 domains exist on the supported Blockchains, and are owned by wallet addresses associated with those Blockchains. We take ownership a step further, to provide improved security and reliability, by including an owner type in our ownership data. The result is that a Domain's owner is defined by two values: address and type

The owner type can be one of the following:

  • NONE: Either the domain has never been owned or belongs to a "burn" address
  • UD: Owned by Unstoppable Domains
  • SELF: Domain belongs to a wallet addressed associated with your account, indicating you are able to manage it via the API
  • EXTERNAL: Owner doesn't qualify as any of the above. Changing to an EXTERNAL owner 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.

By defining an owner in two parts (address and type) we ensure any irreversible action, such as transferring ownership, is deliberate and intended by requiring both the address and type in the request.

Operations

All interactions with the API that initiate changes will create an Operation for tracking that change. Operations can complete immediately or run in the background over the course of several minutes, depending on the Operation type and current conditions on the Blockchain.

Operations include dependencies that represent the smaller units of work associated with the overall operation. These dependencies can also be tracked through the API and each have their own status and metadata.

Your integration should properly handle and anticipate all of the following possible statuses for Operations and their dependencies:

  • QUEUED : The Operation has not started processing yet, but should be started shortly
  • PROCESSING : The Operation has started, often involving sending transactions to the Blockchain
  • SIGNATURE_REQUIRED: The operation is awaiting a signature in order to continue processing. This is only relevant to Self-Custody domain management.
  • COMPLETED : The Operation has finished processing successfully
  • FAILED : The Operation has finished processing and has either fully or partially failed
  • CANCELLED : The Operation has been cancelled, usually due to a failure with a sibling dependency

See the Operations API for additional information.

Wallets

Domains ownership on the Blockchain is handled by associating a Domain with an "address". These addresses are typically managed by Wallets (usually in the form of an application on your computer or mobile device) that manage the private key for the public "address".

The API provides endpoints for creating/managing Wallets within your account to enable you to handle Domain ownership distribution in whatever way works for you. Any Domain that is owned by one of your account's Wallets is fully in your control to manage.

See the Wallets API for additional information.

Get Access

See our quickstart guide for getting your Partner API key: Set up Partner API Access

If you have any questions, contact our Partner Engineering Team to help with API access or learn more.

Overview
Unstoppable Domains (Partner Engineering)
partnerengineering@unstoppabledomains.com
Languages
Servers
Production
https://api.unstoppabledomains.com/partner/v3/
Sandbox
https://api.ud-sandbox.com/partner/v3/

Suggestions

Suggestions for finding available domains

Operations

Domain Lookup & Registration

Domain details/availability lookups and registration.

Operations

Lookup multiple domain details and availability

Request

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.

Security
bearer
Query
$expandArray of strings

Use $expand options to conditionally include portions of the response

Items Enum"records""registration"
endingArray of strings or DomainName (string)

TLD or Parent Domain to apply to your query base names

queryArray of strings or DomainName (string)required
Any of:
string
tldsArray of stringsDeprecated

Use ending instead

Example: tlds=crypto
curl -i -X GET \
  'https://api.unstoppabledomains.com/partner/v3/domains?%24expand=records&ending=example-name&query=example-name&tlds=crypto' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
@typestringrequired
Value"unstoppabledomains.com/partner.v3.List"
itemsArray of objects(DomainSearchResponse)required
items[].​@typestringrequired
Value"unstoppabledomains.com/partner.v3.Domain"
items[].​recordsnull or DomainRecords (object)
One of:
null
items[].​namestring(DomainName)required
items[].​ownerobject(DomainOwnerResponse)required
items[].​owner.​typestring(OwnerType)required
Enum"NONE""UD""SELF""EXTERNAL"
items[].​owner.​addressEvmOwnerAddress (string)(OwnerAddress)
EvmOwnerAddress (string)(OwnerAddress)
items[].​availabilityobject(DomainAvailabilityResponse)required
items[].​availability.​statusstring(DomainAvailabilityStatus)required
Enum"AVAILABLE""AVAILABLE_FROM_ISSUER""REGISTERED""PROTECTED""COMING_SOON""DISALLOWED""RESERVED""EXCEEDS_PRICE_LIMIT"
items[].​availability.​priceobject(DomainPriceResponse)
items[].​availability.​issuerobject(DomainOwnerResponse)
items[].​registrationnull or DomainRegistrationResponse (object)
One of:
null
items[].​blockchainstring(BlockchainType)
Enum"MATIC""ETH""BASE"
Response
application/json
{
  "@type": "unstoppabledomains.com/partner.v3.List",
  "items": [
    { … }
  ]
}

Register a domain

Request

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.

Security
bearer
Query
$previewboolean(OperationPreviewParameter)

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.

Default false
Bodyapplication/jsonrequired
namestring(DomainName)required
recordsobject(UpdateDomainRecords)<= 500 properties
ownerobject(DomainMintRequestBodyOwner)
curl -i -X POST \
  'https://api.unstoppabledomains.com/partner/v3/domains?%24preview=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "matt.crypto",
    "records": {
      "crypto.ETH.address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e4321",
      "crypto.MATIC.version.MATIC.address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e5678",
      "crypto.MATIC.version.ERC20.address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e0921"
    },
    "owner": {
      "type": "NONE",
      "address": "string"
    }
  }'

Responses

Bodyapplication/json
@typestringrequired
Value"unstoppabledomains.com/partner.v3.DomainOperationResult"
operationobject(OperationCheckResponse)required
operation.​idstringrequired
Example: "op-4abb409c-9283-4589-bd36-d27a757a2165"
operation.​@typestringrequired
Value"unstoppabledomains.com/partner.v3.Operation"
operation.​statusstring(OperationStatus)required
Enum"QUEUED""SIGNATURE_REQUIRED""PROCESSING""COMPLETED""FAILED""CANCELLED"
operation.​typestring(OperationType)required
Enum"DOMAIN_CLAIM""DOMAIN_UPDATE""DOMAIN_RETURN""WALLET_CREATE""WALLET_UPDATE""WALLET_VERIFY""ACCOUNT_UPDATE"
operation.​domainstring(DomainName)
operation.​lastUpdatedTimestampnumberrequired
Example: 1684356429790
operation.​dependenciesArray of SubOperationResponse (object)required
Any of:
operation.​dependencies[].​idstringrequired
Example: "bc-2db427bd-5613-40c7-85b1-ab38beed0ed0"
operation.​dependencies[].​statusstringrequired
Enum"QUEUED""SIGNATURE_REQUIRED""PROCESSING""COMPLETED""FAILED""CANCELLED"
operation.​dependencies[].​@typestringrequired
Value"unstoppabledomains.com/partner.v3.BlockchainOperation"
operation.​dependencies[].​transactionobject(SubOperationTransactionResponse)
operation.​dependencies[].​typestringrequired
Value"MINT"
operation.​dependencies[].​parametersobject(MintParametersResponse)required
operation.​dependencies[].​parameters.​initialRecordsobject(DomainRecords)
operation.​dependencies[].​parameters.​toAddressEvmOwnerAddress (string)(OwnerAddress)required
EvmOwnerAddress (string)(OwnerAddress)
Response
application/json
{
  "@type": "unstoppabledomains.com/partner.v3.DomainOperationResult",
  "operation": {
    "id": "op-4abb409c-9283-4589-bd36-d27a757a2165",
    "@type": "unstoppabledomains.com/partner.v3.Operation",
    "status": "QUEUED",
    "type": "DOMAIN_CLAIM",
    "domain": "matt.crypto",
    "lastUpdatedTimestamp": 1684356429790,
    "dependencies": [ … ]
  }
}

Get domain details and availability

Request

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.

Security
bearer
Path
namestring(DomainName)required
Example: matt.crypto
Query
$expandArray of strings

Use $expand options to conditionally include portions of the response

Items Enum"records""registration"
curl -i -X GET \
  'https://api.unstoppabledomains.com/partner/v3/domains/matt.crypto?%24expand=records' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
@typestringrequired
Value"unstoppabledomains.com/partner.v3.Domain"
recordsnull or DomainRecords (object)
One of:
null
namestring(DomainName)required
ownerobject(DomainOwnerResponse)required
owner.​typestring(OwnerType)required
Enum"NONE""UD""SELF""EXTERNAL"
owner.​addressEvmOwnerAddress (string)(OwnerAddress)
EvmOwnerAddress (string)(OwnerAddress)
availabilityobject(DomainAvailabilityResponse)required
availability.​statusstring(DomainAvailabilityStatus)required
Enum"AVAILABLE""AVAILABLE_FROM_ISSUER""REGISTERED""PROTECTED""COMING_SOON""DISALLOWED""RESERVED""EXCEEDS_PRICE_LIMIT"
availability.​priceobject(DomainPriceResponse)
availability.​issuerobject(DomainOwnerResponse)
registrationnull or DomainRegistrationResponse (object)
One of:
null
blockchainstring(BlockchainType)
Enum"MATIC""ETH""BASE"
Response
application/json
{
  "@type": "unstoppabledomains.com/partner.v3.Domain",
  "records": {},
  "name": "matt.crypto",
  "owner": {
    "type": "NONE",
    "address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e4321"
  },
  "availability": {
    "status": "AVAILABLE",
    "price": { … },
    "issuer": { … }
  },
  "registration": {},
  "blockchain": "MATIC"
}

Custody Wallets

Manage custody wallets used for storing and managing domains without any signature collection.

These wallets provide the most streamlined way to interact with domains since the initial management request is the only step needed to make changes.

Operations

Custody Domains

Manage your custody domains.

Operations

Self-Custody Wallets

Manage self-custody wallets to allow for management of self-custody domains.

Operations

Self-Custody Domains

Manage domains that are owned in external, self-custody wallets.

The key difference between Custody and Self-Custody operations is that all Self-Custody operations require a signature from the domain owner.

Before you can initiate self-custody operations, you must verify the self-custody wallet that owns the domain.

Operations

Operations

All asynchronous processes handled by the API are represented as Operations. This includes registering a domain, updating a domain's records, changing a domain's owner, returning a domain and more.

OperationsWebhooks

Account

Manage your account details

Operations

Owners

Search for owned domains

Operations

Webhooks

Manage webhooks used for asynchronous updates to your server.

You can follow our getting started guide here: Webhooks in the Partner API

Operations