GetResearchResults REST Input Reference

The XML output returned by the REST API Interface is identical to the XML Output Schema.

Field	Description	Expected Value	Equivilant XML Field
call_name *	The name of the call you're trying to make.	string	-
version	The version of the call you're schema is based upon.	integer	Version
token *	The Developer Token used to authenticate the call.	string	RequesterCredentials.Token
usr_tok *	The User Token used to authenticate the call.	string	RequesterCredentials.UserToken
dev_name *	The Developer Name used to authenticate the call.	string	RequesterCredentials.DeveloperName
keywords	The keywords you're searching for.	string	SearchQuery.Keywords
end_price_floor	The lowest end price for listings in the result set.	float	SearchQuery.PriceFloor
end_price_ceiling	The highest end price for listings in the result set.	float	SearchQuery.PriceCeiling
start_price_floor	The lowest start price for listings in the result set.	float	SearchQuery.StartPriceFloor
start_price_ceiling	The highest start price for listings in the result set.	float	SearchQuery.StartPriceCeiling
category_id	The category to search.	integer	CategoryLimit.CategoryID
start_date	The day to start searching. When combined with an end_date tag, will search from this day to the end_date. When combined with a date_range tag, will search from this day forward through the range.	date	Dates.StartDate
end_date	The day to finish searching. When combined with a start_date tag, will search from the start_date to this day. When combined with a date_range tag, will search from this day backward through the range.	date	Dates.EndDate
date_range	The date range to search. When combined with a start_date tag, will search from the start_date forward. When combined with an end_date tag, will search from the end_date backwards. When no other tags are included, searches from the most recent day in the system backwards through the range.	date range	Dates.DateRange
date	An individual date to search. You may pass an array of these values to search multiple specific days. Date tags may not be combined with start_date, end_date, or date_range tags.	date	Dates.Date
listing_limit	If included, the search will stop after finding this many listings.	integer	SearchQuery.ListingLimit
return_hourly	Returns hourly statistics (Returned by default if no return tags are specified)	boolean	ResultSet.ReturnHourlyData
return_pricing	Returns pricing statistics (Returned by default if no return tags are specified)	boolean	ResultSet.ReturnPricingInformation
return_features	Returns listing promotion statistics (Returned by default if no return tags are specified)	boolean	ResultSet.ReturnFeatureInformation
return_durations	Returns duration statistics (Returned by default if no return tags are specified)	boolean	ResultSet.ReturnDurationData
return_types	Returns listing type statistics (Returned by default if no return tags are specified)	boolean	ResultSet.ReturnListingTypes
return_price_buckets	Returns price bucket statistics (Returned by default if no return tags are specified)	boolean	ResultSet.ReturnPriceBuckets
return_daily	Returns daily statistics	boolean	ResultSet.ReturnDailyData
return_categories	Returns category breakdowns	boolean	ResultSet.ReturnCategoryInformation
return_items	Returns sample items	boolean	ResultSet.ReturnItemList
return_all	Returns all statistics	boolean	-

* Required Fields