API

  1. Dashboard
  2. Tools
  3. API

API

The EstiBot API allows you to programatically query our system to obtain domain name information in a normalized JSON format.

The API is available to Expert customers only. Queries made to the API are treated the same way as queries executed on the web site and will result in your query counters being incremented.

The following tools currently support API queries:

Need to access to more data such as whois, word parsing, trademark analysis or over 100 API calls? Check out our sister sites DomainPlex for enterprise API services or domainIQ.com for whois API services.

Example Queries

The section below provides example queries as well as the expected JSON responses. If you are logged in your API key is automatically populated in the examples below.

Standard Request Format

A request must have the following components in order to be valid:

Optional query parameters:

A sample API query to appraise the domain "test.com" with your API key (if you are logged in) is provided below:

Standard Response Format

All query responses will result in a JSON response object that follows an identical format. The response object format is provided below:

  • success - True/False status code indicating if the query succeeded or failed. True indicate query succeeded and False indicates query failed.
  • message - Error message if the query failed. Blank/NULL if query did not fail.
  • results - Object containing a summary of the results as well as the results.
  • results.cache - Boolean indicating whether this was a cached query.
  • results.bulk - Boolean indicating whether this was a bulk query (bulk is defined as >1 items).
  • results.item_count - Total number of results in the results.data object.
  • results.result_count - Total number of results in the results.data object.
  • results.data - Object array containing the results.
  • results.not_found - Object array containing a list of items not found in the cache (when query type is cache and there were domains that did not exist in cache). For example, if you appraised a019294858.com and specified cache mode only and if this domain is not in cache it would be in this array.

Sample JSON response to the above referenced appraise API call (with JSON parsed):

Live VS Cache Queries

Some tools allow you to specify whether you would like to perform a live lookup or a cached lookup using the t URL parameter.

The appraisal tool is one of the tools that supports the cache feature.

For example, a live appraisal lookup will force a refresh of all data points related to a domain and perform a new appraisal. This is a fairly time consuming process and may take up to 3 seconds per domain. A cache query would pull the most recent cached appraisal from the database and return it usually in less than 150ms. This makes a big difference when querying multiple domains since a batch query of 200 domains can take 5 minutes in live mode or 2 seconds in cache mode.

To ensure the fastest response time we recommend performing a cache lookup first, and any domains which are not found in the cache database (these are returned in the results as results.not_found array) can be looked up using the live system.

Appraise API Call

The appraise API call performs a domain appraisal and returns approximately 100 data points for every domain name queried.

Please observe the following restrictions when performing API based appraisal calls:

Appraise "test.com" using "auto" mode (auto mode will use cached data if its available and less than 30 days old or live mode if not):

Appraise "test.com" using "cache" mode. Checks recent cached for appraisal data and returns it. If the domain doesn't exist in the cache it will not be returned.

Appraise "test.com" using "live" mode. Forces live appraisal of a domain. This method is significantly slower than the cache method because all data points are refreshed.

Appraise "test.com" and "great.com" using "cache" mode. Checks recent cached for appraisal data and returns it. If the domain doesn't exist in the cache it will not be returned.

The recommended action for performing batch queries is to appraise everything in cache mode and any domain that is not found (it will be returned in the results.not_found array) should be looked up a second time in the live system.

Lead API Call

The lead API call generates a set of end-user leads for a particular domain or keyword and returns the data along with analytics.

Please observe the following restrictions when performing API based lead generation calls:

Generate leads for "estibot.com":

Generate leads for the keyword "fast cars" and domain "fastcars.com" (both must be specified):

Drops API Call

The drops API call allows you to download drop lists programmatically.

Please observe the following restrictions when performing API based lead generation calls:

Please note that the response is always a JSON object containing a URL to the CSV file (compressed) generated by the system.

Get most recent "raw_pendingdelete" file:

Get the AVAILABLE domain list (appraisals only) from 2 days ago:

Get the AVAILABLE domain list (complete with analytics) from 2 days ago:

Get the NAMEJET PRE-RELEASE domain list (complete with analytics) from 2 days ago:

Get the PENDINGDELETE domain list (complete with analytics) from 2 days ago:

  API - Integrate our data into your tools using EstiBot's powerful API.