Open main menu

User:SPage (WMF)/Api help test

{{Api help|query+extracts}} outputs {{Special:ApiHelp/query+extracts}} to transclude api.php help documentation into wiki pages.


Contents

Localization testsEdit

See phab:T89768 about localization problems

Special:ApiHelp redirects to api.php?action=help. The latter has great i18n and improving l10n, e.g. https://www.mediawiki.org/w/api.php?action=help&modules=query%2Bextracts&uselang=fr

The problem for transcluding Special:ApiHelp into localized pages is how to indicate the desired language and then getting the uselang=LANG code to api.php?action=help.

Tests follow. I'm using uselang=es because someone has localized {{Api help}} into Spanish.

Raw inclusionEdit

1. {{Special:ApiHelp?uselang=es}}Edit

Result: This doesn't work, because Title?QueryParams is a valid page name. Also, MediaWiki aggressively converts ?uselang=es into URL-encoded %3Fuselang%3Des, so the query parameter doesn't even look like a query parameter.

Special:ApiHelp?uselang=es

2. {{Special:ApiHelp/query+extracts?uselang=es}}Edit

Result: The subpage handling is passed to Special:ApiHelp, but it doesn't detect the ?uselang=es as a parameter, and so tries and fails to load the bogus module "query+extracts?uselang=es". And again the $#@! URL-encoding. My gerrit:191250 attempts to fix this, though the suggestion is use pipe-separated arguments (see elsewhere).

Module "query+extracts?uselang=es" not found.

3. {{[[Special:ApiHelp|uselang=es]]}}Edit

Result: I think the param gets passed the same way e.g. {{ Special:PrefixIndex/SomePage/ |hideredirects=1 |stripprefix=1 }} works but ApiHelp doesn't respond.

Main module

Status: The MediaWiki API is a mature and stable interface that is actively supported and improved. While we try to avoid it, we may occasionally need to make breaking changes; subscribe to the mediawiki-api-announce mailing list for notice of updates.

Erroneous requests: When erroneous requests are sent to the API, an HTTP header will be sent with the key "MediaWiki-API-Error" and then both the value of the header and the error code sent back will be set to the same value. For more information see API: Errors and warnings.

Parameters:
action

Which action to perform.

