QUERY FORMAT:http://engine.whoisapi.com/api.xml? <-- base URL as provided by your account representative appname=marketplace & version=2 & partner=partnername & key=XXXXX-XXXXX-XXXXX-XXXXX-XXXXX & customer_ip=000.000.000.000 & <-- The IP of the customer requesting the lookup. This prevents abuse. ext=COM|NET|ORG|INFO|BIZ|US & <-- Selection of TLDs to request, separated by pipes. provider=1000 & <-- Binary->Integer of provider (see notes) q=query terms & <-- Terms of the query maxprice=10000 & <-- Maximum price of items to return minprice=0 & <-- Minimum price of items to return wordindex=1 & <-- Search on word boundary rows=50 & <-- Number of results to return bh=n & <-- Block hyphens bn=n & <-- Block numbers bc=25 & <-- Block domains where length is greater than value, set to 'n' to block none adult=y & <-- Allow (y) or Filter (n) adult words. pool=C & <-- C = All domains (default), B = Deleted, A = active left=n & <-- Anchor the left-most word to the left right=n & <-- Anchor the left-most word to the right ordered=n & <-- Words contained in domains will return in the same order as the query string f7=n & <-- Spell check query prior to execution (beta) exactfirst=n & <-- Put exact match on top if foundNotes:
PROVIDERS/PARTNERS: The following providers are available to query: 1 : Sedo 2 : Afternic 4 : BuyDomains 8 : GoDaddy 16 : Fabulous You can provide a single provider in your request key, or you can add the numeric values of each provider together to do a batch request. Responses work similarly, where the "partner" value returned for the domain is the combined value of each site it is listed on, regardless of the providers you specify in the request. These values correlate to their binary value, where each service takes up a bit. The number 00101 (binary, equals 5 in decimal notation) enables Sedo and BuyDomains, for instance. Each "flipped on" bit in the binary formatted number shows the enabled or disabled service. Keep in mind, binary numbers are ready right to left, with the first numeric place from the right being equal to 1. Binary values are always passed and returned in decimal notation.
EXAMPLE QUERY: /api.xml/api.xml?partner=partnername&customer_ip=255.255.255.0&key=XXXXX-XXXXX-XXXXX-XXXXX-XXXXX&appname=marketplace&ext=COM|NET|ORG|INFO|BIZ|US&version=2 &q=destination&maxprice=1999&wordindex=2&minprice=1&rows=5&bh=n&bn=n&bc=25&adult=y&pool=C&fill=n&left=n&right=n&ordered=n&f7=n&exactfirst=y&provider=0 EXAMPLE RESPONSE
<?xml version="1.0" encoding="utf-8" ?> <whoisapi> <application> <appname>marketplace</appname> <version>2</version> <partner>partnername</partner> <key>XXXXX-XXXXX-XXXXX-XXXXX-XXXXX</key> <customer_ip>255.255.255.0</customer_ip> <engine></engine> <spork>burns</spork> </application> <request> <q>destination</q> <rows>5</rows> <bn>y</bn> <bh>B</bh> <bc>20</bc> <f7>n</f7> <left>n</left> <right>n</right> <ordered>n</ordered> <pool>C</pool> <page>1</page> <exactfirst>y</exactfirst> </request> <response> <errlev>nowarnings</errlev> <options>4</options> <time>20080822114954-157</time> <extn>COM|NET|ORG|INFO|BIZ|US</extn> <did_you_mean></did_you_mean> <page_current>1</page_current> <page_min>1</page_min> <page_max>38</page_max> <page_extreme>38</page_extreme> <records_returned>1</records_returned> <record_min>0</record_min> <record_max>0</record_max> <record_extreme>189</record_extreme> <querytime>0.000448</querytime> <d> <id>1</id> <n>SPORTDESTINATION</n> <tld>COM</tld> <dmoz>no</dmoz> <yahoo>no</yahoo> <partner>1</partner> <price>126</price> <starting_price>13</starting_price> </d> <d> <id>2</id> <n>DESTINATIONDESIGNERS</n> <tld>COM</tld> <dmoz>no</dmoz> <yahoo>no</yahoo> <partner>15</partner> <price>1888</price> <starting_price>1888</starting_price> </d> <d> <id>3</id> <n>ASIANDESTINATION</n> <tld>COM</tld> <dmoz>no</dmoz> <yahoo>no</yahoo> <partner>15</partner> <price>888</price> <starting_price>888</starting_price> </d> <d> <id>4</id> <n>BUSINESSDESTINATION</n> <tld>COM</tld> <dmoz>no</dmoz> <yahoo>no</yahoo> <partner>15</partner> <price>688</price> <starting_price>688</starting_price> </d> <d> <id>5</id> <n>DESTINATIONWIRELESS</n> <tld>COM</tld> <dmoz>no</dmoz> <yahoo>no</yahoo> <partner>15</partner> <price>888</price> <starting_price>888</starting_price> </d> </response> </whoisapi> |