Need help? Call Live Support at +31 (0) 38 453 07 59

Attention! You're currently using the OT&E environment.

Action: Suggest

The `suggest` action is used to generate suggestions for available domains based on the input. The input is free format and does not have to be a domain name, dependant on the enabled suggestion providers keywords or entire LLM prompts are possible.

  • WebsocketsMethod
  • wss://adac.api.yoursrs.com/ws?session_id=sessionIdURL
  • application/jsonContent-Type
URL fields
Name Type Description Restrictions
sessionId String UUID4, unique to session
Request content fields
Name Type Required / Optional Description Restrictions
api_key String Required Your ADAC API key
action Enum Required Action to perform

Possible values:

  • suggest
data data Required
data
Name Type Required / Optional Description Restrictions
input String Required Input query
  • Minimum length: 1
hints hints Optional Parameters to pass into specific suggestion tools on a per-request basis
hints
Name Type Required / Optional Description Restrictions
domainsbot domainsbot Optional Domainsbot specific parameters to overwrite during this request. Pass `false` to disable for current request
  • Ignored if suggestion tool is set to be inactive by default
sidn sidn Optional SIDN specific parameters to overwrite during this request. Pass `false` to disable for current request
  • Ignored if suggestion tool is set to be inactive by default
rns rns Optional RNS / Placement+ specific parameters to overwrite during this request. Pass `false` to disable for current request
  • Ignored if suggestion tool is set to be inactive by default
prefixes-suffixes prefixes-suffixes Optional Prefixes Suffixes specific parameters to overwrite during this request. Pass `false` to disable for current request
  • Ignored if suggestion tool is set to be inactive by default
namesuggestion namesuggestion Optional NameStudio specific parameters to overwrite during this request. Pass `false` to disable for current request
  • Ignored if suggestion tool is set to be inactive by default
domainsbot
Name Type Required / Optional Description Restrictions
adult Boolean Optional
no_idn Boolean Optional
include_geolocation Boolean Optional
max_results Integer Optional Maximum number of results to return
  • Maximum value: 25
  • Minimum value: 1
tld_no String Optional TLDs to exclude in the results, separated by a comma
  • Maximum length: 4096
tld_ok String Optional TLDs to include in the results, separated by a comma
  • Maximum length: 4096
tld_only String Optional TLDs to exclusively allow in the results, separated by comma
  • Maximum length: 4096
languages List <Enum> Optional

Possible values:

  • en: English
  • nl: Dutch
  • de: German
  • es: Spanish
  • it: Italian
  • fr: French
func Enum Optional

Possible values:

  • 1: TLDs only
  • 2: Domain only
  • 3: TLD simple
  • 4: Best of TLD and Domain
sidn
Name Type Required / Optional Description Restrictions
limit Integer Optional Maximum results
  • Maximum value: 100
  • Minimum value: 1
rns
Name Type Required / Optional Description Restrictions
allowAdult Boolean Optional Allow adult
allowOffensive Boolean Optional Allow offensive
allowPremium Boolean Optional Allow premium
clientIP Boolean Optional Geotargeting IP
useDomainTld Boolean Optional Use Domain TLD in suggestion search
useaiSLD Boolean Optional Use AI for domain suggestions
useaiTLD Boolean Optional Use AI for TLD suggestions
maxCount Integer Optional Maximum results
  • Maximum value: 150
  • Minimum value: 1
onlyTLDs String Optional TLDs to exclusively allow in the results, separated by comma
  • Maximum length: 255
forceTLDs String Optional TLDs that must be present in the results, separated by comma
  • Maximum length: 255
addTLDs String Optional TLDs to boost in the results, separated by comma
  • Maximum length: 255
removeTLDs String Optional TLDs to exclude in the results, separated by comma
  • Maximum length: 255
prefixes-suffixes
Name Type Required / Optional Description Restrictions
prefixes List <String> Optional Keywords or characters placed at the beginning of the domain name query
  • Maximum length: 255
suffixes List <String> Optional Keywords or characters placed at the end of the domain name query
  • Maximum length: 255
namesuggestion
Name Type Required / Optional Description Restrictions
tlds List <String> Optional The TLD's to include
use_dashes Boolean Optional Include hyphens
use_numbers Boolean Optional Include numbers
use_idns Boolean Optional Include IDN
lang Enum Optional Language

Possible values:

  • eng: English
  • spa: Spanish
  • ita: Italian
  • jpn: Japanese
  • tur: Turkish
  • chi: Chinese
  • ger: German
  • por: Portuguese
  • fre: French
  • kor: Korean
  • vie: Vietnamese
  • dut: Dutch
include_geolocation Boolean Optional Include GEO location
max_results Integer Required Max results
  • Maximum value: 100
  • Minimum value: 5
sensitive_content_filter Boolean Optional Filter sensitive content
use_ai Boolean Optional Use AI for prompt or keyword based name generation
choices String Optional A JSON object containing metadata about a keyword or prompt, e.g. { 'style': 'professional' }. Other parameters like `tlds` and `geolocation` will take priority. (Only works if use_ai is true)

Successful request

Suggestion has been retrieved successfully
  • HTTP Status
  • application/jsonContent-Type
Response fields
Name Type Required / Optional Description
action String Required Action executed, will always be 'suggestion' in this case
data data Required
data
Name Type Required / Optional Description
source String Required The suggestion engine the suggestion came from
domain_name String Required The suggested domain name
suffix String Required The TLD
status Enum Required Status of the domain

Possible values:

  • 0: Waiting
  • 1: Available
  • 2: Taken
  • 3: Invalid
  • 4: Error
  • 5: Unknown
Suggestion generation completed
  • HTTP Status
  • application/jsonContent-Type
Response fields
Name Type Required / Optional Description
action String Required Suggestion generation has complete, not more will follow, will allways 'done' in this case

Failed requests

Example of failed request:

{
    "action": "error",
    "data": "Invalid domain"
}