abusefiltercheckmatch
Check to see if an AbuseFilter matches a set of variables, an edit, or a logged AbuseFilter event.
abusefilterchecksyntax
Check syntax of an AbuseFilter filter.
abusefilterevalexpression
Evaluates an AbuseFilter expression.
abusefilterunblockautopromote
Unblocks a user from receiving autopromotions due to an abusefilter consequence.
abuselogprivatedetails
View private details of an AbuseLog entry.
aggregategroups
Manage aggregate message groups.
antispoof
Check a username against AntiSpoof's normalisation checks.
block
Block a user.
bouncehandler
Receive a bounce email and process it to handle the failing recipient.
categorytree
Internal module for the CategoryTree extension.
centralauthtoken
Fetch a centralauthtoken for making an authenticated request to an attached wiki.
centralnoticecdncacheupdatebanner
Request the purge of banner content stored in the CDN (front-end) cache for anonymous users, for the requested banner and language
centralnoticechoicedata
Get data needed to choose a banner for a given project and language
centralnoticequerycampaign
Get all configuration settings for a campaign.
changeauthenticationdata
Change authentication data for the current user.
checktoken
Check the validity of a token from action=query&meta=tokens.
cirrus-config-dump
Dump of CirrusSearch configuration.
cirrus-mapping-dump
Dump of CirrusSearch mapping for this wiki.
cirrus-profiles-dump
Dump of CirrusSearch profiles for this wiki.
cirrus-settings-dump
Dump of CirrusSearch settings for this wiki.
clearhasmsg
Clears the hasmsg flag for the current user.
clientlogin
Log in to the wiki using the interactive flow.
codediff
Fetch formatted diff from CodeReview's backing revision control system.
coderevisionupdate
Submit comments, new status and tags to a revision.
codeupdate
Update CodeReview repository data from master revision control system.
compare
Get the difference between two pages.
createaccount
Create a new user account.
cspreport
Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser.
delete
Delete a page.
deleteglobalaccount
Delete a global user.
echomarkread
Mark notifications as read for the current user.
echomarkseen
Mark notifications as seen for the current user.
edit
Create and edit pages.
editmassmessagelist
Edit a mass message delivery list.
emailuser
Email a user.
expandtemplates
Expands all templates within wikitext.
fancycaptchareload
Get a new FancyCaptcha.
featuredfeed
Returns a featured content feed.
feedcontributions
Returns a user contributions feed.
feedrecentchanges
Returns a recent changes feed.
feedthreads
Return a feed of discussion threads.
feedwatchlist
Returns a watchlist feed.
filerevert
Revert a file to an old version.
flow
Allows actions to be taken on Structured Discussions pages.
flow-parsoid-utils
Convert text between wikitext and HTML.
flowthank
Send a public thank-you notification for a Flow comment.
globalblock
Globally block or unblock a user.
globalpreferenceoverrides
Change local overrides for global preferences for the current user.
globalpreferences
Change global preferences of the current user.
globaluserrights
Add/remove a user to/from global groups.
graph
Access graph tag functionality.
groupreview
Set message group workflow states.
help
Display help for the specified modules.
imagerotate
This module has been disabled.
import
Import a page from another wiki, or from an XML file.
jsonconfig
Allows direct access to JsonConfig subsystem.
jsondata
Retrieve localized JSON data.
languagesearch
Search for language names in any script.
linkaccount
Link an account from a third-party provider to the current user.
login
Log in and get authentication cookies.
logout
Log out and clear session data.
managetags
Perform management tasks relating to change tags.
massmessage
Send a message to a list of pages.
mergehistory
Merge page histories.
mobileview
Returns data needed for mobile views.
move
Move a page.
newslettersubscribe
Subscribe to or unsubscribe from a newsletter.
oathvalidate
Validate a two-factor authentication (OATH) token.
opensearch
Search the wiki using the OpenSearch protocol.
options
Change preferences of the current user.
paraminfo
Obtain information about API modules.
parse
Parses content and returns parser output.
parsoid-batch
Batch API for Parsoid
patrol
Patrol a page or revision.
protect
Change the protection level of a page.
purge
Purge the cache for the given titles.
query
Fetch data from and about MediaWiki.
readinglists
Reading list write operations.
record-lint
Record a lint error in the database
removeauthenticationdata
Remove authentication data for the current user.
resetpassword
Send a password reset email to a user.
revisiondelete
Delete and undelete revisions.
rollback
Undo the last edit to the page.
rsd
Export an RSD (Really Simple Discovery) schema.
sanitize-mapdata
Performs data validation for Kartographer extension
scribunto-console
Internal module for servicing XHR requests from the Scribunto console.
searchtranslations
Search translations.
setglobalaccountstatus
Set a global user's status.
setnotificationtimestamp
Update the notification timestamp for watched pages.
setpagelanguage
Change the language of a page.
shortenurl
Shorten a long URL into a shorter one.
sitematrix
Get Wikimedia sites list.
spamblacklist
Validate one or more URLs against the SpamBlacklist.
stashedit
Prepare an edit in shared cache.
strikevote
Allows admins to strike or unstrike a vote.
tag
Add or remove change tags from individual revisions or log entries.
templatedata
Fetch data stored by the TemplateData extension.
thank
Send a thank-you notification to an editor.
threadaction
Allows actions to be taken on threads and posts in threaded discussions.
timedtext
Provides timed text content for usage by <track> elements
titleblacklist
Validate a page title, filename, or username against the TitleBlacklist.
transcodereset
Users with the 'transcode-reset' right can reset and re-run a transcode job.
translationaids
Query all translations aids.
translationcheck
Validate translations.
translationreview
Mark translations reviewed.
ttmserver
Query suggestions from translation memories.
ulslocalization
Get the localization of ULS in the given language.
unblock
Unblock a user.
undelete
Restore revisions of a deleted page.
unlinkaccount
Remove a linked third-party account from the current user.
upload
Upload a file, or get the status of pending uploads.
userrights
Change a user's group membership.
validatepassword
Validate a password against the wiki's password policies.
visualeditor
Returns HTML5 for a page from the Parsoid service.
visualeditoredit
Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).
watch
Add or remove pages from the current user's watchlist.
webapp-manifest
Returns a webapp manifest.
wikilove
Give WikiLove to another user.
tokens
Deprecated. Get tokens for data-modifying actions.
One of the following values: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, aggregategroups, antispoof, block, bouncehandler, categorytree, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-profiles-dump, cirrus-settings-dump, clearhasmsg, clientlogin, codediff, coderevisionupdate, codeupdate, compare, createaccount, cspreport, delete, deleteglobalaccount, echomarkread, echomarkseen, edit, editmassmessagelist, emailuser, expandtemplates, fancycaptchareload, featuredfeed, feedcontributions, feedrecentchanges, feedthreads, feedwatchlist, filerevert, flow, flow-parsoid-utils, flowthank, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, graph, groupreview, help, imagerotate, import, jsonconfig, jsondata, languagesearch, linkaccount, login, logout, managetags, massmessage, mergehistory, mobileview, move, newslettersubscribe, oathvalidate, opensearch, options, paraminfo, parse, parsoid-batch, patrol, protect, purge, query, readinglists, record-lint, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, sanitize-mapdata, scribunto-console, searchtranslations, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, stashedit, strikevote, tag, templatedata, thank, threadaction, timedtext, titleblacklist, transcodereset, translationaids, translationcheck, translationreview, ttmserver, ulslocalization, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, visualeditor, visualeditoredit, watch, webapp-manifest, wikilove, tokens
Default: help
format

