Domain Suggestion API

Domain Suggestion API is a name spinning API that gives you available gTLDs for a given name. You submit via the API a name or domain and the API retrieves you close match alternatives of domain names that are still available for registration under ".com" and other gTLDs.

Parameters of the Domain Suggestion API

Name required? Description Default Authorized Example
rows no Number of rows returned 20 [20-100] rows=30
bh no This will exclude domains with hyphens or allow them.
  • 'c' : with and without hyphen
  • 'n' & 'a' : banned hyphen
  • 'y' & 'b' : allowed hyphen
n n, y, a, b, c bh=a
bn no This will exclude domains with numbers or allow them. n n, y bn=y
bc no
n n, y, [2-65] bc=33
left no
n n, y left=
right no
n n, y right=
ordered no
n n, y ordered=
page no
n n, y page=
pool no
n n, y pool=
exactfirst no
n n, y exactfirst=y
intellisearch no
n n, y intellisearch=y
f7 no
n n, y f7=y
ext no Populated the ext variable with all extensions that should be returned in the results. com, net, org, info, biz, us com, net, org, info, biz, us ext=
time no This value is the index back into the session of the current search. 00-00 00-00 time=14-03

Response groups of the Domain Suggestion API

Name Description
extn Returns extensions that got accepted in the EXT variable
page_min Minimum Page Number
page_max Maximum Page Number
page_extreme Highest Page Possible
page_current Current Page Number
record_min Start Number
record_max Ending Number
record_extreme Highest Possible Record Number
records_returned Records in the display
time This value is the index back into the session of the current search
s Current Status for each EXTN p = registered (parked) w = registered (has website) x = registered (no website/has dns) h = registered (on-hold, generic) d = available (deleted, had previous owner) q = available (never registered) e = registered (on-hold, five day pendingdelete) g = registered (on-hold, 30 day graceperiod)
n The name part of the domain in this envelope.

Example of the Domain Suggestion API

JSON

Request

Show/Hidden apache code

View source
 
 
  GET /encrypted-area HTTP/1.1
  Host: api.domainapi.com/v1/search_engine/example.com
  Authorization: Basic YWtpcmF0ZXN0OmR0d3N0ZXN0
 
Response

Show/Hidden apache code

View source
 
 
  Server: Apache-Coyote/1.1
  Content-Type: application/json
  Transfer-Encoding: chunked
  Date: Tue, 03 Feb 2009 15:09:07 GMT
 


Show/Hidden javascript code
View source
 
 
  {
    "service":"search_engine",
    "domain":"example.com",
    "timestamp":1247469723,
    "content":
      {  
        "info":
          {  
          "record_min":"1",
          "record_max":"20",
          "page_extreme":"789",
          "record_extreme":"15773",
          "page_max":"150",
          "extn":"COM|NET|ORG|INFO|BIZ|US",
          "dList":
            [
              {
                "id":"1",
                "s":"hnnnnn",  
                "n":"01234areexamplesof"
              },
              {
                "id":"2",
                "s":"hnnnnn",
                "n":"01example"
              },
              {
                "id":"3",
                "s":"hnnnnn",
                "n":"06example"
              },
              {
                "id":"4",
                "s":"hnnnnn",
                "n":"0example"
              },
              {
                "id":"5",  
                "s":"hnnnnn",
                "n":"0examples"
              },
              {
                ...
              }
            ],
          "records_returned":"20",
          "phase1":"0.014407",
          "page_min":"1",
          "time":"20090713002203-27",
          "phase2":"0.0001",
          "page_current":"1",
          "options":"4"
          }
      }
  }
 

XML

Request

Show/Hidden apache code

View source
 
 
  GET /encrypted-area HTTP/1.1
  Host: api.domainapi.com/v1/whois/xml/example.com
  Authorization: Basic YWtpcmF0ZXN0OmR0d3N0ZXN0
 
Response

Show/Hidden xml code

View source
 
 
  <response>
    <service>search_engine</service>
    <domain>example.com</domain>
    <timestamp>1247471361</timestamp>
    <content>
      <info>
        <record_min>1</record_min>
        <record_max>20</record_max>
        <page_extreme>789</page_extreme>
        <record_extreme>15773</record_extreme>
        <page_max>150</page_max>
        <extn>COM|NET|ORG|INFO|BIZ|US</extn>
        <dList>
          <d>
            <id>1</id>
            <s>hnnnnn</s>
            <n>01234areexamplesof</n>
          </d>
          <d>
            <id>2</id>
            <s>hnnnnn</s>
            <n>01example</n>
          </d>
          <d>
            <id>3</id>
            <s>hnnnnn</s>
            <n>06example</n>
          </d>
          <d>
            <id>4</id>
            <s>hnnnnn</s>
            <n>0example</n>
          </d>
        </dList>
        <records_returned>20</records_returned>
        <phase1>0.004667</phase1>
        <page_min>1</page_min>
        <time>20090713004921-141</time>
        <phase2>0.0001</phase2>
        <page_current>1</page_current>
        <options>4</options>
      </info>
    </content>
  </response>
 

Additional information