API: OpenSRS

OpenSRS API Guide: Domains and SSL

Welcome to the OpenSRS API guide. Here you will find comprehensive documentation regarding our domain and SSL services. We hope this guide will help you start working with OpenSRS as quickly as possible. If you have any questions or concerns, please do not hesitate to contact help@opensrs.com

Get Started

name_suggest (domain)

Checks whether a specified name, word, or phrase is available for registration
in gTLDs and ccTLDs, suggests other similar domain names for .COM,
.NET, .ORG, .INFO, .BIZ, .US, and .MOBI domains, and checks whether they
are available. Reseller must be enabled for the specified TLDs. Can also be
used to search for domains owned by external domain suppliers.

Request parameters for name_suggest (domain)

Standard parameters

  • action = name_suggest
  • object = domain

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

languages

Optional

Specify the languages in which to return suggestions for other similar names.

  • en—English
  • fr —French
  • de—German
  • it—Italian
  • es—Spanish

You can specify the languages in which you want to see name suggestions, for example, you can submit a name, word or phrase in Spanish and specify es to request suggestions
in Spanish.

If you do not specify a language code, the system tries to determine the language used in
the searchstring and returns suggestions in that language.

max_wait_time

Optional

Specify the number of seconds that the command can run, and return as many results as can be found in that time period. You can specify a fraction of a second, as long as the value is at least 0.1. If the results cannot be determined for any of the lookup domains within the specified time, the returned status value is in_progress.

If all results cannot be returned for suggestion, premium, or personal names within the specified time period, no results are returned for that service; that is the command returns all results or no results for each of these services.

After the results obtained within the max_wait_time are returned, the command
continues to run in the background, and you can resubmit the command with the
search_key to see more results.

Note: If you do not include the max_wait_time parameter, the command
takes as long as it needs to return complete results.

search_key

Required

Resumes the previously run name_suggest command if the command did not return
complete results during the specified max_wait_time

searchstring

Required

The name, word, or phrase whose availability you want to check.

Note: The first level domain (for example, .COM) is not required.

service_override

Optional

Overrides default settings for lookup, suggestion, or premium.

For more information, see the
Service_Override table below.

Note: service_override is not available for
personal_names.

services

Optional

Specify the services for which you want to check availability.

  • lookup—Check availability.

  • suggestion—Request suggestions.

  • personal_names—Check the availability of the specified personal name, (firstname lastname).

  • premium—Include domains owned by external domain suppliers.

  • premium_brokered_transfer—Include domain names that may be purchased
    from external suppliers that use a broker to complete the purchase process.

  • premium_make_offer—Include domain names that may be purchased from external suppliers where the buyer and seller negotiate the purchase price.

skip_registry_lookup

Optional

Specifies whether to query the applicable registries to find out if the lookup domain names are available for registration.

  • 0—Query the registries; this is the default.

  • 1—Do not query the registries.

Note: If you set this parameter to 1, the
response is returned more quickly; however, the
results do not indicate whether or not the lookup names are available. You still have to
check the availability of any names you are interested in, for example, by using the lookup (domain) command.

suggestion

Optional

Specify the TLDs to check for name suggestions; can also specify the number of suggestions to return. Suggestions are only available for .COM, .NET, .ORG, .INFO, and .BIZ.

Allowed values may be the tlds array and the maximum parameter.

For more information, see the Lookup and Suggestion table below.

tlds

Required

The TLDs you want to check for domain name availability and suggestions.

Lookups are available for all gTLDs and ccTLDs.

Suggestions are available for .COM, .NET, .ORG, .INFO, .BIZ, .US, and .MOBI.

Service_Override

Parameters within the service_override associative array are described
below.

Parameter name
Obligation
Definition/Value

lookup

Optional

Specify the TLDs to check for availability.

Lookups are available for all gTLDs and ccTLDs.

personal_names

Optional

Specify the TLDs to check for available personal names.

premium

Optional

Specify the TLDs to check for availability. Premium domain name lookups are available for .COM, .NET, .ORG, .INFO, and .BIZ.

suggestion

Optional

Specify the TLDs to check for name suggestions;
can also specify the number of suggestions to return. Suggestions are available for .COM, .NET, .ORG, .INFO, .BIZ, .US, and .MOBI.

Allowed values may be the tlds array and the maximum parameter.

For more information, see the Lookup and Suggestion table below.

Lookup and Suggestion

Parameters within the lookup and suggestion associative arrays are
described below.

Parameter name
Obligation
Definition/Value

maximum

Optional

The maximum number of domain name suggestions
to return.

Specify 1 to 100; 100 is the default.

price_max

Optional; used only for Premium domains

The maximum price of the Premium domains to return.

The value must be an integer, for example, 1150; decimal points are not allowed.

If this parameter is not submitted or if the value is
not acceptable, the default value of 5000 is used. If this value is less than the price_min value, the default values for both price_min and price_max are used

price_min

Optional; used only for Premium domains

The minimum price of the Premium domains to return. The value must be greater than zero, and must be an integer, for example, 250; decimal
points are not allowed.

If this parameter is not submitted or if the value is
not acceptable, the default value of 50 is used. If this value is greater than the price_max value, the default values for both price_min and price_max
are used.

tlds

Required

The TLDs you want to check for domain name availability and suggestions.

Lookups are available for all gTLDs and ccTLDs.

