List Domains

Retrieve a list of all domain names.

What This Does

This endpoint gives you a simple list of all the domain names you have access to through your Limited Access Key.

Think of it like getting a directory listing – you’re asking “what domains do I have permission to work with?”

What You Need

To use this endpoint, you need:

1. A valid Limited Access Key (LAK) with “read” permissions
2. The password for your LAK
3. At least one domain that your LAK has access to

Endpoint

https://api.nerve.io/v1/domains

Headers

All API requests require these authentication headers:

Query Parameters

Output

The response from this endpoint returns an array of domain objects with the following fields:

• Always included:
  • domain: The domain name as a string.
• Included only with full=1 query parameter:
  • registrar: The registrar managing the domain.
  • created: The creation date of the domain in ISO 8601 format.
  • expires: The expiration date of the domain in ISO 8601 format.
  • status: The current status of the domain (e.g., Active).
  • locked: A boolean indicating if the domain is registrar locked (may be null if unknown).
  • nameservers: An array of nameserver strings associated with the domain.

Use the full=1 query parameter to receive complete domain details in the response. Without it, only the domain field will be included.

How to Make a Request

To gather information about your domain(s), send a request to the endpoint using your Limited Access Key and password in the headers.

You can include the optional full=1 query parameter to receive full domain details.

Example requests can be made with tools like cURL, Postman, or your preferred programming language. Or you can use select a Limited Access Key from the pulldown and press the “Run” button to see the results on this page.

Limitations

When listing domains from Namecheap, the bulk list API does not include the registrar lock status. As a result, the locked field in responses will be null (unknown) for Namecheap domains.

To retrieve an accurate lock status for a specific Namecheap domain, use the Get Lock Info endpoint.

Response Codes

// Basic (default)
{
  "result": [
	"demo.org",
	"example.com",
	"test.com"
  ]
}

// With full=1
{
  "result": [
	{
	  "domain": "demo.org",
	  "registrar": "namecheap",
	  "created": "2023-06-10T08:15:00Z",
	  "expires": "2024-06-10T08:15:00Z",
	  "status": "active",
	  "locked": true,
	  "autorenew": false,
	  "privacy": true,
	  "nameservers": ["ns1.demo.org", "ns2.demo.org"]
	},
	{
	  "domain": "example.com",
	  "registrar": "godaddy",
	  "created": "2024-01-15T10:30:00Z",
	  "expires": "2025-01-15T10:30:00Z",
	  "status": "active",
	  "locked": false,
	  "autorenew": true,
	  "privacy": true,
	  "nameservers": ["ns1.example.com", "ns2.example.com"]
	},
	{
	  "domain": "test.com",
	  "registrar": "bluehost",
	  "created": "2022-11-20T14:45:00Z",
	  "expires": "2023-11-20T14:45:00Z",
	  "status": "expired",
	  "locked": false,
	  "autorenew": false,
	  "privacy": false,
	  "nameservers": ["ns1.test.com", "ns2.test.com"]
	}
  ]
}

{
  "error": "RATE_LIMIT",
  "message": "Too many requests. Please wait and try again.",
  "timestamp": "2024-01-15T10:30:00Z",
  "request_id": "req_abc123def456"
}

{
  "error": "INVALID_KEY",
  "message": "The provided access key is not valid or has expired.",
  "timestamp": "2024-01-15T10:30:00Z",
  "request_id": "req_abc123def456"
}

{
  "error": "REGISTRAR_ERROR",
  "message": "Unable to connect to registrar service.",
  "timestamp": "2024-01-15T10:30:00Z",
  "request_id": "req_abc123def456"
}

After signing in and selecting an Access Key, you can quickly fill in your key and password using the tool on the right (or below on mobile).