Home » Reseller Guides » Reseller API Guide » HTTP API » API Requests » Domains

Check Availability - IDN

Description

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

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key or auth-password String Required Authentication Parameter
domain-name Array of Strings Required

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

Refer to the supported character set 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:

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

  • .CC / .TV 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.

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

  • .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.

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

  • .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:

  • .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:
tld String Required TLD for which the domain name availability needs to be checked.
idnLanguageCode String Required

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

  • .CC / .TV 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

  • .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

  • .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 - sw

    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.

    attr-name1=idnLanguageCode&attr-value1=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

    • Danish - da

    • German - de

    • Hungarian - hu

    • Icelandic - is

    • Korean - ko

    • Lithuanian - lt

    • Latvian - lv

    • Polish - pl

    • Spanish - es

    • Swedish - sw

    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

HTTP Method

GET

Example Test URL Request

https://test.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. 1

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

  1. 1. Transferring a Domain Name