Suggestions are available for .COM, .NET, .ORG,
.INFO, .BIZ, .US, and .MOBI.

Lookup

The following parameter may be used in the lookup associative array:

Parameter name
Obligation
Definition/Value

no_cache_tlds

Optional

In order to obtain results quickly, the default for the lookup command is to check the local OpenSRS cache to determine domain name availability. If you specify no_cache_tlds = 1, instead of checking the cache, the lookup command queries the
applicable registries to determine domain name
availability.

Note: Setting no_cache_tlds to 1 increases the
amount of time it takes to get results

Response parameters for name_suggest (domain)

Standard parameters

  • action = reply
  • is_success = a Boolean is returned, indicating success or failure of the
    request
  • response_code = response code indicating outcome of the request
  • response_text = message describing the outcome of the request

Attributes

If the request is successful, the attributes associative array may include the
following:

Parameter name
Obligation
Definition/Value

has_claim

Returned for the new TLDs during the claims period
(90 days from the start of GA)

Indicates whether the domain name has a matching mark registered at the Trademark Clearinghouse (TMCH).

  • 0—No matching marks exist at the TMCH.

  • 1—A mark is registered at the TMCH that matches the domain name.

is_search_completed

Returned if is_success = true

Indicates whether all results were returned within the specified max_wait_time .

  • 0—Search results are not
    complete.

Note: The command continues to run in the background, and you can resubmit the command with
the search_key to see more
results.

  • 1—Search completed.

lookup

Optional

The results returned for lookup.

Values may be the count parameter and items associative array.

For more information, see the Premium, Personal_Names, Lookup, and Suggestion table below.

personal_names

Optional

The results returned for
personal_names.

Values may be the count parameter and the items associative array.

For more information, see the Premium, Personal_Names, Lookup, and Suggestion table below.

premium

Optional

The results returned for premium.

Values may be the count parameter and the items associative array.

For more information, see the Premium, Personal_Names, Lookup, and Suggestion table below.

premium_brokered_transfer

Optional

The results returned for
premium_brokered_transfer.

Values may be the count parameter and
the items associative array.

For more information, see the Premium, Personal_Names, Lookup, and Suggestion table below.

premium_make_offer

Optional

The results returned for
premium_make_offer.

Values may be the count parameter and the items associative array.

For more information, see the Premium, Personal_Names, Lookup, and Suggestion table below.

reason

Returned if the domain queried is a registry premium domain.

Indicates that the domain is registry premium.

Value, if returned:

  • Premium Name

search_key

Returned if is_success = true and is_search_completed = 0

A key that is returned if the
name_suggest command did not return complete results during the specified
max_wait_time.

The command continues to run in the background, and you can resubmit the command with the search_key to see more results.

suggestion

Optional

The results returned for suggestion.

Values may be the count parameter and the items associative array.

For more information, see the Premium, Personal_Names, Lookup, and Suggestion table below.

Domain = Registry Premium

Parameter name
Obligation
Definition/Value

reason

Returned if the domain queried is a registry premium domain.

Indicates that the domain is registry premium.

Value, if returned:

  • Premium Name

Premium, Personal_Names, Lookup, and Suggestion

Parameters within the premium, personal_names, lookup, and suggestion
associative arrays are described below.

Parameter name
Obligation
Definition/Value

count

Always returned

The number of results returned for lookup, personal_names, suggestion, or premium.

items

Always returned

List of domain names and their statuses.

Allowed values are domain and status.

Items

Parameters within the items associative array are described below.

Parameter name
Obligation
Definition/Value

domain

Always returned

Returned domain name.

price

Optional

The purchase price for the premium domain.

status

Always returned

Indicates whether the returned domain names are available and can be registered. Allowed values are:

  • available—Domain name is available and
    can be registered.
  • justsold—Domain name has been sold and
    is not available.
  • taken—Domain name is not available.
  • undetermined—Returned if skip_registry_lookup = 1 in the request, or if the registry could not be contacted.
  • in_progress—The command could not determine the status of the domain name in the allowed time. The command continues to
    run in the background, and you can resubmit
    the command with the search_key to see
    more results.

third_party_offer_url

Returned for
premium_make_offer
domains

The URL of the vendor that is facilitating the negotiations between buyer and seller for the Make Offer Premium domain.

Examples for name_suggest (domain)

Note:

Due to the length of the responses in these examples, in some cases,
the results have been truncated by using ellipses (...) to represent omitted
results.

Example 1

For lookup, suggestion, premium, and personal names with suggestion
limited to .COM, .NET, and .ORG, in English, German, Italian, and Spanish.

Request

