# 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](https://docs.openprovider.com/doc/domain.swagger#operation/CheckDomain) as your reference.*

<div id="bkmrk-after-all-the-regist">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](https://openprovider.help/books/api-plugins/page/api-guides-glossary#premium_domain) domain is checked. You should be aware of it.</div><div id="bkmrk-use-endpoint-path-be"><div><div>![Entering Geo Fence icon](https://openprovider.help/uploads/images/gallery/2026-08/embedded-image-anq7p1va.png)Use endpoint path below. Base URL is determined by both the target environment and API version.</div><div>```
<span><strong>POST <a href="http://docs.openprovider.com/#operation/CheckDomain">{base_url}</a></strong>/domains/check</span>
```

</div></div><div><div id="bkmrk-request-values-name-"><details><summary>REQUEST VALUES</summary>

<div><table><tbody><tr><th>### **Name**

</th><th>### **Type**

</th><th>### **Values**

</th><th>### **Description**

</th></tr><tr><td>**1. additional\_data**</td><td>object</td><td colspan="2">Domain additional data (if required).</td></tr><tr><td>1.1 idn\_script</td><td>string</td><td>Domain name value.</td><td><span>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</span><span>)</span></td></tr><tr><td>**2. domains**</td><td colspan="3">An array of objects (list of domains to check). </td></tr><tr><td>**2.1 item**</td><td>Set of parameters.</td><td colspan="2">Set of items with parameters</td></tr><tr><td>[2.1.1 extension](https://support.openprovider.eu/hc/en-us/sections/360005841014)</td><td>string</td><td>TLD (e.g. com, tv, it, de etc.)</td><td>[Extension](https://support.openprovider.eu/hc/en-us/sections/360005841014) value requested.</td></tr><tr><td>2.1.2 name</td><td>string</td><td>Name required (e.g. example etc.)</td><td><span>Domain name without an extension.</span></td></tr><tr><td>with\_price</td><td>boolean</td><td>true or false</td><td><span>Indicate whether to include the domain price with domain availability.</span></td></tr><tr><td>with\_whois</td><td>boolean</td><td>true or false</td><td><span>Returns domain WHOIS data.</span></td></tr></tbody></table>

  
</div></details><details><summary>REQUEST EXAMPLE</summary>

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

</div></details><details><summary>RESPONSE VALUES</summary>

<div><table><tbody><tr><th>### **Name**

</th><th>### **Type**

</th><th>### **Description**

</th></tr><tr><td>code

</td><td>integer </td><td><span>[API Result with code returned](https://openprovider.help/books/api-plugins/page/api-error-codes).  
0 = Sucess with no errors.</span>

</td></tr><tr><td>**1. data**

</td><td>**An array of values.**</td><td>**An array of data returned per the requested domain name.**</td></tr><tr><td>claim\_key

</td><td>string</td><td>The claim key shown (if presented). </td></tr><tr><td>domain

</td><td>string</td><td>The domain name.</td></tr><tr><td>[is\_premium](https://openprovider.help/books/api-plugins/page/api-guides-glossary#premium_domain)

</td><td>0 or 1</td><td><span>Indicates, whether a domain is [premium](https://openprovider.help/books/api-plugins/page/api-guides-glossary#premium_domain) and has a higher than standard price or not.</span></td></tr><tr><td>[ **1.1 premium** ](https://openprovider.help/books/api-plugins/page/api-guides-glossary#premium_domain)

</td><td>**Set of values.**</td><td>**Return set of values regarding domain [premium](https://openprovider.help/books/api-plugins/page/api-guides-glossary#premium_domain) prices.**</td></tr><tr><td>currency

</td><td>string</td><td>Indicates price currency.</td></tr><tr><td>**1.1.1 price**

</td><td>**Set of values.**</td><td>Return set of values regarding restore price. </td></tr><tr><td>create

</td><td>number (double)</td><td>Price of creation for the premium domain.</td></tr><tr><td>renew

</td><td>number (double)</td><td>Price of renew for the premium domain.</td></tr><tr><td>renewal

</td><td>number (double)</td><td>Price of renewal for the premium domain. </td></tr><tr><td>[ **1.1.1.2 restore** ](https://openprovider.help/books/api-plugins/page/api-guides-glossary#domain_restore)

</td><td>**An array of strings.**</td><td>**Return set of values regarding domain [restore](https://openprovider.help/books/api-plugins/page/api-guides-glossary#domain_restore) price.**</td></tr><tr><td>1.1.1.2.1 description

</td><td>string</td><td>Text description.</td></tr><tr><td>1.1.1.2.2 fee

</td><td>number (double)</td><td>Fee value. </td></tr><tr><td>[transfer](https://openprovider.help/books/api-plugins/page/api-guides-glossary#domain_transfer)

</td><td>number (double) </td><td>The total amount required for domain [transfer](https://openprovider.help/books/api-plugins/page/api-guides-glossary#domain_transfer).</td></tr><tr><td>price\_category

</td><td>string</td><td>Indicates the domain price category if presented.</td></tr><tr><td>price\_currency

</td><td>string</td><td>Indicates the domain price currency if presented.</td></tr><tr><td>**1.2 price**

</td><td>**An array of values.**</td><td>Return set of values regarding domain price. </td></tr><tr><td>**1.2.1 product**

</td><td>**Set of values.**</td><td>**Return set of values regarding product price.**</td></tr><tr><td>1.2.1.1 currency

</td><td>string</td><td>Indicates the domain price currency if presented.</td></tr><tr><td>1.2.1.2 price

</td><td>number (double)</td><td>Indicates the domain price if presented.</td></tr><tr><td>**1.2.2 reseller**

</td><td>**Set of values.**</td><td>**Return set of values regarding product price applicable for the current reseller.**</td></tr><tr><td>1.2.2.1 currency

</td><td>string</td><td>Indicates the domain price currency if presented.</td></tr><tr><td>1.2.2.2 price

</td><td>number (double) </td><td>Indicates the domain price if presented.</td></tr><tr><td>reason

</td><td>string</td><td><span>Reason for returned availability status.</span></td></tr><tr><td>status

</td><td>string</td><td>Domain name status returned.</td></tr><tr><td>whois

</td><td>string</td><td>Data from WHOIS returned.</td></tr><tr><td>desc

</td><td>string</td><td><span>The description.</span></td></tr><tr><td>maintenance

</td><td>boolean</td><td><span>Indicates that the Openprovider system is temporarily unavailable because of maintenance.</span></td></tr><tr><td>**2. warnings**

</td><td>**An array of values.**</td><td>****An array of warning messages (**<span>Contains warning responses if any</span>).**</td></tr><tr><td>2.1 code

</td><td>integer</td><td><span>Warning code value (digits).</span></td></tr><tr><td>2.2 data

</td><td>string</td><td><span>Data (additional warning description) value returned.</span></td></tr><tr><td>2.3 desc

</td><td>string</td><td>The description value returned.</td></tr></tbody></table>

</div></details></div></div><div><details><summary>RESPONSE EXAMPLE</summary>

<div>```
{<br></br>"code": 0,<br></br>"desc": "",<br></br>"data": {<br></br>"results": [<br></br>{<br></br>"domain": "test4.london",<br></br>"status": "free"<br></br>}<br></br>]<br></br>}<br></br>}
```

</div></details></div><details><summary>Section 5</summary>

**Once we successfully checked the domain(s) availability and parameters, please move to the next stage and [check the domain price](https://openprovider.help/books/api-plugins/page/3-domains-api-how-to-retrieve-domain-price).**

</details></div>