All parameters apply equally to /api/news, /api/blogs, and /api/forums - build a request once, reuse it on every product.
| Parameter | Type | Default | Description |
|---|---|---|---|
token | string | - | Your API token. Alternatively use a Bearer header - see Endpoints & Authentication |
q | string | "" | Boolean query - see Query Syntax |
ts | integer | 3 days ago | Start of the search window, Unix milliseconds - see Time Range & History |
size | integer | 100 | Posts per response, 1-100 |
sort | string | crawled | Sort field - see below |
order | string | by sort | asc or desc. Defaults to asc for crawled, updated, and domain_rank, desc otherwise |
crawled (default), relevancy, published, thread.published, updated, domain_rank, performance_score, replies_count, participants_count, ord_in_thread, rating, social.facebook.likes, social.facebook.shares, social.facebook.comments, social.gplus.shares, social.pinterest.shares, social.linkedin.shares, social.stumbledupon.shares, social.vk.shares
The performance_score and social.* sorts are accepted on every product but only order meaningfully on news - these engagement fields are only relevant to news content.
The default crawled sort is the right choice for consuming everything that matches a query - it is the only sort that supports full pagination and news history.
| Parameter | Type | Default | Description |
|---|---|---|---|
from | integer | 0 | Offset into results, used with relevancy and other non-crawled sorts |
ni, ns | string | - | Cursor of the last result. Set automatically in the next URL - do not build these yourself. See Pagination |
| Parameter | Type | Default | Description |
|---|---|---|---|
highlight | boolean | false | Return matched terms wrapped in <em> tags in highlightText, highlightTitle, highlightThreadTitle |
warning | boolean | false | Validate the query and return potential issues in a warnings array |
allowNewsHistory | boolean | false | Allow searching back beyond 31 days (news only, extra credits) - see Time Range & History |
includeSyndicated | boolean | false | Include syndicated copies of articles |
webz_reporter | boolean | false | Include Webz Reporter content |