<?xml version='1.0' encoding='UTF-8' standalone='no' ?> 
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'> 
<OPS_envelope>
 <header>
    <version>0.9</version>
 </header> 
 <body>
  <data_block>
    <dt_assoc>
                <item key='protocol'>XCP</item>
                <item key='action'>name_suggest</item> 
                <item key='object'>domain</item>
                <item key='attributes'>
                     <dt_assoc>
                         <item key='services'>
                             <dt_array>
                                 <item key='0'>lookup</item>
                                 <item key='1'>suggestion</item> 
                                 <item key='2'>premium</item>
                                 <item key='3'>personal_names</item>
                             </dt_array> 
                         </item>
                         <item key='searchstring'>search string</item> 
                         <item key='languages'>
                           <dt_array>
                                 <item key='0'>en</item>
                                 <item key='1'>de</item> 
                                 <item key='2'>it</item> 
                                 <item key='3'>es</item>
                             </dt_array>
                         </item>
                         <item key='tlds'> 
                            <dt_array>
                                 <item key='0'>.com</item> 
                                 <item key='1'>.net</item> 
                                 <item key='2'>.org</item>
                            </dt_array>
                         </item>
                      </dt_assoc> 
                </item>
    </dt_assoc> 
  </data_block>
 </body> 
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="response_text">Command completed successfully</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="lookup">
                            <dt_assoc>
                                <item key="count">6</item>
                                <item key="response_text">Command completed
                                    successfully.</item>
                                <item key="is_success">1</item>
                                <item key="response_code">200</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">searchstring.com</item>
                                                <item key="status">taken</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">searchstring.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">searchstring.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="3">
                                            <dt_assoc>
                                                <item key="domain">search-string.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        ...
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                        <item key="personal_names">
                            <dt_assoc>
                                <item key="count">6</item>
                                <item key="response_text">Command completed successfully.</item>
                                <item key="response_code">200</item>
                                <item key="is_success">1</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">search.stringham.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">search.stringhini.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">search.stringfield.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="3">
                                            <dt_assoc>
                                                <item key="domain">search.stringer.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        ...
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                        <item key="premium">
                            <dt_assoc>
                                <item key="count">20</item>
                                <item key="response_text">Command Successful</item>
                                <item key="response_code">200</item>
                                <item key="is_success">1</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">badmintonstring.com</item>
                                                <item key="status">available</item>
                                                <item key="price">1349.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">cheapstring.com</item>
                                                <item key="status">available</item>
                                                <item key="price">1549.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">elasticstring.com</item>
                                                <item key="status">available</item>
                                                <item key="price">1399.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="3">
                                            <dt_assoc>
                                                <item key="domain">findcordblood.com</item>
                                                <item key="status">available</item>
                                                <item key="price">1688.00</item>
                                            </dt_assoc>
                                        </item>
                                        ...
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                        <item key="suggestion">
                            <dt_assoc>
                                <item key="count">50</item>
                                <item key="response_text">Command Successful</item>
                                <item key="response_code">200</item>
                                <item key="is_success">1</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">amazonsearchstring.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">archivesearchstring.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">briefsearchstring.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        ...
                                        <item key="49"><dt_assoc><item key="domain">search-string.org</item><item key="status">available</item></dt_assoc></item></dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 2

For both lookup and suggestion with lookups limited to .COM and .INFO,
querying the registry (not OpenSRS cache) for .COM lookups, suggestions
limited to .COM and .ORG, and maximum 25 suggestions returned.

Request

<?xml version='1.0' encoding='UTF-8' standalone='no' ?> 
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'> 
<OPS_envelope>
    <header> 
    <version>0.9</version>
    </header> 
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">name_suggest</item> 
                <item key="object">domain</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="searchstring">example@search.com</item>
                        <item key="service_override"> 
                            <dt_assoc>
                                <item key="suggestion"> 
                                    <dt_assoc>
                                        <item key="tlds"> 
                                            <dt_array>
                                              <item key="0">.com</item>
                                                <item key="1">.org</item> 
                                            </dt_array>
                                        </item>
                                        <item key="maximum">25</item>
                                    </dt_assoc>
                                </item>
                                <item key="lookup"> 
                                    <dt_assoc>
                                        <item key="tlds"> 
                                            <dt_array>
                                                <item key="0">.com</item>
                                                <item key="1">.info</item> 
                                            </dt_array>
                                        </item>
                                        <item key = "no_cache_tlds">
                                            <dt_array>
                                                <item key="0">.com</item>
                                            </dt_array>
                                        </item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                          </item>
                        <item key="services">
                            <dt_array>
                                <item key="0">lookup</item> 
                                <item key="1">suggestion</item>
                            </dt_array> 
                        </item>
                    </dt_assoc> 
                </item>
            </dt_assoc>
        </data_block>
    </body> 
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="response_text">Command completed successfully</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="lookup">
                            <dt_assoc>
                                <item key="count">8</item>
                                <item key="response_text" />
                                <item key="response_code">0</item>
                                <item key="is_success">1</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">example-
                                                    search.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">example-
                                                    search.info</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">example.com</item>
                                                <item key="status">taken</item>
                                            </dt_assoc>
                                        </item>
                                        ...
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                        <item key="suggestion">
                            <dt_assoc>
                                <item key="count">25</item>
                                <item key="response_text" />
                                <item key="response_code">0</item>
                                <item key="is_success">1</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">modelhunt.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">modelfind.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">problemfind.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        ...
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 3

For premium domains, limited to .COM and .NET.

Request

