Search in this section
Abstract
Name Suggestion Service based on Versigns API.
Authentication
Authentication is done via HTTP BasicAuth.
HTTP Status Codes
HTTP Status | Description |
---|---|
200 OK | Everything's ok. |
400 Bad Request | Something went wrong. Check Response Message Tag |
401 Unauthorized | Authentication Issues |
500 - Internal Server Error | Internal error. Please contact us and provide details of the query. |
501 - Not Implemented | The feature is not implemented |
502 - Bad Gateway | API server error. Please contact us and provide details of the query. |
200 OK | Everything's ok. |
MIME Typ
Response and Request are application/json.
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
- id-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
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-name
- 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
Parameter name | Type | Default value | Description |
---|---|---|---|
name | String (Unicode or Punycode) | required | Seed domain name. If the seed domain name includes a TLD (e.g. seeddomain.example), then that TLD will also be used for suggestions. See the tlds parameter for more info. |
names | List of strings (Unicode or Punycode) | required | List of domain names (sld only or sld.tld). |
tlds | List of strings (Unicode or Punycode) | com,net | List of TLDs to use for suggestions and availability checks. Defaults to .com and .net if none are specified. If one or more TLDs are specified in the tlds parameter, only those TLDs will be used. Use the string “@all” as a value to return all supported TLDs. Use “@checked” to return all the TLDs that are checked for availability. If the name parameter includes a TLD, then that TLD will also be used for suggestions and availability checks. |
lang | String | eng | Language of the names (used for normalization). |
ip-address | String | optional | Include suggestions based on the approximate geolocation of the provided IP address. |
lat-lng | Comma Separated Double Values | optional | Include suggestions based on the approximate geolocation of the latitude and longitude parameter. Geolocation, in the format: latitude,longitude Valid latitude values: -90.0 to 90.0 Valid longitude values: -180.0 to 180.0 E.g., lat-lng=51.50,-0.126 |
use-numbers | Boolean | true | Also generate suggestions containing numbers. |
use-idns | Boolean | true | Return IDNs or use ASCII only (names will be normalized according to the lang). |
use-dashes | Boolean | null | Also generate suggestions containing dashes. When “true”, suggestions will include dashes. When “false”, suggestions will exclude dashes. When “null”, suggestions will include dashes if name contains dashes. |
sensitive-content- filter | Boolean | false | Filter sensitive content from the results. |
include-registered | Boolean | false | Include registered domain names in the results. |
max-length | Integer between 2 and 63 | 63 | Maximum length of the SLDs to return. |
include-suggestion-type | Boolean | false | Include type of algorithms used to generate the suggested SLD and TLD. |
vocabulary | List of strings (Unicode or Punycode) | “@prefixes“ (/add-prefix) or “@suffixes” (/add-suffix) | Vocabulary to use when picking the affixes. Can be empty (i.e use every word in the language), or a list of custom words (max. 2000), or references to predefined lists ("@prefixes", "@suffixes" are predefined popular affix lists). Note that several lists and words can be mixed (e.g.: "computer, services, @prefixes, mouse, dragon, @suffixes, tips"). |
position | Integer with a value between 0 and the number of words in the input less 1 | all positions | Position of the word for selective word suggestion starting with “0” for the first word. |
similarity | Double with a value between 0.00 and 1.00 | 0.60 | The higher this value, the closer the alternate words will be to the original word. |
first-name | String (Unicode or Punycode) | First name. | |
middle-names | List of strings (Unicode or Punycode) | optional | List of middle names. |
last-name | String (Unicode or Punycode) | Last name. | |
sort-order | String | relevance | Order by relevance / popularity (based on TLD zone size) / geographic |
use-whoisproxy | Boolean | false | Check availability via InterNetX WhoisProxy for not supported Domains, see @checked in parameter tlds. |
Query Example with CURL
curl --user 'user:password' -H 'Accept: application/json' https://api.autodns.com/namesuggestion/v1/suggestion
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 }