# DomainKit

> DomainKit is a domain availability API and toolkit for developers and AI agents. Check domain availability, get registration links, and discover supported TLDs programmatically.

DomainKit is designed for agent integration. All endpoints return JSON. No authentication required. Rate limited to 60 requests/minute per IP.

## Quick Start

Base URL: https://api.domainkit.bot

Check domain availability:
```
GET https://api.domainkit.bot/check?name=example
```

Response:
```json
{
  "name": "example",
  "results": [
    {
      "domain": "example.com",
      "tld": "com",
      "available": false,
      "status": ["active"],
      "premium": false,
      "source": "rdap",
      "checkedAt": "2024-01-30T12:00:00Z",
      "responseMs": 180
    }
  ],
  "totalMs": 250,
  "timestamp": "2024-01-30T12:00:00Z"
}
```

## API Documentation

- [API Overview](/docs/api/index.md): Complete API reference
- [Check Availability](/docs/api/availability.md): GET /check - Check domain availability
- [List TLDs](/docs/api/tlds.md): GET /tlds - List supported TLDs (with type filter)
- [Register](/docs/api/register.md): GET /register - Get registration links
- [Health Check](/docs/api/health.md): GET /health - API status and version
- [Rate Limits](/docs/rate-limits.md): Usage limits and quotas
- [Error Codes](/docs/api/errors.md): Error response reference

## MCP Server

DomainKit provides an MCP server for AI agent integration:

```
npm install -g @domainkit/mcp
```

Tools: check_domain, bulk_check, list_tlds, get_registration_link

- [MCP Setup](/mcp/): Install and configure the DomainKit MCP server

## Endpoints

| Endpoint | Method | Description |
|----------|--------|-------------|
| /check | GET | Check domain availability (params: name, tld) |
| /tlds | GET | List supported TLDs (params: type) |
| /register | GET | Get registration links (params: domain, registrar) |
| /health | GET | API health check |

## Supported TLDs

gTLDs: app, biz, bot, cloud, com, dev, info, net, online, org, site, store, tech, xyz
ccTLDs: ai, cc, io, me, tv

## Supported Registrars

- Porkbun (slug: porkbun) - includes estimated pricing
- Namecheap (slug: namecheap)
- GoDaddy (slug: godaddy)

## Quick Reference

- Base URL: https://api.domainkit.bot
- Auth: None required
- Format: JSON
- Rate Limit: 60/min per IP

## Response Fields

/check returns:
- name: domain name checked
- results[]: array of check results
- results[].domain, tld, available, status[], premium, source, checkedAt, responseMs
- totalMs: total check time
- timestamp: response timestamp

/tlds returns:
- count: number of TLDs
- tlds[]: array of {tld, type, rdapServer, enabled}

/register returns:
- domain: requested domain
- registrars[]: array of {name, slug, url, estimatedPrice?}
- timestamp: response timestamp

## OpenAPI Specification

Full OpenAPI 3.0 spec available at: https://domainkit.bot/openapi.yaml