# 1 TLD API: Search an extension *This is a series of articles dedicated to demonstrating how to get acquainted with Openprovider Domains API methods. To get more information about our API in general, please use our[documentation portal](http://docs.openprovider.com/#operation/ListTlds)as your reference.*
Before registering a domain name you need to get familiar with TLD parameters and find one that suits your requirements. The current method returns a [list](https://support.openprovider.eu/hc/en-us/sections/360005841014) of extensions (TLDs) matching your search criteria. To retrieve a single or several specific extensions - use the following endpoint: **GET** [**{base\_url}**](http://docs.openprovider.com/#operation/ListProducts)/tlds/{name}
![Entering Geo Fence icon](https://openprovider.help/uploads/images/gallery/2026-08/embedded-image-vxtr4zmv.png) Use endpoint path below. Base URL is determined by both the target environment and API version.
``` GET {base_url}/tlds ```
REQUEST VALUES
### **Name** ### **Type** ### **Values** ### **Description**
limit numericDefault: 0, Max: 1000 The maximum number of records to be returned.
offset numeric Default: 0Indicates the starting position of the response list. Indexing starts at 0, meaning that in order to start with the 10th domain, this value should be 9.
orderstringOutput sorting method (ASC or DESC)
order\_bystring Indicates an attribute that used for ordering output records.
extensionsarray of stringsRefer to the [list](https://support.openprovider.eu/hc/en-us/sections/360005841014) of TLDs.Extensions you are interested in.
name\_patternstringExtension name pattern.
only\_namesboolean true or falseReturns extension names only in the response
with\_descriptionboolean true or falseReturn extensions with descriptions.
with\_restrictionsboolean true or falseReturns extensions with restrictions.
with\_usage\_countboolean true or falseReturns number of domains in your portfolio using specified extension.
with\_application\_modeboolean true or falseReturns list of supported pre-registration modes.
with\_priceboolean true or falseReturns prices if enabled.
with\_level\_pricesbooleantrue or falseReturns extension prices for each Openprovider discount tier.
is\_activebooleantrue or falseIndicates if the extension is active.
is\_new\_gtldbooleantrue or falseIndicates if the extension is a new GLTDs.
statusstringEg: **ACT** for activeExtension status.
REQUEST EXAMPLE
``` curl -X GET \

'https://api.openprovider.eu/v1beta/tlds?status=ACT&extensions=com' \

-H 'Authorization: Bearer 1c26def9e68dd9a********5abe264fc' \ ```
RESPONSE EXAMPLE
``` {

"code": 0,

"desc": "",

"data": {

"results": [

{

"name": "com",

"min_period": 1,

"max_period": 10,

"transfer_available": true,

"trade_available": false,

"renew_available": true,

"is_transfer_auth_code_required": true,

"is_trade_auth_code_required": false,

"is_auth_code_requested": false,

"is_auth_code_available": true,

"is_auth_code_changeable": true,

"is_private_whois_allowed": true,

"domicile_available": false,

"soft_quarantine_period": 40,

"quarantine_period": 0,

"dnssec_allowed": true,

"status": "ACT",

"billing_handle_enabled": true,

"reseller_handle_enabled": false,

"supported_idn_scripts": [

{

"value": "AFR",

"description": "Afrikaans"

},

{

"value": "ALB",

"description": "Albanian"

},

{

"value": "ARA",

"description": "Arabic"

},

{

"value": "ARG",

"description": "Aragonese"

},

{

"value": "ARM",

"description": "Armenian"

},

{

"value": "ASM",

"description": "Assamese"

},

{

"value": "AST",

"description": "Asturian"

},

{

"value": "AVE",

"description": "Avestan"

},

{

"value": "AWA",

"description": "Awadhi"

},

{

"value": "AZE",

"description": "Azerbaijani"

},

{

"value": "BAN",

"description": "Balinese"

},

{

"value": "BAL",

"description": "Baluchi"

},

{

"value": "BAS",

"description": "Basa"

},

{

"value": "BAK",

"description": "Bashkir"

},

{

"value": "BAQ",

"description": "Basque"

},

{

"value": "BEL",

"description": "Belarusian"

},

{

"value": "BEN",

"description": "Bengali"

},

{

"value": "BHO",

"description": "Bhojpuri"

},

{

"value": "BOS",

"description": "Bosnian"

},

{

"value": "BUL",

"description": "Bulgarian"

},

{

"value": "BUR",

"description": "Burmese"

},

{

"value": "CAR",

"description": "Carib"

},

{

"value": "CAT",

"description": "Catalan"

},

{

"value": "CHE",

"description": "Chechen"

},

{

"value": "CHI",

"description": "Chinese"

},

{

"value": "CHV",

"description": "Chuvash"

},

{

"value": "COP",

"description": "Coptic"

},

{

"value": "COS",

"description": "Corsican"

},

{

"value": "SCR",

"description": "Croatian"

},

{

"value": "CZE",

"description": "Czech"

},

{

"value": "DAN",

"description": "Danish"

},

{

"value": "DIV",

"description": "Divehi"

},

{

"value": "DOI",

"description": "Dogri"

},

{

"value": "DUT",

"description": "Dutch"

},

{

"value": "ENG",

"description": "English"

},

{

"value": "EST",

"description": "Estonian"

},

{

"value": "FAO",

"description": "Faroese"

},

{

"value": "FIJ",

"description": "Fijian"

},

{

"value": "FIN",

"description": "Finnish"

},

{

"value": "FRE",

"description": "French"

},

{

"value": "FRY",

"description": "Frisian"

},

{

"value": "GLA",

"description": "Gaelic"

},

{

"value": "GEO",

"description": "Georgian"

},

{

"value": "GER",

"description": "German"

},

{

"value": "GON",

"description": "Gondi"

},

{

"value": "GRE",

"description": "Greek"

},

{

"value": "GUJ",

"description": "Gujarati"

},

{

"value": "HEB",

"description": "Hebrew"

},

{

"value": "HIN",

"description": "Hindi"

},

{

"value": "HUN",

"description": "Hungarian"

},

{

"value": "ICE",

"description": "Icelandic"

},

{

"value": "INC",

"description": "Indic"

},

{

"value": "IND",

"description": "Indonesian"

},

{

"value": "INH",

"description": "Ingush"

},

{

"value": "GLE",

"description": "Irish"

},

{

"value": "ITA",

"description": "Italian"

},

{

"value": "JPN",

"description": "Japanese"

},

{

"value": "JAV",

"description": "Javanese"

},

{

"value": "KAS",

"description": "Kashmiri"

},

{

"value": "KAZ",

"description": "Kazakh"

},

{

"value": "KHM",

"description": "Khmer"

},

{

"value": "KIR",

"description": "Kirghiz"

},

{

"value": "KOR",

"description": "Korean"

},

{

"value": "KUR",

"description": "Kurdish"

},

{

"value": "LAO",

"description": "Lao"

},

{

"value": "LAV",

"description": "Latvian"

},

{

"value": "LIT",

"description": "Lithuanian"

},

{

"value": "LTZ",

"description": "Luxembourgisch"

},

{

"value": "MAC",

"description": "Macedonian"

},

{

"value": "MAL",

"description": "Malayalam"

},

{

"value": "MAY",

"description": "Malay"

},

{

"value": "MLT",

"description": "Maltese"

},

{

"value": "MAO",

"description": "Maori"

},

{

"value": "MOL",

"description": "Moldavian"

},

{

"value": "MON",

"description": "Mongolian"

},

{

"value": "NEP",

"description": "Nepali"

},

{

"value": "NOR",

"description": "Norwegian"

},

{

"value": "ORI",

"description": "Oriya"

},

{

"value": "OSS",

"description": "Ossetian"

},

{

"value": "PAN",

"description": "Panjabi"

},

{

"value": "PER",

"description": "Persian"

},

{

"value": "POL",

"description": "Polish"

},

{

"value": "POR",

"description": "Portugese"

},

{

"value": "PUS",

"description": "Pushto"

},

{

"value": "RAJ",

"description": "Rajasthani"

},

{

"value": "RUM",

"description": "Romanian"

},

{

"value": "RUS",

"description": "Russian"

},

{

"value": "SMO",

"description": "Samoan"

},

{

"value": "SAN",

"description": "Sanskrit"

},

{

"value": "SRD",

"description": "Sardinian"

},

{

"value": "SCC",

"description": "Serbian"

},

{

"value": "SND",

"description": "Sindhi"

},

{

"value": "SIN",

"description": "Sinhalese"

},

{

"value": "SLO",

"description": "Slovak"

},

{

"value": "SLV",

"description": "Slovenian"

},

{

"value": "SOM",

"description": "Somali"

},

{

"value": "SPA",

"description": "Spanish"

},

{

"value": "SWA",

"description": "Swahili"

},

{

"value": "SWE",

"description": "Swedish"

},

{

"value": "SYR",

"description": "Syriac"

},

{

"value": "TGK",

"description": "Tajik"

},

{

"value": "TAM",

"description": "Tamil"

},

{

"value": "TEL",

"description": "Telugu"

},

{

"value": "THA",

"description": "Thai"

},

{

"value": "TIB",

"description": "Tibetan"

},

{

"value": "TUR",

"description": "Turkish"

},

{

"value": "UKR",

"description": "Ukrainian"

},

{

"value": "URD",

"description": "Urdu"

},

{

"value": "UZB",

"description": "Uzbek"

},

{

"value": "VIE",

"description": "Vietnamese"

},

{

"value": "WEL",

"description": "Welsh"

},

{

"value": "YID",

"description": "Yiddish"

}

],

"owner_handle_supported": true,

"admin_handle_supported": true,

"tech_handle_supported": true,

"billing_handle_supported": true,

"reseller_handle_supported": false,

"dnssec_keys_allowed": true,

"dnssec_digests_allowed": true,

"dnssec_max_records_amount": 0,

"dnssec_algorithms": [

8,

10,

12,

13,

14,

15,

16

]

}

],

"total": 1

}

} ```
RESPONSE VALUES
### **Name** ### **Values** ### **Description**
coderesult code number [API Result with code returned](https://openprovider.help/books/api-plugins/page/api-error-codes). 0 = Success with no errors.
**1. data****set of values****Returns an array of elements related to an extension**
**1.1 results****An array of elements.**
admin\_handle\_supportedbooleanIndicates if the administrator [handle](https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle) exists for an extension.
billing\_handle\_enabledboolean Indicates if the billing [handle](https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle) exists for an extension.
billing\_handle\_supported boolean Indicates if the billing [handle](https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle) is supported for an extension.
**1.1.1 description****Set of values (text strings).**Returns the description.
1.1.1.1 textstringReturns text description.
1.1.1.2 urlstringLink to registry providing extension.
dnssec\_algorithmsintegerReturns one or multiple records of methods available to be used with an extension.
[dnssec](https://openprovider.help/books/api-plugins/page/api-guides-glossary#dnssec)\_allowedbooleanIndicates if [DNSSEC](https://openprovider.help/books/api-plugins/page/api-guides-glossary#dnssec) can be enabled for an extension.
[dnssec](https://openprovider.help/books/api-plugins/page/api-guides-glossary#dnssec)\_digests\_allowedboolean Indicates if [DNSSEC](https://openprovider.help/books/api-plugins/page/api-guides-glossary#dnssec) support digest type.
[dnssec](https://openprovider.help/books/api-plugins/page/api-guides-glossary#dnssec)\_keys\_allowedbooleanIndicates if [DNSSEC](https://openprovider.help/books/api-plugins/page/api-guides-glossary#dnssec) keys can be used for an extension.
[dnssec](https://openprovider.help/books/api-plugins/page/api-guides-glossary#dnssec)\_max\_records\_amountinteger The maximum amount of [DNSSEC](https://openprovider.help/books/api-plugins/page/api-guides-glossary#dnssec) records allowed.
[domicile](https://openprovider.help/books/api-plugins/page/api-guides-glossary#domicile)\_availablebooleanIndicates if extension support [domicile](https://openprovider.help/books/api-plugins/page/api-guides-glossary#domicile) option.
is\_[auth\_code](https://openprovider.help/books/api-plugins/page/api-guides-glossary#auth_code)\_availablebooleanIf the [authorization code](https://openprovider.help/books/api-plugins/page/api-guides-glossary#auth_code) is available immediately on demand.
is\_auth\_code\_changeablebooleanIndicates if the [authorization code](https://openprovider.help/books/api-plugins/page/api-guides-glossary#auth_code) could be changed per administrator request.
is\_private\_whois\_allowedbooleanIndicated whenever [WPP](https://openprovider.help/books/api-plugins/page/api-guides-glossary#wpp) feature is available for an extension.
is\_trade\_auth\_code\_requiredbooleanIndicates if the customer requires an [authorization code](https://openprovider.help/books/api-plugins/page/api-guides-glossary#auth_code) to complete trade procedure.
is\_transfer\_auth\_code\_requiredbooleanIndicates if the transfer is done via [authorization code](https://openprovider.help/books/api-plugins/page/api-guides-glossary#auth_code).
**1.1.2 level\_prices****An array.**Returns an array of lever ([Tier](https://support.openprovider.eu/hc/en-us/articles/216644088)) price.
levelMin:1, Max: 8Indicates reseller Level ([Tier](https://support.openprovider.eu/hc/en-us/articles/216644088)).
**1.1.2.1 price****Set of values.**Returns a set of values.
**1.1.2.1.1 product**
1.1.1.2.1.1 currencystringIndicates the domain price currency if presented.
1.1.1.2.1.2 pricenumber (double)Indicates the domain price if presented.
**1.1.2.1.2 reseller**Set of values.Set of values returned.
1.1.2.1.2.1 currencystringIndicates the domain price currency if presented.
1.1.2.1.2.2 pricenumber (double)Indicates the domain price if presented.
max\_periodintegerIndicates max. period of registration (in years).
min\_periodintegerIndicates min. period of registration (in years).
namestringExtension name.
owner\_handle\_supportedbooleanIndicates if extension support owner handle.
**1.1.3 prices****Set of values.****Set of values returned.**
**1.1.3.1 create\_price**
**1.1.3.1.1 product**
1.1.3.1.1.1 currencystringIndicates the domain price currency if presented.
1.1.3.1.1.2 pricenumber (double)Indicates the domain price if presented.
**1.1.3.1.2 reseller****Set of values: reseller price for an extension.****Set of values returned.**
1.1.3.1.2.1 currencystring Indicates the domain price currency if presented.
1.1.3.1.2.2 pricenumber (double)Indicates the domain price if presented.
**1.1.3.2 domicile\_price****Set of values: domicile price for the product itself and for reseller.** **Set of values returned.**
**1.1.3.2.1 product****Set of values.****Set of values returned.**
1.1.3.2.1.1 currencystringIndicates the domain price currency if presented.
1.1.3.2.1.2 pricenumber (double)Indicates the domain price if presented.
**1.1.3.2.2 reseller****Set of values.****Set of values returned.**
1.1.3.2.2.1 currencystringIndicates the domain price currency if presented.
1.1.3.2.2.2 pricenumber (double)Indicates the domain price if presented.
max\_periodintegerIndicates max. period of registration (in years).
min\_periodintegerIndicates min. period of registration (in years).
**1.1.3.3 renew\_price****Set of values: renewal price for the product itself and for reseller.****Set of values returned.**
**1.1.3.3.1 product****Set of values.**
1.1.3.3.1.1 currencystring Indicates the domain price currency if presented.
1.1.3.3.1.2 pricenumber (double)Indicates the domain price if presented.
**1.1.3.3.2 reseller****Set of values.****Set of values returned.**
1.1.3.3.2.1 currencystringIndicates the domain price currency if presented.
1.1.3.3.2.2 pricenumber (double)Indicates the domain price if presented.
**1.1.3.4 reseller\_price****Set of values: reseller price for the product itself and for reseller.**An array of price parameters applicable to the current reseller.
**1.1.3.4.1 product****Set of price values.****Set of values returned.**
1.1.3.4.1.1 currencystringIndicates the domain price currency if presented.
1.1.3.4.1.2 pricenumber (double)Indicates the domain price if presented.
**1.1.3.4.2 reseller****Set of values.****Set of values returned.**
1.1.3.4.2.1 currencystringIndicates the domain price currency if presented.
1.13.4.2.2 pricenumber (double) Indicates the domain price if presented.
**1.1.3.5 restore\_price****Set of values: restore price for the product itself and for reseller.****Set of values returned.**
**1.1.3.5.1 product****Set of values****Set of values returned.**
1.1.3.5.1.1 currencystringIndicates the domain price currency if presented.
1.1.3.5.1.2 price number (double)Indicates the domain price if presented.
**1.1.3.5.2 reseller****Set of values**
1.1.3.5.2.1 currencystring Indicates the domain price currency if presented.
1.1.3.5.2.2 price number (double)Indicates the domain price if presented.
**1.1.3.6 setup\_price****Set of values: setup price for the product itself and for reseller.****Set of values returned.**
**1.1.3.6.1 product****Set of values.****Set of values returned.**
1.1.3.6.1.1 currencystringIndicates the domain price currency if presented.
1.1.3.6.1.2 pricenumber (double)Indicates the domain price if presented.
**1.1.3.6.2 reseller****Set of values.****Set of values returned**
1.1.3.6.2.1 currencystringIndicates the domain price currency if presented.
1.1.3.6.2.2 pricenumber (double)Indicates the domain price if presented.
**1.1.3.7 soft\_restore\_price****Set of values: soft restore price for the product itself and for reseller.****Set of values returned.**
**1.1.3.7.1 product****Set of values.****Set of values returned.**
1.1.3.7.1.1 currencystringIndicates the domain price currency if presented.
1.1.3.7.1.2 pricenumber (double) Indicates the domain price if presented.
**1.1.3.7.2 reseller****Set of values.****Set of values returned.**
1.1.3.7.2.1 currencystringIndicates the domain price currency if presented.
1.1.3.7.2.2 pricenumber (double)Indicates the domain price if presented.
**1.1.3.8 trade\_price****Set of values: trade price for the product itself and for reseller.****Set of values returned.**
**1.1.3.8.1 product****Set of values.****Set of values returned.**
1.1.3.8.1.1 currencystringIndicates the domain price currency if presented.
1.1.3.8.1.2 pricenumber (double) Indicates the domain price if presented.
**1.1.3.8.2 reseller****Set of values.****Set of values returned.**
1.1.3.8.2.1 currencystringIndicates the domain price currency if presented.
1.1.3.8.2.2 pricenumber (double) Indicates the domain price if presented.
**1.1.3.9 transfer\_price****Set of values: transfer price for the product itself and for reseller.****Set of values returned.**
**1.1.3.9.1 product****Set of values.****Set of values returned.**
1.1.3.9.1.1 currency stringIndicates the domain price currency if presented.
1.1.3.9.1.2 pricenumber (double) Indicates the domain price if presented.
**1.1.3.9.2 reseller****Set of values.****Set of values returned.**
1.1.3.9.2.1 currencystringIndicates the domain price currency if presented.
1.1.3.9.2.2 pricenumber (double) Indicates the domain price if presented.
**1.1.3.10 update\_price****Set of values: update price for the product itself and for reseller.****Set of values returned.**
**1.1.3.10.1 product****Set of values.****Set of values returned.**
1.1.3.10.1.1 currencystringIndicates the domain price currency if presented.
1.1.3.10.1.2 pricenumber (double) Indicates the domain price if presented.
**1.1.3.10.2 reseller****Set of values.****Set of values returned.**
1.1.3.10.2.1 currencystringIndicates the domain price currency if presented.
1.1.3.10.2.2 pricenumber (double) Indicates the domain price if presented.
[quarantine\_period ](https://openprovider.help/books/api-plugins/page/api-guides-glossary)integerIndicates [quarantine](https://openprovider.help/books/api-plugins/page/api-guides-glossary) period application for an extension.
reseller\_handle\_enabledbooleanIndicates if domain reseller handle enabled for an extension.
reseller\_handle\_supportedbooleanIndicates if domain reseller handle supported enabled for an extension.
restrictionsAn array of string(s).Returns an extension restrictions.
statusstring.Returns extension status.
**1.2 supported\_application\_mode****An array of strings.****An array of strings returned.**
1.2.1 namestringReturns supported name application mode.
1.2.2 titlestringReturns supported the title of application mode.
**[1.3 supported\_idn\_scripts](https://openprovider.help/books/api-plugins/page/api-guides-glossary#idn)****An array of strings.****Returns parameters related to [IDN](https://openprovider.help/books/api-plugins/page/api-guides-glossary#idn).**
1.3.1 descriptionstringReturns supported IDN description.
1.3.2 valuestringReturns values of IDN scripts.
tech\_handle\_supportedbooleanIndicates if technical handle supported fr an extension.
[trade\_available](https://openprovider.help/books/api-plugins/page/api-guides-glossary#domain_trade)booleanIndicates if [trade](https://openprovider.help/books/api-plugins/page/api-guides-glossary#domain_trade) operation allowed for an extension.
[transfer\_available](https://openprovider.help/books/api-plugins/page/api-guides-glossary#domain_transfer)booleanIndicates if [transfer](https://openprovider.help/books/api-plugins/page/api-guides-glossary#domain_transfer) operation allowed for an extension.
usage\_countintegerReturns a quantity of domain with requested extension from the current resellers account.
descstringThe description.
maintenancebooleanIndicates if Openprovider is under maintenance mode.
**1.4 warnings****An array of strings.****An array of boolean and string data returned if maintenance is in progress.**
1.4.1 codeintegerCode value (digits).
1.4.2 datastringData value returned.
1.4.3 descstringThe description value returned.
REQUEST EXAMPLE FOR MORE THAN ONE TLDs
``` curl -X GET 'https://api.openprovider.eu/v1beta/tlds?status=ACT&extensions=com&extensions=store' -H 'Authorization: Bearer *******************' ```
The above query will fetch details for both "com" and "store" extensions. **Once we've retrieved an extension(s) with its parameters and requirements then we can check an exact domain we want to register. Please move to "[2 Domains API: Check Domain](https://openprovider.help/books/api-plugins/page/2-domains-api-check-domain)".**