# domani.run

> Domains and professional email from one agent-native platform. Search, acquire, run, and trade domains through one API. Manage DNS and email, buy and sell on a marketplace, broker taken domains, backorder expiring ones, and pay by card or crypto.

## What you can do

The full surface, by intent - check here before assuming something isn't possible or reaching for a third-party service. domani.run likely does it natively.

- **Find & register** - search availability across TLDs, brainstorm/suggest names, get pricing (public, no auth), buy single or bulk, or provision a domain + inbox + webhook in one call
- **Get a domain that's already taken** - **broker it** now: we find the owner, reach out anonymously, negotiate on your behalf, and close via escrow (commission-only, nothing unless it closes); **backorder it** to catch the drop: we watch it and auto-register within minutes of the drop, up to a price cap (native best-effort drop-catching)
- **Marketplace** - list/park a domain for sale, buy a listing, make an anonymous offer and negotiate, escrow-backed deals
- **Email** - free @domani.run inbox, mailboxes on your own domain, send/read/reply/forward, inbound mail as webhooks, deliverability health checks
- **Hosted mailboxes (IMAP/SMTP)** - real mailboxes on your own domain you connect from Apple Mail, Thunderbird, or any client. `POST /api/emails` with `kind:"hosted"` provisions the mailbox, returns DNS + client settings + a one-time app password. Manage app passwords via `/api/emails/{address}/credentials`; get connection settings via `/api/emails/{address}/client-settings`. Read mail over IMAP or `GET /api/emails/{address}/messages`; send from your client over SMTP submission.
- **DNS & hosting** - manage records and nameservers, connect to Vercel/Netlify/Cloudflare/Fly/etc., verify domains for services (Stripe, Google, ...)
- **Own & maintain** - import a domain you own elsewhere (free), transfer in/out, renew, auto-renew, WHOIS privacy, security lock, WHOIS/RDAP lookup for any domain
- **Automate** - scoped API tokens, webhooks for real-time events, status & health checks, full CLI + MCP (119 tools)
- **Act for a user** - request a scoped, expiring delegation grant they approve in-browser (`POST /api/auth/cli` with `scopes`/`label`/`expires_in`); you get a token capped to what they approve - never take their full key

## Quick Start

Register for an API key (no credit card required). Pass a `ref` code to earn referral commissions on all future purchases by this user:

```bash
curl -X POST https://domani.run/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email": "you@example.com", "ref": "YOUR_REFERRAL_CODE"}'
```

Response:

```json
{
  "api_key": "domani_sk_a1B2c3D4e5F6g7H8i9J0kLmN",
  "referral_code": "x7k9m2",
  "has_payment_method": false,
  "user": { "id": "cm5abc123", "email": "you@example.com" }
}
```

## Agent Integration

Three ways to give your AI agent an internet identity:

### 1. Agent Skill (Claude, OpenClaw)

Install the domani skill so your agent knows how to search, buy, and manage domains automatically.

