User:SPage (WMF)/Api help test

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

phab:T89680

Localization tests

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 inclusion

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

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

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]]}}

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

Source: MediaWiki
License: GPL-2.0-or-later

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.

Testing: For ease of testing API requests, see Special:ApiSandbox.

Specific 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.
acquiretempusername: Acquire a temporary user username and stash it in the current session, if temp account creation is enabled and the current user is logged out. If a name has already been stashed, returns the same name.
aggregategroups: Manage aggregate message groups.
antispoof: Check a username against AntiSpoof's normalisation checks.
block: Block a user.
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.
changecontentmodel: Change the content model of a page
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.
compare: Get the difference between two pages.
createaccount: Create a new user account.
createlocalaccount: Forcibly create a local account. The central account must exist.
delete: Delete a page.
deleteglobalaccount: Delete a global user.
discussiontoolsedit: Post a message on a discussion page.
discussiontoolsfindcomment: Find a comment by its ID or name.
discussiontoolsgetsubscriptions: Get the subscription statuses of given topics.
discussiontoolssubscribe: Subscribe (or unsubscribe) to receive notifications about a topic.
discussiontoolsthank: Send a public thank-you notification for a comment.
echocreateevent: Manually trigger a notification to a user
echomarkread: Mark notifications as read for the current user.
echomarkseen: Mark notifications as seen for the current user.
echomute: Mute or unmute notifications from certain users or pages.
edit: Create and edit pages.
editmassmessagelist: Edit a mass message delivery list.
emailuser: Email a user.
expandtemplates: Expands all templates within wikitext.
featuredfeed: Returns a featured content feed.
feedcontributions: Returns a user's 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.
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.
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.
markfortranslation: Mark a page for translation
massmessage: Send a message to a list of pages.
mergehistory: Merge page histories.
move: Move a page.
newslettersubscribe: Subscribe to or unsubscribe from a newsletter.
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.
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.
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.
searchtranslations: Search translations.
setglobalaccountstatus: Hide or lock (or unhide or unlock) a global user account.
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 spam block list.
streamconfigs: Exposes event stream config. Returns only format=json with formatversion=2.
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.
titleblacklist: Validate a page title, filename, or username against the TitleBlacklist.
torblock: Check if an IP address is blocked as a Tor exit node.
transcodereset: Users with the 'transcode-reset' right can reset and re-run a transcode job.
translationaids: Query all translations aids.
translationreview: Mark translations reviewed.
translationstats: Fetch translation statistics
ttmserver: Query suggestions from translation memories.
unblock: Unblock a user.
undelete: Undelete 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.
watch: Add or remove pages from the current user's watchlist.
webapp-manifest: Returns a webapp manifest.
webauthn: API Module to communicate between server and client during registration/authentication process.
wikilove: Give WikiLove to another user.
bouncehandler: Internal. Receive a bounce email and process it to handle the failing recipient.
categorytree: Internal. Internal module for the CategoryTree extension.
cirrus-check-sanity: Internal. Reports on the correctness of a range of page ids in the search index
collection: Internal. API module for performing various operations on a wiki user's collection.
cspreport: Internal. 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.
discussiontoolscompare: Internal. Get information about comment changes between two page revisions.
discussiontoolspageinfo: Internal. Returns metadata required to initialize the discussion tools.
discussiontoolspreview: Internal. Preview a message on a discussion page.
editcheckreferenceurl: Internal. Check the status of a URL for use as a reference.
fancycaptchareload: Internal. Get a new FancyCaptcha.
jsondata: Internal. Retrieve localized JSON data.
managegroupsynchronizationcache: Internal. Manage group synchronization cache.
managemessagegroups: Internal. Add a message as a rename of an existing message or a new message in the group during imports
messagegroupsubscription: Internal. Message group subscription related operations
oathvalidate: Internal. Validate a two-factor authentication (OATH) token.
parser-migration: Internal. Parse a page with two different parser configurations.
readinglists: Internal. Reading list write operations.
sanitize-mapdata: Internal. Performs data validation for Kartographer extension
scribunto-console: Internal. Internal module for servicing XHR requests from the Scribunto console.
securepollauth: Internal. Allows a remote wiki to authenticate users before granting access to vote in the election.
stashedit: Internal. Prepare an edit in shared cache.
timedtext: Internal. Provides timed text content for usage by <track> elements
translationcheck: Internal. Validate translations.
translationentitysearch: Internal. Search for message groups and messages
ulslocalization: Internal. Get the localization of ULS in the given language.
ulssetlang: Internal. Update user's preferred interface language.
visualeditor: Internal. Returns HTML5 for a page from the Parsoid service.
visualeditoredit: Internal. Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).
wikimediaeventsblockededit: Internal. Log information about blocked edit attempts

