United States Products

Endpoint URL: http://api.prosperent.com/api/search
HTTP Method: GET or POST

Common API Examples

Request Parameters
Parameter Name Required Data Type Format/Values (Default in bold) Description
api_key Yes string Key that authorizes access to the data. Log in to view yours.
query Yes (No, if a filter is used) string The search term used for the request.
location Yes string http%3A%2F%2Fmydomain.com%2Fmypage The encoded url from which the API request is made. If this is a mobile app, please use the website of the mobile app.
httpHost No string Same as location
visitor_ip No string IP Address of the visitor viewing your page.
referrer No string http%3A%2F%2Fsearchengine.com%2Fsearch The encoded url from which the traffic came. Refer to the documentation of the programming language you are using for more information on retrieving the referrer url.
userAgent No string User agent of the visitor viewing your page.
relevancyThreshold No float 0.7 (decimal between 0 and 1) Sets the relevancy threshold for the query param. Lower values will return more results, but not as relevant, while higher values will return less results, but more relevant. Note: Lower thresholds = slower API request times.
filterBrand No string pipe seperated values Filter the results by brand names
filterCatalogId No string pipe seperated values Filter the results by a product's catalogId (Only matches one product).
filterCategory No string pipe seperated values or null Filter results by categories. Full category list.
filterKeyword No string pipe seperated values Filter results by keyword.
filterKeywords No string pipe seperated values Filter results by keywords.
filterMerchant No string pipe seperated values Filter results by merchant names.
filterMerchantId No string pipe seperated values Filter by the merchant's ID. This ID is specific to one merchant across other networks.
filterPercentOff No float PercentOff or range Filter results by the range of percentage off or a specific percentage off.
filterPremier No boolean true or false Filter result set by Premier merchants only.
filterPrice No float 0.00 or range Filter result set by a specific price or price range.
filterPriceSale No float 0.00, range Filter result set by a specific sale price or sale price range.
filterProductId No string pipe seperated values Filter by a product's productId (Can match multiple of the same products.)
sortBy No string • relevance
• keyword
• brand
• merchant
• merchantId
• price
• price_sale
• minPrice
• maxPrice
• minPriceSale
• maxPriceSale
• percentOff
• groupCount
Sort results by the sort method in either ascending or descending order.

Append either of the following to change the sort direction:
asc
• desc
groupBy No string • brand
• category
• merchant
• merchantId
• productId
Group results by one of the attributes.
maxPrice No float 0.00 All prices will be lower than the price given.
minPrice No float 0.00 All prices will be higher than the price given.
maxPriceSale No float 0.00 All results will have a smaller sale price than that which you gave.
minPriceSale No float 0.00 All results will have a greater sale price than that which you gave.
limit No integer 10 Amount of results you want to receive from the API call.
page No integer 1 Enter a page number to get the next set of results.
imageSize No string • 75x75
• 125x125
• 250x250
• 500x500
Size of image to be returned with each product.
sid No string The sub-id to track a site's purchase through.
enableFacets No boolean true or false or pipe seperated values of facet names Enable or disable the return of facets with the results.
enableQuerySuggestion No boolean true or false Enable or disable query suggestion.
enableFullData No boolean true or false True returns all data. False returns minimum data for performance boost and lower bandwidth
imageMaskDomain No string Allows you to make your image URLs appear as though they are coming from your own domain instead of Prosperent. Requires a CNAME entry at your DNS Provider. Start this field with http:// or https:// DNS must be through CloudFlare.
clickMaskDomain No string Allows you to make your click URLs appear as though they are coming from your own domain instead of Prosperent. Requires a CNAME entry at your DNS Provider. Start this field with http:// or https:// DNS must be through CloudFlare.
debugMode No boolean true or false Only set to true to skip impression logging and return a more verbose response.
Response Fields
Field Name Data Type Format Description
errors array Will show any errors that may have occured, otherwise it will be empty.
warnings array Will show any warnings that may have occured, otherwise it will be empty.
data array Displays the product data.
catalogId string ID that belongs to each individual product.
productId string ID that can be used to match multiples of the same product.
affiliate_url string URL used to get to the merchant.
image_url string Image URL of the product.
keyword string Product name.
keywords string Deprecated
description string Description of the product
category string Category the product belongs to.
price float 0.00 Price of the product.
price_sale float 0.00 Sale price of the product if it is on sale.
percentOff float 0.00 Percent Off of the product. Difference between the price and price_sale.
currency string USD Currency type of the product.
merchant string Merchant name.
merchantId string The ID of the merchant, this ID is specific to only one merchant.
brand string Brand name.
upc string UPC of the product.
isbn string ISBN of the product. Usually attributed to books.
sales string Amount of sales for a product group. (Only available if groupBy is set)
minPrice float 0.00 Minimum price for a product group. (Only available if groupBy is set)
maxPrice float 0.00 Maximum price for a product group. (Only available if groupBy is set)
minPriceSale float 0.00 Minimum sale price for a product group. (Only available if groupBy is set)
maxPriceSale float 0.00 Maximum sale price for a product group. (Only available if groupBy is set)
groupCount integer 0 Number of products in a group. (Only available if groupBy is set)
facets array The facets that are active and their counts and values.
[facetName] array The name of the facet.
count integer The amount of products found for each facet value.
value string The value of the facet, for instance, the merchant name.
extendedFieldValue string Deprecated
countryCode string US The country code for the catalog you are searching.
page integer 0 The page number of the result set.
limit integer 0 The limit you have set.
totalRecords integer 0 Total records for the page of results.
totalRecordsAvailable integer 0 Total records available to you.
totalRecordsFound integer 0 Total records available in our data feed that match your search.
extendedQuery string Deprecated
Build a Request