Implementing TTRSS: Get Headlines #82

getHeadlines

Returns JSON-encoded list of headlines.

Parameters:

feed_id (integer) - only output articles for this feed
limit (integer) - limits the amount of returned articles (see below)
skip (integer) - skip this amount of feeds first
filter (string) - currently unused (?)
is_cat (bool) - requested feed_id is a category
show_excerpt (bool) - include article excerpt in the output
show_content (bool) - include full article text in the output
view_mode (string = all_articles, unread, adaptive, marked,
updated)
include_attachments (bool) - include article attachments (e.g.
enclosures) requires version:1.5.3
since_id (integer) - only return articles with id greater than
since_id requires version:1.5.6
include_nested (boolean) - include articles from child categories
requires version:1.6.0
order_by (string) - override default sort order requires
version:1.7.6
sanitize (bool) - sanitize content or not requires version:1.8
(default: true)
force_update (bool) - try to update feed before showing headlines
requires version:1.14 (api 9) (default: false)
has_sandbox (bool) - indicate support for sandboxing of iframe
elements (default: false)
include_header (bool) - adds status information when returning
headlines, instead of array(articles) return value changes to
array(header, array(articles)) (api 12)

Limit:

Before API level 6 maximum amount of returned headlines is capped at
60, API 6 and above sets it to 200.

This parameters might change in the future (supported since API level
2):

search (string) - search query (e.g. a list of keywords)
search_mode (string) - all_feeds, this_feed (default), this_cat
(category containing requested feed)
match_on (string) - ignored

Special feed IDs are as follows:

-1 starred
-2 published
-3 fresh
-4 all articles
0 - archived
IDs < -10 labels

Sort order values:

date_reverse - oldest first
feed_dates - newest first, goes by feed date
(nothing) - default

### getHeadlines Returns JSON-encoded list of headlines. Parameters: - feed\_id (integer) - only output articles for this feed - limit (integer) - limits the amount of returned articles (see below) - skip (integer) - skip this amount of feeds first - filter (string) - currently unused (?) - is\_cat (bool) - requested feed\_id is a category - show\_excerpt (bool) - include article excerpt in the output - show\_content (bool) - include full article text in the output - view\_mode (string = all\_articles, unread, adaptive, marked, updated) - include\_attachments (bool) - include article attachments (e.g. enclosures) **requires version:1.5.3** - since\_id (integer) - only return articles with id greater than since\_id **requires version:1.5.6** - include\_nested (boolean) - include articles from child categories **requires version:1.6.0** - order\_by (string) - override default sort order **requires version:1.7.6** - sanitize (bool) - sanitize content or not **requires version:1.8** (default: true) - force\_update (bool) - try to update feed before showing headlines **requires version:1.14 (api 9)** (default: false) - has\_sandbox (bool) - indicate support for sandboxing of iframe elements **<span class="10 api"></span>** (default: false) - include\_header (bool) - adds status information when returning headlines, instead of array(articles) return value changes to array(header, array(articles)) (api 12) Limit: Before **API level 6** maximum amount of returned headlines is capped at 60, API 6 and above sets it to 200. This parameters might change in the future (supported since **API level 2**): - search (string) - search query (e.g. a list of keywords) - search\_mode (string) - all\_feeds, this\_feed (default), this\_cat (category containing requested feed) - match\_on (string) - ignored Special feed IDs are as follows: - -1 starred - -2 published - -3 fresh - -4 all articles - 0 - archived - IDs \< -10 labels Sort order values: - date\_reverse - oldest first - feed\_dates - newest first, goes by feed date - (nothing) - default