Function   /domain/check

Function invocation

Function description

Check status for input domains for registration.

Input parameters

This function takes the following input parameters:

ParameterTypeRequiredDefault valueDescription
names string[] YES Domain names to check
domains string[] empty array Domain names to check (deprecated, please use 'names' parameter)
taste boolean false If true then output pricing is fetched for taste registration (deprecated and unused)
period integer 0 Registration period in years, if not set or 0 then minimal registration period will be checked INFO: If period will be out of scope for domain TLD the 'status' output will 'unavailable' even if domain is free. Also in this situation 'amount' and 'myAmount' output will be 0 but it doesn't mean that domain can be registered for free it means that price for given registration period can't be received.
useCode boolean false Use bonus code

Return value

List of domains (list of structures with the following fields):

Field nameTypeDescription
amount float Amount in main currency
available boolean Domain available to register
currency string Main currency
myAmount float Amount in member's currency
myCurrency string Member's currency
name string Domain name (in Punycode)
nameIDN string Domain name (internationalized)
status string Domain status
registrationPeriods string Available registration periods in years.