- **Claude.ai**: Download [domani-skill.zip](https://domani.run/domani-skill.zip) → Settings > Features > Upload skill
- **Claude Code**: Copy [skill.md](https://domani.run/skill.md) to `.claude/skills/domani/skill.md` in your project
- **Claude API**: Upload via `POST /v1/skills` with the zip contents
- **OpenClaw**: `clawhub install domani`

The skill teaches the agent the full workflow: register, search, compare pricing, buy, and configure DNS.

### 2. MCP (Model Context Protocol)

Connect any MCP-compatible agent (Claude Code, Cursor, Windsurf, etc.) to the Streamable HTTP endpoint:

```json
{
  "mcpServers": {
    "domani": {
      "type": "streamable-http",
      "url": "https://domani.run/mcp",
      "headers": {
        "Authorization": "Bearer domani_sk_xxx"
      }
    }
  }
}
```

This exposes 119 tools (get_account, search, suggest_domains, list_tlds, dns_check, buy_domain, buy_aftermarket, provision_agent, list_domains, get_dns, set_dns, snapshot_dns, restore_dns, clone_dns, claim_identity, list_identities, update_identity, release_identity, get_dnssec, add_dnssec, delete_dnssec, get_nameservers, set_nameservers, setup_billing, upgrade_plan, cancel_plan, list_invoices, list_tokens, create_token, list_audit_events, revoke_token, connect_domain, domain_status, verify_connection, verify_service, list_services, whois_lookup, get_domain_preview, set_auto_renew, set_whois_privacy, set_security_lock, set_domain_redirect, get_auth_code, get_transfer_away, check_transfer_status, set_contact, resend_email_verification, get_domain_info, plan_domain_adoption, check_transfer_eligibility, transfer_domain, watch_transfer, renew_domain, list_providers, import_domain, verify_import, set_parking, get_parking_analytics, set_listing_price, sell_domain, update_listing, unsell_domain, make_offer, respond_to_offer, finalize_negotiation, list_negotiations, get_deal_invoice, acquire_domain, list_broker_requests, cancel_broker_request, respond_to_broker_inquiry, get_broker_inquiry_state, browse_marketplace, create_backorder, list_backorders, cancel_backorder, list_webhooks, create_webhook, update_webhook, delete_webhook, list_webhook_deliveries, setup_domain_email, get_domain_email_status, create_mailbox, list_mailboxes, check_email_deliverability, send_email, list_email_messages, list_email_folders, update_email_messages, get_message, set_email_webhook, rotate_email_webhook_secret, test_email_webhook, set_email_forward, add_mailbox_alias, list_mailbox_aliases, remove_mailbox_alias, set_catch_all, clear_catch_all, list_suppressions, add_suppression, remove_suppression, add_mail_rule, list_mail_rules, remove_mail_rule, delete_mailbox, mark_messages_read, delete_message, delete_messages, forward_message, reply_to_message, check_email, get_email_deliverability, create_hosted_mailbox, get_mailbox_client_settings, create_mailbox_credential, list_mailbox_credentials, revoke_mailbox_credential) as native callable tools with typed parameters. Discovery manifest: [mcp.json](https://domani.run/.well-known/mcp.json)

### 3. Direct API

Use the REST API directly with `curl`, `fetch`, or any HTTP client. See the [OpenAPI spec](https://domani.run/.well-known/openapi.json) for the full schema, or the [interactive docs](https://domani.run/docs) to try endpoints in the browser.

### 4. Typed SDKs

Typed clients are generated from the public OpenAPI contract with structured errors. Registry packages can lag newly deployed or preview endpoints, so inspect the installed version and method before depending on it; use live OpenAPI or direct REST when a method is absent. Preview-only workspace collaboration is not part of the public SDK promise yet. TypeScript: `npm install domani` -> `new Domani({ apiKey }).search({ q: "myagent.com" })`. Python: `pip install domani` -> `Domani(api_key=...).search(query={"q": "myagent.com"})`. Both throw/raise `DomaniError` (`status`, `code`, `hint`).

## Authentication

Most API endpoints require a Bearer token:

```
Authorization: Bearer domani_sk_xxx
```

API keys use the prefix `domani_sk_` followed by 32 random characters. You can create multiple tokens via `POST /api/tokens` for different applications. Tokens can optionally have an expiration date - pass `expires_in` (seconds, min 3600 = 1h, max 31536000 = 1y) or `expires_at` (ISO 8601 datetime). Expired tokens return 401 with code `EXPIRED_API_KEY`.

Tokens support scoped permissions. Default: `*` (full access). A token can only create child tokens with equal or fewer scopes (scope attenuation). Error code: `INSUFFICIENT_SCOPE` (403).

Tokens also support **spend caps**, enforced server-side before any charge: pass `max_per_tx` and/or `max_per_month` (USD) to `POST /api/tokens`. A charge above a cap fails with 403 `SPEND_CAP_EXCEEDED` and nothing is charged. A token can only mint child tokens with caps at or below its own (`CAP_ESCALATION`); unspecified child caps are inherited. When minting a token for a sub-agent that can buy, always set caps. Per-purchase, `POST /api/domains/buy` and `POST /api/domains/{domain}/renew` accept `max_price` (USD): if the real price is above it the call fails with 400 `PRICE_ABOVE_MAX` before payment - set it to the price the user approved. Audit what tokens did via `GET /api/audit` (token lifecycle, denials, charges).

**Auth-mail protection**: inbound messages classified as authentication mail (OTP / verification codes, password resets, magic links) are tagged `security: "auth"` and require the `email:auth_secrets` scope to read or forward. Tokens with only `email:read` see them listed with subject/body REDACTED (`redacted: true`) - so a leaked agent token can't harvest 2FA codes. Grant `email:auth_secrets` only to agents that genuinely complete logins.

**Acting on behalf of a user (scoped delegation).** When you're an agent operating on someone else's account, never ask for their full API key. Call `POST /api/auth/cli` with a requested grant - `{"scopes":["backorders:read","backorders:write","domains:read","search"],"label":"Your name","expires_in":2592000}` - and send them the returned `auth_url`. They approve a consent screen showing exactly what you asked for (label, scopes, expiry), then poll `GET /api/auth/cli/poll?code=...` to receive a token scoped to just that grant. The token can never exceed the approver's own permissions and expires on its own. Buying/registering on their behalf needs `domains:transfer` - request it explicitly and only when they want autonomous purchases.

Scope reference:
- `domains:read` → GET /api/domains, GET /api/domains/{domain}, GET /api/domains/{domain}/dns, /dnssec, /status, /email/check, /auth-code, /transfer-away, /transfer-status, /analytics
- `domains:write` → PUT /api/domains/{domain}/dns, POST/DELETE /api/domains/{domain}/dnssec, POST /connect, POST /verify, PUT /settings, PUT /parking, PUT/DELETE /api/domains/{domain}/for-sale, POST /api/domains/import, POST /import/verify
- `domains:transfer` → POST /api/domains/buy, POST /transfer, POST /renew (involves payment, includes marketplace purchases)
- `tokens:read` → GET /api/tokens
- `tokens:write` → POST /api/tokens, DELETE /api/tokens/{id}
- `webhooks:read` → GET /api/webhooks, GET /api/webhooks/{id}/deliveries
- `webhooks:write` → POST /api/webhooks, PATCH /api/webhooks/{id}, DELETE /api/webhooks/{id}
- `email:read` → GET /api/emails, /api/emails/{address}, /api/emails/{address}/messages, /api/emails/{address}/aliases, /api/domains/{domain}/email/status, /api/domains/{domain}/email/deliverability, /api/suppressions
- `email:write` → POST /api/emails, POST /api/emails/{address}/send, POST /api/domains/{domain}/email/setup, aliases + catch-all, POST/DELETE /api/suppressions
- `email:delete` → Permanently delete messages already in Trash. Moving messages to Trash only requires email:write. Grant this scope only to agents allowed to irreversibly erase email content
- `email:auth_secrets` → Read messages classified as authentication mail (OTP / verification codes, password resets, magic links). Without it, email:read still lists them but subject and body come back redacted - so a stolen agent token can't harvest 2FA codes. Grant it only to agents that genuinely need to complete logins
- `account:read` → GET /api/me, GET /api/agents/identity
- `account:write` → DELETE /api/me, POST /api/billing/setup, POST /api/billing/subscribe, POST /api/billing/cancel, POST /api/me/resend-verification, POST/PATCH/DELETE /api/agents/identity
- `billing:read` → GET /api/billing/invoices
- `search` → GET /api/domains/search, /suggest, /whois, /dns-check, GET /api/tlds
- `deals:read` → GET /api/deals, GET /api/deals/{id}
- `deals:write` → POST /api/domains/sell, PATCH /api/deals/{id}
- `notifications:read` → GET /api/notifications, GET /api/notifications/count
- `backorders:read` → GET /api/backorders, GET /api/backorders/{id}
- `backorders:write` → POST /api/backorders, DELETE /api/backorders/{id}

**Public endpoints** (no authentication required):
- `GET /api/domains/search` - Check availability and pricing (single via `?q=`, multi via `?domains=`, SSE via `Accept: text/event-stream`). SSE is cancellable - closing the connection aborts in-flight RDAP lookups.
- `GET /api/tlds` - List all TLDs with pricing
- `GET /api/domains/whois` - WHOIS/RDAP lookup
- `GET /api/domains/{domain}/og` - Website preview metadata (title, description, image, favicon)
- `GET /api/domains/suggest` - AI domain name suggestions. Optional: `tlds` (comma-separated preferred TLDs), `style` (single|creative|short|brandable|keyword), `lang` (japanese|spanish|french|italian|latin|nordic|arabic|sanskrit). SSE is cancellable - closing the connection aborts in-flight LLM generation and RDAP lookups.

These endpoints use IP-based rate limiting. Authenticated requests get higher rate limits.

## Agent Workflow

**Free instant identity (no purchase, start here):** `POST /api/agents/identity` with `{"slug": "myagent", "name": "My Agent", "bio": "...", "emoji": "🤖"}` claims `myagent.domani.run` - a live public profile page, instantly, $0, no domain required. Optional `email` (e.g. your free @domani.run inbox) and up to 6 `links`. Update via `PATCH /api/agents/identity/{slug}`, list with `GET`, release with `DELETE`. Use this to give an agent an identity the moment it exists; upgrade to a real owned domain (`myagent.com`) whenever you're ready.

**Fastest path to a full owned identity - one call:** `POST /api/agents/provision` with `{"domain": "myagent.run", "slug": "hi", "webhook_url": "https://my-agent.example.com/inbox"}` buys the domain (if not owned), sets up email DNS, creates the mailbox `hi@myagent.run`, and registers the webhook - in a single request. The domain purchase is the only step that can fail the call; a mailbox still propagating DNS comes back in `warnings`. Payment works like `/api/domains/buy` (card, marketplace balance, or USDC). Use this whenever the goal is "set up an agent from scratch".

The steps below are the granular building blocks if you need finer control.

1. **Check account**: `GET /api/me` - verify authentication, check `has_payment_method` and `has_contact`
1b. **Set contact info** (optional, can be done after purchase): WHOIS registrant contact is optional for purchases - a default contact is used if none is set, so do not block a purchase on it. To use your own details: `PUT /api/me/contact` with `{"first_name":"...","last_name":"...","address1":"...","city":"...","state":"...","postal_code":"...","country":"US","phone":"+1.5551234567","email":"..."}`. When updated, the new contact is automatically propagated to all active domains at supported registrars.
2. **Get name ideas**: `GET /api/domains/suggest?prompt=AI+coding+assistant&tlds=com,dev&style=short` - AI-generated domain names with availability (10/min). Optional filters: `tlds` (preferred TLDs), `style` (single|creative|short|brandable|keyword), `lang` (japanese|spanish|french|...)
3. **Browse TLDs**: `GET /api/tlds?max_price=20&sort=price` - list available TLDs with pricing
4. **Search domains**: `GET /api/domains/search?domains=myproject.com,myproject.dev,myproject.ai` - check availability and pricing across TLDs via RDAP (max 200 domains, 20/min). For a single domain: `GET /api/domains/search?q=myproject.dev`. For real-time streaming: add `Accept: text/event-stream` header.
5. **Purchase**: `POST /api/domains/buy` with `{"domain": "myproject.dev", "payment_method": "card"}` for single or `{"domains": ["myproject.dev", "myproject.com"]}` for bulk (max 10). Each domain is processed independently - failures don't block other purchases. Optional `years` (1-10, default 1) to register for multiple years - price is multiplied by years. Optional `payment_method`: `"card"` (charge card) or `"usdc"` (returns 402 with payment instructions). For USDC: first call returns 402 with `payment_options.crypto` (wallet, amount, chains), send USDC, then retry with `payment_tx` (tx hash) and `payment_chain` ("base" or "ethereum"). If omitted, uses the user's `preferred_payment_method` (set via `PUT /api/me`), or auto-selects (card if available, else 402). Bulk purchases require card.
6. **Connect**: `POST /api/domains/myproject.dev/connect` with `{"target": "my-app.vercel.app"}` - auto-detects provider and sets DNS records. Or use `{"provider": "google-workspace"}` for email. Add `"dry_run": true` to preview the diff; replacing existing MX records requires `"confirm_replace_mx": true`. For imported domains (registrar=external), returns the records as instructions with `status: "manual_setup_required"` instead of writing them - the user adds records at their registrar manually.
7. **Set up email**: `POST /api/domains/myproject.dev/connect` with `{"provider": "google"}` - shorthand for email setup. Sets MX, SPF, DMARC records. Shorthand names: `google` (Google Workspace), `proton` (Proton Mail), `fastmail` (Fastmail).
8. **Check email health**: `GET /api/domains/myproject.dev/email/check` - verifies MX propagation, SPF, DMARC, DKIM. Auto-detects the email provider from MX records.
9. **Verify**: `POST /api/domains/myproject.dev/verify` with `{"target": "my-app.vercel.app"}` - confirms DNS propagation
10. **Verify service**: `POST /api/domains/myproject.dev/verify-service` with `{"service": "stripe", "token": "xxx"}` - adds verification DNS records for Stripe, Google Search Console, AWS SES, etc.
11. **Check status**: `GET /api/domains/myproject.dev/status` - DNS, SSL, email, and expiry health check
12. **WHOIS / RDAP lookup**: `GET /api/domains/whois?q=example.com` - look up full registration data for any domain: registrar (name, URL, IANA ID), dates (created, expires, updated, days_until_expiry), status codes, nameservers, DNSSEC, privacy redaction status, and contacts (registrant, admin, tech, billing, abuse - each with name, organization, email, phone, address). Uses RDAP with automatic WHOIS port 43 fallback. Cached 1h (registered) / 5min (not-found). Rate limit: 30/min
13. **Domain info**: `GET /api/domains/myproject.dev` - get detailed info about a domain you own: status, auto-renew, parking_enabled, listing_price, purchase/expiry dates, days until expiry, payment method, and registrar-side data (security lock, WHOIS privacy, auto-renew status, creation/expiration dates). Rate limit: 60/min
14. **Domain settings**: `PUT /api/domains/myproject.dev/settings` with `{"auto_renew": false}`, `{"whois_privacy": true}`, and/or `{"security_lock": false}` - toggle auto-renew, WHOIS privacy, and security lock. Applied at registrar first, then synced to local DB. WHOIS privacy and security lock are enabled by default on new registrations. Rate limit: 60/min
14a. **DNS snapshot**: `POST /api/domains/myproject.dev/dns/snapshot` - capture all DNS records via public DNS lookups (Cloudflare DoH). Discovers subdomains from Certificate Transparency logs, SPF records, and common names. Returns `domain`, `records[]`, `subdomains[]`, `sources[]`, `capturedAt`. Also stores a server-side backup. Optional body: `{"extra_subdomains": ["api", "cdn"]}`. Rate limit: 10/min
14b. **DNS restore**: `POST /api/domains/myproject.dev/dns/restore` - apply DNS records from a snapshot to the current registrar. Uses diff algorithm to avoid duplicating existing records. If no body, restores from server backup. Optional body: `{"snapshot": {...}}` with a snapshot object; add `"dry_run": true` to preview (`would_apply`) without writing. Returns `applied`, `skipped`, `errors[]`. Rate limit: 10/min
14b2. **DNS safety**: `GET /dns` returns per-record `id`s and a `zone_version`; pass `zone_version` back on `PUT /dns` to fail with 409 `DNS_VERSION_CONFLICT` (current records included) instead of overwriting a concurrent change. PUT is an rrset upsert: only (type, name) pairs you send are replaced, the rest is preserved, NS untouched. Every zone write takes an automatic server-side backup first. `connect` refuses to silently replace foreign MX records (409 `MX_REPLACEMENT_REQUIRES_CONFIRMATION`) - preview with `"dry_run": true`, then retry with `"confirm_replace_mx": true`.
14c. **Nameservers**: `GET /api/domains/myproject.dev/nameservers` - get authoritative nameservers. `PUT /api/domains/myproject.dev/nameservers` with `{"nameservers": ["ns1.systemdns.com", "ns2.systemdns.com", "ns3.systemdns.com"]}` - replace nameservers (2-13 required). If a domain has no nameservers, DNS operations (parking, email, connect) will fail. Rate limit: 60/min (GET), 30/min (PUT)
14g. **DNSSEC + DANE** (preview): protect a domain end-to-end. `GET /api/domains/myproject.dev/dnssec` lists the DNSSEC DS records at the registry and whether it's enabled. `POST /api/domains/myproject.dev/dnssec` with `{"keyTag": "12345", "algorithm": "13", "digestType": "2", "digest": "ABC123..."}` publishes a DS record (enables DNSSEC - get the DS values from your zone provider after signing). `DELETE /api/domains/myproject.dev/dnssec?keyTag=12345` removes it. For DANE, publish TLSA records via the normal DNS endpoint: `{"type": "TLSA", "name": "_443._tcp", "value": "3 1 1 <hex-spki>", "ttl": 3600}` - cryptographically pins your mail/TLS cert. DS management is registrar-dependent (Porkbun). Rate limit: 60/min
14d. **Get auth code** (transfer away): `GET /api/domains/myproject.dev/auth-code` - get the EPP auth code to transfer a domain to another registrar. Automatically unlocks the domain if locked. Returns `auth_code`, `was_unlocked`, and `next_steps`. Give the auth code to the new registrar to initiate the transfer. Rate limit: 10/min
14e. **Transfer away status**: `GET /api/domains/myproject.dev/transfer-away` - check status of an outbound domain transfer. Returns `status` (none|pending|approved|completed|rejected|expired), `gaining_registrar`, `request_date`. Rate limit: 30/min
14f. **Parking**: `PUT /api/domains/myproject.dev/parking` with `{"enabled": true}` - enable or disable the parking page. When enabled, visitors see a branded parking page. If the domain has existing DNS records, the API returns 409 with `requires_confirmation: true` and `existing_dns` listing the records that will be overwritten - call again with `{"enabled": true, "confirm": true}` to proceed. Newly purchased domains are parked by default.
14g. **Parking analytics**: `GET /api/domains/myproject.dev/analytics` - get visitor analytics for a parked domain: `views_7d`, `views_30d`, `daily_views` (30-day breakdown by date). Rate limit: 60/min
14h. **Sell domain (open marketplace)**: `POST /api/domains/sell` with `{"domain": "example.com", "price": 5000}` - list ANY domain for sale, even on other registrars. Optional `description` (max 500 chars). Domains in your Domani account are auto-verified and listed immediately. External domains require TXT verification first (status `pending_verification`). Returns listing details + verify instructions if needed. Rate limit: 30/min
14i2. **Verify listing**: `POST /api/domains/sell/verify` with `{"domain": "example.com"}` - verify TXT record ownership for an external domain listing. Add the TXT record shown in the sell response to your DNS, then call this endpoint. Activates the listing on success. Rate limit: 10/min
14i3. **Cancel listing**: `POST /api/domains/sell` with `{"domain": "example.com", "cancel": true}` or `DELETE /api/domains/myproject.dev/for-sale` - cancel an active listing. Domain stays in your account. Rate limit: 30/min
14i4. **Listing status**: `GET /api/domains/sell/status?domain=example.com` - check listing status and any active deal. Returns listing details, deal status, and contextual hints. Rate limit: 60/min
14i5. **Search marketplace**: `GET /api/domains/search?domains=...&source=secondary` - search only marketplace listings. Returns results with `for_sale` field (`{price, currency, source, buyable, status}`). Domains with `buyable: true` can be purchased via `POST /api/domains/buy`. Listings with status `pending_verification` are visible but not yet buyable.
14i6. **Deals (escrow pipeline)**: When buying an external domain (not hosted on Domani), a Deal is created with escrow. `GET /api/deals` - list your deals (buyer + seller). `GET /api/deals/{id}` - deal detail with event timeline. `PATCH /api/deals/{id}` with `{"auth_code": "EPP_CODE"}` - seller provides EPP/auth code to initiate transfer. Deal statuses: `escrow_held` → `epp_pending` → `transfer_started` → `completed` (or `refunded`/`expired`). Seller has 7 days to provide EPP code, transfer has 14 days to complete. 10% marketplace fee, seller credited on completion. `GET /api/deals/{id}/invoice` - a role-aware receipt (buyer) or statement (seller: sale − commission = net payout).
14i6b. **Negotiate price (anonymous)**: Instead of paying the asking price, make an offer. `POST /api/negotiations` with `{"domain": "example.com", "offer": 500}` opens an anonymous negotiation on a listing - you and the seller are labelled `you`/`counterparty`, identities are never exchanged. The other party can counter/accept/decline: `POST /api/negotiations/{id}` with `{"action": "counter", "counter": 750}` (or `{"action": "accept"}` / `{"action": "decline"}`). `accept` locks the price; the buyer then finalizes: `POST /api/negotiations/{id}/finalize` (pays the agreed price, creates the escrow deal). `GET /api/negotiations` lists yours; `DELETE /api/negotiations/{id}` withdraws. Offers expire in 7 days.
14i6c. **Seller payouts (bank)**: Sellers cash marketplace earnings out to their bank via Stripe Connect. `GET /api/billing/connect` - payout status + available balance. `POST /api/billing/connect` - start onboarding (returns a Stripe-hosted URL). `POST /api/billing/connect/payout` - withdraw balance to bank. Sale proceeds are credited to your balance and swept to your bank automatically once onboarded.
14i6d. **Broker (autonomous acquisition)**: Want a specific taken, unlisted domain? `POST /api/broker` with `{"domain": "dream.com", "max_budget": 5000}` - domani sources the owner (RDAP), reaches out anonymously, and negotiates on your behalf. **Commission-only, no upfront fee.** If the owner is interested, an anonymous negotiation opens (you get a `broker.owner_interested` notification + a negotiation to accept/counter). Statuses: `sourcing` → `contacted` → `negotiating` → `closing` → `completed` (or `no_contact` when the owner is unreachable/GDPR-redacted, `declined`, `expired`, `failed`). When you accept a price and finalize (pay into escrow), the request enters `closing`: the owner is asked to deliver the transfer code and gets paid on completion - all anonymous. `GET /api/broker` lists yours; `DELETE /api/broker/{id}` cancels. Reality check: many .com owners are unreachable via public WHOIS, so `no_contact` is common. Rate limit: 20/min.
- **Owner side (if you're the one being asked to sell)**: the outreach links to a secure claim. `POST /api/broker/claim` with `{"owner_token":"..."}` returns a scoped API key + deal id; then provide your transfer code via `PATCH /api/deals/{deal_id}` with `{"auth_code":"..."}` and set up payout via `POST /api/billing/connect` (or take the domani balance). You're paid automatically once the transfer completes. Fully doable by an owner-agent, no account signup needed to start.
14i7. **Notifications**: `GET /api/notifications` - list notifications (cursor pagination, snake_case response). `GET /api/notifications/count` - unread count (`{unread_count}`). `PATCH /api/notifications/{id}` with `{"read": true}` - mark read. `POST /api/notifications/read-all` - mark all read. **Preferences**: `GET /api/notifications/preferences` - returns per-category/channel toggles (categories: domains, transfers, marketplace, email, inquiries; channels: in_app, email). `PUT /api/notifications/preferences` with `{"preferences":[{"category":"marketplace","channel":"email","enabled":false}]}` - update preferences. All default to enabled. 42 event types across 5 categories flow through a unified notification system dispatching to in-app, email, and webhooks.
14i8. **Parking listing price** (legacy): `PUT /api/domains/myproject.dev/parking` with `{"listing_price": 499.99}` - set a "For Sale" price on the parking page. Visitors see a contact form. Set `{"listing_price": null}` to remove. Analytics include `inquiries_30d`, `conversion_rate`, and `recent_inquiries`. Rate limit: 60/min
14i9. **Backorders (drop-catching)**: Watch a currently-registered domain and auto-register it when it drops (best-effort, polled every few minutes). `POST /api/backorders` with `{"domain": "taken.com"}` (optional `max_price` USD cap, `payment_method` "card"|"balance"). No upfront fee - you're charged only if the catch succeeds, up to your cap. Requires a card on file (or `payment_method: "balance"`). If the domain is available now, it returns 400 `DOMAIN_AVAILABLE` (buy it directly instead). `GET /api/backorders` - list yours (filter `?status=watching|caught|failed|cancelled|expired`). `GET /api/backorders/{id}` - one. `DELETE /api/backorders/{id}` - stop watching. A cron polls availability every few minutes; on a confirmed drop it registers + charges via the buy flow and emits the `backorder.caught` webhook (or `backorder.failed`). Best-effort: a contested drop may be secured by a specialized drop-catcher first. Rate limit: 20/min
14i. **Webhooks**: Register HTTPS endpoints to receive real-time event notifications. `POST /api/webhooks` with `{"url":"https://example.com/hook","events":["domain.purchased","dns.updated"]}` - returns `id`, `url`, `events`, `secret` (shown once), `active`. Verify payloads with the `X-Domani-Signature` header (`t=timestamp,v1=hmac-sha256`). Events: `domain.purchased`, `domain.renewed`, `domain.expiring`, `dns.updated`, `transfer.initiated`, `transfer.completed`, `transfer.failed`, `transfer.eligible`, `inquiry.received`, `parking.updated`, `listing.created`, `listing.verified`, `listing.sold`, `listing.cancelled`, `listing.updated`, `deal.created`, `deal.epp_required`, `deal.transfer_started`, `deal.completed`, `deal.expired`, `deal.refunded`, `email.verified`, `email.received`, `email.queued`, `email.sent`, `email.delivered`, `email.bounced`, `email.complained`, `email.failed`, `email.delayed`, `email.suppressed`, `email.deleted`, `backorder.created`, `backorder.caught`, `backorder.failed`. Max 5 per account, HTTPS only. Failed deliveries retried 3x with backoff. Manage: `GET /api/webhooks` (list), `PATCH /api/webhooks/{id}` (update), `DELETE /api/webhooks/{id}` (delete), `GET /api/webhooks/{id}/deliveries` (delivery history), `GET /api/webhooks/events` (list event types, public). Rate limit: 60/min
14j. **Programmatic Email**: Send and receive emails from any domain you own. Create mailboxes, send/receive messages, and forward inbound emails to webhooks. Email DNS (MX/SPF/DKIM/DMARC) is auto-configured on first mailbox creation.
- **Create mailbox**: `POST /api/emails` with `{"address": "hello@myproject.dev"}` - creates `hello@myproject.dev`. Email DNS is auto-configured on first use - no separate setup step needed. On `domani.run`: `POST /api/email` auto-generates a random handle. Max 5 mailboxes per user total. Only 1 free @domani.run mailbox per user (buy a domain for unlimited custom-domain mailboxes). Many common slugs are reserved on @domani.run (admin, support, hello, info, ceo, etc.). Pass `{"force": true}` to override existing email provider (Google Workspace, Fastmail, Proton) MX records.
- **Check status**: `GET /api/domains/myproject.dev/email/status` - check DNS verification and readiness.
- **Preflight deliverability**: before authentication, onboarding, payment, or high-volume transactional mail, call `POST /api/emails/hello%40myproject.dev/deliverability-check` with the same subject/body. It does not send or consume quota and returns `safe_to_send`, blocking evidence, warnings and fixes. Local/private links and executable attachments are never allowed.
- **Domain email health**: call `GET /api/domains/myproject.dev/email/deliverability` to inspect authentication readiness, 30-day bounce/complaint outcomes, sending pauses, and provider placement evidence. Readiness is configuration, not an Inbox probability; unmeasured placement is reported as `not_tested`.
- **Send email**: `POST /api/emails/hello%40myproject.dev/send` with `{"to": "user@example.com", "subject": "Hello", "text": "Hi there", "idempotency_key": "job-123"}`. Supports `cc`, `bcc`, `reply_to`; max 20 unique recipients. The same preflight is mandatory server-side and its report is returned as `deliverability`. Rate limit: 100 recipient deliveries/hr per mailbox. Provider `delivered` means accepted by the receiving server, not guaranteed Inbox placement.
- **Reply / threading**: Include `in_reply_to` (parent Message-ID) and `references` (space-separated Message-ID chain) to thread emails. Example: `{"to": "user@example.com", "subject": "Re: Hello", "text": "Thanks!", "in_reply_to": "<abc@myproject.dev>", "references": "<abc@myproject.dev>"}`.
- **List messages**: `GET /api/emails/hello%40myproject.dev/messages?folder=inbox` - canonical folders are `inbox|archive|sent|spam|trash`; virtual views are `?view=starred|all`. Defaults to Inbox. Messages expose folder, read/starred/answered/forwarded flags and independent spam verdicts. Use cursor/limit plus direction/from/to/subject/since filters.
- **Folder counts**: `GET /api/emails/hello%40myproject.dev/folders` - server-derived total/unread counts and backend lifecycle capabilities.
- **Inbound webhooks**: `PUT /api/emails/hello%40myproject.dev/webhook` with `{"url": "https://my-app.com/hook"}` - forward incoming emails to your URL as signed JSON. `DELETE /api/emails/hello%40myproject.dev/webhook` to remove. `POST /api/emails/hello%40myproject.dev/webhook/rotate` to regenerate the HMAC signing secret. `POST /api/emails/hello%40myproject.dev/webhook/test` to send a test payload.
- **Email forwarding**: `PATCH /api/emails/hello%40myproject.dev` with `{"forward_to": "me@gmail.com"}` - forward a copy of every inbound email to a personal address. The original is still stored. Reply-To is set to the original sender. Set to `null` to remove. Can be used alongside webhook.
- **Aliases**: `POST /api/emails/hello%40myproject.dev/aliases` with `{"alias": "sales"}` (bare slug, or a full `sales@myproject.dev`) - deliver several public addresses (sales@, contact@, hello@) into one mailbox without using a mailbox slot. `GET /api/emails/hello%40myproject.dev/aliases` lists them; `DELETE /api/emails/hello%40myproject.dev/aliases/{alias}` removes one. The alias must be on the same domain as the mailbox.
- **Catch-all**: `PUT /api/domains/myproject.dev/email/catch-all` with `{"mailbox": "inbox"}` - route every email sent to an unmatched address on the domain into one designated mailbox (the mailbox must already exist). `DELETE /api/domains/myproject.dev/email/catch-all` clears it. The current catch-all is shown in `GET /api/domains/myproject.dev/email/status` (`catch_all` field).
- **Subaddressing** (`user+tag@`): `agent+github@myproject.dev` delivers to `agent@myproject.dev` automatically - no setup, Gmail-style. The `+tag` is exposed as `subaddress` on the stored message and in the inbound webhook payload; use it to filter or route without creating an alias per tag.
- **Inbound routing order**: an incoming recipient resolves in this precedence: (1) exact mailbox, (2) subaddress base (`user+tag@` -> `user@`), (3) alias, (4) domain catch-all. If none match, the message is dropped.
- **Suppression list**: hard bounces and spam complaints are added to a per-account suppression list automatically; `send` skips any suppressed recipient (returned in a `suppressed` array; if all `to` are suppressed the send fails `RECIPIENTS_SUPPRESSED` and is not charged). `GET /api/suppressions` (cursor-paginated) lists them; `POST /api/suppressions` with `{"address": "stop@example.com"}` adds one manually; `DELETE /api/suppressions/{address}` removes one (e.g. after the recipient fixed their mailbox).
- **Inbound rules + spam**: server-side rules run on each received message (priority order, first match wins): `POST /api/emails/{address}/rules` with `{"match_field":"from|to|subject|body","match_op":"contains|equals|regex","match_value":"...","action":"drop|mark_read|forward|webhook_only|label","action_arg":"..."}`; `GET`/`DELETE .../rules[/{ruleId}]` manage them. Inbound is also flagged `spam`/`virus` from upstream verdict headers (virus always dropped); `PATCH /api/emails/{address}` with `{"drop_spam":true}` drops spam for a mailbox, and `GET .../messages?spam=false` hides spam-flagged mail.
- **Get single message**: `GET /api/emails/hello%40myproject.dev/messages/{messageId}` - fetch a single message by ID with full headers and body.
- **Mark messages read**: `PATCH /api/emails/hello%40myproject.dev/messages/read` with `{"message_ids": ["id1", "id2"], "read": true}` - batch mark messages as read/unread.
- **Trash message**: `DELETE /api/emails/hello%40myproject.dev/messages/{messageId}` or bulk `POST .../messages/delete` - moves to Trash and is reversible.
- **Lifecycle actions**: `POST /api/emails/{address}/messages/actions` with explicit IDs and `action=move|mark_read|star|restore|delete_permanently`. Move accepts destination. Permanent deletion is Trash-only and requires `email:delete`.
- **Forward message**: `POST /api/emails/hello%40myproject.dev/messages/{messageId}/forward` with `{"to": "user@example.com"}` - forward a message to another address.
- **Reply to message**: `POST /api/emails/hello%40myproject.dev/messages/{messageId}/reply` with `{"text": "Thanks!"}` - reply to a message (auto-sets threading headers).
- **List all mailboxes**: `GET /api/emails` (or `GET /api/email`) - all mailboxes across all domains.
- **Pre-configure email DNS** (optional): `POST /api/domains/myproject.dev/email/setup` - explicitly set up email DNS before creating mailboxes. Called automatically by create mailbox when needed. Pass `{"force": true}` to override existing MX records.
- **Remove email**: `DELETE /api/domains/myproject.dev/email/setup` - removes email, deletes all mailboxes and messages.
- Webhook events: `email.verified` (DNS verified, ready to send/receive), `email.received`, `email.queued`, `email.sent`, `email.delivered` (outbound delivered), `email.bounced` (outbound bounced), `email.complained` (recipient marked as spam), `email.failed` (outbound failed), `email.delayed` (temporary delivery issue, retrying), `email.suppressed` (address on suppression list), `email.deleted`.
- After first mailbox creation, DNS verification is automatic (polled every 2 minutes). Subscribe to the `email.verified` webhook to be notified when the domain is ready - no manual polling needed.
15. **Renew domain**: `POST /api/domains/myproject.dev/renew` with `{"years": 1}` - extend registration by 1-10 years. Optional `payment_method`: `"card"` or `"usdc"`. Payment charged upfront. Returns new expiry date. Rate limit: 10/min
**Bring an existing domain**: Start with `GET /api/domains/adoption-plan?domain=example.com`. **Import** connects it for free without changing registrar or DNS. **Transfer** moves registrar management while preserving current nameservers and DNS provider. DNS migration is separate. Show the returned price and get explicit confirmation immediately before initiating.
16. **Import an existing domain** (free): `POST /api/domains/import` with `{"domain": "mysite.com"}` → returns a TXT record to add at your DNS provider. After adding the record, call `POST /api/domains/import/verify` with `{"domain": "mysite.com"}` to complete. Then use `POST /api/domains/mysite.com/connect` with `{"target": "my-app.vercel.app"}` to get the exact DNS records to add at your registrar (`status: "manual_setup_required"`). Verify with `POST /api/domains/mysite.com/verify`. No lock-in - domain stays at your current registrar. Rate limit: 30/min (initiate), 10/min (verify)
17. **Plan domain adoption**: `GET /api/domains/adoption-plan?domain=example.com` - read-only inspection of registrar, nameservers, DNS provider, DNSSEC, account state, transfer eligibility, price, and exact next actions. Call before requesting an EPP code. Rate limit: 30/min
17a. **Transfer registrar management** (paid): `POST /api/domains/transfer` with `{"domain": "example.com", "auth_code": "EPP-CODE", "payment_method": "card"}`. The returned adoption plan provides the exact price, which must be shown and confirmed first. The transfer includes 1 year, preserves authoritative nameservers, and does not migrate DNS. Domani captures NS and public DS before payment, then verifies continuity after completion. Returns 202 (async, takes 1-5 days). Rate limit: 5/min
**Before transferring**: The user must (1) unlock the domain at their current registrar, (2) get the EPP/auth code, and (3) optionally disable WHOIS privacy. Common registrar paths: GoDaddy (Domain Settings → Transfer away), Namecheap (Sharing & Transfer → Transfer Out → Unlock → Auth Code), Cloudflare (Configuration → Authorization Code), Squarespace (Settings → Transfer away → Get auth code). If the domain was registered or transferred less than 60 days ago, ICANN rules prevent transfer. **If the domain is not yet eligible**, the API returns the eligibility date and we automatically email the user when it becomes eligible - they'll need a fresh EPP code at that time. No payment is charged until the transfer actually goes through.
17b. **Watch for transfer eligibility**: `POST /api/domains/transfer-watch` with `{"domain": "example.com"}` - uses RDAP to check EPP status codes and ICANN 60-day lock windows. If not yet eligible, sets up a notification (email + `transfer.eligible` webhook) for when the domain becomes transferable. If already eligible, returns immediately. Rate limit: 30/min
17c. **Check transfer status**: `GET /api/domains/example.com/transfer-status` - check inbound transfer progress. Returns detailed status (`pending_owner`, `pending_admin`, `pending_registry`, `completed`, `cancelled`) with actionable hints. Rate limit: 30/min

### Example: Search and Buy

```bash
# Step 1: Compare pricing across TLDs (no auth needed)
curl "https://domani.run/api/domains/search?domains=myproject.com,myproject.dev,myproject.xyz,myproject.ai&max_price=20"

# Step 2: Buy the cheapest available option
curl -X POST https://domani.run/api/domains/buy \
  -H "Authorization: Bearer domani_sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{"domain": "myproject.xyz"}'

# Step 3: Connect to your hosting provider (auto-detects Vercel)
# The response includes a next_steps array with provider-specific actions
# (e.g., add the domain in Vercel dashboard). Always present these to the user.
# Some providers (cloudflare-pages, github-pages, railway, fly) require a target
# parameter - use GET /api/domains/{domain}/connect to check requires_target first.
curl -X POST https://domani.run/api/domains/myproject.xyz/connect \
  -H "Authorization: Bearer domani_sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{"target": "my-app.vercel.app"}'

# Step 4: Verify the connection is live
curl -X POST https://domani.run/api/domains/myproject.xyz/verify \
  -H "Authorization: Bearer domani_sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{"target": "my-app.vercel.app"}'

# Step 5: Verify domain for Stripe
curl -X POST https://domani.run/api/domains/myproject.xyz/verify-service \
  -H "Authorization: Bearer domani_sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{"service": "stripe", "token": "abc123def456"}'

# Step 6: Check overall domain health
curl https://domani.run/api/domains/myproject.xyz/status \
  -H "Authorization: Bearer domani_sk_xxx"
```

### Example: Bulk Buy

```bash
# Buy multiple domains at once (requires card on file)
curl -X POST https://domani.run/api/domains/buy \
  -H "Authorization: Bearer domani_sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{"domains": ["myproject.com", "myproject.dev", "myproject.ai"]}'
```

Response (partial success):

```json
{
  "results": [
    {"domain": "myproject.com", "status": "active", "price": 16.50, "currency": "USD", "payment_method": "card"},
    {"domain": "myproject.dev", "status": "active", "price": 19.00, "currency": "USD", "payment_method": "card"}
  ],
  "errors": [
    {"domain": "myproject.ai", "error": "Domain is not available", "code": "DOMAIN_UNAVAILABLE"}
  ],
  "summary": {"total": 3, "succeeded": 2, "failed": 1}
}
```

## Endpoints

| Method | Path | Description |
|--------|------|-------------|
| `POST` | `/api/auth/register` | Create a new account |
| `POST` | `/api/auth/login` | Send a magic link sign-in email |
| `GET` | `/api/auth/verify` | Verify a magic link token |
| `GET` | `/api/me` | Get current account details |
| `PUT` | `/api/me` | Update account preferences |
| `DELETE` | `/api/me` | Delete account (blocked while domains are held) |
| `GET` | `/api/me/contact` | Get registrant contact info |
| `PUT` | `/api/me/contact` | Set registrant contact info |
| `POST` | `/api/me/resend-verification` | Resend contact email verification |
| `GET` | `/api/tlds` | List all available TLDs with pricing |
| `GET` | `/api/domains/search` | Check availability and pricing for domains |
| `GET` | `/api/domains/suggest` | AI-powered domain suggestions with availability |
| `GET` | `/api/domains` | List all your registered domains |
| `POST` | `/api/agents/identity` | Claim a free agent identity (<handle>.domani.run) |
| `GET` | `/api/agents/identity` | List your agent identities |
| `PATCH` | `/api/agents/identity/{slug}` | Update an agent identity |
| `DELETE` | `/api/agents/identity/{slug}` | Release an agent identity |
| `POST` | `/api/agents/provision` | Provision a complete agent identity in one call |
| `POST` | `/api/backorders` | Place a backorder on a taken domain |
| `GET` | `/api/backorders` | List your backorders |
| `GET` | `/api/backorders/{id}` | Get a backorder |
| `DELETE` | `/api/backorders/{id}` | Cancel a backorder |
| `POST` | `/api/domains/buy` | Purchase one or more domains |
| `GET` | `/api/domains/{domain}/dns` | Get DNS records for a domain you own |
| `PUT` | `/api/domains/{domain}/dns` | Set DNS records for a domain you own |
| `GET` | `/api/domains/{domain}/dnssec` | List DNSSEC DS records for a domain you own |
| `POST` | `/api/domains/{domain}/dnssec` | Publish a DNSSEC DS record (enable DNSSEC) |
| `DELETE` | `/api/domains/{domain}/dnssec` | Remove a DNSSEC DS record (disable DNSSEC) |
| `POST` | `/api/domains/{domain}/dns/snapshot` | Capture a DNS snapshot |
| `POST` | `/api/domains/{domain}/dns/restore` | Restore DNS from a snapshot |
| `POST` | `/api/domains/{domain}/dns/clone` | Clone another domain's DNS onto this one |
| `GET` | `/api/domains/{domain}/nameservers` | Get nameservers for a domain |
| `PUT` | `/api/domains/{domain}/nameservers` | Set nameservers for a domain |
| `POST` | `/api/domains/{domain}/connect` | Connect a domain to a hosting or email provider |
| `GET` | `/api/domains/{domain}/connect` | List available providers for connecting a domain |
| `GET` | `/api/domains/{domain}/status` | Check domain health: DNS, SSL, email, expiry |
| `GET` | `/api/domains/{domain}/email/check` | Check email DNS health (MX, SPF, DMARC, DKIM) |
| `GET` | `/api/domains/{domain}/email/deliverability` | Get owner-scoped email deliverability health |
| `POST` | `/api/domains/{domain}/verify` | Verify that a provider connection is working |
| `POST` | `/api/domains/{domain}/verify-service` | Add DNS records to verify domain ownership for a third-party service |
| `GET` | `/api/domains/{domain}/verify-service` | List supported services for domain verification |
| `GET` | `/api/domains/{domain}` | Get detailed information about a domain you own |
| `PUT` | `/api/domains/{domain}/settings` | Update domain settings |
| `PUT` | `/api/domains/{domain}/parking` | Update parking settings |
| `PUT` | `/api/domains/{domain}/redirect` | Forward a domain to a URL |
| `DELETE` | `/api/domains/{domain}/redirect` | Stop forwarding a domain |
| `PUT` | `/api/domains/{domain}/for-sale` | List a domain for sale |
| `PATCH` | `/api/domains/{domain}/for-sale` | Update a domain listing |
| `DELETE` | `/api/domains/{domain}/for-sale` | Cancel a domain listing |
| `POST` | `/api/domains/sell` | List a domain for sale (open marketplace) |
| `POST` | `/api/domains/sell/verify` | Verify TXT ownership for external listing |
| `GET` | `/api/domains/sell/status` | Check listing and deal status |
| `GET` | `/api/deals` | List your deals |
| `POST` | `/api/deals` | Purchase an external domain (create deal) |
| `GET` | `/api/deals/{id}` | Get deal detail with timeline |
| `PATCH` | `/api/deals/{id}` | Provide EPP/auth code (seller) |
| `GET` | `/api/deals/{id}/invoice` | Get a deal receipt / statement |
| `GET` | `/api/negotiations` | List your negotiations |
| `POST` | `/api/negotiations` | Make an offer on a listing |
| `GET` | `/api/negotiations/{id}` | Get a negotiation thread |
| `POST` | `/api/negotiations/{id}` | Counter, accept, or decline |
| `DELETE` | `/api/negotiations/{id}` | Withdraw a negotiation |
| `POST` | `/api/negotiations/{id}/finalize` | Finalize an agreed negotiation (pay) |
| `GET` | `/api/broker` | List your broker requests |
| `POST` | `/api/broker` | Request acquisition of a taken domain |
| `GET` | `/api/broker/{id}` | Get a broker request |
| `DELETE` | `/api/broker/{id}` | Cancel a broker request |
| `GET` | `/api/broker/respond` | Read a broker inquiry's state (owner side) |
| `POST` | `/api/broker/respond` | Respond to a broker inquiry (owner side) |
| `GET` | `/api/notifications` | List notifications |
| `GET` | `/api/notifications/count` | Get unread notification count |
| `PATCH` | `/api/notifications/{id}` | Mark notification as read |
| `POST` | `/api/notifications/read-all` | Mark all notifications as read |
| `GET` | `/api/notifications/preferences` | Get notification preferences |
| `PUT` | `/api/notifications/preferences` | Update notification preferences |
| `GET` | `/api/domains/{domain}/analytics` | Get parking analytics |
| `GET` | `/api/domains/{domain}/auth-code` | Get EPP auth code |
| `GET` | `/api/domains/{domain}/transfer-away` | Get outbound transfer status |
| `GET` | `/api/domains/{domain}/transfer-status` | Check inbound transfer status |
| `POST` | `/api/domains/import` | Import an external domain |
| `POST` | `/api/domains/import/verify` | Verify and complete domain import |
| `GET` | `/api/domains/adoption-plan` | Plan how to adopt an existing domain |
| `GET` | `/api/domains/transfer-check` | Pre-check transfer eligibility |
| `POST` | `/api/domains/transfer-watch` | Watch a domain for transfer eligibility |
| `POST` | `/api/domains/transfer` | Transfer domain from another provider |
| `POST` | `/api/domains/{domain}/renew` | Renew a domain |
| `POST` | `/api/domains/{domain}/buy-aftermarket` | Buy an aftermarket domain |
| `GET` | `/api/domains/whois` | Look up domain registration data via RDAP |
| `GET` | `/api/domains/{domain}/og` | Get website preview metadata for a domain |
| `GET` | `/api/domains/dns-check` | Fast DNS-based domain existence check |
| `GET` | `/api/tokens` | List your API tokens |
| `POST` | `/api/tokens` | Create a new API token |
| `DELETE` | `/api/tokens/{id}` | Revoke an API token |
| `GET` | `/api/audit` | List security audit events |
| `POST` | `/api/billing/setup` | Get checkout URL for adding a payment method |
| `DELETE` | `/api/billing/card` | Remove saved payment method |
| `GET` | `/api/billing/connect` | Get marketplace payout status |
| `POST` | `/api/billing/connect` | Start bank payout onboarding |
| `POST` | `/api/billing/connect/payout` | Withdraw marketplace balance to bank |
| `GET` | `/api/billing/invoices` | List payment invoices |
| `GET` | `/api/referrals` | Get referral earnings and history |
| `GET` | `/api/webhooks` | List webhooks |
| `POST` | `/api/webhooks` | Create webhook |
| `PATCH` | `/api/webhooks/{id}` | Update webhook |
| `DELETE` | `/api/webhooks/{id}` | Delete webhook |
| `GET` | `/api/webhooks/{id}/deliveries` | List webhook deliveries |
| `GET` | `/api/webhooks/events` | List webhook event types |
| `POST` | `/api/domains/{domain}/email/setup` | Set up email on a domain |
| `DELETE` | `/api/domains/{domain}/email/setup` | Remove email from a domain |
| `GET` | `/api/domains/{domain}/email/status` | Check email DNS status |
| `POST` | `/api/email` | Create a mailbox on domani.run |
| `GET` | `/api/email` | List all mailboxes |
| `POST` | `/api/emails` | Create a mailbox |
| `GET` | `/api/emails` | List all mailboxes |
| `GET` | `/api/emails/{address}` | Get mailbox details |
| `PATCH` | `/api/emails/{address}` | Update mailbox |
| `DELETE` | `/api/emails/{address}` | Delete a mailbox |
| `POST` | `/api/emails/{address}/send` | Send an email |
| `POST` | `/api/emails/{address}/deliverability-check` | Preflight an outbound email |
| `GET` | `/api/emails/{address}/messages` | List emails |
| `GET` | `/api/emails/{address}/folders` | List email folders and counts |
| `POST` | `/api/emails/{address}/messages/actions` | Apply a lifecycle action to messages |
| `PATCH` | `/api/emails/{address}/messages/read` | Mark messages as read or unread |
| `POST` | `/api/emails/{address}/messages/delete` | Bulk delete messages |
| `GET` | `/api/emails/{address}/messages/{id}` | Get a message |
| `DELETE` | `/api/emails/{address}/messages/{id}` | Delete a message |
| `POST` | `/api/emails/{address}/messages/{id}/reply` | Reply to a message |
| `POST` | `/api/emails/{address}/messages/{id}/forward` | Forward a message |
| `GET` | `/api/emails/{address}/avatar` | Get mailbox avatar info |
| `GET` | `/api/emails/{address}/webhook` | Get mailbox webhook config |
| `PUT` | `/api/emails/{address}/webhook` | Set mailbox webhook |
| `DELETE` | `/api/emails/{address}/webhook` | Remove mailbox webhook |
| `POST` | `/api/emails/{address}/webhook/rotate` | Rotate webhook signing secret |
| `POST` | `/api/emails/{address}/webhook/test` | Test mailbox webhook |
| `GET` | `/api/emails/{address}/aliases` | List mailbox aliases |
| `POST` | `/api/emails/{address}/aliases` | Add a mailbox alias |
| `DELETE` | `/api/emails/{address}/aliases/{alias}` | Remove a mailbox alias |
| `GET` | `/api/emails/{address}/client-settings` | Get mail client settings (hosted) |
| `GET` | `/api/emails/{address}/credentials` | List app passwords (hosted) |
| `POST` | `/api/emails/{address}/credentials` | Create an app password (hosted) |
| `DELETE` | `/api/emails/{address}/credentials/{id}` | Revoke an app password (hosted) |
| `GET` | `/api/emails/{address}/rules` | List inbound mail rules |
| `POST` | `/api/emails/{address}/rules` | Add an inbound mail rule |
| `DELETE` | `/api/emails/{address}/rules/{ruleId}` | Remove an inbound mail rule |
| `PUT` | `/api/domains/{domain}/email/catch-all` | Set domain catch-all |
| `DELETE` | `/api/domains/{domain}/email/catch-all` | Clear domain catch-all |
| `POST` | `/api/workspaces/{id}/ownership-transfer` | Request a workspace ownership transfer |
| `DELETE` | `/api/workspaces/{id}/ownership-transfer/{transferId}` | Revoke a pending ownership transfer |
| `POST` | `/api/workspaces/ownership-transfers/accept` | Accept workspace ownership |
| `GET` | `/api/suppressions` | List suppressed addresses |
| `POST` | `/api/suppressions` | Add a suppression |
| `DELETE` | `/api/suppressions/{address}` | Remove a suppression |

## Rate Limits

All responses include rate limit headers:

- `X-RateLimit-Limit` - Maximum requests allowed per window
- `X-RateLimit-Remaining` - Requests remaining in current window
- `X-RateLimit-Reset` - Unix timestamp when the window resets

| Endpoint | Public Limit | Auth Limit | Notes |
|----------|-------------|------------|-------|
| `GET /api/domains/search` | 20/min (IP) | 60/min (user) | Availability + pricing (single, multi, SSE) |
| `GET /api/tlds` | 30/min (IP) | 60/min (user) | TLD listing |
| `GET /api/domains/suggest` | 10/min (IP) | 10/min (IP) | AI-generated domain names |
| `GET /api/domains/whois` | 10/min (IP) | 30/min (user) | Cached 1h registered, 5min not-found |
| `GET /api/domains/{domain}/og` | 30/min (IP) | 30/min (IP) | Cached 7 days, CDN 24h |
| `GET /api/domains/{domain}` | - | 60/min (user) | Auth required |
| `PUT /api/domains/{domain}/settings` | - | 60/min (user) | Auth required |
| `POST /api/domains/buy` | - | 10/min (user) | Auth required |
| `PUT /api/domains/{domain}/for-sale` | - | 30/min (user) | Auth required, list for sale |
| `DELETE /api/domains/{domain}/for-sale` | - | 30/min (user) | Auth required, cancel listing |
| `POST /api/domains/import` | - | 30/min (user) | Auth required |
| `POST /api/domains/import/verify` | - | 10/min (user) | Auth required, DNS lookup |
| `GET /api/domains/adoption-plan` | - | 30/min (user) | Auth required, read-only plan |
| `POST /api/domains/transfer` | - | 5/min (user) | Auth required, async (1-5 days) |
| `GET /api/domains/{domain}/transfer-status` | - | 30/min (user) | Auth required, inbound transfer status |
| `GET /api/domains/{domain}/auth-code` | - | 10/min (user) | Auth required, auto-unlocks domain |
| `GET /api/domains/{domain}/transfer-away` | - | 30/min (user) | Auth required |
| `POST /api/domains/{domain}/renew` | - | 10/min (user) | Auth required |
| `POST /api/auth/register` | 5/min (IP) | - | |
| `POST /api/auth/login` | 10/min (IP) | - | |
| All other authenticated | - | 60/min (user) | Per endpoint |

When rate limited (HTTP 429), the response includes a `Retry-After` header with seconds to wait. Recommended strategy: exponential backoff starting at the `Retry-After` value.

## Error Format

All errors return a consistent JSON envelope:

```json
{
  "error": "Human-readable message",
  "code": "MACHINE_CODE",
  "hint": "Actionable recovery guidance",
  "documentation_url": "https://domani.run/llms.txt"
}
```

### Error Codes

| Code | HTTP | Meaning | Recovery |
|------|------|---------|----------|
| `MISSING_API_KEY` | 401 | No Authorization header | Add `Authorization: Bearer domani_sk_xxx` header |
| `INVALID_API_KEY` | 401 | Key not found or revoked | Check key or create a new one via `POST /api/tokens` |
| `EXPIRED_API_KEY` | 401 | Token has expired | Create a new token via `POST /api/tokens` or run `domani login` |
| `INSUFFICIENT_SCOPE` | 403 | Token lacks required scope | Create a new token with the needed scopes via `POST /api/tokens` |
| `MISSING_PARAMETER` | 400 | Required field missing | Check `hint` field for the missing parameter |
| `INVALID_DOMAIN` | 400 | Bad domain format | Use format `name.tld` (e.g. `mysite.com`) |
| `PAYMENT_REQUIRED` | 402 | No payment method | Pay with USDC via x402 (automatic) or add a card via `POST /api/billing/setup` |
| `DOMAIN_UNAVAILABLE` | 409 | Domain is taken | Try a different domain or TLD |
| `RATE_LIMIT_EXCEEDED` | 429 | Too many requests | Wait `retry_after` seconds, then retry |
| `USER_EXISTS` | 409 | Email already registered | Use `POST /api/auth/login` instead |
| `NOT_FOUND` | 404 | Resource not found | Verify the ID/domain exists and belongs to you |
| `NOT_AVAILABLE` | 501 | Feature not available | The requested feature is not supported by the current registrar (Preview - coming soon) |

### CLI Error Format (`--json` mode)

When using the CLI with `--json`, errors include a `fix_command` field for auto-recovery:

```json
{
  "error": "Not logged in",
  "code": "auth_required",
  "hint": "Run 'domani login' or set DOMANI_API_KEY",
  "fix_command": "domani login"
}
```

| CLI Code | fix_command | When |
|----------|-------------|------|
| `auth_required` | `domani login` | 401/403 or missing token |
| `payment_required` | `domani billing` | 402 or `setup_url` present |
| `contact_required` | `domani contact set` | Contact info missing |
| `validation_error` | - | Invalid input (422) |
| `not_found` | - | Resource not found (404) |
| `rate_limited` | - | Too many requests (429) |
| `conflict` | - | Conflict (409) |

### CLI Flags for Agents

The CLI (`npx domani-cli`, installs the `domani` command) supports flags designed for agent integration:

- `--json` - Machine-readable JSON output on all commands
- `--fields <fields>` - Filter JSON output to specific fields (comma-separated, e.g. `--fields domain,status`)
- `--dry-run` - Preview mutations without executing (buy, dns set, connect, etc.)
- `--yes` - Skip confirmation prompts (for automated workflows)
- `$DOMANI_API_KEY` - Set as environment variable to authenticate without `domani login`

**TTY auto-detect**: When stdout is piped (not a terminal), the CLI automatically outputs JSON and skips confirmations - no `--json` or `--yes` needed.

**Input hardening**: Domain and TLD inputs are validated against path traversal (`../`), control characters, query strings (`?`/`#`), and percent-encoding (`%2e`). Invalid input returns `code: "invalid_input"` with a hint.

### Schema Introspection

Discover CLI command schemas programmatically:

- All commands: `GET https://domani.run/api/schema`
- Single command: `GET https://domani.run/api/schema?command=buy`
- CLI: `domani schema [command] --json`

Returns parameters, types, constraints, enums, and error codes for each command.

## Referral Program

Agents and integrations can earn commissions on domain purchases:

1. **Register** with `POST /api/auth/register` to get your `referral_code`
2. **Link users** by passing your code as `ref` when registering new users: `{"email": "...", "ref": "YOUR_CODE"}`
3. **Earn automatically** - every domain purchased by a user you referred earns you a 20% commission on the markup, permanently

The referral link is set once at registration and applies to all future purchases. No need to pass the code on every buy request.

Check your earnings with `GET /api/referrals`.

## Paying with USDC

No credit card needed. Two-step flow:

1. `POST /api/domains/buy` with `{"domain": "mysite.com", "payment_method": "usdc"}` - returns 402 with wallet address, USDC amount, and supported chains (Base or Ethereum) in `payment_options.crypto`.
2. Send USDC to the provided address, then retry: `POST /api/domains/buy` with `{"domain": "mysite.com", "payment_tx": "0xabc...", "payment_chain": "base"}`.

The server verifies the transaction on-chain and completes registration. Each tx hash can only be used once. Works for single domain purchases.

**Chains (live now)**: Base (`eip155:8453`), Solana (`solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`). **Asset**: USDC. A 402 challenge lists a payment option per live chain in its `accepts[]`; your agent pays on whichever it holds USDC on. More chains (Polygon, Arbitrum) are supported by the facilitator and turn on as receiving wallets are added.

### Automatic payments with x402

For agents with their own crypto wallet, the API supports the [x402 protocol](https://x402.org) for fully automatic USDC payments - no manual transfer needed. Setup: `npm install @x402/fetch`, create a wallet funded with USDC on a supported chain (e.g. Base), then wrap your fetch:

```typescript
import { wrapFetch } from "@x402/fetch";
const x402Fetch = wrapFetch(fetch, walletClient); // walletClient = a wallet holding USDC on a supported chain
const res = await x402Fetch("https://domani.run/api/domains/buy", {
  method: "POST",
  headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({ domain: "mysite.com" }),
});
```

Every API call that requires payment is handled automatically via `PAYMENT-REQUIRED` / `PAYMENT-SIGNATURE` / `PAYMENT-RESPONSE` headers.

## Pagination

The `GET /api/tlds` endpoint supports pagination via `limit` and `offset` query parameters. When more results exist, the response includes a `Link` header:

```
Link: </api/tlds?limit=20&offset=20&sort=price>; rel="next"
```