running
Utility
11 Developers use this API
Methods
- Get Whois info
- Get domain suggestions
Get Whois info (GET)
This call retrieves detailed public whois information for a domain.
Parameters
Domain to retrieve whois data for e.g. nametoolkit.com. Note - Will NOT work correctly if you specify a domain with subdomain.
For example: "/whois?q=mashape.com"
Results
The city part of an address.
For example: "Paris"
The country part of an address.
For example: "France"
Post code part of address
For example: "12345"
The first line of a street address
For example: "15 place de la Nation"
Second line of street address
For example: "District 9"
In the event of a lengthy street address this may also be populated.
For example: "Manhattan"
Domain which was checked.
For example: "nametoolkit.com"
Whois created date for this domain.
For example: "15-jul-1999"
Normalised whois expiration date for this domain. RAW Whois expiration dates are in a different format in practically every TLD.
For example: "2018-7-15"
Description - Uncommonly used field
Domain which was sent to API. Can be different from checked if there was a problem parsing a domain.
For example: "nametoolkit.com"
Email of domain owner
For example: "customerservice@nametoolkit.com"
Whois expiration date in raw format Note - Can differ between TLDs
For example: "15-jul-2018"
Fax number of domain owner Note - Optional and different formatting is allowed between registries.
For example: "+33.143730576"
Name of domain owner
For example: "Parsity Ltd."
List of name servers for this domain.
For example: "[ "a.dns.gandi.net" "b.dns.gandi.net" "c.dns.gandi.net" ]"
Phone number Note - Optional and not well defined between registries.
For example: "+442.890424190"
Raw text whois string
For example: "Whois Server Version 2.0 Domain names in the .com and .net domains can now be registered with many different competing registrars. Go to http://www.internic.net for detailed information. Domain Name: SILICONREPUBLIC.COM Registrar: TUCOWS.COM CO. Whois Server: whois.tucows.com Referral URL: http://domainhelp.opensrs.net Name Server: NS0.TIBUS.NET Name Server: NS1.TIBUS.NET Name Server: NS2.TIBUS.NET Status: ok Updated Date: 22-jul-2011 Creation Date:"
Page/site usually provided by a registrar to answer common queries by/about it's registrant's domains.
For example: "domainhelp.opensrs.net"
Company with which a domain was registered
For example: "OpenSRS"
Whether a domain is available or not
For example: ""taken"|"free""
Timestamp of last update to this whois record
For example: "22-jul-2011"
Example
{"address_city":"Paris","address_country":"France","address_postal_code":"12345","address_street1":"15 place de la Nation","address_street2":"District 9","address_street3":"Manhattan","checked":"nametoolkit.com","created":["15-jul-1999"],"dateExpires":"2018-7-15","descr":"sample value","domain":"nametoolkit.com","email":"customerservice@nametoolkit.com","expiration_date":"15-jul-2018","fax":"+33.143730576","name":"Parsity Ltd.","name_server":"[
\"a.dns.gandi.net\"
\"b.dns.gandi.net\"
\"c.dns.gandi.net\"
]","phone":"+442.890424190","raw":"Whois Server Version 2.0
Domain names in the .com and .net domains can now be registered
with many different competing registrars. Go to http://www.internic.net
for detailed information.
Domain Name: SILICONREPUBLIC.COM
Registrar: TUCOWS.COM CO.
Whois Server: whois.tucows.com
Referral URL: http://domainhelp.opensrs.net
Name Server: NS0.TIBUS.NET
Name Server: NS1.TIBUS.NET
Name Server: NS2.TIBUS.NET
Status: ok
Updated Date: 22-jul-2011
Creation Date:","referral_domain":"domainhelp.opensrs.net","registrar":"OpenSRS","status":"\"taken\"|\"free\"","updated":"22-jul-2011"}
JSON (Learn how)
GET http://mapi.nametoolkit.com/whois?search=A-VALUE
- The required parameters have a yellow background, while the optional are gray
- Authentication: Request a valid _token before making the API call. Learn how.
Get domain suggestions (GET)
Get a list of domain name suggestions
Parameters
A word or phrase that should be in the domain. Results differ depending on algorithm used.
For example: "/suggest?q=app"
Algo used to generate the results. Examples below are for ?q=app adjectives - Prepends adjectives e.g. fastapp thesaurus - e.g. appliction phoneme - Replace parts of words with similar alternate spellings that sound similar. rhyming - Similar to phoneme, soundex hyphenate - Hyphens between words pluralise - Add s to words, no irregular plurals handled. reverse-hyphenate - Reverse the word sequence, hyphenate reverse - Reverse the word ngrams - Use bigrams that match the search
For example: "/suggest?q=app&type=animals"
length|alpha|relevance|similarity
For example: "/suggest?q=app&sort=length"
Whether to hide or show taken domains 0|1 - Default is 0
For example: "/suggest?q=app&hide_taken=1"
Results
algoCounts
Count of results generated by different algorithms, useful for fine-tuning which type of results you want.
Example algo, appends generic animal names in English to words. e.g. "mash" might return mashape.com using the animals algo ;)
For example: "20"
Whether to show taken domains or hide them. Defaults to 0
For example: "/whois?q=mashape.com&hide_taken=1"
Search term used
Sort used
suggestions
This result field has no description
Levenshtein distance from search term
Algo used to generate result
Domain without TLD
Search term
Domain with TLD
Whether domain is taken
Top level Domain
For example: "com|net"
Algo used to generate result
For example: "animals|thesaurus etc."
Example
{"algoCounts":{"animals":"20"},"hide_taken":/whois?q=mashape.com&hide_taken=1,"search":"sample value","sort":"sample value","suggestions":[{"lev":123,"source":"sample value","root":"sample value","phrase":"sample value","domain":"sample value","taken":true,"tld":"com|net"}],"type":"animals|thesaurus etc."}