The format of the output.

json
Output data in JSON format.
jsonfm
Output data in JSON format (pretty-print in HTML).
none
Output nothing.
php
Output data in serialized PHP format.
phpfm
Output data in serialized PHP format (pretty-print in HTML).
rawfm
Output data, including debugging elements, in JSON format (pretty-print in HTML).
xml
Output data in XML format.
xmlfm
Output data in XML format (pretty-print in HTML).
One of the following values: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Default: jsonfm
maxlag

Maximum lag can be used when MediaWiki is installed on a database replicated cluster. To save actions causing any more site replication lag, this parameter can make the client wait until the replication lag is less than the specified value. In case of excessive lag, error code maxlag is returned with a message like Waiting for $host: $lag seconds lagged.
See Manual: Maxlag parameter for more information.

Type: integer
smaxage

Set the s-maxage HTTP cache control header to this many seconds. Errors are never cached.

Type: integer
Default: 0
maxage

Set the max-age HTTP cache control header to this many seconds. Errors are never cached.

Type: integer
Default: 0
assert

Verify the user is logged in if set to user, or has the bot user right if bot.

One of the following values: user, bot
assertuser

Verify the current user is the named user.

Type: user name
requestid

Any value given here will be included in the response. May be used to distinguish requests.

servedby

Include the hostname that served the request in the results.

Type: boolean (details)
curtimestamp

Include the current timestamp in the result.

Type: boolean (details)
responselanginfo

Include the languages used for uselang and errorlang in the result.

Type: boolean (details)
origin

When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body).

For authenticated requests, this must match one of the origins in the Origin header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is whitelisted, the Access-Control-Allow-Origin and Access-Control-Allow-Credentials headers will be set.

For non-authenticated requests, specify the value *. This will cause the Access-Control-Allow-Origin header to be set, but Access-Control-Allow-Credentials will be false and all user-specific data will be restricted.

uselang

Language to use for message translations. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify user to use the current user's language preference, or specify content to use this wiki's content language.

