2 Domains API: Check Domain

This is a series of articles dedicated to demonstrating how to get acquainted with Openprovider Domains API methods.

This is the third article in a series in which we are going to check domain data. To get more information about our API in general, please use our documentation portal link as your reference.

After all the registration requirements for registering exact extensions are clear, we can begin the process of checking the availability of the desired domain for registration, cause some of the names may be already reserved or be too expensive if the premium domain is checked. You should be aware of it.
Entering Geo Fence iconUse endpoint path below. Base URL is determined by both the target environment and API version.
POST {base_url}/domains/check

REQUEST VALUES

Name

Type

Values

Description

1. additional_data object Domain additional data (if required).
1.1 idn_script string Domain name value. The idn script states what language or character set the domain name is in Applicable to: .actor, .ae.org, .airforce, .army, .art, .attorney, .auction, .band, .bar, .best, .br.com, .ceo, .cn.com, .college, .com, .com.de, .com.se, .consulting, .dance, .de.com, .degree, .democrat, .dentist, .design, .engineer, .eu.com, .eus, .feedback, .fm, .forsale, .frl, .fun, .futbol, .gal, .gb.net, .gives, .gr.com, .haus, .hiv, .host, .immobilien, .in.net, .info, .ink, .jp.net, .jpn.com, .kaufen, .kyoto, .lawyer, .love, .market, .me, .mex.com, .moda, .mortgage, .navy, .net, .ninja, .nrw, .online, .ooo, .org, .press, .protection, .pub, .pw, .quebec, .radio.am, .radio.fm, .realty, .rehab, .rent, .republican, .rest, .reviews, .rip, .rocks, .ru.com, .sa.com, .scot, .se.net, .security, .site, .social, .software, .space, .store, .tech, .theatre, .tickets, .top, .uk.com, .uk.net, .us.com, .us.org, .vet, .website, .wiki, .xn--4gbrim, .xn--55qx5d, .xn--5tzm5g, .xn--80asehdb, .xn--80aswg, .xn--c1avg, .xn--czru2d, .xn--i1b6b1a6a2e, .xn--io0a7i, .xn--mk1bu44c, .xn--ngbc5azd, .xn--nqv7f, .xn--t60b56a, .xn--tckwe, .xyz, .za.com)
2. domains An array of objects (list of domains to check). 
2.1 item Set of parameters. Set of items with parameters
2.1.1 extension string TLD (e.g. com, tv, it, de etc.) Extension value requested.
2.1.2 name string Name required (e.g. example etc.) Domain name without an extension.
with_price boolean 0 or 1 Indicate whether to include the domain price with domain availability.
with_whois boolean 0 or 1 Returns domain WHOIS data.

REQUEST EXAMPLE

curl -X POST \
https://api.cte.openprovider.eu/v1beta/domains/check \
-H 'Authorization: Bearer 1c26def9e68d********98b5abe264fc' \
-H 'Content-Type: application/json' \
-d '{
"additional_data": {
"idn_script": "cyrl"
},
"domains": [
{
"extension": "london",
"name": "test4"
}
],
"with_price": false,
"with_whois": false
}'

RESPONSE VALUES

Name

Type

Description

code

integer 

API Result with code returned.
0 = Sucess with no errors.

1. data

An array of values. An array of data returned per the requested domain name.

claim_key

string The claim key shown (if presented). 

domain

string The domain name.

is_premium

0 or 1 Indicates, whether a domain is premium and has a higher than standard price or not.

1.1 premium

Set of values. Return set of values regarding domain premium prices.

currency

string Indicates price currency.

1.1.1 price

Set of values. Return set of values regarding restore price. 

create

number (double) Price of creation for the premium domain.

renew

number (double) Price of renew for the premium domain.

renewal

number (double) Price of renewal for the premium domain. 

1.1.1.2 restore

An array of strings. Return set of values regarding domain restore price.

1.1.1.2.1 description

string Text description.

1.1.1.2.2 fee

number (double) Fee value. 

transfer

number (double)  The total amount required for domain transfer.

price_category

string Indicates the domain price category if presented.

price_currency

string Indicates the domain price currency if presented.

1.2 price

An array of values. Return set of values regarding domain price. 

1.2.1 product

Set of values. Return set of values regarding product price.

1.2.1.1 currency

string Indicates the domain price currency if presented.

1.2.1.2 price

number (double) Indicates the domain price if presented.

1.2.2 reseller

Set of values. Return set of values regarding product price applicable for the current reseller.

1.2.2.1 currency

string Indicates the domain price currency if presented.

1.2.2.2 price

number (double)  Indicates the domain price if presented.

reason

string Reason for returned availability status.

status

string Domain name status returned.

whois

string Data from WHOIS returned.

desc

string The description.

maintenance

boolean Indicates that the Openprovider system is temporarily unavailable because of maintenance.

2. warnings

An array of values. An array of warning messages (Contains warning responses if any).

2.1 code

integer Warning code value (digits).

2.2 data

string Data (additional warning description) value returned. 

2.3 desc

string The description value returned.

Once we successfully checked the domain(s) availability and parameters, please move to the next stage and check the domain price.

Was this article helpful?
0 out of 0 found this helpful