API:Watch

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
  • 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
• 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

MediaWiki version:

1.18

Token

To (un)watch a page, a token is required. This token is the same for all pages (and is not different for watch vs unwatch), but changes at every login. Watch/unwatch tokens can be obtained via action=tokens with type=watch (MW 1.20+), or by using the following method:

Obtaining a watch token

api.php?action=query&prop=info&intoken=watch&titles=Main%20Page [try in ApiSandbox]

Watching and unwatching pages

Pages can be watched (added to your watchlist) and unwatched (removed from your watchlist) with action=watch. Of course, you can only add and remove pages to/from your own watchlist.

Parameters

• title: Single page to (un)watch (Deprecated (MW 1.24)+ in favour of titles)
• titles: List of one or more pages to (un)watch
• entirewatchlist: If set, unwatches all pages in bulk. This can be useful for some situations with prolific accounts that have accidentally overfilled their watchlists and have trouble managing it. Can only be used along with unwatch parameter. Since 1.24
• unwatch: If set, unwatch the page. If not set, watch the page.
• token: Your (un)watch token.

Requests Must be "POST"ed, but for example's sake, "GET"s are used here:

Examples

Watching Main Page

api.php?action=watch&title=Main_Page&token=f2583b3edcdc2142f7256be161764d91%2B\ [try in ApiSandbox]

Unwatching Dog

api.php?action=watch&title=Dog&unwatch&token=f2583b3edcdc2142f7256be161764d91%2B\ [try in ApiSandbox]

Possible errors

Only the usual stuff.