Default: user
errorformat

Format to use for warning and error text output.

plaintext
Wikitext with HTML tags removed and entities replaced.
wikitext
Unparsed wikitext.
html
HTML.
raw
Message key and parameters.
none
No text output, only the error codes.
bc
Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.
One of the following values: plaintext, wikitext, html, raw, none, bc
Default: bc
errorlang

Language to use for warnings and errors. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify content to use this wiki's content language, or specify uselang to use the same value as the uselang parameter.

Default: uselang
errorsuselocal

If given, error texts will use locally-customized messages from the MediaWiki namespace.

Type: boolean (details)
centralauthtoken

When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use action=centralauthtoken on this wiki to retrieve the token, before making the CORS request. Each token may only be used once, and expires after 10 seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body).

Permissions:
writeapi
Use of the write API
Granted to: all, user and bot
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
Granted to: bot and sysop

4. {{[[Special:ApiHelp/query+extracts|uselang=es]]}}Edit

Result: I think the param gets passed, but it's not parsed.

prop=extracts (ex)

(main | query | extracts)

Returns plain-text or limited HTML extracts of the given pages.

Parameters:
exchars

How many characters to return. Actual text returned might be slightly longer.

The value must be between 1 and 1,200.
Type: integer
exsentences

How many sentences to return.

The value must be between 1 and 10.
Type: integer
exlimit

How many extracts to return. (Multiple extracts can only be returned if exintro is set to true.)

No more than 20 (20 for bots) allowed.
Type: integer or max
Default: 20
exintro

Return only content before the first section.

Type: boolean (details)
explaintext

Return extracts as plain text instead of limited HTML.

Type: boolean (details)
exsectionformat

How to format sections in plaintext mode:

plain
No formatting.
wiki
Wikitext-style formatting (== like this ==).
raw
This module's internal representation (section titles prefixed with <ASCII 1><ASCII 2><section level><ASCII 2><ASCII 1>).
One of the following values: plain, wiki, raw
Default: wiki
excontinue

When more results are available, use this to continue.

Type: integer

using templateEdit

Either {{Api help}} needs a lang parameter, or the localized version {{Api help/es}} needs to modify the transclusion.


Invoke the localized subpage: {{Api help/es|query+extracts}}Edit

This works but we need a way to pass the language to the transclusion (tests above).

Should callers be using {{TNTN}}, does that call the localized template automatically?



prop=extracts (ex)

(main | query | extracts)

Returns plain-text or limited HTML extracts of the given pages.

Parameters:
exchars

How many characters to return. Actual text returned might be slightly longer.

The value must be between 1 and 1,200.
Type: integer
exsentences

How many sentences to return.

The value must be between 1 and 10.
Type: integer
exlimit

How many extracts to return. (Multiple extracts can only be returned if exintro is set to true.)

No more than 20 (20 for bots) allowed.
Type: integer or max
Default: 20
exintro

Return only content before the first section.

Type: boolean (details)
explaintext

Return extracts as plain text instead of limited HTML.

Type: boolean (details)
exsectionformat

How to format sections in plaintext mode:

plain
No formatting.
wiki
Wikitext-style formatting (== like this ==).
raw
This module's internal representation (section titles prefixed with <ASCII 1><ASCII 2><section level><ASCII 2><ASCII 1>).
One of the following values: plain, wiki, raw
Default: wiki
excontinue

When more results are available, use this to continue.

Type: integer

In EngishEdit

Template works fine in English

{{Api Help|query+extracts}}Edit


prop=extracts (ex)

(main | query | extracts)

Returns plain-text or limited HTML extracts of the given pages.

Parameters:
exchars

How many characters to return. Actual text returned might be slightly longer.

The value must be between 1 and 1,200.
Type: integer
exsentences

How many sentences to return.

The value must be between 1 and 10.
Type: integer
exlimit

How many extracts to return. (Multiple extracts can only be returned if exintro is set to true.)

