Loading...

Knowledge Base
Home 
 
/
 Check Availability of Internationalized Domain Names (IDN) Using the API
Categories: DNS API

Check Availability of Internationalized Domain Names (IDN) Using the API

When you want to check the availability of Internationalized Domain Names (IDN) using the API. This article explains supported IDN TLDs, language codes, character set requirements, request parameters, availability statuses, and Unicode or Punycode format support.

Check Availability - IDN

 

Description

Checks the availability of the specified Internationalized Domain Name(s) (IDN).

Parameters

NameData TypeRequired / OptionalDescription
auth-useridIntegerRequiredAuthentication Parameter
api-keyStringRequiredAuthentication Parameter
domain-nameArray of StringsRequired

Internationalized Domain Name(s) that you need to check the availability for

Refer to the supported character sets mentioned below:

  • .ASIA IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets here.

  • .BIZ IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below:

    • Chinese

    • Danish

    • Finnish

    • German

    • Hungarian

    • Icelandic

    • Japanese

    • Korean

    • Latvian

    • Lithuanian

    • Norwegian

    • Polish

    • Portuguese

    • Spanish

    • Swedish

  • .CA IDN: French characters, English alphabets and digits

  • .CO IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below:

    • Chinese

    • Danish

    • Finnish

    • Icelandic

    • Japanese

    • Korean

    • Norwegian

    • Spanish

    • Swedish

  • .COM / .NET IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets here.

    Note

    the character ? (codepoint=962) is not supported on our platform.

  • .DE IDN: Restricted German characters, English alphabets and digits

    Note

    the character ß (codepoint=223) is not supported on our platform.

  • .ES IDN: Restricted Spanish characters, English alphabets and digits

  • .EU IDN: You can refer to supported character sets here.

  • .IN.NET IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets here.

  • .INFO IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below:

    • Danish

    • German

    • Hungarian

    • Icelandic

    • Korean

    • Latvian

    • Lithuanian

    • Polish

    • Spanish

    • Swedish

  • .NAME IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets here.

    Note

    the character ? (codepoint=962) is not supported on our platform.

  • .ORG IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below:

    • Chinese (for IDN.org domain name and .?? domain name - the Chinese IDN for .org)

    • Cyrillic (for .??? domain name - the Russian IDN for .org)

    • Danish

    • German

    • Hindi (for .????? domain name - the Hindi IDN for .org)

    • Hungarian

    • Icelandic

    • Korean

    • Latvian

    • Lithuanian

    • Polish

    • Spanish

    • Swedish

  • .PW IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets here.

  • .TEL IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below:

    • Chinese

    • Danish

    • Finnish

    • French

    • German

    • Hungarian

    • Icelandic

    • Japanese

    • Korean

    • Latvian

    • Lithuanian

    • Norwegian

    • Polish

    • Portuguese

    • Russian

    • Spanish

    • Swedish

  • CentralNic IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below:

    • .EU.COM:

      • Arabic

      • Cyrillic

      • Greek

      • Hebrew

      • Latin

    • .GB.COM:

      • Latin

    • .AE.ORG:

      • Arabic

    • .KR.COM:

      • Korean

    • .US.COM:

      • Arabic

      • Chinese

      • Cyrillic

      • Greek

      • Hebrew

      • Japanese

      • Latin

    • .QC.COM:

      • Latin

    • .DE.COM:

      • Latin

    • .GB.NET:

      • Latin

    • .NO.COM:

      • Latin

    • .HU.COM:

      • Latin

    • .GR.COM:

      • Greek

    • .JPN.COM:

      • Japanese

    • .UY.COM:

      • Latin

    • .ZA.COM:

      • Latin

    • .BR.COM:

      • Latin

    • .CN.COM:

      • Chinese

    • .SA.COM:

      • Arabic

    • .SE.COM:

      • Latin

    • .SE.NET:

      • Latin

    • .UK.COM:

      • Latin

    • .UK.NET:

      • Latin

    • .RU.COM:

      • Cyrillic

  • .?? (Chinese IDN for .online): You can refer to supported character set here.

  • .??? (Chinese IDN for .network): You can refer to supported character set here.

Note

The domain name used in the API call can be in Unicode (the native language) or in Punycode format.

Example: The domain name can be provided as ??111 (Unicode) or xn--111-dkd4l (Punycode).

domain-name=??111 domain-name=xn--111-dkd4l

tldStringRequiredTLD for which the domain name availability needs to be checked 1
idnLanguageCodeStringRequired

