Signup Free Login
Try a free snipe now! —>
 FAQ  Help  Testimonials  Screenshots

BidSlammer API Documentation

Our API is for developers or computer-savvy customers. You can use it to create applications, or make shortcuts using your own tools and utilities, such as AppleScript.

You can use the API from any program that can fetch URLs. Manage your snipes in a custom way that you create! For questions of usage or terms for high-volume usage, please contact us.

To access the API, you will need an API key. This is located in your Preferences tab, which you can see in the top navigation bar after you log in. Please note: The API requires a Power Pack upgrade.

Note: This is not a REST API. For simplicity, the API uses GET for all calls, even for update and delete operations.

Special Notice: Make sure to urlencode all values!

justTesting

justTesting is for trying out the API.

parameter type description
key string (required) Your API key.
arg1 string (required) Pass anything in - it will appear in the return data.
arg2 string (optional) Pass anything in - it will appear in the return data.
arg3 string (optional) Pass anything in - it will appear in the return data.

Sample Call

Returns:

{
	"status": "OK",
	"message": "Well, the API seems to be working.",
	"arg1": "Hello, World",
	"arg2": "",
	"arg3": "",
	"version": "1",
	"timestamp": "2020-03-01 21:41:53"
}

addBid

addBid is for adding a snipe bid.

parameter type description
key string (required) Your API key.
item_no integer (required) The item number.
bid float(2) (optional) The bid amount. Default is zero (0.00).
groupName string (optional) (text) The name of the Bid Group to add the snipe to.
delay integer (optional) (integer) The number of seconds of lead time before the snipe is placed. Values can be: Integers of value 1 through 15 only.
enabled boolean (optional) 0 or 1. Turn the snipe on or off.
force boolean (optional) Use 0 or 1 to determine whether to force the bid amount.

Sample Call

Returns:

{
	"bid": "0.01",
	"delay": 7,
	"group_id": 0,
	"groupName": "",
	"item_no": "153847324676",
	"status": "OK",
	"alert": "success",
	"short_message": "Bid added for 0.01.",
	"message": "You successfully added a snipe for 0.01 on eBay item #153847324676.",
	"message_color": "green",
	"new_snipe": true
}

deleteBid

deleteBid will delete a snipe entirely from the system (if you own the snipe).

parameter type description
key string (required) Your API key.
item_no integer (required) The item number.

Sample Call


addSearch

addSearch adds a search to your "Saved Searches" list.

parameter type description
key string (required) Your API key.
query string (required) The query to add. Max 255 characters.

Sample Call


deleteSearch

deleteSearch deletes a search from your "Saved Searches" list.

