THE NYMWELL FOUNDATION
A clear API and key model.
The REST API behind the console and the MCP server: the same actions, the same approvals.
Registration, renewal, transfers and domain changes run only where the server has a registrar and a payment provider configured;
nymwell_status and GET /api/v1/status say which. Without them those calls answer integration_not_configured and nothing is charged.| Method | Endpoint | Purpose |
|---|---|---|
| GET | /api/v1/status | What is configured: registrar, payments, webhooks |
| GET | /api/v1/domains/search?domain= | Availability and price from the registrar (public, rate limited) |
| GET | /api/v1/domains/suggest?q= | Registrar suggestions for a keyword (public) |
| GET | /api/v1/domains/tld-info?tlds= | Ending prices and rules (public) |
| GET | /api/v1/domains/screen?q= | RDAP + DNS screen, not availability (public) |
| POST | /api/v1/quotes | Register, renew or transfer quote, locked 40 minutes |
| POST | /api/v1/renewals | Renewal quote |
| POST | /api/v1/transfers | Owner submits an auth code; returns the transfer quote |
| GET | /api/v1/transfers | Transfers and their status |
| POST | /api/v1/orders | Pay a quote: returns the checkout URL |
| GET | /api/v1/orders?id= | Order status |
| GET | /api/v1/domains/detail?domain= | Live domain state from the registrar |
| POST | /api/v1/domains/auto-renew | Renewal preference |
| POST | /api/v1/domains/settings | Privacy or transfer lock (approval) |
| POST | /api/v1/domains/nameservers | Nameservers (approval) |
| POST | /api/v1/domains/contacts | Contacts (approval) |
| POST | /api/v1/domains/auth-code | Unlock and reveal the auth code (approval) |
| POST | /api/v1/domains/cancel | Cancel in the grace period and refund (approval) |
| GET | /api/v1/domains/services?domain=&service= | DNSSEC, URL / email forwarding, vanity nameservers |
| POST | /api/v1/domains/services | Change one of those (approval) |
| POST | /api/v1/transfers/cancel | Cancel a transfer in or out (approval) |
| GET | /api/v1/dns/records?domain=&refresh=1 | DNS records, optionally re-read from the registrar |
| POST | /api/v1/dns/change-sets | Create, update, delete records (approval) |
| GET | /api/v1/contacts/unverified | Registrants still to verify |
| POST | /api/v1/contacts/resend | Resend the verification email |
| GET | /api/v1/approvals | Changes waiting for a person |
| POST | /api/v1/approvals | Approve or reject (people only) |
| POST | /api/v1/api-keys | Issue a scoped agent key once |
| POST | /api/v1/webhooks/namecom | Registrar events, HMAC-verified |
API keys
Send X-Nymwell-Key. Keys start with nw_live_ or nw_test_.
{
"domain": "example.com",
"action": "renew",
"years": 1,
"currency": "USD"
}