<?xml version='1.0' encoding='UTF-8' standalone='no' ?> 
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'> 
<OPS_envelope>
    <header> 
    <version>0.9</version>
    </header> 
    <body>
        <data_block>
            <dt_assoc>
                <item key='protocol'>XCP</item>
                <item key='action'>name_suggest</item>
                <item key='object'>domain</item> 
                <item key='attributes'>
                    <dt_assoc>
                        <item key='searchstring'>abc&amp;d !</item> 
                        <item key='service_override'>
                            <dt_assoc>
                                <item key='premium'>
                                    <dt_assoc>
                                        <item key='tlds'>
                                            <dt_array>
                                              <item key='0'>.com</item> 
                                                <item key='1'>.net</item>
                                            </dt_array>
                                        </item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc> 
                        </item>
                        <item key='services'> 
                            <dt_array>
                                <item key='0'>premium</item> 
                            </dt_array>
                        </item> 
                    </dt_assoc>
                </item> 
            </dt_assoc> 
        </data_block>
    </body> 
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no' ?> 
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'> 
<OPS_envelope>
    <header>
    <version>0.9</version>
    </header> 
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="is_success">1</item>
                <item key="response_text">Command completed successfully</item>
                <item key="response_code">200</item>
                <item key="attributes"> 
                    <dt_assoc>
                        <item key="premium"> 
                            <dt_assoc>
                                <item key="count">4</item>
                                <item key="response_text"/>
                                <item key="response_code">0</item>
                                <item key="is_success">1</item>
                                <item key="items"> 
                                  <dt_array>
                                        <item key="0"> 
                                            <dt_assoc>
                                                <item key="domain">abc-and-d.com</item>
                                                <item key="status">available</item>
                                                <item key="price">299.98</item> 
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc> 
                                                <item key="domain">abcandd.com</item>
                                                <item key="status">available</item>
                                                <item key="price">499.98</item> 
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                   <item key="domain">abcandd.net</item>
                                                <item key="status">available</item>
                                                <item key="price">99.78</item> 
                                            </dt_assoc>
                                        </item>
                                        <item key="3">
                                            <dt_assoc>
                                                <item key="domain">abcd.com</item> 
                                                <item key="status">available</item> 
                                                <item key="price">1523.45</item>
                                              </dt_assoc>
                                           </item>
                                    </dt_array>
                                 </item>
                              </dt_assoc>
                           </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block> 
    </body>
</OPS_envelope>

Example 4

For premium, lookup, and suggestion, limited to .COM, maximum 10
suggestions returned.

Request

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">name_suggest</item>
                <item key="object">domain</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="service_override">
                            <dt_assoc>
                                <item key="premium">
                                    <dt_assoc>
                                        <item key="tlds">
                                            <dt_array>
                                                <item key="0">.com</item>
                                            </dt_array>
                                        </item>
                                    </dt_assoc>
                                </item>
                                <item key="suggestion">
                                    <dt_assoc>
                                        <item key="tlds">
                                            <dt_array>
                                                <item key="0">.com</item>
                                            </dt_array>
                                        </item>
                                        <item key="maximum">10</item>
                                    </dt_assoc>
                                </item>
                                <item key="lookup">
                                    <dt_assoc>
                                        <item key="tlds">
                                            <dt_array>
                                                <item key="0">.com</item>
                                            </dt_array>
                                        </item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                        <item key="services">
                            <dt_array>
                                <item key="0">lookup</item>
                                <item key="1">suggestion</item>
                                <item key="2">premium</item>
                            </dt_array>
                        </item>
                        <item key="searchstring">abc&amp;d</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version=’1.0’ encoding=’UTF-8’ standalone=’no’ ?> 
<!DOCTYPE OPS_envelope SYSTEM ’ops.dtd’> 
<OPS_envelope>
    <header> 
   <version>0.9</version>
    </header> 
   <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="response_text">Command completed successfully </item>
                <item key="is_success">1</item>
                <item key="response_code">200</item> 
                <item key="attributes">
                    <dt_assoc>
                        <item key="lookup">
                            <dt_assoc>
                              <item key="count">2</item> 
                                <item key="response_text"/>
                                <item key="response_code">0</item> 
                                <item key="is_success">1</item>
                                <item key="items"> 
                                    <dt_array>
                                        <item key="0"> 
                                            <dt_assoc>
                                                <item key="domain">abc-d.com</item>
                                                <item key="status">available</item>     
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">abcd.com</item>
                                                <item key="status">taken</item> 
                                            </dt_assoc>
                                        </item> 
                                    </dt_array>
                                 </item>
                              </dt_assoc>
                        </item>
                        <item key="premium">
                            <dt_assoc>
                                <item key="count">3</item>
                                <item key="response_text"/>
                              <item key="response_code">0</item> 
                                <item key="is_success">1</item> 
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">abc-and-d.com</item>
                                                <item key="status">available</item>
                                                <item key="price">299.98</item> 
                                            </dt_assoc>
                                       </item>
                                       <item key="1">
                                            <dt_assoc> 
                                                <item key="domain">abcandd.com</item>
                                                <item key="status">available</item>
                                                <item key="price">499.98</item> 
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                              <item key="domain">abcd.com</item> 
                                                <item key="status">available</item>
                                                <item key="price">1523.45</item> 
                                            </dt_assoc>
                                       </item>
                                    </dt_array>
                                </item> 
                            </dt_assoc>
                        </item>
                        <item key="suggestion">
                            <dt_assoc>
                                <item key="count">10</item> 
                                <item key="response_text"/>
                                <item key="response_code">0</item> 
                                <item key="is_success">1</item>
                                <item key="items"> 
                                    <dt_array>
                                        <item key="0"> 
                                            <dt_assoc>
                                              <item key="domain">abcdlive.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">abcdpro.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">abcdslive.com</item>
                                                <item key="status">available</item>
                                                                                          </dt_assoc>
                                        </item>
                                    </dt_array> 
                                </item>
                            </dt_assoc>
                         </item>
                      </dt_assoc>
                </item>
              </dt_assoc>
        </data_block>
   </body>
