Base URL
Actions
Each endpoint is an action appended to the base URL. Some actions include the domain as a path segment.GET /version→.../index.php/versionPOST /domains/lookup→.../index.php/domains/lookupGET /domains/example.com/information→.../index.php/domains/example.com/information
GET or POST) is listed with each endpoint in this reference.
Authentication
Every request sends two headers:username— the reseller client’s WHMCS email.token— an HMAC-SHA256 value that rotates every UTC hour.
Request format
POST bodies are application/x-www-form-urlencoded, encoded the way PHP’s http_build_query produces. Nested objects and arrays use bracket notation:
See Models for the full shape of each nested parameter.
Response format
Responses are JSON. The shape varies by endpoint:- A bare string, such as
"2.3.0","success", or"unlocked". - A small object, such as
{"success":true}or{"status":"success","message":"","success":"success"}. - An array of objects, such as availability or DNS results.
error key and a non-2xx status. See Errors for the full list.
Explore the reference
Availability & pricing
Look up domains, get suggestions, and read TLD and cart pricing.
Ordering
Register, transfer, and renew domains.
Domain management
Contacts, nameservers, DNS, locks, EPP, transfer out, and deletion.
Account
Read your credit balance and the API version.
Models
Shared shapes: contacts, nameservers, DNS records, and addons.