No more than 20 (20 for bots) allowed.
Type: integer or max
Default: 20
exintro

Return only content before the first section.

Type: boolean (details)
explaintext

Return extracts as plain text instead of limited HTML.

Type: boolean (details)
exsectionformat

How to format sections in plaintext mode:

plain
No formatting.
wiki
Wikitext-style formatting (== like this ==).
raw
This module's internal representation (section titles prefixed with <ASCII 1><ASCII 2><section level><ASCII 2><ASCII 1>).
One of the following values: plain, wiki, raw
Default: wiki
excontinue

When more results are available, use this to continue.

Type: integer

Api help| queryEdit


action=query

(main | query)

Fetch data from and about MediaWiki.

All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites.

Parameters:
prop

Which properties to get for the queried pages.

categories
List all categories the pages belong to.
categoryinfo
Returns information about the given categories.
cirrusbuilddoc
Dump of a CirrusSearch article document from the database servers
cirrusdoc
Dump of a CirrusSearch article document from the search servers
contributors
Get the list of logged-in contributors and the count of anonymous contributors to a page.
deletedrevisions
Get deleted revision information.
description
Get a short description a.k.a. subtitle explaining what the target page is about.
duplicatefiles
List all files that are duplicates of the given files based on hash values.
extlinks
Returns all external URLs (not interwikis) from the given pages.
extracts
Returns plain-text or limited HTML extracts of the given pages.
fileusage
Find all pages that use the given files.
globalusage
Returns global image usage for a certain image.
imageinfo
Returns file information and upload history.
images
Returns all files contained on the given pages.
info
Get basic page information.
iwlinks
Returns all interwiki links from the given pages.
langlinks
Returns all interlanguage links from the given pages.
links
Returns all links from the given pages.
linkshere
Find all pages that link to the given pages.
mapdata
Request all Kartographer map data for the given pages
pageimages
Returns information about images on the page, such as thumbnail and presence of photos.
pageprops
Get various page properties defined in the page content.
pageterms
Get the Wikidata terms (typically labels, descriptions and aliases) associated with a page via a sitelink. On the entity page itself, the terms are used directly. Caveat: On a repo wiki, this module only works directly on entity pages, not on pages connected to an entity via a sitelink. This may change in the future.
pageviews
Shows per-page pageview data (the number of daily pageviews for each of the last pvipdays days).
redirects
Returns all redirects to the given pages.
references
Return a data representation of references associated with the given pages.
revisions
Get revision information.
stashimageinfo
Returns file information for stashed files.
templates
Returns all pages transcluded on the given pages.
transcludedin
Find all pages that transclude the given pages.
transcodestatus
Get transcode status for a given file page.
videoinfo
Extends imageinfo to include video source (derivatives) information
wbentityusage
Returns all entity IDs used in the given pages.
flowinfo
Deprecated. Get basic Structured Discussions information about a page.
Values (separate with | or alternative): categories, categoryinfo, cirrusbuilddoc, cirrusdoc, contributors, deletedrevisions, description, duplicatefiles, extlinks, extracts, fileusage, globalusage, imageinfo, images, info, iwlinks, langlinks, links, linkshere, mapdata, pageimages, pageprops, pageterms, pageviews, redirects, references, revisions, stashimageinfo, templates, transcludedin, transcodestatus, videoinfo, wbentityusage, flowinfo
list

Which lists to get.