</OPS_envelope>

Example 5

For lookup and suggestion, limited to .COM, not checking the availability of
the lookup domain, maximum 10 suggestions returned.

Request

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">name_suggest</item>
                <item key="object">domain</item>
                <item key="attributes">
                    <item key="services">
                        <dt_array>
                            <item key="0">lookup</item>
                            <item key="1">suggestion</item>
                        </dt_array>
                    </item>
                    <dt_assoc>
                        <item key="searchstring">smith</item>
                        <item key="skip_registry_lookup">1</item>
                        <item key="service_override">
                            <dt_assoc>
                                <item key="suggestion">
                                    <dt_assoc>
                                        <item key="tlds">
                                            <dt_array>
                                                <item key="0">.com</item>
                                            </dt_array>
                                        </item>
                                        <item key="maximum">10</item>
                                    </dt_assoc>
                                </item>
                                <item key="lookup">
                                    <dt_assoc>
                                        <item key="tlds">
                                            <dt_array>
                                                <item key="0">.com</item>
                                            </dt_array>
                                        </item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
                <item key="request_response_time">0.169</item>
                <item key="response_text">Command completed successfully</item>
                <item key="is_search_completed">1</item>
                <item key="action">REPLY</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="lookup">
                            <dt_assoc>
                                <item key="count">1</item>
                                <item key="response_text">Command completed successfully.</item>
                                <item key="response_code">200</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">smith.com</item>
                                                <item key="status">undetermined</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_array>
                                </item>
                                <item key="is_success">1</item>
                            </dt_assoc>
                        </item>
                        <item key="suggestion">
                            <dt_assoc>
                                <item key="count">10</item>
                                <item key="response_text">Command Successful</item>
                                <item key="response_code">200</item>
                                <item key="is_success">1</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">myjosephsmith.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">josephsmithonline.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">mysmithonline.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="3">
                                            <dt_assoc>
                                                <item key="domain">mystevesmith.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="4">
                                            <dt_assoc>
                                                <item key="domain">thefortsmith.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="5">
                                            <dt_assoc>
                                                <item key="domain">my-smith.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="6">
                                            <dt_assoc>
                                                <item key="domain">myfortsmithonline.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="7">
                                            <dt_assoc>
                                                <item key="domain">mymikesmith.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="8">
                                            <dt_assoc>
                                                <item key="domain">thejosephsmith.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="9">
                                            <dt_assoc>
                                                <item key="domain">fortsmithgroup.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 6

For lookup, suggestion, premium, and personal names with suggestion
limited to .COM, .NET, .ORG, and .IN, in English, German, Italian, and
Spanish, with the command run time limited to 0.4 seconds.

Request

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">name_suggest</item>
                <item key="object">domain</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="searchstring">search string</item>
                        <item key="max_wait_time">0.4</item>
                        <item key="languages">
                            <dt_array>
                                <item key="0">en</item>
                                <item key="1">de</item>
                                <item key="2">it</item>
                                <item key="3">es</item>
                            </dt_array>
                        </item>
                        <item key="tlds">
                            <dt_array>
                                <item key="0">.com</item>
                                <item key="1">.net</item>
                                <item key="2">.org</item>
                                <item key="3">.in</item>
                            </dt_array>
                        </item>
                        <item key="services">
                            <dt_array>
                                <item key="0">lookup</item>
                                <item key="1">suggestion</item>
                                <item key="2">premium</item>
                                <item key="3">personal_names</item>
                            </dt_array>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

