# Availability API

Find out whether a domain name is free to register, asked of the registry itself, not a registrar's shop.

`GET /v1/availability`

- Price: Costs 1 credit per call; cached answers cost the same. Calls that fail upstream (502) are free.
- Cache: Answers are cached per account for up to 10 minutes; send fresh=true to ask the source again.
- MCP tool: `check_availability`

Whether a domain name is available, taken, restricted or unknown, how certain that is, and the steps that decided it (DNS at the TLD's own servers, then the registry). Costs 1 credit per call; cached answers cost the same. Calls that fail upstream (502) are free. Answers are cached per account for up to 10 minutes; send fresh=true to ask the source again. A retry with the same `X-Request-Id` returns the stored result of the first call for 24 hours without charging again, marked with the `X-Replayed: true` header.

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `domain` | string | yes | The domain name to check, such as brightidea.io. |
| `fresh` | boolean | no | Skip the cache and ask the source again; costs the same. |

## Response

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `tool` | string | yes |  |
| `target` | string | yes |  |
| `status` | "ok" | "partial" | "error" | yes |  |
| `fetched_at` | string | no |  |
| `cached` | boolean | no |  |
| `credits_used` | integer | no | Credits this call took from your balance. 0 for free tools, for a replay of an earlier call, and for a free check run on the website without signing in |
| `summary` | string | yes |  |
| `score` | integer or null | no |  |
| `findings` | array of object | no |  |
| `credits_remaining` | integer | yes | Your balance after this call. It can be below zero after a refund; free tools still work then |
| `data` | object | yes | This tool's result |
| `data.name` | string | yes |  |
| `data.unicode` | string | yes |  |
| `data.tld` | string | yes |  |
| `data.tier` | "A" | "B" | "C" | "D" | yes |  |
| `data.reduced_from` | string or null | no |  |
| `data.verdict` | "available" | "taken" | "unknown" | "restricted" or null | no |  |
| `data.certainty` | "confirmed" | "likely" or null | no |  |
| `data.reason` | "delegated" | "registry_not_found" | "registered_without_dns" | "reserved" | "brand_tld" | "dns_only" | "dns_inconclusive" or null | no |  |
| `data.may_become_available` | boolean | no |  |
| `data.statuses` | array of string | no |  |
| `data.source` | "dns" | "rdap" | "whois" | "dns-only" or null | no |  |
| `data.steps` | array of object | no |  |
| `data.steps.method` | string | yes |  |
| `data.steps.server` | string | yes |  |
| `data.steps.result` | string | yes |  |
| `data.steps.elapsed_ms` | integer | yes |  |
| `data.price_note` | boolean | no |  |
| `data.retry_after_s` | number or null | no |  |

## Errors

- `400` Invalid domain, URL or parameter, a TLD this tool can't check, or an X-Request-Id already used for another call (`invalid_domain`, `invalid_url`, `invalid_request`, `unsupported_tld`)
- `401` Missing, unknown or revoked API key, or one whose creator is no longer a member of the account (`unauthorized`)
- `402` Balance below the call's price (`insufficient_credits`)
- `403` Account suspended, the key's creator is over the plan's seats, or an anonymous check without a valid proof-of-work or for a tool that needs an account, or bulk checks before a first purchase (`account_suspended`, `plan_limit`, `challenge_required`, `sign_in_required`, `bulk_locked`)
- `429` Too many requests, today's free checks are used up, or too many website scans at once; wait for the number of seconds in the Retry-After header (`rate_limited`, `free_limit_reached`, `too_many_jobs`). Not charged
- `500` Unexpected error (`internal_error`)
- `502` Every upstream source failed; not charged (`source_unavailable`). A Retry-After header says how long to wait when the source asked us to

## Example

```sh
curl "https://api.dnssuper.com/v1/availability?domain=example.com" \
  -H "Authorization: Bearer $DNSSUPER_API_KEY"
```

```python
import os

import httpx

client = httpx.Client(
    base_url="https://api.dnssuper.com",
    headers={"Authorization": f"Bearer {os.environ['DNSSUPER_API_KEY']}"},
    timeout=60,
)
response = client.get("/v1/availability", params={
    "domain": "example.com",
})
response.raise_for_status()
result = response.json()
print(result["summary"], result["credits_used"])
```

```ts
const response = await fetch(`https://api.dnssuper.com/v1/availability?${new URLSearchParams({"domain":"example.com"})}`, {
  headers: { Authorization: `Bearer ${process.env.DNSSUPER_API_KEY}` },
});
if (!response.ok) throw new Error((await response.json()).error.message);
const result = await response.json();
console.log(result.summary, result.credits_used);
```

Example response:

```json
{
  "tool": "domain-availability",
  "target": "brightidea.io",
  "status": "ok",
  "fetched_at": "2026-11-14T10:00:00Z",
  "cached": false,
  "credits_used": 1,
  "summary": "brightidea.io is available. The .io registry has no record of it; check the price at your registrar before you buy.",
  "findings": [
    {
      "id": "availability.confirm_price",
      "severity": "info",
      "title": "Check the price before you buy",
      "detail": "",
      "fix": "Registrars set their own prices, and some names cost more than usual; check the price at your registrar before you buy."
    }
  ],
  "data": {
    "name": "brightidea.io",
    "unicode": "brightidea.io",
    "tld": "io",
    "tier": "A",
    "verdict": "available",
    "certainty": "confirmed",
    "reason": "registry_not_found",
    "may_become_available": false,
    "statuses": [],
    "source": "rdap",
    "steps": [
      {
        "method": "dns-parent",
        "server": "192.0.2.200",
        "result": "nxdomain",
        "elapsed_ms": 12
      },
      {
        "method": "rdap",
        "server": "rdap.identitydigital.services",
        "result": "not_found",
        "elapsed_ms": 12
      }
    ],
    "price_note": true
  },
  "credits_remaining": 498
}
```

## MCP

```json
{
  "tool": "check_availability",
  "arguments": {
    "domain": "example.com"
  }
}
```

```text
brightidea.io is available. The .io registry has no record of it; check the price at your registrar before you buy.
brightidea.io: Available (confirmed; the registry has no record)
Checked: dns-parent -> rdap
- info: Check the price before you buy
Credits: 1 credit used, 498 remaining | fresh | checked 2026-11-14 10:00 UTC
```
