Name Suggestion API

Abstract

Name Suggestion Service based on Versigns API.

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

suggest (main)

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

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

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

add-prefix / 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

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

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

{
   "name":"sport",
   "tlds":[
      "com",
      "net"
   ],
   "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":63,
   "include-suggestion-type":false,
   "use-whoisproxy":false
}