The results were in the specified time; however, not all lookup results are
complete. Premium name results were returned but suggestion and personal
names could not be returned in the specified time. The returned unique_key
allows you to resubmit the command.

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="search_key">Ko1fN8Fnw1qaCuFE1tc1daCaT1E</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
                <item key="response_text">Command completed successfully</item>
                <item key="is_search_completed">0</item>
                <item key="action">REPLY</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="lookup">
                            <dt_assoc>
                                <item key="count">8</item>
                                <item key="response_text">Command completed successfully.</item>
                                <item key="response_code">200</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">searchstring.com</item>
                                                <item key="status">taken</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">searchstring.net</item>
                                                <item key="status">taken</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">searchstring.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="3">
                                            <dt_assoc>
                                                <item key="domain">searchstring.in</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="4">
                                            <dt_assoc>
                                                <item key="domain">search-string.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="5">
                                            <dt_assoc>
                                                <item key="domain">search-string.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="6">
                                            <dt_assoc>
                                                <item key="domain">search-string.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="7">
                                            <dt_assoc>
                                                <item key="domain">search-string.in</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_array>
                                </item>
                                <item key="is_success">1</item>
                            </dt_assoc>
                        </item>
                        <item key="personal_names">
                            <dt_assoc>
                                <item key="count">5</item>
                                <item key="response_text">Command completed successfully.</item>
                                <item key="response_code">200</item>
                                <item key="is_success">1</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">search.stringham.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">search.stringhini.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">search.stringfield.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="3">
                                            <dt_assoc>
                                                <item key="domain">search.stringer.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="4">
                                            <dt_assoc>
                                                <item key="domain">search.stringfield.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                        <item key="suggestion">
                            <dt_assoc>
                                <item key="count">48</item>
                                <item key="response_text">Command Successful</item>
                                <item key="response_code">200</item>
                                <item key="is_success">1</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">mysearchstring.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">mysearchstring.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">mysearchstring.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="3">
                                            <dt_assoc>
                                                <item key="domain">searchstringonline.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="4">
                                            <dt_assoc>
                                                <item key="domain">searchstringonline.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="5">
                                            <dt_assoc>
                                                <item key="domain">thesearchstring.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="6">
                                            <dt_assoc>
                                                <item key="domain">thesearchstring.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="7">
                                            <dt_assoc>
                                                <item key="domain">thesearchstring.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="8">
                                            <dt_assoc>
                                                <item key="domain">mysearchstringonline.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="9">
                                            <dt_assoc>
                                                <item key="domain">mysearchstringonline.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="10">
                                            <dt_assoc>
                                                <item key="domain">mysearchstringonline.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="11">
                                            <dt_assoc>
                                                <item key="domain">searchstringgroup.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="12">
                                            <dt_assoc>
                                                <item key="domain">my-searchstring.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="13">
                                            <dt_assoc>
                                                <item key="domain">searchstringgroup.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="14">
                                            <dt_assoc>
                                                <item key="domain">my-searchstring.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="15">
                                            <dt_assoc>
                                                <item key="domain">searchstringgroup.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="16">
                                            <dt_assoc>
                                                <item key="domain">my-searchstring.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="17">
                                            <dt_assoc>
                                                <item key="domain">searchstring-online.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="18">
                                            <dt_assoc>
                                                <item key="domain">bestsearchstring.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="19">
                                            <dt_assoc>
                                                <item key="domain">searchstring-online.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="20">
                                            <dt_assoc>
                                                <item key="domain">searchstring-online.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="21">
                                            <dt_assoc>
                                                <item key="domain">bestsearchstring.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="22">
                                            <dt_assoc>
                                                <item key="domain">bestsearchstring.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="23">
                                            <dt_assoc>
                                                <item key="domain">thesearchstringonline.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="24">
                                            <dt_assoc>
                                                <item key="domain">thesearchstringonline.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="25">
                                            <dt_assoc>
                                                <item key="domain">thesearchstringonline.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="26">
                                            <dt_assoc>
                                                <item key="domain">mysearchstringgroup.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="27">
                                            <dt_assoc>
                                                <item key="domain">the-searchstring.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="28">
                                            <dt_assoc>
                                                <item key="domain">mysearchstringgroup.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="29">
                                            <dt_assoc>
                                                <item key="domain">the-searchstring.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="30">
                                            <dt_assoc>
                                                <item key="domain">mysearchstringgroup.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="31">
                                            <dt_assoc>
                                                <item key="domain">searchstringshop.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="32">
                                            <dt_assoc>
                                                <item key="domain">the-searchstring.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="33">
                                            <dt_assoc>
                                                <item key="domain">my-searchstring-online.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="34">
                                            <dt_assoc>
                                                <item key="domain">topsearchstring.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="35">
                                            <dt_assoc>
                                                <item key="domain">searchstringshop.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="36">
                                            <dt_assoc>
                                                <item key="domain">my-searchstring-online.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="37">
                                            <dt_assoc>
                                                <item key="domain">searchstringshop.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="38">
                                            <dt_assoc>
                                                <item key="domain">my-searchstring-online.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="39">
                                            <dt_assoc>
                                                <item key="domain">searchstring-group.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="40">
                                            <dt_assoc>
                                                <item key="domain">topsearchstring.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="41">
                                            <dt_assoc>
                                                <item key="domain">topsearchstring.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="42">
                                            <dt_assoc>
                                                <item key="domain">bestsearchstringonline.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="43">
                                            <dt_assoc>
                                                <item key="domain">searchstring-group.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="44">
                                            <dt_assoc>
                                                <item key="domain">searchstring-group.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="45">
                                            <dt_assoc>
                                                <item key="domain">bestsearchstringonline.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="46">
                                            <dt_assoc>
                                                <item key="domain">bestsearchstringonline.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="47">
                                            <dt_assoc>
                                                <item key="domain">thesearchstringgroup.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 7

Resubmits the previously run name_suggest command which did not return
complete lookup results during the specified max_wait_time. The command
can run for a maximum of 0.7 seconds.

Request

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">name_suggest</item>
                <item key="object">DOMAIN</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="search_key">vgL2FeBzZ8JuS5lIluIEYhDc7Vg</item>
                        <item key="max_wait_time">0.7</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

Complete results for lookup are returned as well as results for suggestion,
premium
, and personal names.

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="response_text">Command completed successfully</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
                <item key="is_search_completed">1</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="lookup">
                            <dt_assoc>
                                <item key="count">84</item>
                                <item key="response_text">Command completed
                                    successfully.</item>
                                <item key="response_code">200</item>
                                <item key="is_success">1</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">searchstring.com</item>
                                                <item key="status">taken</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">searchstring.net</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">searchstring.org</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="3">
                                            <dt_assoc>
                                                <item key="domain">searchstring.in</item>
                                                <item key="status">undetermined</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                        <item key="premium">
                            <dt_assoc>
                                <item key="count">20</item>
                                <item key="response_text">Command Successful</item>
                                <item key="response_code">200</item>
                                <item key="is_success">1</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">badmintonstring.com</item>
                                                <item key="status">available</item>
                                                <item key="price">1349.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">cheapstring.com</item>
                                                <item key="status">available</item>
                                                <item key="price">1549.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">elasticstring.com</item>
                                                <item key="status">available</item>
                                                <item key="price">13998.00</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                        <item key="personal_names">
                            <dt_assoc>
                                <item key="count">6</item>
                                <item key="response_text">Command completed
                                    successfully.</item>
                                <item key="response_code">200</item>
                                <item key="is_success">1</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">search.stringham.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">search.stringhini.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">search.stringfield.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                        <item key="suggestion">
                            <dt_assoc>
                                <item key="count">50</item>
                                <item key="response_text">Command Successful</item>
                                <item key="response_code">200</item>
                                <item key="is_success">1</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">amazonsearchstring.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">archivesearchstring.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">briefsearchstring.com</item>
                                                <item key="status">available</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 8

