Skip to content

API Overview

https://api.namecheap.itz.tools

Generate your API key on the dashboard.

x-api-key: sk-itzn_your-key
{
"data": { ... }
}

Paginated endpoints include meta:

{
"data": [ ... ],
"meta": { "totalItems": 42, "currentPage": 1, "pageSize": 20 }
}

Errors:

{
"error": { "code": "NOT_FOUND", "message": "Domain not found" }
}
StatusCodeMeaning
400BAD_REQUESTInvalid input
401UNAUTHORIZEDInvalid or expired API key
403FORBIDDENDisabled key, or domain not in your account
404NOT_FOUNDResource not found
409CONFLICTDomain unavailable, expired, or wrong DNS state
412PRECONDITION_FAILEDNamecheap rejected your credentials
428PRECONDITION_REQUIREDNamecheap profile not configured
429TOO_MANY_REQUESTSRate limited
503SERVICE_UNAVAILABLENamecheap upstream error
MethodPathDescription
GET/domains/checkCheck availability
GET/domainsList your domains
GET/domains/tldsList available TLDs
POST/domainsRegister a domain
GET/domains/:domainGet domain info
POST/domains/:domain/renewRenew
MethodPathDescription
GET/domains/:domain/dnsGet DNS records
POST/domains/:domain/dnsSet DNS records
POST/domains/:domain/dns/defaultReset to default
MethodPathDescription
GET/domains/:domain/nameserversGet nameservers
POST/domains/:domain/nameserversSet custom nameservers
POST/domains/:domain/nsRegister glue nameserver
GET/domains/:domain/ns/:nsGet nameserver info
POST/domains/:domain/ns/:nsUpdate nameserver IP
DELETE/domains/:domain/ns/:nsDelete nameserver
MethodPathDescription
GET/domains/:domain/email-forwardingGet rules
POST/domains/:domain/email-forwardingSet rules
MethodPathDescription
GET/domains/:domain/contactsGet contacts
POST/domains/:domain/contactsSet contacts
MethodPathDescription
GET/domains/:domain/lockGet lock status
POST/domains/:domain/lockSet lock
MethodPathDescription
GET/transfersList transfers
POST/transfersInitiate transfer
GET/transfers/:id/statusGet status
POST/transfers/:id/statusResubmit
MethodPathDescription
GET/whoisguardList entries
POST/whoisguard/:id/enableEnable
POST/whoisguard/:id/disableDisable
POST/whoisguard/:id/renewRenew
POST/whoisguard/:id/allotAllot to domain
POST/whoisguard/:id/unallotUnallot
POST/whoisguard/:id/emailChange email
MethodPathDescription
GET/account/balanceGet balance
GET/account/pricingGet pricing
MethodPathDescription
GET/addressesList
POST/addressesCreate
GET/addresses/:idGet
POST/addresses/:idUpdate
DELETE/addresses/:idDelete
POST/addresses/:id/defaultSet default