In order to use the API you need to call an endpoint URL with your private access token.
http://webhose.io/productFilter?token=XXXXX-XXXXX&format=json&q=[QUERY]
q
A string query containing the filters that define which products will be returned.
Find any product containing either ipod or ipad:
(ipod OR ipad)
token
Your private access token. You get a unique access token when you sign up.
sort
By default (when the sort parameter isn't specified) the results are sorted by the recommended order of crawl date.
You can however change the sort order to relevancy.
&sort=relevancy
from
A paging parameter that works only for relevancy sort order.
&from=100
ts
The "ts" (timestamp) parameter is telling the system to return results that were crawled after this timestamp (Unix Timestamp in milliseconds).
When not specified the default is the past 3 days.
&ts=1459835503426
format
The output format of the results set. It can be either:
- json
- xml
The default is json
&format=xml
size
The total number of products returned per request, ranges between 1 to 100 (default is 100)
&size=2
Will return 2 products
latest
This will return the latest 100 crawled products matching your query.
It's NOT recommended to use this feature as it may result in you missing important products.
&latest=true