Documentation
Registrars and Resellers
The Domainr API provides instant autocomplete results for domain registrars and resellers. You can use it to supplement your search boxes with instant results, while preserving your existing search landing pages.
Getting Started
Using the Domainr API is simple and straightforward—a web developer can have it working in just a few minutes:
- Add the JavaScript example code to your site, and customize as needed.
- Use a RapidAPI key, or
client_id
if your usage will be high-volume. - Send us your
zones.txt
file URL; see below for details.
WHMCS
If you use WHMCS for your reseller site, you can easily use the open source, JavaScript-based Domainr Search Box to add autocomplete to your site.
zones.txt
Search results can be restricted to only include top-level domains you support; we maintain an internal mapping of supported TLDs, keyed by registrars' domain names.
To keep your listing current, publish a zones.txt
file at the root of your website (e.g. https://dnsimple.com/zones.txt), listing your supported TLDs separated by newlines. Domainr will automatically ingest this file several times per day, to keep our internal mapping up to date.
Email us the URL of your file, so that we can add it to the Domainr backend.
Here’s an example:
com
net
org
blog
space
online
tech
site
app
page
Note: The TLDs in your zones.txt
file should be a strict subset of the primary list at zonedb.org.