BidSlammer API
White label BidSlammer - Purchase a software license to white label BidSlammer under your own website name, and earn commissions. Customize your own style sheet. Registration fee for this service is $99.00 USD which covers set-up. Click to read more about white label. The API accepts requests via standard HTTP GET, and can respond with XML.
Send requests to the following URL: http://api.bidslammer.com/api/1/index.php
Required parameters
The following parameters are required with every request to the API.userid
Every account has its own unique alphanumeric ID (for example, 'bidslammer99'. Your request must include the site's ID that you want to access data from.sitekey
Available from your site preferences tab. The sitekey is a 12-16 character string of random letters and numbers that is unique for every web site and is assigned when you first register your web site with us. Because you don't "log in" to the API like you would to a normal web site, every request must be authenticated by your sitekey. Available from your site preferences page.type
The type of data you want. Note that some data types are only available with a premium account.action
The action you are taking (create, get, delete, update). Please note that the delete action also requires usage of the "delete=1" parameter, to avoid human error.Example requests
Query snipes from January through March 2010:
http://api.bidslammer.com/api/1/?userid=bidslammer&auth=abcd1234&type=snipe&action=get&start_date=2010-01-01&end_date=2010-03-01
http://api.bidslammer.com/api/1/?userid=bidslammer&auth=abcd1234&type=snipe&action=set&item_no=1234567890&bid=5.00
http://api.bidslammer.com/api/1/?userid=bidslammer&auth=abcd1234&type=snipe&action=set&item_no=1234567890&bid=5.00&group_name=testgroup
Note - this call requires a "delete=1" on the end for security reasons
http://api.bidslammer.com/api/1/?userid=bidslammer&auth=abcd1234&type=snipe&action=delete&item_no=1234567890&delete=1
Optional parameters
The following parameters are optional. If a parameter is not included in your request, or the value specificied is invalid, the default value will be used automatically.limit
The maximum number of results that will be returned. If you are requesting multiple types and/or "daily" values, this limit will apply to each group of data, not the overall set.Default value: 10
Accepted values: Any number between 1 and 1000, or "all" for "no limit". "all" is actually limited to 10,000 results, because of memory limitations. This means for high traffic sites, visitors-list and actions-list will probably be incomplete if you are requesting more than a single date. It is recommended that high traffic sites only request a single day at a time for these two data types.
date
The date (or date range) you want to access. If you give an invalid date or date range (range too large, end is before start, etc), we'll automatically use "today" instead.Default value: today (in date format)
Accepted values:
- YYYY-MM-DD - for a specific date, e.g. 2010-11-21
- YYYY-MM-DD,YYYY-MM-DD - for a specific date range, e.g. 2010-10-01,2010-10-31
- nnn - offset - return values ending within nnn hours.
item_no
eBay item number.Responses
You will always receive a response to all requests. The response will be simple XML. We have given some 3-line code PHP parsing examples below.- title - the name, title or description of the item
- bid - the amount bid on the item (0 if watch item)
- cost - the item's value (typically, the number of occurences)
- item_url - a URL of the item itself, if applicable (pages, incoming links, outbound links, etc)
- ends - the item's value as a percent of the total values of all other items in the same category
- group_name - (optional) name of the group the snipe is in (for bid groups only)
- snipePlacedAt1 - the exact time the snipe was placed (YYYY-MM-DD MM:HH:SS)
- snipePlacedAt2 - the exact time the snipe was placed (YYYY-MM-DD MM:HH:SS)
- thumbnail_url - a 50x50 image of the URL. (You may host this URL from your site)
Sample Responses
http://api.bidslammer.com/api/1/?userid=bidslammer&auth=abcd1234&type=snipe&action=set&item_no=1234567890&bid=5.00&group_name=testgroup
1234567890
324.34
235
232.32
EUR
2010-12-23 23:23:11
Star Wars Lego
2010-12-23 23:23:06
2010-12-23 23:23:18
Luke Skywalker Jedi Knight official Lego set
http://cgi.ebay.com/?ViewItem&item_id=12345678890&_sample=default&mkw=true>
http://p1.bidslammer.com/images/thumbnails/1234567890.jpg
Response for addition of a snipe on item 1234567890 for 123 EUR (includes item data)
http://api.bidslammer.com/api/1/?userid=bidslammer&auth=abcd1234&type=snipe&action=set&item_no=1234567890&bid=5.00&group_name=testgroup
1234567890
324.34
235
123.00
EUR
2010-12-23 23:23:11
Star Wars Lego
OK
Luke Skywalker Jedi Knight official Lego set
http://cgi.ebay.com/?ViewItem&item_id=12345678890&_sample=default&mkw=true>
http://p1.bidslammer.com/images/thumbnails/1234567890.jpg
