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

Check Availability

Description

Checks the availability of the specified domain name(s).

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 Domain name(s) that you need to check the availability for.
tlds Array of Strings Required TLDs for which the domain name availability needs to be checked.
suggest-alternative Boolean Optional Pass true if domain name suggestions are required. Default value is false.

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/domains/available.json?auth-userid=0&api-key;=key&domain-name;=domain1&domain-name;=domain2&tlds;=com&tlds;=net

Response

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

  • Domain Availability Status (status)

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

      Note

      • In case of Donuts TLDs, domain name availability can be checked for a maximum of 5 domain names per Donuts TLD group in one API call. Including more than 5 domain names belonging to the same Donuts TLD group in an API call will return the status as unknown for all the domain names.

        Additional Information

        Donuts TLDs

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

  • Trademark Claims Key (tm-claims-key) - will be returned only if the domain name is available and Trademark for that domain name is listed in the Trademark Clearinghouse database

    Additional Information

    Trademark Claim Process