One of the following values: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, acquiretempusername, aggregategroups, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-profiles-dump, cirrus-settings-dump, clearhasmsg, clientlogin, compare, createaccount, createlocalaccount, delete, deleteglobalaccount, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, discussiontoolsthank, echocreateevent, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, featuredfeed, feedcontributions, feedrecentchanges, feedthreads, feedwatchlist, filerevert, flow-parsoid-utils, flow, flowthank, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, groupreview, help, imagerotate, import, jsonconfig, languagesearch, linkaccount, login, logout, managetags, markfortranslation, massmessage, mergehistory, move, newslettersubscribe, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, searchtranslations, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, streamconfigs, strikevote, tag, templatedata, thank, threadaction, titleblacklist, torblock, transcodereset, translationaids, translationreview, translationstats, ttmserver, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, webauthn, wikilove, bouncehandler, categorytree, cirrus-check-sanity, collection, cspreport, discussiontoolscompare, discussiontoolspageinfo, discussiontoolspreview, editcheckreferenceurl, fancycaptchareload, jsondata, managegroupsynchronizationcache, managemessagegroups, messagegroupsubscription, oathvalidate, parser-migration, readinglists, sanitize-mapdata, scribunto-console, securepollauth, stashedit, timedtext, translationcheck, translationentitysearch, ulslocalization, ulssetlang, visualeditor, visualeditoredit, wikimediaeventsblockededit

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

The value must be no less than 0.

Default: 0

maxage

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

Type: integer

The value must be no less than 0.

Default: 0

assert

Verify that the user is logged in (including possibly as a temporary user) if set to user, not logged in if set to anon, or has the bot user right if bot.

One of the following values: anon, bot, user

assertuser

Verify the current user is the named user.

Type: user, by any of username and Temporary user

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 allowed, 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&siprop=languages returns a list of language codes. You can specify user to use the current user's language preference or content to use this wiki's content language.

Default: user

variant

Variant of the language. Only works if the base language supports variant conversion.

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: bc, html, none, plaintext, raw, wikitext

Default: bc

errorlang

Language to use for warnings and errors. action=query&meta=siteinfo&siprop=languages returns a list of language codes. Specify content to use this wiki's content language or 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).

Examples:

Help for the main module.: api.php?action=help [open in sandbox]
All help in one page.: api.php?action=help&recursivesubmodules=1 [open in sandbox]

Permission:

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]]}}

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

prop=extracts (ex)

(main | query | extracts)

This module requires read rights.
Source: TextExtracts
License: GPL-2.0-or-later

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

https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:TextExtracts#API

Specific parameters:

Other general parameters are available.

exchars

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

Type: integer

The value must be between 1 and 1,200.

exsentences

How many sentences to return.

Type: integer

The value must be between 1 and 10.

exlimit

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

Type: integer or max

The value must be between 1 and 20.

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, raw, wiki

Default: wiki

excontinue

When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.

Type: integer

Example:

Get a 175-character extract: api.php?action=query&prop=extracts&exchars=175&titles=Therion [open in sandbox]

using template

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

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?

La siguiente documentación es la producción de $especial, generado automáticamente por la pre-versión de liberación de MediaWiki que se ejecuta en este sitio (MediaWiki.org).

prop=extracts (ex)

(main | query | extracts)

This module requires read rights.
Source: TextExtracts
License: GPL-2.0-or-later

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

https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:TextExtracts#API

Specific parameters:

Other general parameters are available.

exchars

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

Type: integer

The value must be between 1 and 1,200.

exsentences

How many sentences to return.

Type: integer

The value must be between 1 and 10.

exlimit

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

Type: integer or max

The value must be between 1 and 20.

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, raw, wiki

Default: wiki

excontinue

When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.

Type: integer

Example:

Get a 175-character extract: api.php?action=query&prop=extracts&exchars=175&titles=Therion [open in sandbox]

In Engish

Template works fine in English

The following documentation is the output of Special:ApiHelp/query+extracts, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org).

prop=extracts (ex)

(main | query | extracts)

This module requires read rights.
Source: TextExtracts
License: GPL-2.0-or-later

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

https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:TextExtracts#API

