Partner API v2 (Legacy) (2.0.0)

Unstoppable Domains (Partner Engineering): partnerengineering@unstoppabledomains.com

The Partner API v2 requires you to be authorized to access. To access the Partner API v2 and integrate it into your application, check our Set up Partner API Access guide.

orders

Create an order and get the status of orders

Buy a domain or claim for free

This API endpoint is used for buying domains from UD. The blockchain needs time before a transaction is mined. In rare cases, it is possible for someone to front run your purchase, which would result in an order being cancelled. We expect this to happen in less than 1 out of 10000 cases. Please make sure you are using the 'Order Status' endpoint and wait until the transaction is mined. Endpoint requires one of the following: email, owner address, or useResellerCustodialWallet. If email is provided - domain will be linked to Unstoppable website account. If owner address is provided - domain will be minted right into crypto wallet. If ownerAddress is not provided and useResellerCustodialWallet = true, the domain will be minted to the reseller's custodial wallet. Optionally user can specify domain records that will be added to the domain once it's minted (i.e. if owner address is provided).

SecurityApiSecret
Request
Request Body schema: application/json
object (OrderPayment)

Payment type and parameters

Array of objects (OrderSecurity)
Array of objects
Responses
200

Successful

400

Bad Request

401

Partner Not Found

post/orders
Request samples
application/json
{
  • "payment": {
    },
  • "security": [
    ],
  • "domains": [
    ]
}
Response samples
application/json
{
  • "orderNumber": "-Lm9wiYytgrpf4YCWYv6",
  • "payment": {
    },
  • "total": 0,
  • "items": [
    ]
}

Get order status by order number

Use this endpoint to pull the status of the order

Request
path Parameters
orderNumber
required
string

ID of the order

Example: -Lm9wiYytgrpf4YCWYv6
Responses
200

Successful

401

Partner Not Found

404

Order Not Found

get/orders/{orderNumber}
Request samples 
Response samples 
application/json
{
  • "orderNumber": "-Lm9wiYytgrpf4YCWYv6",
  • "payment": {
    },
  • "total": 0,
  • "items": [
    ]
}
domains
Check domain availability and suggestions for purchase or claim


Check multiple domain names availability
Check multiple domain names availability


SecurityApiSecret 
Request 
query Parameters
search
required
Array of strings
Keywords that will be used to check domain(s) availability. Can be domain name(s) with or without TLD.


 
 Example:  search=fancyfox123.crypto&search=firstname&search=domainsforfree1.888
Responses 
200
Successful


400
Bad Request


401
Partner Not Found


get/domains
Request samples 
Response samples 
application/json
{
  • "domains": [
    ]
}
Check domain name availability
Check domain name availability


Request 
path Parameters
domainName
required
string
 
 Example:  beresnev.crypto
Responses 
200
Successful


400
Bad Request


401
Partner Not Found


get/domains/{domainName}
Request samples 
Response samples 
application/json
{
  • "domain": {
    },
  • "availability": {
    }
}
Get domains suggestions
This endpoint is used to provide domains variants based on provided domains and label. Method will provide domains similar to domains provided in domains parameter.


Request 
query Parameters
search
Array of strings
Keywords that will be used to build FREE domain suggestions. Can be TLD or domain name.


 
 Example:  search=fancyfox123.crypto&search=firstname&search=domainsforfree1.888
tlds
Array of strings
Limit suggestions output by specific TLDs (crypto, dao, etc.)


 
 Example:  tlds=crypto&tlds=nft&tlds=888
Responses 
200
Valid


400
Bad Request


401
Partner Not Found


get/domains/suggestions
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    },
  • {
    }
]
Get free domains suggestions
This endpoint is used to provide free domains suggestions if a partner is eligible for free domains. If partner isn't eligible for free domains suggestions - endpoint will return error.


Request 
query Parameters
search
Array of strings
Keywords that will be used to build FREE domain suggestions. Can be TLD or domain name.


 
 Example:  search=fancyfox123.crypto&search=firstname&search=domainsforfree1.888
tlds
Array of strings
Limit suggestions output by specific TLDs (crypto, dao, etc.)


 
 Example:  tlds=crypto&tlds=nft&tlds=888
Responses 
200
Valid


400
Bad Request


401
Partner Not Found


get/domains/suggestions/free
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    },
  • {
    }
]
Reserve free domain name for period of time
Reserve free domain name for external user identifier. Usually it's a user identifier or email in a partner's system. Domain name becomes unavailable for selling and claiming to anyone except identity that reserved the domain. Only one domain could be reserved per resellerIdentityKey. Reserve time is 168 hours.


SecurityApiSecret 
Request 
path Parameters
domainName
required
string
 
 Example:  beresnev.crypto
Request Body schema: application/json
resellerIdentityKey
string
Unique external identifier of user. Could by ANY string value. Unstoppable will try to match internal and external user id.


 
Responses 
200
Valid


400
Bad Request


401
Partner Not Found


post/domains/{domainName}/reserve
Request samples 
application/json
{
  • "resellerIdentityKey": "example@user.com"
}
Response samples 
application/json
{
  • "error": {
    },
  • "constraints": [
    ]
}
security
Prepare security parameters for domain orders


Get Fingerprint Public Key
Use this endpoint to fetch Fingerprint public keys


Responses 
200
Successful


post/security/fingerprintjs/keys
Request samples 
Response samples 
application/json
{
  • "key": "TSveZYwtMdTcHjY9MEPa"
}