Abstract

With the NameStudio™ API you receive suggestions for domain names according to various criteria. The NameStudio™ API is based on Versigns API.

Activating NameStudio™ API in AutoDNS

You can activate the NameStudio™ API via your AutoDNS account:  User Management / User Configuration / User Profile / API Settings / NameStudio™ API.

To activate click on the button "Activate NameStudio™ API". A confirmation window will open, in which you have to click on "Activate NameStudio™ API" again.

Access data is required here. Your AutoDNS access data is entered by default. You can also assign a new password (at least 6 characters).

Deleting the Activation

You can delete the activation for the NameStudio™ API in your user profile: User Management / User Configuration / User Profile / API Settings / NameStudio™ API

To delete your account click on the button "Delete NameStudio™ API Account". A confirmation window will open in which you have to enter your access data for NameStudio API™ and click "Delete NameStudio™ AP Account" again.

URL

https://api.autodns.com/namesuggestion/v1/$endpoint

Different endpoints can be used instead of $endpoint.

Authentication

Authentication is done via HTTP Basic-Auth.

HTTP Status Codes

MIME Type

Response and request must be: application/json.

Limits

The request limit is 60 requests per second.

Endpoints

Endpoint "suggest" (main)

https://api.autodns.com/namesuggestion/v1/suggest

The suggest endpoint delivers a turn-key solution for generating relevant and effective suggestions for domain name queries. It combines keyword segmentation, related suggestions, creative, name-shortening suggestions and more.

Additionally, optional parameters can be used for further customization, such as specifying the inclusion or exclusion of numbers or hyphens, as well as the ability to enable or disable IDN results.

Allowed Keys

• name
• tlds
• lang
• ip-address
• lat-lng
• use-numbers
• use-idns
• use-dashes
• sensitive-content-filter
• include-registered
• max-length
• max-results
• include-suggestion-type
• use-whoisproxy

Endpoint "rank-tlds"

https://api.autodns.com/namesuggestion/v1/rank-tlds

This endpoint ranks TLDs for a given input domain name based on relevance, popularity (based on TLD zone size) or geography.

Allowed Keys

• name
• tlds
• lang
• ip-address
• lat-lng
• max-results
• include-registered
• sort-order
• use-whoisproxy

Endpoint "suggest-personal-names"

https://api.autodns.com/namesuggestion/v1/suggest-personal-names

This endpoint generates domain names from personal names (first-name, middle-names, last-name).

Allowed Keys

• first-name
• last-name
• tlds
• middle-names
• spin-first-name
• lang
• use-numbers
• use-idns
• use-dashes
• sensitive-content-filter
• max-length
• max-results
• include-registered
• use-whoisproxy

Endpoints "add-prefix" and "add-suffix"

https://api.autodns.com/namesuggestion/v1/add-prefix

https://api.autodns.com/namesuggestion/v1/add-suffix

The "add-prefix" and "add-suffix" endpoints provide relevant affix (both syntactically and semantically) suggestions for domain names.

Allowed Keys

• name
• tlds
• lang
• vocabulary
• use-numbers
• use-idns
• use-dashes
• sensitive-content-filter
• include-registered
• max-length
• max-results
• use-whoisproxy

Endpoint "spin-word"

https://api.autodns.com/namesuggestion/v1/spin-word

This endpoint finds syntactically and semantically relevant alternatives for one word within the input domain and replaces that word to give new suggested domain names.

Allowed Keys

• name
• tlds
• lang
• position
• similarity
• use-numbers
• use-idns
• sensitive-content-filter
• include-registered
• max-length
• max-results
• use-whoisproxy

Endpoint "bulk-check"

https://api.autodns.com/namesuggestion/v1/bulk-check

The "bulk-check endpoint" performs bulk availability checks for supported TLDs with a single query.

Allowed Keys

• names
• tlds
• include-registered

Keys

Availability Check

Every endpoint returning domain name suggestions will include an availability status for each domain. The availability check is not authoritative and should be used for informational purposes only. Additionally, a "bulk-check" endpoint has been introduced to perform a large number (max 1000 domain names) of availability checks with a single query.

Availability checks are currently offered in Verisign-operated TLDs and other select TLDs. Availability checks in non-Verisign-operated TLDs are subject to change. For TLDs for which we do not provide availability checks, the API response will have the status “unknown.”

As post filter you have to possibility to check this results via InterNetX WhoisProxy to get more accurate results. You only need to set the Flag use-whoisproxy. The max. results are then reduced to 100.

Query Example with CURL

cat request.json | curl -X POST --user 'user:password'  -H 'Content-type: application/json' 'https://api.autodns.com/namesuggestion/v1/suggest' --data-binary @-

JSON Example

The following example request searches for the terms sport, house and cat in the TLDs  .com, .net, .ltda and .shop.  It restricts the results to a total of 20 and domain length of 15 and uses the whois proxy for the .ltda and .shop TLDs. The request is sent to the /suggest endpoint.

{
   "name":"sport,house,cat",
   "tlds":[
      "com",
      "net",
      "ltda",
      "shop"
 ],
   "lang":"eng",
   "ip-address":"",
   "lat-lng":"",
   "include-registered":false,
   "max-results":20,
   "use-numbers":false,
   "use-idns":false,
   "use-dashes":null,
   "sensitive-content-filter":false,
   "max-length":15,
   "include-suggestion-type":false,
   "use-whoisproxy":true
}

{  
   "data":[  
      {  
         "name":"SportHouseCat.com",
         "availability":"available"
      },
      {  
         "name":"PokerHouseCat.com",
         "availability":"available"
      },
      {  
         "name":"MySportHouseCat.com",
         "availability":"available"
      },
      {  
         "name":"SportHouseCat.shop",
         "availability":"available(whois)"
      },
      {  
         "name":"SportHouseCat.net",
         "availability":"available"
      },
      {  
         "name":"SportHouseCat.ltda",
         "availability":"available(whois)"
      },
      {  
         "name":"GolfHouseCat.com",
         "availability":"available"
      },
      {  
         "name":"PokerHouseCat.shop",
         "availability":"available(whois)"
      },
      {  
         "name":"PokerHouseCat.net",
         "availability":"available"
      },
      {  
         "name":"MySportHouseCat.net",
         "availability":"available"
      },
      {  
         "name":"SpHoCa.com",
         "availability":"available"
      },
      {  
         "name":"SHC.shop",
         "availability":"available(whois)"
      },
      {  
         "name":"MySportHouseCat.shop",
         "availability":"available(whois)"
      },
      {  
         "name":"GolfHouseCat.shop",
         "availability":"available(whois)"
      },
      {  
         "name":"PokerHouseCat.ltda",
         "availability":"available(whois)"
      },
      {  
         "name":"SpHoCa.shop",
         "availability":"available(whois)"
      },
      {  
         "name":"GoSportHouseCat.com",
         "availability":"available"
      },
      {  
         "name":"SportHouseCap.com",
         "availability":"available"
      },
      {  
         "name":"GoSportHouseCat.shop",
         "availability":"available(whois)"
      },
      {  
         "name":"GolfHouseCat.net",
         "availability":"available"
      }
   ]
}

Namestudio Postman Collection

Need direct access to a working Namestudio Postman Collection? Visit https://namestudio.internetx.host

Supplier List:

Depending on the location of the supplier, data will be forwarded to the respective country.
Organization: VeriSign Global Registry Services 
Address: 12061 Bluemont Way,Reston Virginia 20190,United States