parameter type description
key string (required) Your API key.
id integer (required) The id number of the query. (To get the id number, call getUserSearches.

Sample Call


fetchItem

fetchItempulls the latest details for an eBay item. (The item must be in your account; you can't use this call to scrape eBay listings.)

parameter type description
key string (required) Your API key.
item_no integer (required) The item number.

Sample Call

Returns:

{
	"status": "OK",
	"alert": "success",
	"bids": 0,
	"cost": 9.99,
	"ends": "2020-03-05 09:03:08",
	"eBayItemId": 153847324676,
	"currentPrice": 9.99,
	"currency": "USD",
	"country": "US",
	"sellerPercent": 100,
	"sellerScore": 0,
	"sellerUserId": "chinese*food*is*good",
	"shippingType": "Calculated",
	"startTime": "2020-02-27 09:03:08",
	"timeLeft": "8h 8m ",
	"category": "Everything Else:Test Category For Internal Use Only Parent Level 2:General",
	"endTime": "2020-03-05 09:03:08",
	"pictureURL": "https:\/\/i.ebayimg.com\/00\/s\/NDgwWDY0MA==\/z\/nicAAOSwi5xeMhKl\/$_12.JPG?set_id=880000500F",
	"title": "Coconut Lime Verbena Pineapple Cilantro Two Wicked 16oz ",
	"images": [
		"https:\/\/i.ebayimg.com\/00\/s\/NDgwWDY0MA==\/z\/nicAAOSwi5xeMhKl\/$_12.JPG?set_id=880000500F",
		"https:\/\/i.ebayimg.com\/00\/s\/NDgwWDY0MA==\/z\/wq0AAOSwUMpeMhK1\/$_12.JPG?set_id=880000500F",
		"https:\/\/i.ebayimg.com\/00\/s\/NDgwWDY0MA==\/z\/bBQAAOSwPMpeMhK2\/$_12.JPG?set_id=880000500F",
		"https:\/\/i.ebayimg.com\/00\/s\/NDgwWDY0MA==\/z\/XbIAAOSwepleMhK2\/$_12.JPG?set_id=880000500F",
		"https:\/\/i.ebayimg.com\/00\/s\/NDgwWDY0MA==\/z\/PjYAAOSwmoheMhK3\/$_12.JPG?set_id=880000500F",
		"https:\/\/i.ebayimg.com\/00\/s\/NDgwWDY0MA==\/z\/EgsAAOSwW1NeMhK4\/$_12.JPG?set_id=880000500F",
		"https:\/\/i.ebayimg.com\/00\/s\/NDgwWDY0MA==\/z\/CLoAAOSw1T1eMhK5\/$_12.JPG?set_id=880000500F"
	],
	"message": ""
}

checkSnipeStatus

checkSnipeStatus will give win/loss status of the item. If a loss, will give the reason. If the snipe has not executed, it will return a status of "Pending."

parameter type description
item_no integer (required) The item number.

Sample Call

Returns:

{
"bidResult": {
	"success": -7,
	"status": "Minimum Bid Increment Not Met",
	"message": "You did not meet the minimum bid increment for this item.",
	"shorthand": "bid-incr",
	"color": "red"
},
"item_info": {
	[same as fetchItem call]
}
}

getSearchResults

getSearchResults will return search results (up to 100 items) from eBay for a given query.

parameter type description
key string (required) Your API key.
country_code string (optional) 2-letter country code. Default is US. Examples: US GB AU DE ...
query string (required) The search query.

Sample Call


getUserItems

getUserItems returns a list of user snipes with all parameters.

parameter type description
key string (required) Your API key.
filter string (required) The list of items you want. Values are:
"watched" - for watch list (bid = 0)
"current" - for pending (current) snipes
"completed" - for recently completed snipes
"archive" - for archived snipes (older than 60 days)
orderby string (optional) The field to order by. Values are (ends|bids)
dir string (optional) The order to return the values. Values are (ASC | DESC).
offset integer (optional) The number of records to skip over in the returned list.
limit integer (optional) Number of records to limit to. Max = 20.
show_won boolean (optional) 0 or 1. Whether or not to include "won" items in the returned list.

Sample Call


getUserSearches

getUserSearches returns your list of "Saved Searches."

parameter type description
key string (required) Your API key.

Sample Call


importWatchList

importWatchList imports your Watch List from eBay. Note: Can take up to a minute or more!

parameter type description
key string (required) Your API key.

getBidHistoryDataset

getBidHistoryDataset gives you a dataset for the bidding history of an item that can be fed directly into Chart.js or QuickChart.io. A second dataset is added that is a horizontal line representing your current snipe value.

parameter type description
key string (required) Your API key.
item_no integer (required) The item number.

Sample Call


Returns:

[
  {
    "backgroundColor": "#0099c6",
    "borderColor": "#0099c6",
    "borderWidth": 0.25,
    "fill": false,
    "label": "LEGO Star Wars: Ewok Village (10236)",
    "data": [
      {
        "x": 1714944227000,
        "y": 600
      },
      {
        "x": 1715048287000,
        "y": 600
      }
    ],
    "pointRadius": 4,
    "pointHoverRadius": 12,
    "pointHoverBackgroundColor": "#0099c6",
    "showLine": true
  },
  {
    "borderCapStyle": "round",
    "borderColor": "#0099c6",
    "borderDash": [
      10,
      5
    ],
    "borderWidth": 2,
    "lineTension": 5,
    "data": [
      {
        "x": 1714653979000,
        "y": 600
      },
      {
        "x": 1715084265000,
        "y": 600
      }
    ],
    "fill": false,
    "label": "Your snipe of 5.00",
    "pointRadius": 1,
    "showLine": true
  }
]

Join Now for Free!   Start winning items today.