Skip to content

Generate Domain Names

POST
/provider-domains/generate-domains

Suggest buyable domain names around a keyword. SPENDS NOTHING.

A naming aid, not a reservation: a name returned here can still be gone by the time you buy it, so check-availability remains the authority.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Suggest buyable domain names around a keyword. SPENDS NOTHING.

object
count

How many suggestions to return

integer
default: 5 >= 1 <= 100
keyword
required

Seed word the generated names are built around, e.g. ‘acme’

string
prefixes
Any of:
string
provider

Provisioning path to generate for

string
default: registrar
Allowed values: registrar managed pilot
suffixes
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for one provider/deliverability result.

Open on purpose. These payloads are provider state and advisory reads whose contents grow with the product, and a dropped field reads as “nothing to report” rather than “we did not tell you”. Every value passes through scrub_vendor_names on the way in.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string