Get domain details by domain name
Gets details of the Domain Registration Order associated with the specified domain name.
path Parameters
domainNameDomain name associated with the Domain Registration Order whose details need to be fetched.
query Parameters
optionsSections of the domain order to include in the response. Combine values in a comma-separated list.
Allowed values
| Value | Description |
|---|---|
| All | All available order sections |
| OrderDetails | Core order fields such as dates, locks, product, and cost |
| StatusDetails | Order and domain status flags |
| ContactIds | Contact identifiers only |
| RegistrantContactDetails | Full registrant contact |
| AdminContactDetails | Full administrative contact |
| TechContactDetails | Full technical contact |
| BillingContactDetails | Full billing contact |
| NsDetails | Nameserver hostnames |
| DomainStatus | Domain status flags |
| DNSSECDetails | DNSSEC DS records |
Get domain details by domain name › Responses
OK
Nested domain registration order details.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
Get domain details by order ID
Returns the full details of a domain order, looked up by its order ID.
path Parameters
orderIdOrder Id of the Domain Registration Order whose details need to be fetched.
query Parameters
optionsSections of the domain order to include in the response.
Allowed values
| Value | Description |
|---|---|
| All | All available order sections |
| OrderDetails | Core order fields such as dates, locks, product, and cost |
| StatusDetails | Order and domain status flags |
| ContactIds | Contact identifiers only |
| RegistrantContactDetails | Full registrant contact |
| AdminContactDetails | Full administrative contact |
| TechContactDetails | Full technical contact |
| BillingContactDetails | Full billing contact |
| NsDetails | Nameserver hostnames |
| DomainStatus | Domain status flags |
| DNSSECDetails | DNSSEC DS records |
Get domain details by order ID › Responses
OK
Nested domain registration order details.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
Get order ID for a domain name
Returns the order ID for a domain you already own, for use in other endpoints that require it instead of the domain name.
path Parameters
domainNameGet order ID for a domain name › Responses
OK
orderIdOrder Id.
Search and list domains
Gets a list of Domain Registration Orders matching the search criteria, along with the details.
query Parameters
sizeNumber of Orders to be fetched.
pagePage number for which details are to be fetched
orderIdOrder Id(s) of the Domain Registration Order(s) whose details need to be fetched
resellerIdReseller Id(s) whose Orders need to be fetched
customerIdCustomer Id(s) whose Orders need to be fetched
showChildOrdersWhether Sub-Reseller Orders need to be fetched or not
productKeyProduct keys of the TLDs
statusFilter orders by status. Repeat the status query parameter to require every
listed value at once (AND). An order is returned only if it matches all specified
statuses.
Allowed values
| Value | Description |
|---|---|
| InActive | Inactive domain registration orders. |
| Active | Active domain registration orders. |
| Suspended | Suspended domain registration orders. |
| Pending Delete Restorable | Domain is in the pending-delete restorable (redemption) period. |
| Deleted | Orders deleted within the past 30 days. |
| Archived | Orders deleted more than 30 days ago. |
| Pending Verification | Registrant contact email verification is pending. |
| Failed Verification | Orders deactivated because the registrant contact email was not verified within the Whois Data Verification period. |
| NIXI Pending EKYC Verification | NIXI-managed domains with eKYC verification pending. |
| NIXI Pending Email Verification | NIXI-managed domains with email verification pending. |
| NIXI Failed Verification | NIXI-managed domains suspended because eKYC verification, email verification, or both are incomplete. |
privacyEnabledPrivacy Protection status filter. true — Privacy Protection enabled. false — disabled. na — not applicable (not allowed); search results include Inactive Orders as well.
domainNameName of the Domain.
creationDateStartUNIX timestamp. Returns domain registration orders whose creation date is after this value.
creationDateEndUNIX timestamp. Returns domain registration orders whose creation date is before this value.
expiryDateStartUNIX timestamp. Returns domain registration orders whose expiry date is after this value.
expiryDateEndUNIX timestamp. Returns domain registration orders whose expiry date is before this value.
sortField used to sort matching orders. Repeat the parameter to sort by more than one field.
Append asc or desc after the field name. Default is asc.
Allowed fields: orderid, customerid, endtime, timestamp, entitytypeid,
creationtime, creationdt.
Examples: sort=orderid, sort=timestamp desc.
Search and list domains › Responses
OK
Collection of domain entries returned for this operation.
totalItemsTotal number of matching records in the database.
itemsOnPageNumber of records returned on this page.