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 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 of extensions (TLDs) matching your search criteria. To retrieve a single or several specific extensions - use the following endpoint: GET {base_url}/tlds/{name}

Entering Geo Fence icon 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  numeric Default: 0, Max: 1000
The maximum number of records to be returned.
offset  numeric   Default: 0 Indicates 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.
order string   Output sorting method (ASC or DESC)
order_by string    Indicates an attribute that used for ordering output records.
extensions array of strings Refer to the list of TLDs. Extensions you are interested in.
name_pattern string   Extension name pattern.
only_names boolean  0 or 1 Returns extension names only in the response
with_description boolean  0 or 1 Return extensions with descriptions.
with_restrictions boolean  0 or 1 Returns extensions with restrictions.
with_usage_count boolean  0 or 1 Returns number of domains in your portfolio using specified extension.
with_application_mode boolean  0 or 1 Returns list of supported pre-registration modes.
with_price boolean  0 or 1 Returns prices if enabled.
with_level_prices boolean 0 or 1 Returns extension prices for each Openprovider discount tier.
is_active boolean 0 or 1 Indicates if the extension is active.
is_new_gtld boolean 0 or 1 Indicates if the extension is a new GLTDs.
status string   Extension status.

REQUEST EXAMPLE

 curl -X GET \
'https://api.cte.openprovider.eu/v1beta/tlds?limit=5&extensions=biz&extensions=com' \
-H 'Authorization: Bearer 1c26def9e68dd9a********5abe264fc' \

RESPONSE EXAMPLE

{
"data": {
"results": [
{
"name": "biz",
"min_period": 1,
"max_period": 10,
"transfer_available": true,
"is_transfer_auth_code_required": "yes",
"is_trade_auth_code_required": "no",
"is_auth_code_available": true,
"is_auth_code_changeable": true,
"is_private_whois_allowed": true,
"quarantine_period": 28,
"dnssec_allowed": true,
"status": "ACT",
"billing_handle_enabled": true,
"owner_handle_supported": true,
"admin_handle_supported": true,
"tech_handle_supported": true,
"billing_handle_supported": true,
"dnssec_keys_allowed": true,
"dnssec_digests_allowed": true,
"dnssec_algorithms": [
3,
4,
5,
6,
7,
8,
10,
12,
13
]
},
{
"name": "com",
"min_period": 1,
"max_period": 10,
"transfer_available": true,
"is_transfer_auth_code_required": "yes",
"is_trade_auth_code_required": "no",
"is_auth_code_available": true,
"is_auth_code_changeable": true,
"is_private_whois_allowed": true,
"quarantine_period": 28,
"dnssec_allowed": true,
"status": "ACT",
"billing_handle_enabled": true,
"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,
"dnssec_keys_allowed": true,
"dnssec_digests_allowed": true,
"dnssec_algorithms": [
3,
4,
5,
6,
7,
8,
10,
12,
13
]
}
],
"total": 2
}
}a

RESPONSE VALUES

Name

Values

Description

code

result code number

