XML-RPC API Reference¶

Warning: as of 1.4.0 XML-RPC api is considered deprecated and won't be extended. See this thread for more information. Also, JsonApiReference

USING THIS API IS NOT RECOMMENDED.

Version 1.2.0 adds XML-RPC server, xml-rpc.php.

Notes¶

• If you have any other method ideas, post them to forum or this ticket.
• In single user mode login and password are ignored, default user is assumed automatically.

Available methods¶

1.2.0¶

rss.getVersion

Returns tt-rss version.

rss.subscribeToFeed (user, password, feed_url)

Tries to subscribe user to specified feed.

rss.getSubscribedFeeds (user, password)

Returns array of user subscribed feed entries.

rss.getFeedHeadlines (user, password, feed_id, limit, filter)

Returns array of article headlines, sorted by last update time.

filter modes:

• 0 - no filtering
• 1 - return only unread
• 2 - return only starred

Changes in 1.2.1

• Return format is different, includes feed/label/whatever title.
• Support for querying virtual feeds (if virtual feed is queried, actual feed_id is returned with every headline entry)
  • ID = -1 - Starred
  • ID < -10 - Labels
  • alphanumeric ID - Tags
• Support for "adaptive" filter mode (3)

rss.getArticle (user, password, article_id)

Returns specified article

rss.setArticleRead (user, password, article_id, set_read)

Sets or toggle article unread state

set_unread:

• 0 - set unread
• 1 - set read
• 2 - toggle

rss.setArticleMarked (user, password, article_id, set_marked)

Sets or toggle article marked (starred) state

set_marked:

• 0 - set unmarked
• 1 - set marked
• 2 - toggle

1.2.1¶

rss.getTotalUnread (user, password)

Returns total number of unread articles.

rss.getCategories (user, password)

Returns existing feed categories.

rss.getVirtualFeeds (user, password)

Returns information about virtual feeds (Starred feed and Labels)