While performing check availability for an Internationalized Domain Name, you need to provide the corresponding language code:

  • .ASIA IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Chinese - zh

    • Japanese - ja

    • Korean - ko

    idnLanguageCode=ko

  • .BIZ IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Chinese - zh

    • Danish - da

    • Finnish - fi

    • German - de

    • Hungarian - hu

    • Icelandic - is

    • Japanese - jp

    • Korean - ko

    • Lithuanian - lt

    • Latvian - lv

    • Norwegian - no

    • Polish - pl

    • Portuguese - pt

    • Spanish - es

    • Swedish - sv

    idnLanguageCode=ko

  • .CA IDN: The language code needs to be mentioned as fr.

    idnLanguageCode=fr

  • .CO IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Chinese - zh

    • Danish - da

    • Finnish - fi

    • Icelandic - is

    • Japanese - jp

    • Korean - ko

    • Norwegian - no

    • Spanish - es

    • Swedish - sv

    idnLanguageCode=da

  • .COM / .NET IDN: The language code depends upon the language whose characters are used in the domain name. You can refer to the list of languages supported and the corresponding language code.

    idnLanguageCode=aze

  • .DE IDN: The language code needs to be mentioned as de.

    idnLanguageCode=de

  • .ES IDN: The language code needs to be mentioned as es.

    idnLanguageCode=es

  • .EU IDN: The language code needs to be mentioned as latin.

    idnLanguageCode=latin

  • .IN.NET IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Arabic - ara

    • Chinese - chi

    • Cyrillic - cyr

    • Greek - gre

    • Hebrew - heb

    • Japanese - jpn

    • Korean - kor

    • Lao - lao

    • Latin - lat

    • Thai - tha

    idnLanguageCode=jpn

  • .INFO IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Danish - da

    • German - de

    • Hungarian - hu

    • Icelandic - is

    • Korean - ko

    • Lithuanian - lt

    • Latvian - lv

    • Polish - pl

    • Spanish - es

    • Swedish - sv

    idnLanguageCode=ko

  • .NAME IDN: The language code depends upon the language whose characters are used in the domain name. You can refer to the list of languages supported and the corresponding language code.

    idnLanguageCode=aze

  • .ORG IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Chinese - zh-cn (for IDN.org domain name and .?? domain name - the Chinese IDN for .org)

    • Cyrillic - ru (for .??? domain name - the Russian IDN for .org)

    • Danish - da

    • German - de

    • Hindi - hin-deva (for .????? domain name - the Hindi IDN for .org)

    • Hungarian - hu

    • Icelandic - is

    • Korean - ko

    • Latvian - lv

    • Lithuanian - lt

    • Polish - pl

    • Spanish - es

    • Swedish - sv

    idnLanguageCode=ko

  • .PW IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Arabic - ara

    • Chinese - chi

    • Cyrillic - cyr

    • Greek - gre

    • Hebrew - heb

    • Japanese - jpn

    • Korean - kor

    • Lao - lao

    • Latin - lat

    • Thai - tha

    idnLanguageCode=tha

  • .TEL IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Chinese - zh

    • Danish - da

    • Finnish - fi

    • French - fr

    • German - de

    • Hungarian - hu

    • Icelandic - is

    • Japanese - jp

    • Korean - ko

    • Latvian - lv

    • Lithuanian - lt

    • Norwegian - no

    • Polish - pl

    • Portuguese - pt

    • Russian - ru

    • Spanish - es

    • Swedish - sv

    idnLanguageCode=ko

  • CentralNic IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • .EU.COM:

      • Arabic - ara

      • Cyrillic - cyr

      • Greek - gre

      • Hebrew - heb

      • Latin - lat

    • .GB.COM, .QC.COM, .DE.COM, .GB.NET, .NO.COM, .HU.COM, .UY.COM, .ZA.COM, .BR.COM, .SE.COM, .SE.NET, .UK.COM and .UK.NET:

      • Latin - lat

    • .AE.ORG and .SA.COM:

      • Arabic - ara

    • .KR.COM:

      • Korean - kor

    • .US.COM:

      • Arabic - ara

      • Chinese - chi

      • Cyrillic - cyr

      • Greek - gre

      • Hebrew - heb

      • Japanese - jpn

      • Latin - lat

    • .GR.COM:

      • Greek - gre

    • .JPN.COM:

      • Japanese - jpn

    • .CN.COM:

      • Chinese - chi

    • .RU.COM:

      • Cyrillic - cyr

    idnLanguageCode=lat

  • .?? (Chinese IDN for .online): The language code needs to be mentioned as zh.

    attr-name1=idnLanguageCode&attr-value1=zh

  • .??? (Chinese IDN for .network): The language code needs to be mentioned as zh.

    attr-name1=idnLanguageCode&attr-value1=zh

  • .???? (Hindi IDN for .BHARAT): The language code needs to be mentioned as hin-deva.

    attr-name1=idnLanguageCode&attr-value1=hin-deva

HTTP Method

GET

Example Test URL Request

https://domaincheck.httpapi.com/api/domains/idn-available.json?auth-userid=0&api-key=key&domain-name=??111&domain-name=??112&tld=com&idnLanguageCode=aze

Response

Returns a hash map containing domain name availability status for the requested TLDs:

  • available - domain name available for registration

  • regthroughus - domain name currently registered through the Registrar whose connection is being used to check the availability of the domain name

  • regthroughothers - domain name currently registered through a Registrar other than the one whose connection is being used to check the availability of the domain name. If you wish to manage such a domain name through your Reseller / Registrar Account, you may pass a Domain Transfer API call. 2

  • unknown - returned, if for some reason, the Registry connections are not available. You should ideally re-check the domain name availability after some time.

     

    Note

    In case of .CA TLD, domain name availability can be checked for a maximum of 15 strings in one API call. Including more than 15 strings in an API call will return the status as unknown for all the strings.