Introduction
Welcome to the BETA Globalr API documentation. This API allows developers to interact with the Globalr system programmatically, providing a set of endpoints and functionalities to manage domains, user accounts, and more.
Base URL
Production:
https://globalr.com/api/v2
User
This area you can explore endpoints related to user accounts, including authentication, profile management, and billing details.
Domain
What made this section unhelpful for you?
Domain information
There is posible 4 type of response
- domain is invalid
- domain is free for registration
- domain has unsupported extension
- domain Name already registered, but not by you
- domain Name already registered, and owned by you
Header Parameters
Path Parameters
Response
Response Attributes
Show child attributes
Show child attributes
Response Attributes
Show child attributes
What made this section unhelpful for you?
Response
{
"domain": "checkfreedomain.am",
"massage": "This domain is busy and unavailable for registration",
"info": {
"name": "example.am",
"created_at": "2016-08-10 10:38:58",
"expiration_date": "2017-08-11 00:00:00",
"status_id": "2",
"registered_at": "2016-08-11 00:00:00",
"exp_days": 204,
"contacts": {
"admin": {
"entity": "person",
"name": "Jone",
"last_name": "Smith",
"organisation": "",
"email": "jhone@example.com",
"phone": "+5555555555",
"mobile_phone": "",
"fax": "",
"country_code": "AM",
"city": "Yerevan",
"state": "",
"address1": "Example street 8/33",
"address2": "",
"zip": "0010"
},
"owner": {
"entity": "person",
"name": "Jone",
"last_name": "Smith",
"organisation": "",
"email": "jhone@example.com",
"phone": "+5555555555",
"mobile_phone": "",
"fax": "",
"country_code": "AM",
"city": "Yerevan",
"state": "",
"address1": "Example street 8/33",
"address2": "",
"zip": "0010"
},
"billing": {
"entity": "person",
"name": "Jone",
"last_name": "Smith",
"organisation": "",
"email": "jhone@example.com",
"phone": "+5555555555",
"mobile_phone": "",
"fax": "",
"country_code": "AM",
"city": "Yerevan",
"state": "",
"address1": "Example street 8/33",
"address2": "",
"zip": "0010"
},
"technical": {
"entity": "person",
"name": "Jone",
"last_name": "Smith",
"organisation": "",
"email": "jhone@example.com",
"phone": "+5555555555",
"mobile_phone": "",
"fax": "",
"country_code": "AM",
"city": "Yerevan",
"state": "",
"address1": "Example street 8/33",
"address2": "",
"zip": "0010"
}
},
"ns": [
{
"name": "ns1.globalr.com",
"ip": ""
},
{
"name": "ns2.globalr.com",
"ip": ""
}
]
},
"available": false,
"whois": "%\n%AM TLD whois server #1\n%\n\n Domain name: example.am\n ..... Full whois info ......",
"prices": [
{
"price": 19.9,
"year": 1
},
{
"price": 39.8,
"year": 2
},
{
"price": 59.7,
"year": 3
},
{
"price": 79.6,
"year": 4
},
{
"price": 99.5,
"year": 5
}
]
}What made this section unhelpful for you?
Register Domain
For domain registration you must send 3 type contacts, minimum 2 unique valid name server, domain name, and optional registration period in year (by default year is equivalent to 1);
Additional Fields
Please, check domains additional fields Additional Fields.
If you want send test request you mast send param mode=test
Available status codes
- Status: 200 - success
- Status: 201 - completed
- Status: 402 - Payment Required
- Status: 422 - invalid data (in this case field will be provided in errors array)
- Status: 500 - Internal Error
Header Parameters
Body Parameters
Domain name
Registration period time(year). By default 1 year.
Show child attributes
Show child attributes
boolean(optional, only for am)
Response
Response Attributes
Response Attributes
Show child attributes
What made this section unhelpful for you?
Response
{
"status": 201,
"textStatus": "completed",
"message": "Domain/s registered Successfully",
"errors": []
}What made this section unhelpful for you?
Renew Domain
If you want send test request you mast send param mode=test
Header Parameters
Body Parameters
Domain collection, where key is domain , value is a renew time(year)
Show child attributes
Response
Response Attributes
Response Attributes
Show child attributes
What made this section unhelpful for you?
Response
{
"status": 200,
"textStatus": "success",
"message": "Your renewal is now completed.",
"errors": []
}What made this section unhelpful for you?
Auto Renew Domain
This API call enabled/disabled domain auto-renew.
Header Parameters
Body Parameters
Domain name
1 enable auto-renew, 0 - disable auto-renew
Response
Response Attributes
Response Attributes
Show child attributes
What made this section unhelpful for you?
Response
{
"status": 200,
"textStatus": "success",
"message": "Your example.am domain will be renewed 7 days before the expiration date! Please, fill your balance in time.",
"errors": []
}What made this section unhelpful for you?
Modify Domain records
There are four block of contact information - Owner, Administrative, Technical and Billing. Each block could be updated seperately. While update of any information in some block, whole information of the block must be sent.
For .AM domain in the block of owner you can’t change Name and Last Name or Company Name (in case of organization) information. This part requires printed documents.
If you want send test request you mast send param mode=test
Transfer Domain
Transfer procedure divorced to two type.
- transfer must be done in GlobalR system
- transfer from other registrar
In any case more preferable make two request first check domain can be transferred or not (and which way it can be transferеd), second send transfer code.
If domain that must be transferеd registered thru globalr.com, in checking part our system will generate inner transfer code and will send to admin email.
Other ways you must send transfer code, that you get from losing registrar or registry.
Prices
This API call get extension prices list.
Header Parameters
Query Parameters
Limit of extension list
Search name
Response
Response Attributes
Show child attributes
Response Attributes
What made this section unhelpful for you?
Response
{
"limit": 20,
"offset": 0,
"count": null,
"data": [
{
"id": 2,
"name": ".ge",
"price": 15.8,
"renew_price": 15.8,
"transfer_price": 15.8,
"amount_with_trustee": null,
"min_registration_year": 1
}
]
}