API:Watchlist

Other languages:	English  • 日本語

MediaWiki Action API
Basics All Query modules Get properties of pages List pages matching a criterion Get module parameters information Get meta information about the wiki and user Authentication Get tokens for data modifying operations Login Logout Accounts and Users Create an account Block or unblock a user Get info about the current user Get the current user's watchlist as a feed Change user options Change user group membership Send an email Page Operations Parse content of a page Create and edit a page Upload a file Import a page Delete a page Watch or unwatch a page Purge cache for page(s) Rollback a page Move a page Patrol a page or revision Restore revisions of a deleted page Change a page's protection level Change a page's language More... Search Search for a title or text Fetch results in an OpenSearch format Search for wiki pages near a location Search for a language Perform a prefix search for page titles Developer Utilities Access libraries Cross-site requests Creating an API module in an extension Using the API in MediaWiki and extensions Restricting API usage Localisation Implementation Strategy Tutorials Action API Tutorial Article ideas generator Nearby places viewer Picture of the day viewer

MediaWiki version:

≥ 1.9

GET Request to list pages on the current user's watchlist that were changed within the given time period, ordered by time of the last change of the watched page.

This module can be used as a generator

API documentation

list=watchlist (wl) (main | query | watchlist) This module requires read rights. This module can be used as a generator. Source: MediaWiki License: GPL-2.0-or-later Get recent changes to pages in the current user's watchlist. https://www.mediawiki.org/wiki/Special:MyLanguage/API:Watchlist Parameters: wlallrev Include multiple revisions of the same page within given timeframe. Type: boolean (details) wlstart The timestamp to start enumerating from. Type: timestamp (allowed formats) wlend The timestamp to end enumerating. Type: timestamp (allowed formats) wlnamespace Filter changes to only the given namespaces. Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 90, 91, 92, 93, 100, 101, 102, 103, 104, 105, 106, 107, 486, 487, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303, 2600, 5500, 5501 To specify all values, use *. wluser Only list changes by this user. Type: user name wlexcludeuser Don't list changes by this user. Type: user name wldir In which direction to enumerate: newer List oldest first. Note: wlstart has to be before wlend. older List newest first (default). Note: wlstart has to be later than wlend. One of the following values: newer, older Default: older wllimit How many total results to return per request. No more than 500 (5,000 for bots) allowed. Type: integer or max Default: 10 wlprop Which additional properties to get: ids Adds revision IDs and page IDs. title Adds title of the page. flags Adds flags for the edit. user Adds the user who made the edit. userid Adds user ID of whoever made the edit. comment Adds comment of the edit. parsedcomment Adds parsed comment of the edit. timestamp Adds timestamp of the edit. patrol Tags edits that are patrolled. sizes Adds the old and new lengths of the page. notificationtimestamp Adds timestamp of when the user was last notified about the edit. loginfo Adds log information where appropriate. tags Lists tags for the entry. Values (separate with | or alternative): ids, title, flags, user, userid, comment, parsedcomment, timestamp, patrol, sizes, notificationtimestamp, loginfo, tags Default: ids|title|flags wlshow Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set wlshow=minor|!anon. Values (separate with | or alternative): minor, !minor, bot, !bot, anon, !anon, patrolled, !patrolled, autopatrolled, !autopatrolled, 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 wlowner Used along with wltoken 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. wlcontinue When more results are available, use this to continue. Examples: List the top revision for recently changed pages on the current user's watchlist. api.php?action=query&list=watchlist [open in sandbox] Fetch additional information about the top revision for recently changed pages on the current user's watchlist. api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment [open in sandbox] Fetch information about all recent changes to pages on the current user's watchlist. api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment [open in sandbox] Fetch page info for recently changed pages on the current user's watchlist. api.php?action=query&generator=watchlist&prop=info [open in sandbox] Fetch revision info for recent changes to pages on the current user's watchlist. api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user [open in sandbox] List the top revision for recently changed pages on the watchlist of user Example. api.php?action=query&list=watchlist&wlowner=Example&wltoken=123ABC [open in sandbox]

Example

GET Request

Get the currently logged-in user's watchlist.

api.php?action=query&format=json&list=watchlist [try in ApiSandbox]

Response

{
  "batchcomplete": "",
  "query": {
    "watchlist": [
      {
        "ns": 1,
        "old_revid": 898447862,
        "pageid": 5858,
        "revid": 898447924,
        "title": "Talk:Software",
        "type": "edit"
      },
      {
        "ns": 0,
        "old_revid": 896386764,
        "pageid": 18934886,
        "revid": 897854521,
        "title": "Proprietary software",
        "type": "edit"
      },
      {
        "minor": "",
        "ns": 0,
        "old_revid": 894771707,
        "pageid": 1721496,
        "revid": 897348916,
        "title": "Free and open-source software",
        "type": "edit"
      }
    ]
  }
}

Sample code

get_watchlist.py

#!/usr/bin/python3

"""
    get_watchlist.py

    MediaWiki API Demos
    Demo of `Watchlist` module: Get the currently logged-in user's watchlist.

    MIT License
"""

import requests

S = requests.Session()

URL = "https://en.wikipedia.org/w/api.php"

# Step 1: Retrieve a login token
PARAMS_1 = {
    "action": "query",
    "meta": "tokens",
    "type": "login",
    "format": "json"
}

R = S.get(url=URL, params=PARAMS_1)
DATA = R.json()

LOGIN_TOKEN = DATA['query']['tokens']['logintoken']

# Step 2: Send a post request to log in. For this login
# method, Obtain bot credentials by visiting
# https://en.wikipedia.org/wiki/Special:BotPasswords/
# See https://www.mediawiki.org/wiki/API:Login for more
# information on log in methods.
PARAMS_2 = {
    "action": "login",
    "lgname": "username",
    "lgpassword": "password",
    "format": "json",
    "lgtoken": LOGIN_TOKEN
}

R = S.post(URL, data=PARAMS_2)

# Step 3: While logged in, get the watchlist
PARAMS_3 = {
    "action": "query",
    "list": "watchlist",
    "format": "json"
}

R = S.get(url=URL, params=PARAMS_3)
DATA = R.json()

print(DATA)

Possible errors

Code	Info
wlnotloggedin	You must be logged-in to have a watchlist
wlpatrol	patrol property is not available
wlshow	Incorrect parameter - mutually exclusive values may not be supplied

Parameter history

• v1.24: Introduced unread, !unread
• v1.23: Introduced wlcontinue
• v1.22: Introduced wltype
• v1.18: Introduced loginfo
• v1.17: Introduced userid
• v1.16: Introduced wluser, wlexcludeuser, parsedcomment, notificationtimestamp, wlowner, wltoken
• v1.14: Introduced patrolled, !patrolled
• v1.12: Introduced wlshow
• v1.11: Introduced ids, title, flags, sizes

Additional Notes

• This module should not be confused with API:Watchlistraw, which lists all the pages on the logged in user's watchlist, regardless of whether they were recently changed or not.

See also

• API:Watchlistraw - Get all the pages on the logged in user's watchlist, regardless of whether they were recently changed or not.
• API:Watchlist feed - Get the RSS feed of a user's watchlist.