Documentation
Search
The search method performs a real-time query of the search term(s) against the known zone database, making recommendations, stemming, applying Unicode folding, IDN normalization, registrar supported-zone restrictions, and other refinements.
The server responds with a JSON object containing search result(s) or an error.
Search method responses do not include domain availability status.
Arguments
| Parameter | Description | Example |
|---|---|---|
query | Term(s) to search against (required). | query=foo%20bar |
location | Override IP location detection for country-code zones, with a two-character country code (optional). | location=de |
registrar | The domain name of a specific registrar, for filtering results by zones supported by the that registrar (optional). | registrar=dnsimple.com |
defaults | Comma-separated list of default zones to include in the response (optional). | defaults=club |
keywords | Beta: Comma-separated list of keywords for seeding the results. For example, a new gTLD like kitchen, or a related keyword like vegan. Helpful for search result relevance (e.g. from a targeted ad click, a user profile, etc.). (optional). | keywords=food,kitchen |
Example
Request
/v2/search?query=foo%20bar&keywords=food,kitchen&defaults=club®istrar=dnsimple.com
Response
{ "results": [ { "domain": "foo.bar", "host": "", "subdomain": "foo.", "zone": "bar", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foo.bar&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foo.beer", "host": "", "subdomain": "foo.", "zone": "beer", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foo.beer&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foobar.cafe", "host": "", "subdomain": "foobar.", "zone": "cafe", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foobar.cafe&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foobar.menu", "host": "", "subdomain": "foobar.", "zone": "menu", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foobar.menu&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foobar.kitchen", "host": "", "subdomain": "foobar.", "zone": "kitchen", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foobar.kitchen&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foo.cafe", "host": "", "subdomain": "foo.", "zone": "cafe", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foo.cafe&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foo.pub", "host": "", "subdomain": "foo.", "zone": "pub", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foo.pub&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foo.club", "host": "", "subdomain": "foo.", "zone": "club", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foo.club&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foo.menu", "host": "", "subdomain": "foo.", "zone": "menu", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foo.menu&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foo.kitchen", "host": "", "subdomain": "foo.", "zone": "kitchen", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foo.kitchen&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foobar.com", "host": "", "subdomain": "foobar.", "zone": "com", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foobar.com&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foobar.club", "host": "", "subdomain": "foobar.", "zone": "club", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foobar.club&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foobar.net", "host": "", "subdomain": "foobar.", "zone": "net", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foobar.net&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foobar.org", "host": "", "subdomain": "foobar.", "zone": "org", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foobar.org&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foobar.co", "host": "", "subdomain": "foobar.", "zone": "co", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foobar.co&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foobar.io", "host": "", "subdomain": "foobar.", "zone": "io", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foobar.io&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" }, { "domain": "foobar.us", "host": "", "subdomain": "foobar.", "zone": "us", "path": "", "registerURL": "https://api.domainr.com/v2/register?domain=foobar.us&gl=US%2CSan+Francisco%2CUS-CA®istrar=dnsimple.com&source=" } ]}