For premium domains, limited to .COM and .NET names that cost between
$100 and $10000, maximum 10 suggestions returned.

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="action">name_suggest</item>
                <item key="object">domain</item>
                <item key="protocol">XCP</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="service_override">
                            <dt_assoc>
                                <item key="premium">
                                    <dt_assoc>
                                        <item key="tlds">
                                            <dt_array>
                                                <item key="0">.com</item>
                                                <item key="1">.net</item>
                                            </dt_array>
                                        </item>
                                        <item key="maximum">10</item>
                                        <item key="price_min">100</item>
                                        <item key="price_max">10000</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                        <item key="services">
                            <dt_array>
                                <item key="0">premium</item>
                            </dt_array>
                        </item>
                        <item key="searchstring">computerstore</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
                <item key="response_text">Command completed successfully</item>
                <item key="is_search_completed">1</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="premium">
                            <dt_assoc>
                                <item key="count">2</item>
                                <item key="response_text">Command Successful</item>
                                <item key="response_code">200</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">childhoodneglect.com</item>
                                                <item key="status">available</item>
                                                <item key="price">499.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">child-neglect.com</item>
                                                <item key="status">available</item>
                                                <item key="price">499.00</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_array>
                                </item>
                                <item key="is_success">1</item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 9

Lookup for one of the new TLDs.

Request

<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
        <msg_type>standard</msg_type>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="action">name_suggest</item>
                <item key="object">domain</item>
                <item key="protocol">XCP</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="services">
                            <dt_array>
                                <item key="0">lookup</item>
                            </dt_array>
                        </item>
                        <item key="searchstring">example</item>
                        <item key="tlds">
                            <dt_array>
                                <item key="0">guru</item>
                            </dt_array>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
                <item key="request_response_time">0.065</item>
                <item key="response_text">Command completed
                    successfully</item>
                <item key="is_search_completed">1</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="lookup">
                            <dt_assoc>
                                <item key="count">1</item>
                                <item key="response_text">Command completed
                                    successfully.</item>
                                <item key="is_success">1</item>
                                <item key="response_code">200</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">example.guru</item>
                                                <item key="status">available</item>
                                                <item key="has_claim">1</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 10

For premium, premium_brokered_transfer, and premium_make_offer
domains, limited to .COM, .NET, .ORG, and .DE names.

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">NAME_SUGGEST</item>
                <item key="object">DOMAIN</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="searchstring">testdomain</item>
                        <item key="tlds">
                            <dt_array>
                                <item key="0">.com</item>
                                <item key="1">.net</item>
                                <item key="2">.org</item>
                                <item key="3">.de</item>
                            </dt_array>
                        </item>
                        <item key="services">
                            <dt_array>
                                <item key="0">premium</item>
                                <item key="1">premium_make_offer</item>
                                <item key="2">premium_brokered_transfer</item>
                                <item key="3">lookup</item>
                            </dt_array>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
                <item key="request_response_time">1.791</item>
                <item key="response_text">Command completed successfully</item>
                <item key="is_search_completed">1</item>
                <item key="action">REPLY</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="lookup">
                            <dt_assoc>
                                <item key="count">3</item>
                                <item key="response_text">Command completed successfully.</item>
                                <item key="response_code">200</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">testdomain.net</item>
                                                <item key="status">taken</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">testdomain.org</item>
                                                <item key="status">taken</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">testdomain.de</item>
                                                <item key="status">taken</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_array>
                                </item>
                                <item key="is_success">1</item>
                            </dt_assoc>
                        </item>
                        <item key="premium_brokered_transfer">
                            <dt_assoc>
                                <item key="count">3</item>
                                <item key="response_text">Command Successful</item>
                                <item key="response_code">200</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">testsname.com</item>
                                                <item key="status">available</item>
                                                <item key="price">343.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">analysisdomains.com</item>
                                                <item key="status">available</item>
                                                <item key="price">341.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">testdomain123.com</item>
                                                <item key="status">available</item>
                                                <item key="price">5612.00</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                        <item key="premium">
                            <dt_assoc>
                                <item key="count">17</item>
                                <item key="response_text">Command Successful</item>
                                <item key="response_code">200</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">testdomain.com</item>
                                                <item key="status">available</item>
                                                <item key="price">5899.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="1">
                                            <dt_assoc>
                                                <item key="domain">testdomainsearch.com</item>
                                                <item key="status">available</item>
                                                <item key="price">3045.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="2">
                                            <dt_assoc>
                                                <item key="domain">testdomainname.com</item>
                                                <item key="status">available</item>
                                                <item key="price">3395.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="3">
                                            <dt_assoc>
                                                <item key="domain">testdomain01.com</item>
                                                <item key="status">available</item>
                                                <item key="price">4619.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="4">
                                            <dt_assoc>
                                                <item key="domain">testdomain1.com</item>
                                                <item key="status">available</item>
                                                <item key="price">2695.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="5">
                                            <dt_assoc>
                                                <item key="domain">testdomain020911c.com</item>
                                                <item key="status">available</item>
                                                <item key="price">299.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="6">
                                            <dt_assoc>
                                                <item key="domain">testdomain3.com</item>
                                                <item key="status">available</item>
                                                <item key="price">2195.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="7">
                                            <dt_assoc>
                                                <item key="domain">testmaxdomain.com</item>
                                                <item key="status">available</item>
                                                <item key="price">1495.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="8">
                                            <dt_assoc>
                                                <item key="domain">testdomainsl.com</item>
                                                <item key="status">available</item>
                                                <item key="price">1077.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="9">
                                            <dt_assoc>
                                                <item key="domain">shoemoneytestdomain.com</item>
                                                <item key="status">available</item>
                                                <item key="price">799.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="10">
                                            <dt_assoc>
                                                <item key="domain">demodomains.com</item>
                                                <item key="status">available</item>
                                                <item key="price">5743.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="11">
                                            <dt_assoc>
                                                <item key="domain">analysisdomain.com</item>
                                                <item key="status">available</item>
                                                <item key="price">2639.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="12">
                                            <dt_assoc>
                                                <item key="domain">testdomain1.com</item>
                                                <item key="status">available</item>
                                                <item key="price">3099.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="13">
                                            <dt_assoc>
                                                <item key="domain">testnewdomain.com</item>
                                                <item key="status">available</item>
                                                <item key="price">2179.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="14">
                                            <dt_assoc>
                                                <item key="domain">thetestdomain.com</item>
                                                <item key="status">available</item>
                                                <item key="price">4736.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="15">
                                            <dt_assoc>
                                                <item key="domain">domainfortest.com</item>
                                                <item key="status">available</item>
                                                <item key="price">2524.00</item>
                                            </dt_assoc>
                                        </item>
                                        <item key="16">
                                            <dt_assoc>
                                                <item key="domain">testyourdomain.com</item>
                                                <item key="status">available</item>
                                                <item key="price">1949.00</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_array>
                                </item>
                                <item key="is_success">1</item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example for name_suggest (domain) for Registry Premium Domains

