Skip to main content

Search domains

This endpoint allows you to search domains in your wallet

Endpoint

GET /registrar/v1/domains

Parameters

NameLocationRequiredTypeDefault valueDescription
domain_searchedURLNoStringA part or a complete domain name
statusURLNoStringDomain status. Possible values:
  • ORDERED
  • PENDING_CREATION
  • CREATED
  • INVOICED
  • PAID
  • PENDING_DELETION
  • PENDING_MODIFY
include_scopeURLNoInteger1Include your subsidiaries. Possible values:
  • 1
  • 0
with_bastionURLNoIntegerInclude or exclude domain names using the DNS Bastion. Possible values:
  • 1
  • 0

Response

Domain search

Example Request

GET https://api.nameshield.net/registrar/v1/domains?domain_searched=exemple.com&inclue_scope=1&status=ORDERED&with_bastion=0
Content-Type: application/json

Example Response

Renew domain

{
"message": "Ok",
"data": [
{
"id": 0,
"domain": "example.com",
"unicode": "example.com",
"customerId": 0,
"status": "BLOCKED",
"bastion": true
}
]
}