The `input` action is used to perform availability checks for domain names. Furthermore, it provides suggestions based on active suggestion tools, if enabled.
Name | Type | Description | Restrictions |
---|---|---|---|
sessionId | String | UUID4, unique to session |
|
Name | Type | Required / Optional | Description | Restrictions |
---|---|---|---|---|
tld_set_token | String | Required | Token of specific TLD set, can be obtained from ADAC Management Panel |
|
categories | List <Integer> | Required | TLD categories to include, will include all available by default | |
input | String | Required | Domain name query |
|
priority_list_token | String | Optional | Token of specific TLD set, will be overwritten by `tld_set_token` |
|
hints | hints | Optional | Parameters to pass into specific suggestion tools on a per-request basis |
Name | Type | Required / Optional | Description | Restrictions |
---|---|---|---|---|
domainsbot | domainsbot | Optional | Domainsbot specific parameters to overwrite during this request. Pass `false` to disable for current request |
|
sidn | sidn | Optional | SIDN specific parameters to overwrite during this request. Pass `false` to disable for current request |
|
rns | rns | Optional | RNS / Placement+ specific parameters to overwrite during this request. Pass `false` to disable for current request |
|
prefixes-suffixes | prefixes-suffixes | Optional | Prefixes Suffixes specific parameters to overwrite during this request. Pass `false` to disable for current request |
|
namesuggestion | namesuggestion | Optional | NameStudio specific parameters to overwrite during this request. Pass `false` to disable for current request |
|
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 |
|
tld_no | String | Optional | TLDs to exclude in the results, separated by a comma |
|
tld_ok | String | Optional | TLDs to include in the results, separated by a comma |
|
tld_only | String | Optional | TLDs to exclusively allow in the results, separated by comma |
|
languages | List <Enum> | Optional |
Possible values:
|
|
func | Enum | Optional |
Possible values:
|
Name | Type | Required / Optional | Description | Restrictions |
---|---|---|---|---|
limit | Integer | Optional | Maximum results |
|
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 |
|
onlyTLDs | String | Optional | TLDs to exclusively allow in the results, separated by comma |
|
forceTLDs | String | Optional | TLDs that must be present in the results, separated by comma |
|
addTLDs | String | Optional | TLDs to boost in the results, separated by comma |
|
removeTLDs | String | Optional | TLDs to exclude in the results, separated by comma |
|
Name | Type | Required / Optional | Description | Restrictions |
---|---|---|---|---|
tlds | List <Enum> | Optional |
Possible values:
|
|
use_dashes | Boolean | Optional | Include hyphens | |
use_numbers | Boolean | Optional | Include numbers | |
use_idns | Boolean | Optional | Include IDN | |
lang | Enum | Optional | Language |
Possible values:
|
include_geolocation | Boolean | Optional | Include GEO location | |
max_results | Integer | Required | Max results |
|
sensitive_content_filter | Boolean | Optional | Filter sensitive content |
Name | Type | Required / Optional | Description |
---|---|---|---|
status | Enum | Required |
Status of the domain
Possible values:
|
domain_name | String | Required | The suggested domain name |
suffix | String | Required | The TLD |
type | Enum | Required |
Possible values:
|
currency | String | Required | Currency for the price, e.g. 'USD' |
price | Integer | Required | Price of the domain in cents |
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:
|
Example of failed request:
{
"action": "error",
"data": "Invalid domain"
}