Specific parameters:

Other general parameters are available.

exchars

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

Type: integer

The value must be between 1 and 1,200.

exsentences

How many sentences to return.

Type: integer

The value must be between 1 and 10.

exlimit

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

Type: integer or max

The value must be between 1 and 20.

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, raw, wiki

Default: wiki

excontinue

When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.

Type: integer

Example:

Get a 175-character extract: api.php?action=query&prop=extracts&exchars=175&titles=Therion [open in sandbox]

Api help| query

The following documentation is the output of Special:ApiHelp/query, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org).

action=query

(main | query)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0-or-later

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.

Specific parameters:

Other general parameters are available.

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
cirruscompsuggestbuilddoc: Dump of the document used by the completion suggester
cirrusdoc: Dump of a CirrusSearch article document from the search servers
contributors: Get the list of logged-in contributors and the count of logged-out contributors to a page.
deletedrevisions: Get deleted revision information.
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.
mmcontent: Get the description and targets of a spamlist
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.
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.
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.
description: Internal. Get a short description a.k.a. subtitle explaining what the target page is about.
mapdata: Internal. Request all Kartographer map data for the given pages

Values (separate with | or alternative): categories, categoryinfo, cirrusbuilddoc, cirruscompsuggestbuilddoc, cirrusdoc, contributors, deletedrevisions, duplicatefiles, extlinks, extracts, fileusage, globalusage, imageinfo, images, info, iwlinks, langlinks, links, linkshere, mmcontent, pageimages, pageprops, pageterms, pageviews, redirects, revisions, stashimageinfo, templates, transcludedin, transcodestatus, videoinfo, wbentityusage, flowinfo, description, mapdata

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.
embeddedin: Find all pages that embed (transclude) the given title.
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.
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.
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.
extdistbranches: Internal. Returns the list of branches for a repository supported by ExtensionDistributor
messagegroupsubscription: Internal. List message groups the current user is subscribed to.
readinglistentries: Internal. List the pages of a certain list.

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, embeddedin, extdistrepos, exturlusage, filearchive, gadgetcategories, gadgets, globalallusers, globalblocks, globalgroups, imageusage, iwbacklinks, langbacklinks, linterrors, logevents, messagecollection, mostviewed, mystashedfiles, pagepropnames, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, search, tags, threads, usercontribs, users, watchlist, watchlistraw, wblistentityusage, wikisets, deletedrevs, extdistbranches, messagegroupsubscription, readinglistentries

Maximum number of values is 50 (500 for clients that are allowed higher limits).

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
managemessagegroups: Fetch possible renames for a message in a group during imports
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.
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.
oath: Internal. Check to see if two-factor authentication (OATH) is enabled for a user.
readinglists: Internal. List or filter the user's reading lists and show metadata about them.

Values (separate with | or alternative): allmessages, authmanagerinfo, babel, featureusage, filerepoinfo, globalpreferences, globalrenamestatus, globaluserinfo, languageinfo, languagestats, linterstats, managemessagegroups, messagegroups, messagegroupstats, messagetranslations, notifications, siteinfo, siteviews, tokens, unreadnotificationpages, userinfo, wikibase, oath, readinglists

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.11

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. More detailed information on how to continue queries can be found on mediawiki.org.

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 clients that are allowed higher limits).

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 clients that are allowed higher limits).

revids

A list of revision IDs to work on. Note that almost all query modules will convert revision IDs to the corresponding page ID and work on the latest revision instead. Only prop=revisions uses exact revisions for its response.

Type: list of integers

Separate values with | or alternative.

Maximum number of values is 50 (500 for clients that are allowed higher limits).

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.
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.
readinglistentries: Internal. List the pages of a certain list.

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, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw, wblistentityusage, readinglistentries

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 ban, en, crh, gan, iu, ku, mni, sh, shi, sr, tg, tly, uz, wuu, zgh and zh.

Type: boolean (details)

Examples:

Fetch site info and revisions of MediaWiki.: api.php?action=query&prop=revisions&meta=siteinfo&titles=MediaWiki&rvprop=user|comment&continue= [open in sandbox]
Fetch revisions of pages beginning with API/.: api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue= [open in sandbox]

User:SPage (WMF)/Api help test

Contents

Localization tests

Raw inclusion

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

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

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

Main module

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

prop=extracts (ex)

using template

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

prop=extracts (ex)

In Engish

{{Api Help|query+extracts}}

prop=extracts (ex)

Api help| query

action=query