Admin at 07:22, 21 July 2015

2015-07-21T07:22:27Z

← Older revision		Revision as of 12:52, 21 July 2015
Line 36:		Line 36:

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

Line 55:		Line 56:

	Note		Note

	For .UK availability check, the API call need to have only one domain name. Otherwise, the ror parameter will not be returned in the result.		For .UK availability check, the API call need to have only one domain name. Otherwise, the ror parameter will not be returned in the result.

Admin: Created page with "1. Description 2. Parameters 3. HTTP Method 4. Example Test URL Request 5. Response Description Checks the availability of the specified domain name(s). ParametersTop Name..."

2015-07-21T07:20:43Z

Created page with "1. Description 2. Parameters 3. HTTP Method 4. Example Test URL Request 5. Response Description Checks the availability of the specified domain name(s). ParametersTop Name..."

New page

1. Description
2. Parameters
3. HTTP Method
4. Example Test URL Request
5. Response

Description

Checks the availability of the specified domain name(s).
ParametersTop
Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key 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 1
suggest-alternative Boolean Optional Pass true if domain name suggestions are required. Default value is false.

HTTP Method
GET

Example Test URL RequestTop
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. 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 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

Premium Names (costHash) - A hash map will be returned only if the domain is a premium name along with the pricing of the domain ("create", "renew", "transfer") and the selling currency symbol

Early Access Program (costHash) - A hash map will be returned only if the domain is in EAP along with the early access fee ("early_access_fee") and the selling currency symbol. The early access fee is the non-refundable component which needs to added to the selling price of the domain
Additional Information

Trademark Claim Process

3rd Level .UK domain name (ror) - will be returned for an available 2nd Level .UK domain name, if the corresponding 3rd Level .UK domain name already exists. Currently, a 2nd Level .UK domain name can only be registered by the person/entity that owns the 3rd Level .UK domain name, if it already exists.

Note
For .UK availability check, the API call need to have only one domain name. Otherwise, the ror parameter will not be returned in the result.

Check Availability - Revision history

Admin at 07:22, 21 July 2015

Admin: Created page with "1. Description 2. Parameters 3. HTTP Method 4. Example Test URL Request 5. Response Description Checks the availability of the specified domain name(s). ParametersTop Name..."