API:Watchlist feed

This page is part of the MediaWiki action API documentation.

MediaWiki APIsAPI:Main page

• Web APIs showcaseAPI:Web APIs hub
• REST content API

MediaWiki action API

• Introduction and quick startAPI:Main page
• FAQAPI:FAQ
  • Etiquette and usage limitsAPI:Etiquette
• TutorialAPI:Tutorial
• FormatsAPI:Data formats
• Error reportingAPI:Errors and warnings
• Restricting usageAPI:Restricting API usage
• Cross-site requestsAPI:Cross-site requests
• Authentication
  • LoginAPI:Login
  • LogoutAPI:Logout
  • Account creationAPI:Account creation
• QueriesAPI:Query
  • Meta informationAPI:Meta
  • PropertiesAPI:Properties
  • ListsAPI:Lists
• Searching (by title, content, coordinates...)API:Search and discovery
• Parsing wikitext and expanding templatesAPI:Parsing wikitext
• Purging pages' cachesAPI:Purge
• Parameter informationAPI:Parameter information
• Changing wiki contentAPI:Changing wiki content
  • Create and edit pagesAPI:Edit
  • Move pagesAPI:Move
  • Merge pagesAPI:Mergehistory
  • RollbackAPI:Rollback
  • Delete pagesAPI:Delete
  • Restore deleted revisionsAPI:Undelete
  • (Un)protect pagesAPI:Protect
  • (Un)block usersAPI:Block
  • (Un)watch pagesAPI:Watch
  • Mark revisions of watched pages as visitedAPI:SetNotificationTimestamp
  • Send emailAPI:Email
  • Patrol changesAPI:Patrol
  • Import pagesAPI:Import
  • Change user group membershipAPI:User group membership
  • Upload filesAPI:Upload
  • User optionsAPI:Options
  • TokensAPI:Tokens
  • Page languageAPI:PageLanguage
  • More...API:Changing wiki content
• Watchlist feedAPI:Watchlist feed
• WikidataWikibase/API
• ExtensionsAPI:Extensions
• Using the API in MediaWiki and extensionsAPI:Calling internally
• MiscellaneousAPI:Other services
• ImplementationAPI:Implementation Strategy
  • LocalisationAPI:Localisation
• Client codeAPI:Client code
• AssertingAPI:Assert

feedwatchlist
Returns a watchlist feed. This module cannot be used as a GeneratorAPI:generator.
Prefix	none
Required rights	none
Post only?	No
Generated help	Current
Version added	≥ 1.9

Returns a watchlist feed.

Parameters

• feedformat: The format of the feed. Possible values: rss or atom. (Default: rss)
• hours: List pages modified within this many hours from now. Possible values: an integer between 1 and 72. (Default: 24) 1.11+
• linktosections: Link to changed sections instead of whole article pages – if possible
• allrev: Include multiple revisions of the same page within given timeframe. 1.12+
• wlowner: Used along with token to access a different user's watchlist. 1.16+
• wltoken: Security token that requested user set in their preferences. 1.16+
• wlexcludeuser: Do not list changes made by this given user. 1.19+
• wltype: Only list certain types of changes. (Default: edit|new|log|categorize) 1.22+
  • edit: Regular page edits.
  • external: External edits.
  • new: Page creations.
  • log: Log entries.
  • categorize: Changes in categorization arising from conditional parser functions. 1.27+
• wlshow: Only list revisions that meet these criteria. Conflicting options (such as minor and !minor) cannot be used together. Use names below separated by a pipe
  • minor: Only list minor edits.
  • !minor: Don't list minor edits.
  • bot: Only list bot edits.
  • !bot: Don't list bot edits.
  • anon: Only list edits by anonymous users.
  • !anon: Only list edits by registered users.
  • patrolled: Only list patrolled pages.
  • !patrolled: Don't list patrolled pages.
  • unread: Only list unread pages. 1.25+
  • !unread: Don't list unread pages. 1.25+
• linktodiffs: Link to change differences instead of article pages. From version 1.24 forward, difference links will always be emitted if available. 1.17-1.24 (Removed in 1.24)

Examples

Get the current user's Special:Watchlist as a feed.

api.php?action=feedwatchlist [try in ApiSandbox]

---

action=feedwatchlist

(main | feedwatchlist)

• This module requires read rights.
• Source: MediaWiki
• License: GPL-2.0+

Returns a watchlist feed.

• https://www.mediawiki.org/wiki/Special:MyLanguage/API:Watchlist_feed

Parameters:

feedformat

The format of the feed.

One of the following values: rss, atom

Default: rss

hours

List pages modified within this many hours from now.

The value must be between 1 and 72.

Type: integer

Default: 24

linktosections

Link directly to changed sections if possible.

Type: boolean (details)

allrev

Include multiple revisions of the same page within given timeframe.

Type: boolean (details)

wlowner

Used along with token to access a different user's watchlist.

Type: user name

wltoken

A security token (available in the user's preferences) to allow access to another user's watchlist.

wlshow

Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set show=minor|!anon.

Values (separate with | or alternative): minor, !minor, bot, !bot, anon, !anon, patrolled, !patrolled, unread, !unread

wltype

Which types of changes to show:

edit

Regular page edits.

new

Page creations.

log

Log entries.

external

External changes.

categorize

Category membership changes.

Values (separate with | or alternative): edit, new, log, external, categorize

Default: edit|new|log|categorize

wlexcludeuser

Don't list changes by this user.

Type: user name

Examples:

Show the watchlist feed.

api.php?action=feedwatchlist [open in sandbox]

Show all changes to watched pages in the past 6 hours.

api.php?action=feedwatchlist&allrev=&hours=6 [open in sandbox]