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

trade_domain

Transfers ownership of a domain name from one registrant to another. This command may be used for the following domains: .CL, .COM.AR, .DK, FI, .FR, .HK, .HU, .MY, .NO, .NU, .PM, .RE, .RO, .RU, .SE, .SG, .TF, .WF, and .YT.

Request parameters for trade_domain

Standard parameters

  • action = trade_domain
  • object = domain

Attributes

Parameters within the attributes associative array are described below.

Parameter name 
Obligation
Definition/Value

address1

Required for all except .BE.

The street address of the new owner.

city

Required for all except .BE.

The new owner’s city.

country

Required for all except .BE.

The new owner’s country.

domain

Required

The domain that is being traded.

domain_auth_info

Required for .BE

The domain's Authcode. To request an Authcode you can use the send_authcode command; the Authcode is sent to the domain's admin contact.

email

Required

The new owner’s email address.

first_name

Required

The first name of the new owner.

last_name

Required

The last name of the new owner

org_name

Required

The name of the new owner’s organization.

phone

Required for all except .BE.

The new owner’s phone number.

postal_code

Required for all except .BE.

The new owner’s postal code.

state

Required for all except .BE.

The new owner’s state.

tld_data

Required for all except .BE.

An associative array containing the except .BE. registrant_extra_info associative array
which submits additional parameters that are required by various domain registries.

For more information, see the TLD Data section.

Response parameters for trade_domain

Standard parameters

  • action = reply
  • object = domain
  • 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

Examples for trade_domain

Example 1

Transfers ownership of a .BE domain.

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">TRADE_DOMAIN</item>
                <item key="object">DOMAIN</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="first_name">Simon</item>
                        <item key="last_name">Dubois</item>
                        <item key="domain">js4.be</item>
                        <item key="email">dubois@example.be</item>
                        <item key="org_name">Example Co.</item>
                        <item keyi="domain_auth_info">ewgnRwnH</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="object">DOMAIN</item>
                <item key="response_text">Command completed successfully
                    OK</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
                <item key="registry_response_code">1000</item>
                <item key="response_text">Trade for js4.be has been successfully issued.</item>
                <item key="response_code">200</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 2

Transfers ownership of a .DK domain

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">TRADE_DOMAIN</item>
                <item key="object">DOMAIN</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="org_name">Example Co.</item>
                        <item key="domain">example.dk</item>
                        <item key="first_name">Daniel</item>
                        <item key="last_name">Jensen</item>
                        <item key="address1">Gammel Kongevej 1</item>
                        <item key="city">Copenhagen V</item>
                        <item key="state" />
                        <item key="country">DK</item>
                        <item key="postal_code">1610</item>
                        <item key="phone">+1.33257400</item>
                        <item key="email">djensen@example.dk</item>
                        <item key="tld_data">
                            <dt_assoc>
                                <item key="registrant_extra_info">
                                    <dt_assoc>
                                        <item key="registrant_type">individual</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'?>
<!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="object">DOMAIN</item>
                <item key="response_text">Trade for example.dk has been successfully issued.</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 3

Transfers ownership of a .FR domain.

Request

<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">TRADE_DOMAIN</item>
                <item key="object">DOMAIN</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">example.fr</item>
                        <item key="first_name">Henri</item>
                        <item key="last_name">LeFluer</item>
                        <item key="address1">13 Rue Daze</item>
                        <item key="city">Paris</item>
                        <item key="state" />
                        <item key="country">FR</item>
                        <item key="postal_code">75002</item>
                        <item key="org_name">French Impressions</item>
                        <item key="phone">+1.3365551212</item>
                        <item key="email">lefluer@example.com</item>
                        <item key="tld_data">
                            <dt_assoc>
                                <item key="registrant_extra_info">
                                    <dt_assoc>
                                        <item key="date_of_birth">1979-03-03</item>
                                        <item key="place_of_birth">Paris</item>
                                        <item key="country_of_birth">FR</item>
                                        <item key="postal_code_of_birth">75008</item>
                                        <item key="registrant_type">individual</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'?>
<!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="object">DOMAIN</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
                <item key="response_text">Trade for example.fr has been successfully issued.</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 4

Transfers ownership of a .COM.AR domain

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">TRADE_DOMAIN</item>
                <item key="object">DOMAIN</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="first_name">Daniela</item>
                        <item key="last_name">Sosa</item>
                        <item key="address1">Piedras No 623</item>
                        <item key="city">San Sebastian</item>
                        <item key="state" />
                        <item key="postal_code">B1000TBU</item>
                        <item key="country">AR</item>
                        <item key="org_name">Sosa Informatica S.A.</item>
                        <item key="domain">example.com.ar</item>
                        <item key="phone">+1.4165350123</item>
                        <item key="email">sosa@example.com</item>
                        <item key="tld_data">
                            <dt_assoc>
                                <item key="registrant_extra_info">
                                    <dt_assoc>
                                        <item key="tax_number">27-10563145-8</item>
                                        <item key="id_card_number">10563145</item>
                                        <item key="registrant_type">individual</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'?>
<!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="object">DOMAIN</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
                <item key="response_text">Trade for example.com.ar has been successfully issued.</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

trade_domain

Transfers ownership of a domain name from one registrant to another. This command may be used for the following domains: .CL, .COM.AR, .DK, FI, .FR, .HK, .HU, .MY, .NO, .NU, .PM, .RE, .RO, .RU, .SE, .SG, .TF, .WF, and .YT.