## GET /api/v2/whois

**Look up domain WHOIS**

Return parsed WHOIS research data for a domain. The endpoint requires an authenticated caller with `read:domains`. Pass `sourceText=true` only when diagnostics require the full upstream WHOIS socket response; normal callers should use the parsed fields instead of scraping that text.

### Related Endpoints

- `GET /api/v2/domains`: List domains
- `GET /api/v2/dns-zones`: List DNS zones
- `GET /api/v2/domains/{id}`: Get domain details

### Headers

- `Accept`: application/json
- `Authorization`: Bearer YOUR_API_KEY
- Required API scope: `read:domains`

### Parameters

- `domain` (query, string, required): Domain name to look up. The server normalizes and punycodes the value before querying WHOIS. Example: `example.com`
- `sourceText` (query, boolean): When true, include `sourceText` with the full upstream WHOIS response. Example: `true`

### Request Example

```bash
curl -X GET "https://cloud.hostup.se/api/v2/whois?domain=example.com" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
```

### Response Schema

- `domain` (string, required) Example: `example.com`
- `available` (boolean, required) Example: `false`
- `reason` (string,null, required) Example: `Domain is currently registered.`
- `registrar` (string,null, required) Example: `Hostup AB`
- `registrarUrl` (string,null, required) Example: `null`
- `registrant` (object | null, required) Example: `null`
- `registrant.organization` (string,null, required) Example: `null`
- `registrant.countryCode` (string,null, required) Example: `SE`
- `nameservers` (array<string>, required) Example: `["primary.ns.hostup.se","secondary.ns.hostup.se"]`
- `dates` (object, required)
- `dates.registeredAt` (string,null, required) Example: `2017-07-16T00:00:00.000Z`
- `dates.expiresAt` (string,null, required) Example: `2034-07-16T00:00:00.000Z`
- `dates.updatedAt` (string,null, required) Example: `2026-05-13T00:00:00.000Z`
- `statuses` (array<string>, required) Example: `["active","ok"]`
- `dnssec` (boolean,null, required) Example: `true`
- `sourceText` (string, optional): Full upstream WHOIS response. Present only when `sourceText=true`. Example: `Domain Name: EXAMPLE.COM
Registry Domain ID: 2336799_DOMAIN_COM-VRSN
Registrar: Example Registrar, LLC`

### Responses

#### 200 - WHOIS lookup result.
```json
{
  "domain": "example.com",
  "available": false,
  "reason": "Domain is currently registered.",
  "registrar": "Example Registrar, LLC",
  "registrarUrl": null,
  "registrant": null,
  "nameservers": [
    "primary.ns.hostup.se",
    "secondary.ns.hostup.se"
  ],
  "dates": {
    "registeredAt": "2017-07-16T00:00:00.000Z",
    "expiresAt": "2034-07-16T00:00:00.000Z",
    "updatedAt": "2026-05-13T00:00:00.000Z"
  },
  "statuses": [
    "active",
    "ok"
  ],
  "dnssec": true,
  "sourceText": "Domain Name: EXAMPLE.COM\nRegistry Domain ID: 2336799_DOMAIN_COM-VRSN\nRegistrar: Example Registrar, LLC"
}
```

#### 400 - Invalid request. The response body is an RFC 7807 Problem Details document.
```json
{
  "type": "https://developer.hostup.se/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "The request body failed validation.",
  "code": "invalid_request",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z",
  "errors": [
    {
      "pointer": "/items/0/domainName",
      "detail": "`domainName` is required.",
      "code": "invalid_request"
    }
  ]
}
```

#### 401 - Unauthorized. Authentication is required.
```json
{
  "type": "https://developer.hostup.se/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication is required.",
  "code": "unauthorized",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 403 - Forbidden. The caller lacks a required scope or does not own the resource.
```json
{
  "type": "https://developer.hostup.se/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The caller lacks a required scope or does not own the resource.",
  "code": "forbidden",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 404 - Not found. The resource does not exist or is not owned by the caller.
```json
{
  "type": "https://developer.hostup.se/errors/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource could not be found.",
  "code": "not_found",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 429 - Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.
```json
{
  "type": "https://developer.hostup.se/errors/rate_limit_exceeded",
  "title": "Too many requests",
  "status": 429,
  "detail": "Too many requests. Retry after the limit resets.",
  "code": "rate_limit_exceeded",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 500 - Internal error. Retry later or contact support if the issue persists.
```json
{
  "type": "https://developer.hostup.se/errors/internal_error",
  "title": "Internal server error",
  "status": 500,
  "detail": "An unexpected error occurred. Retry later or contact support if the issue persists.",
  "code": "internal_error",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```