Please note: The response generated when querying a registry premium domain with name_suggest (domain) is dependent upon which registry premium domains the reseller has enabled. An available registry premium domain will appear unavailable or "taken" if the reseller has not enabled the tier of registry premium domains into which the domain falls.

Request

<?xml version=\'1.0\' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="object">DOMAIN</item>
                <item key="action">NAME_SUGGEST</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="services">
                            <dt_array>
                                <item key="0">lookup</item>
                            </dt_array>
                        </item>
                        <item key="tlds">
                            <dt_array>
                                <item key="0">.bike</item>
                            </dt_array>
                        </item>
                        <item key="searchstring">ddd.bike</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

Example 1
This example shows the response generated if the reseller has enabled the tier of registry premium domains into which the domain falls.

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<OPS_envelope>
   <header>
       <version>0.9</version>
   </header>
   <body>
       <data_block>
           <dt_assoc>
               <item key="protocol">XCP</item>
               <item key="response_code">200</item>
               <item key="is_success">1</item>
               <item key="request_response_time">0.074</item>
               <item key="response_text">Command completed successfully</item>
               <item key="is_search_completed">1</item>
               <item key="action">REPLY</item>
               <item key="attributes">
                   <dt_assoc>
                       <item key="lookup">
                           <dt_assoc>
                               <item key="count">1</item>
                               <item key="response_text">Command completed successfully.</item>
                               <item key="response_code">200</item>
                               <item key="is_success">1</item>
                               <item key="items">
                                   <dt_array>
                                       <item key="0">
                                           <dt_assoc>
                                               <item key="domain">sydney.space</item>
                                               <item key="status">available</item>
                                               <item key="reason">Premium Name</item>
                                           </dt_assoc>
                                       </item>
                                   </dt_array>
                               </item>
                           </dt_assoc>
                       </item>
                   </dt_assoc>
               </item>
           </dt_assoc>
       </data_block>
   </body>
</OPS_envelope>

Example 2
This example shows the response generated if the reseller has not enabled the tier of registry premium domains into which the domain falls.

<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
                <item key="request_response_time">0.063</item>
                <item key="response_text">Command completed successfully</item>
                <item key="is_search_completed">1</item>
                <item key="action">REPLY</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="lookup">
                            <dt_assoc>
                                <item key="count">1</item>
                                <item key="response_text">Command completed successfully.</item>
                                <item key="response_code">200</item>
                                <item key="is_success">1</item>
                                <item key="items">
                                    <dt_array>
                                        <item key="0">
                                            <dt_assoc>
                                                <item key="domain">sydney.space</item>
                                                <item key="status">taken</item>
                                                <item key="reason">Premium Name</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_array>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

name_suggest (domain)


Checks whether a specified name, word, or phrase is available for registration
in gTLDs and ccTLDs, suggests other similar domain names for .COM,
.NET, .ORG, .INFO, .BIZ, .US, and .MOBI domains, and checks whether they
are available. Reseller must be enabled for the specified TLDs. Can also be
used to search for domains owned by external domain suppliers.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.