Skip to main content
POST
/
domains
/
lookup
/
suggestions
Get Domain Suggestions
curl --request POST \
  --url https://vicem.com/modules/addons/DomainsReseller/api/index.php/domains/lookup/suggestions \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'token: <token>' \
  --header 'username: <username>' \
  --data searchTerm=example \
  --data 'punyCodeSearchTerm=<string>' \
  --data-urlencode tldsToInclude%5B0%5D=.com \
  --data-urlencode tldsToInclude%5B1%5D=.net \
  --data isIdnDomain=true \
  --data premiumEnabled=true
[
  {
    "domainName": "example.com",
    "idnDomainName": "<string>",
    "tld": "com",
    "tldNoDots": "<string>",
    "sld": "example",
    "idnSld": "<string>",
    "status": "available for registration",
    "legacyStatus": "available",
    "score": 123,
    "isRegistered": true,
    "isAvailable": true,
    "isValidDomain": true,
    "domainErrorMessage": "<string>",
    "pricing": {},
    "shortestPeriod": {},
    "group": "<string>",
    "minLength": 123,
    "maxLength": 123,
    "isPremium": true,
    "premiumCostPricing": [
      "<unknown>"
    ]
  }
]

Headers

​
username
string<email>
required

Reseller email address registered in WHMCS

Example:

"[email protected]"

​
token
string
required

HMAC-SHA256 authentication token.

PHP formula: base64_encode(hash_hmac('sha256', $apiKey, $email . ':' . gmdate('y-m-d H')))

Important: hash_hmac without the 3rd parameter true (returns hex, not binary), then base64_encode of the hex result. The token is 88 characters long.

An optional timestamp header (Unix timestamp, 60-second tolerance) can be sent to synchronize time.

Example:

"YTk4YjRmNjI..."

Body

application/x-www-form-urlencoded
​
searchTerm
string

Search term (e.g. 'example'). Use either searchTerm or punyCodeSearchTerm.

Example:

"example"

​
punyCodeSearchTerm
string

Punycode search term for IDN domains. Takes priority over searchTerm if both are provided.

​
tldsToInclude
string[]

List of TLDs to include. Format: .extension (e.g. .com, .net).

Example:
[".com", ".net"]
​
isIdnDomain
boolean

Indicates whether the domain is an IDN

​
premiumEnabled
boolean

Enable premium domain search

​
suggestionSettings
any[]

Suggestion settings. Must be an array, never null.

Example:
[]

Response

Success - Returns domain suggestions

​
domainName
string

Full domain name

Example:

"example.com"

​
idnDomainName
string

IDN domain name

​
tld
string

TLD without dot

Example:

"com"

​
tldNoDots
string

TLD without dot

​
sld
string

Second Level Domain

Example:

"example"

​
idnSld
string

IDN Second Level Domain

​
status
string

Availability status

Example:

"available for registration"

​
legacyStatus
string

Legacy status (available/unavailable)

Example:

"available"

​
score
number

Relevance score

​
isRegistered
boolean

Whether the domain is registered

​
isAvailable
boolean

Whether the domain is available

​
isValidDomain
boolean

Whether the domain is valid

​
domainErrorMessage
string

Error message if any

​
pricing
object

Pricing per period

​
shortestPeriod
object

Shortest available period

​
group
string

Domain group

​
minLength
integer

Minimum domain length

​
maxLength
integer

Maximum domain length

​
isPremium
boolean

Whether the domain is premium

​
premiumCostPricing
any[]

Premium domain pricing if applicable