/Items GET

Returns search results as a Item List Response for active items with given search parameters.

URL
/Items
Verb
GET

Common GunBroker.com Searches

Auctions Only:
/items?keywords=yourkeywords&MinStartingBid=0.01

BuyNow Only:
/items?keywords=yourkeywords&BuyNowOnly=true

Big Ticket:
/items?MinPrice=10000

Headers

Header Data Type Valid Values Required Description
Content-Type string application/json YES The format your data will be sent to our site.
X-DevKey string string YES The devkey assigned to the developer.
X-AccessToken string string Optional The token acquired from a POST to Users/AccessToken.

Input

NOTE: Variables to place in the body of the request.

Parameter Data Type Valid Values Description
BuyNowOnly boolean true/false Returns only BuyNow auctions if set to true.
Categories string Comma-separated list of valid category ids Ex: Categories=3024,3026
Condition integer 0 - All Conditions

1 - New Items Only

2 - New and New Old Stock Items

3 - Used and New Old Stock Items

4 - Used Items Only

5 - New Old Stock Items Only

6 - New and Used Items
The condition an item is in.
Country string 2 character The ISO 2 character country code to search on. EX: Country=US for United States
CanOffer boolean true/false Returns Items that accept offers if set to true. Returns Items that do not accept offers if set to false
EligibleForImmediateCheckout boolean true/false Whether or not this item can be purchased with a credit card immediately.
Exclude string string Words or phrases that will be excluded from the search
FeaturedListing boolean true/false Return Featured auctions if set to true. Return auctions without Featured if set to false
FixedPriceOnly boolean true/false Returns only fixed price items if set to true.
HasPictures boolean true/false Return auctions with pictures if set to true. Return auctions without pictures if set to false
IncludeSellers string Comma-separated seller user ids List of seller items to search for. Ex: IncludeSellers=1234,5678
ItemIDList string Comma-separated item ids List of item ids to search for. Ex: ItemIdList=173423,8278972
Keywords string Keywords for search The keywords to use for search
KeywordOperator integer 0 - All Terms

1 - Any Term

2 - Exact Match
Whether to search by All Terms, Any Terms or Exact Match
MaxBidCount integer positive # The maximum number of bids an item can have.
MinBidCount integer positive # The minimum number of bids an item can have.
MaxStartingBid decimal positive # The maximum starting bid an item can have.
MinStartingBid decimal positive # The minimum starting bid an item can have.
NoReserveItems boolean true/false Return items without a reserve price if set to true. The parameter is ignored if set to false.
SearchType integer 0 - Search by title

1 - Search by Title and Description
Search by title or title and description. Default = 0 - Search by title.
SellerName string string Username of the seller you want to look for.
SellingStatus integer 0 - Both

1 - Selling

2 - Not Selling
Search for items that are selling or items that are not selling. Default = 0 - Both.
NOTE: You must pass an AccessToken to use this filter.
NOTE: You must pass a SellerName to filter on.
SKU string SKU for search The SKU to use for search
Sort integer 0 - Shortest time left Asc

1 - Longest time left Desc

2 - Item number Asc

3 - Item number Desc

4 - Item price Asc

5 - Item price Desc

6 - Starting date Asc

7 - Starting date Desc

8 - Bid count Asc

9 - Bid count Desc

10 - Quantity Asc

11 - Quantity Desc

12 - Relevance

13 - Feature and Relevance
The order in which the results are returned. Default = 13 - Feature and Relevance
SponsoredListing integer bitwise enumeration Allows searching for items that are viewable on one or more sponsored sites using a bitwise sum
SponsoredOnsiteListing boolean true/false Allow searching for items that have been sponsored on GunBroker.com.
State string 2 character The USPS 2 character state abbreivation.
Timeframe integer 0 - View Current

3 - View Going Going Gone

4 - View New Calendar Today

5 - View Ending Calendar Today

6 - View New Last 24

7 - View New Last 48

16 - View Ending Next 24
Using this parameter requires a valid X-AccessToken authentication header. This sets the time frame to search for. Default = 0 - View Current.
UPC string string UPC you would like to search for.
WillShipInternational boolean true/false Return items that are available to ship out of the country. Return items that are not available to ship out of the country
PageOrder integer integer 0 - According to Sort Order
1 - Random

Optional PagingParameters

Output

If the search parameters are not valid, you will receive a 400 BadRequest and a Message Response indicating the reason.

If there are no errors with the input parameters, this call will respond with a 200 OK and the following data as serialized JSON

Parameter Data Type Valid Values Description
ItemID integer positive # id belonging to item
Bids integer positive # Number of bids the item has.
BuyNowPrice decimal positive # The "Buy Now" price for an item, if applicable. Will be 0 if a "Buy Now" price is not set
CanOffer boolean true/false Does the Item accept Offers?
EligibleForImmediateCheckout boolean true/false Whether or not this item can be purchased with a credit card immediately.
FreeShippingAvailable boolean true/false Whether or not the item can potentially have free shipping available
EndingDate datetime Valid ISO 8601 DateTime format The ending date time of the item in UTC.
HasColor boolean true/false Whether or not this item has the paid Colored Title feature.
HasPictures boolean true/false Does the item have pictures?
HasReserve boolean true/false Does the item have reserve price?
HasReserveBeenMet boolean true/false Has the reserved been meet on this item?
HasBuyNow boolean true/false Does the item have a buy now?
HighBidderID integer positive # The user id of the high bidder.
IsFeaturedItem boolean true/false Is this item featured?
IsFixedPrice boolean true/false Is this item a fixed price item?
IsShowCaseItem boolean true/false Whether or not this item has the paid Showcase Listing feature.
IsHighlighted boolean true/false Whether or not this item has the paid Highlight feature.
IsTitleBoldface boolean true/false Whether or not this item has the paid Boldface Title feature.
Price decimal positive # The current cost of an item.
BuyPrice decimal positive # Purchase Price
BidPrice decimal positive # Current Bid Price
Quantity integer positive # The number of items for sale for this item.
RelistedAsItemID integer positive # The item ID for the item this item was relisted as.
SerialNumber string string The serial number of the item
Seller User Summary User Summary The User Summary for the item.
SKU string string The SKU of the item.
SponsoredListing integer bitwise enumeration A bitwise sum representing the sponsored sites on which the item is visible
SubTitle string string The subtitle of an item.
ThumbnailURL string A fully qualified url to an image file The location of the image file to be used as the thumbnail for the item.
Title string string The title of the item.
TitleColor string Valid hex color strings (ex: #000000) The color of the item title. If the paid feature isn't available, black (#000000) will be returned.
SponsoredOnsiteListing boolean true/false Whether the item is Sponsored on GunBroker.com.

Links

Rel Description Condition
self The item details