{"id":19366,"date":"2026-10-30T09:14:03","date_gmt":"2026-10-30T09:14:03","guid":{"rendered":"https:\/\/truehost.com\/support\/?post_type=docs&p=19366"},"modified":"2026-11-03T09:33:05","modified_gmt":"2026-11-03T09:33:05","password":"","slug":"truehost-domains-reseller-api","status":"publish","type":"docs","link":"https:\/\/truehost.com\/support\/knowledge-base\/truehost-domains-reseller-api\/","title":{"rendered":"Truehost Domains Reseller API"},"content":{"rendered":"\n

Reference for integrating domain registration into your own website or software<\/strong><\/p>\n\n\n\n

<\/td><\/td><\/tr>
Version<\/td>1.0 (October 2026)<\/td><\/tr>
Protocol<\/td>HTTPS, REST-style paths<\/td><\/tr>
Request format<\/td>application\/x-www-form-urlencoded<\/td><\/tr>
Response format<\/td>JSON (one exception: domain lookup<\/a>)<\/td><\/tr>
Authentication<\/td>Username plus an hourly HMAC-SHA256 token<\/td><\/tr>
Time zone<\/td>UTC for all times<\/td><\/tr>
Standards<\/td>ISO 8601 dates, ISO 3166-1 alpha-2 country codes, ITU-T E.164 phone numbers, IDNA 2008 (Punycode) for internationalised names<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

This is for: developers at a Truehost reseller who want to register, transfer, renew and manage domains from their own system, without WHMCS or the Truehost Reseller Panel. If you use either, use its Truehost module instead; it makes these calls for you, and the panel’s module also keeps your extension prices in step with your price list.<\/p>\n\n\n\n

Contents<\/strong><\/h2>\n\n\n\n
\n

Table of Contents<\/h2>\n\n
    \n
  1. Before you start<\/a><\/li>\n
  2. Base URL<\/a><\/li>\n
  3. Authentication<\/a><\/li>\n
  4. Requests<\/a><\/li>\n
  5. Responses and errors<\/a><\/li>\n
  6. Endpoint summary<\/a><\/li>\n
  7. Account<\/a><\/li>\n
  8. Availability<\/a><\/li>\n
  9. Orders<\/a><\/li>\n
  10. Domain status<\/a><\/li>\n
  11. Nameservers<\/a><\/li>\n
  12. Child nameservers (glue records)<\/a><\/li>\n
  13. Transfer lock and EPP code<\/a><\/li>\n
  14. Contacts and WHOIS privacy<\/a><\/li>\n
  15. DNS and email forwarding<\/a><\/li>\n
  16. Release and deletion<\/a><\/li>\n
  17. Data formats<\/a><\/li>\n
  18. Code examples<\/a><\/li>\n
  19. Recommended integration flow<\/a><\/li>\n
  20. Troubleshooting<\/a><\/li>\n <\/ol>\n<\/div>\n\n\n\n

    1. Before you start<\/h2>\n\n\n\n\n

    You need:<\/p>\n\n\n\n

    Item<\/strong><\/td>Where to get it<\/strong><\/td><\/tr>
    A reseller account<\/strong> on a Truehost site, for example truehost.cloud or truehost.co.ke<\/td>Sign up on that site and ask Truehost to switch on domain reselling<\/td><\/tr>
    Your API username<\/strong><\/td>The email address you log in to that site with<\/td><\/tr>
    Your API key<\/strong><\/td>That site’s client area \u2192 Domains Reseller<\/strong> \u2192 API settings<\/strong><\/td><\/tr>
    A reseller balance<\/strong><\/td>Top up in the same client area. Every registration, transfer and renewal is paid from it<\/td><\/tr>
    A server with an accurate clock<\/strong><\/td>Use NTP. The token changes every hour (see Authentication<\/a>)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    Each Truehost site is separate.<\/strong> Accounts, API keys, balances and price lists are not shared between sites. Always call the site where your reseller account was opened, with the key issued by that site.<\/p>\n\n\n\n

    Keep the API key on your server.<\/strong> Never put it in a browser, mobile app or public repository. Anyone with the key can spend your balance.<\/p>\n\n\n\n

    2. Base URL<\/h2>\n\n\n\n\n

    https:\/\/{site}\/cloud\/modules\/addons\/DomainsReseller\/api\/index.php<\/a><\/p>\n\n\n\n

    {site} is the Truehost site of your reseller account. Examples:<\/p>\n\n\n\n

    Site<\/strong><\/td>Base URL<\/strong><\/td><\/tr>
    truehost.cloud<\/td>https:\/\/truehost.cloud\/cloud\/modules\/addons\/DomainsReseller\/api\/index.php<\/td><\/tr>
    truehost.co.ke<\/td>https:\/\/truehost.co.ke\/cloud\/modules\/addons\/DomainsReseller\/api\/index.php<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    Every endpoint is appended to the base URL with a \/. For example, the balance endpoint on truehost.cloud is:<\/p>\n\n\n\n

    https:\/\/truehost.cloud\/cloud\/modules\/addons\/DomainsReseller\/api\/index.php\/billing\/credits<\/a><\/p>\n\n\n\n

    In this document, {BASE} means the base URL and {domain} means a domain name such as example.co.ke.<\/p>\n\n\n\n

    3. Authentication<\/h2>\n\n\n\n\n

    Send these two HTTP headers with every<\/strong> request:<\/p>\n\n\n\n

    Header<\/strong><\/td>Value<\/strong><\/td><\/tr>
    username<\/td>Your API username (login email)<\/td><\/tr>
    token<\/td>The hourly token described below<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    Building the token<\/strong><\/h3>\n\n\n\n

    hour  = current UTC time formatted as “yy-mm-dd HH”     e.g. “26-10-26 14”<\/p>\n\n\n\n

    key   = username + “:” + hour                           e.g. “reseller@example.com:26-10-26 14”<\/p>\n\n\n\n

    hex   = HMAC-SHA256(message = API key, key = key), as lowercase hexadecimal<\/p>\n\n\n\n

    token = Base64(hex)<\/p>\n\n\n\n

    Note the details that are easy to get wrong:<\/p>\n\n\n\n