abusefilters
Show details of the abuse filters.
abuselog
Show events that were caught by one of the abuse filters.
allcategories
Enumerate all categories.
alldeletedrevisions
List all deleted revisions by a user or in a namespace.
allfileusages
List all file usages, including non-existing.
allimages
Enumerate all images sequentially.
alllinks
Enumerate all links that point to a given namespace.
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
List all redirects to a namespace.
allrevisions
List all revisions.
alltransclusions
List all transclusions (pages embedded using {{x}}), including non-existing.
allusers
Enumerate all registered users.
backlinks
Find all pages that link to the given page.
betafeatures
List all BetaFeatures
blocks
List all blocked users and IP addresses.
categorymembers
List all pages in a given category.
centralnoticeactivecampaigns
Get a list of currently active campaigns with start and end dates and associated banners.
centralnoticelogs
Get a log of campaign configuration changes.
checkuser
Check which IP addresses are used by a given username or which usernames are used by a given IP address.
checkuserlog
Get entries from the CheckUser log.
codecomments
List comments on revisions in CodeReview.
codepaths
Get a list of 10 paths in a given repository, based on the input path prefix.
coderevisions
List revisions in CodeReview.
codetags
Get a list of tags applied to revisions in a given repository.
embeddedin
Find all pages that embed (transclude) the given title.
extdistbranches
Returns the list of branches for a repository supported by ExtensionDistributor
extdistrepos
Returns the list of repositories supported by ExtensionDistributor
exturlusage
Enumerate pages that contain a given URL.
filearchive
Enumerate all deleted files sequentially.
gadgetcategories
Returns a list of gadget categories.
gadgets
Returns a list of gadgets used on this wiki.
globalallusers
Enumerate all global users.
globalblocks
List all globally blocked IP addresses.
globalgroups
Enumerate all global groups.
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
Find all pages that link to the given language link.
linterrors
Get a list of lint errors
logevents
Get events from logs.
messagecollection
Query MessageCollection about translations.
mmsites
Serve autocomplete requests for the site field in MassMessage.
mostviewed
Lists the most viewed pages (based on last day's pageview count).
mystashedfiles
Get a list of files in the current user's upload stash.
pagepropnames
List all page property names in use on the wiki.
pageswithprop
List all pages using a given page property.
prefixsearch
Perform a prefix search for page titles.
protectedtitles
List all titles protected from creation.
querypage
Get a list provided by a QueryPage-based special page.
random
Get a set of random pages.
readinglistentries
List the pages of a certain list.
recentchanges
Enumerate recent changes.
search
Perform a full text search.
tags
List change tags.
threads
Show details of LiquidThreads threads.
usercontribs
Get all edits by a user.
users
Get information about a list of users.
watchlist
Get recent changes to pages in the current user's watchlist.
watchlistraw
Get all pages on the current user's watchlist.
wblistentityusage
Returns all pages that use the given entity IDs.
wikisets
Enumerate all wiki sets.
deletedrevs
Deprecated. List deleted revisions.
Values (separate with | or alternative): abusefilters, abuselog, allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, allusers, backlinks, betafeatures, blocks, categorymembers, centralnoticeactivecampaigns, centralnoticelogs, checkuser, checkuserlog, codecomments, codepaths, coderevisions, codetags, embeddedin, extdistbranches, extdistrepos, exturlusage, filearchive, gadgetcategories, gadgets, globalallusers, globalblocks, globalgroups, imageusage, iwbacklinks, langbacklinks, linterrors, logevents, messagecollection, mmsites, mostviewed, mystashedfiles, pagepropnames, pageswithprop, prefixsearch, protectedtitles, querypage, random, readinglistentries, recentchanges, search, tags, threads, usercontribs, users, watchlist, watchlistraw, wblistentityusage, wikisets, deletedrevs
Maximum number of values is 50 (500 for bots).
meta

Which metadata to get.

allmessages
Return messages from this site.
authmanagerinfo
Retrieve information about the current authentication status.
babel
Get information about what languages the user knows
featureusage
Get a summary of logged API feature usages for a user agent.
filerepoinfo
Return meta information about image repositories configured on the wiki.
globalpreferences
Retrieve global preferences for the current user.
globalrenamestatus
Show information about global renames that are in progress.
globaluserinfo
Show information about a global user.
languageinfo
Return information about available languages.
languagestats
Query language stats.
linterstats
Get number of lint errors in each category
messagegroups
Return information about message groups.
messagegroupstats
Query message group stats.
messagetranslations
Query all translations for a single message.
notifications
Get notifications waiting for the current user.
oath
Check to see if two-factor authentication (OATH) is enabled for a user.
readinglists
List or filter the user's reading lists and show metadata about them.
siteinfo
Return general information about the site.
siteviews
Shows sitewide pageview data (daily pageview totals for each of the last pvisdays days).
tokens
Gets tokens for data-modifying actions.
unreadnotificationpages
Get pages for which there are unread notifications for the current user.
userinfo
Get information about the current user.
wikibase
Get information about the Wikibase client and the associated Wikibase repository.
Values (separate with | or alternative): allmessages, authmanagerinfo, babel, featureusage, filerepoinfo, globalpreferences, globalrenamestatus, globaluserinfo, languageinfo, languagestats, linterstats, messagegroups, messagegroupstats, messagetranslations, notifications, oath, readinglists, siteinfo, siteviews, tokens, unreadnotificationpages, userinfo, wikibase
indexpageids

Include an additional pageids section listing all returned page IDs.

Type: boolean (details)
export

Export the current revisions of all given or generated pages.

Type: boolean (details)
exportnowrap

Return the export XML without wrapping it in an XML result (same format as Special:Export). Can only be used with query+export.

Type: boolean (details)
exportschema

Target the given version of the XML dump format when exporting. Can only be used with query+export.

One of the following values: 0.10, 0.11
Default: 0.10
iwurl

Whether to get the full URL if the title is an interwiki link.

Type: boolean (details)
continue

When more results are available, use this to continue.

rawcontinue

Return raw query-continue data for continuation.

Type: boolean (details)
titles

A list of titles to work on.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
pageids

A list of page IDs to work on.

Type: list of integers
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
revids

A list of revision IDs to work on.

Type: list of integers
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

allcategories
Enumerate all categories.
alldeletedrevisions
List all deleted revisions by a user or in a namespace.
allfileusages
List all file usages, including non-existing.
allimages
Enumerate all images sequentially.
alllinks
Enumerate all links that point to a given namespace.
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
List all redirects to a namespace.
allrevisions
List all revisions.
alltransclusions
List all transclusions (pages embedded using {{x}}), including non-existing.
backlinks
Find all pages that link to the given page.
categories
List all categories the pages belong to.
categorymembers
List all pages in a given category.
deletedrevisions
Get deleted revision information.
duplicatefiles
List all files that are duplicates of the given files based on hash values.
embeddedin
Find all pages that embed (transclude) the given title.
exturlusage
Enumerate pages that contain a given URL.
fileusage
Find all pages that use the given files.
images
Returns all files contained on the given pages.
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
Find all pages that link to the given language link.
links
Returns all links from the given pages.
linkshere
Find all pages that link to the given pages.
messagecollection
Query MessageCollection about translations.
mostviewed
Lists the most viewed pages (based on last day's pageview count).
pageswithprop
List all pages using a given page property.
prefixsearch
Perform a prefix search for page titles.
protectedtitles
List all titles protected from creation.
querypage
Get a list provided by a QueryPage-based special page.
random
Get a set of random pages.
readinglistentries
List the pages of a certain list.
recentchanges
Enumerate recent changes.
redirects
Returns all redirects to the given pages.
revisions
Get revision information.
search
Perform a full text search.
templates
Returns all pages transcluded on the given pages.
transcludedin
Find all pages that transclude the given pages.
watchlist
Get recent changes to pages in the current user's watchlist.
watchlistraw
Get all pages on the current user's watchlist.
wblistentityusage
Returns all pages that use the given entity IDs.
One of the following values: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, messagecollection, mostviewed, pageswithprop, prefixsearch, protectedtitles, querypage, random, readinglistentries, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw, wblistentityusage
redirects

Automatically resolve redirects in query+titles, query+pageids, and query+revids, and in pages returned by query+generator.

Type: boolean (details)
converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include en, crh, gan, iu, kk, ku, shi, sr, tg, uz and zh.

Type: boolean (details)