API Result with code returned.
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_supported boolean Indicates if the administrator handle exists for an extension.
billing_handle_enabled boolean  Indicates if the billing handle exists for an extension.
billing_handle_supported  boolean  Indicates if the billing handle is supported for an extension.
1.1.1 description Set of values (text strings). Returns the description.
1.1.1.1 text string Returns text description.
1.1.1.2 url string Link to registry providing extension.
dnssec_algorithms integer Returns one or multiple records of methods available to be used with an extension.
dnssec_allowed boolean Indicates if DNSSEC can be enabled for an extension.
dnssec_digests_allowed boolean  Indicates if DNSSEC support digest type.
dnssec_keys_allowed boolean Indicates if DNSSEC keys can be used for an extension.
dnssec_max_records_amount integer  The maximum amount of DNSSEC records allowed.
domicile_available boolean Indicates if extension support domicile option.
is_auth_code_available boolean If the authorization code is available immediately on demand.
is_auth_code_changeable boolean Indicates if the authorization code could be changed per administrator request.
is_private_whois_allowed boolean Indicated whenever WPP feature is available for an extension.
is_trade_auth_code_required boolean Indicates if the customer requires an authorization code to complete trade procedure.
is_transfer_auth_code_required boolean Indicates if the transfer is done via authorization code.
1.1.2 level_prices An array. Returns an array of lever (Tier) price.
level Min:1, Max: 8 Indicates reseller Level (Tier).
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 currency string Indicates the domain price currency if presented. 
 1.1.1.2.1.2 price number (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 currency string Indicates the domain price currency if presented. 
1.1.2.1.2.2 price number (double) Indicates the domain price if presented.
max_period integer Indicates max. period of registration (in years).
min_period integer Indicates min. period of registration (in years).
name string Extension name.
owner_handle_supported boolean Indicates 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 currency string Indicates the domain price currency if presented. 
1.1.3.1.1.2 price number (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 currency string  Indicates the domain price currency if presented. 
1.1.3.1.2.2 price number (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 currency string Indicates the domain price currency if presented. 
1.1.3.2.1.2 price number (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 currency string Indicates the domain price currency if presented. 
1.1.3.2.2.2 price number (double) Indicates the domain price if presented. 
max_period integer Indicates max. period of registration (in years). 
min_period integer Indicates 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 currency string  Indicates the domain price currency if presented. 
1.1.3.3.1.2 price number (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 currency string Indicates the domain price currency if presented.
1.1.3.3.2.2 price number (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 currency string Indicates the domain price currency if presented. 
 1.1.3.4.1.2 price number (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 currency string Indicates the domain price currency if presented.
1.13.4.2.2 price number (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 currency string Indicates 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 currency string  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 currency string Indicates the domain price currency if presented. 
1.1.3.6.1.2 price number (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 currency string Indicates the domain price currency if presented. 
1.1.3.6.2.2 price number (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 currency string Indicates the domain price currency if presented. 
1.1.3.7.1.2 price number (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 currency string Indicates the domain price currency if presented. 
1.1.3.7.2.2 price number (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 currency string Indicates the domain price currency if presented.
1.1.3.8.1.2 price number (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 currency string Indicates the domain price currency if presented.
1.1.3.8.2.2 price number (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  string Indicates the domain price currency if presented.
1.1.3.9.1.2 price number (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 currency string Indicates the domain price currency if presented.
1.1.3.9.2.2 price number (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 currency string Indicates the domain price currency if presented. 
1.1.3.10.1.2 price number (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 currency string Indicates the domain price currency if presented. 
1.1.3.10.2.2 price number (double)  Indicates the domain price if presented.
quarantine_period  integer Indicates quarantine period application for an extension.
reseller_handle_enabled boolean Indicates if domain reseller handle enabled for an extension.
reseller_handle_supported boolean Indicates if domain reseller handle supported enabled for an extension.
restrictions An array of string(s). Returns an extension restrictions.
status string. Returns extension status.
1.2 supported_application_mode An array of strings. An array of strings returned.
1.2.1 name string Returns supported name application mode.
1.2.2 title string Returns supported the title of application mode.
1.3 supported_idn_scripts An array of strings. Returns parameters related to IDN.
1.3.1 description string Returns supported IDN description.
1.3.2 value string Returns values of IDN scripts.
tech_handle_supported boolean Indicates if technical handle supported fr an extension.
trade_available boolean Indicates if trade operation allowed for an extension.
transfer_available boolean Indicates if transfer operation allowed for an extension.
usage_count integer Returns a quantity of domain with requested extension from the current resellers account.
desc string The description.
maintenance boolean Indicates 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 code integer Code value (digits).
1.4.2 data string Data value returned.
1.4.3 desc string The description value returned.

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

Was this article helpful?
2 out of 2 found this helpful
Additional questions? Submit a request