GetResearchItems Input Field Reference

Click on the fields below to view a detailed description and example input.

Call Specific Fields
Field	Type	Summary	Req.
GetResearchItems.Version	integer	The API Schema Version you wish to send and recieve results in.	no
GetResearchItems.RequesterCredentials		Contains the authorization keys required for every call.	yes
...RequesterCredentials.Token	string	One of three required authorization keys that must be included with every call.	yes
...RequesterCredentials.UserToken	string	One of three required authorization keys that must be included with every call.	yes
...RequesterCredentials.DeveloperName	string	One of three required authorization keys that must be included with every call.	yes
GetResearchItems.SearchQuery		Contains all the parameters of the search	yes
...SearchQuery.Keywords	string	The keyword or keywords you are searching for.	yes
...SearchQuery.Pricing		Defines start and end price filters for resulting auctions.	no
...Pricing.EndPriceFloor	float	The lowest closing price for items you want to research.	no
...Pricing.EndPriceCeiling	float	The lowest closing price for items you want to research.	no
...Pricing.StartPriceFloor	float	The lowest starting price for items you want to research.	no
...Pricing.StartPriceCeiling	float	The highest starting price for items you want to research.	no
...SearchQuery.CategoryLimit		This node contains CategoryIDs to be searched.	no
...CategoryLimit.CategoryID	integer	The category in which to search for results.	no
...SearchQuery.Dates		Contains the date range for your search.	no
...Dates.StartDate	date	The first date in the range of dates that you are searching.	no
...Dates.EndDate	date	The last date in the range of dates that you are searching.	no
...Dates.DateRange	date range	Used to specific the number of days to search.	no
...Dates.Date	date	A single date you wish to search. You may include multiple instances of this tag.	no
...SearchQuery.Hours		Filters the search to only those listings that closed during certain hours of the day.	no
...Hours.StartHour	integer	Forms the range of hours that will be included in the search.	no
...Hours.EndHour	integer	Forms the range of hours that will be included in the search.	no
...Hours.Hour	integer	A single hour that will be searched for in the result set.	no
...SearchQuery.DurationFilter	integer	Filters the results based on the duration of the auction.	no
...SearchQuery.ListingFilters		This node contains filters for the search based on various listing promotions.	no
...ListingFilters.BuyItNow	boolean	Return only listings that used the Buy It Now feature.	no
...ListingFilters.Successful	boolean	Return only listings that were successful.	no
...ListingFilters.Bold	boolean	Return only listings that used the Bold feature.	no
...ListingFilters.FrontPageFeatured	boolean	Return only listings that used the Front-Page Featured feature.	no
...ListingFilters.CategoryFeatured	boolean	Return only listings that used the Category Featured feature.	no
...ListingFilters.GiftIcon	boolean	Return only listings that used the Gift Icon feature.	no
...ListingFilters.Gallery	boolean	Return only listings that used the Gallery feature.	no
...ListingFilters.GalleryFeatured	boolean	Return only listings that used the Gallery Featured feature.	no
...ListingFilters.PictureServices	boolean	Return only listings that used the Picture Services feature.	no
...ListingFilters.Reserve	boolean	Return only listings that used the Reserve Price feature.	no
...ListingFilters.Highlight	boolean	Return only listings that used the Highlight feature.	no
...ListingFilters.Scheduled	boolean	Return only listings that used the Scheduled Auction feature.	no
...ListingFilters.MultiListed	boolean	Return listings that used the Multiple Category feature.	no
...ListingFilters.Subtitle	boolean	Return only listings that used the Subtitle feature.	no
...SearchQuery.ListingTypes		Contains filters for the various types of listings.	no
...ListingTypes.Chinese	boolean	Auctions listed with the Chinese (regular bid) type will be returned.	no
...ListingTypes.Dutch	boolean	Auctions listed with the Dutch (multiple item) type will be returned.	no
...ListingTypes.Live	boolean	Live auctions will be returned.	no
...ListingTypes.Store	boolean	Auctions listed in eBay stores will be returned.	no
...ListingTypes.PersonalOffer	boolean	Auctions sold via a Personal Offer will be returned.	no
...ListingTypes.FixedPrice	boolean	Auctions listed as a Pure Fixed Price auction will be returned.	no
...SearchQuery.SiteID	integer	eBay Site ID to search, assuming you have access.	no
...SearchQuery.Currency	string	Currency to return results in.	no
...SearchQuery.Page		Allows you to sort and paginate results	no
...Page.Order	string	Determines the sorted order of the listings	no
...Page.OrderDir	string	Determines the direction of the sort	no
...Page.Limit	integer	Determines the number of listings returned	no
...Page.Offset	integer	Determines the offset that the returned listings start at	no