CINXE.COM

<!DOCTYPE html> <html class="client-nojs" lang="en" dir="ltr"> <head> <meta charset="UTF-8"> <title>MediaWiki API help - MediaWiki</title> <script>document.documentElement.className="client-js";RLCONF={"wgBreakFrames":true,"wgSeparatorTransformTable":["",""],"wgDigitTransformTable":["",""],"wgDefaultDateFormat":"dmy","wgMonthNames":["","January","February","March","April","May","June","July","August","September","October","November","December"],"wgRequestId":"15f78602-a71a-4657-8789-433abb5f72dc","wgCanonicalNamespace":"Special","wgCanonicalSpecialPageName":"ApiHelp","wgNamespaceNumber":-1,"wgPageName":"Special:ApiHelp","wgTitle":"ApiHelp","wgCurRevisionId":0,"wgRevisionId":0,"wgArticleId":0,"wgIsArticle":false,"wgIsRedirect":false,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":[],"wgPageViewLanguage":"en","wgPageContentLanguage":"en","wgPageContentModel":"wikitext","wgRelevantPageName":"Special:ApiHelp","wgRelevantArticleId":0,"wgIsProbablyEditable":false,"wgRelevantPageIsProbablyEditable":false,"wgNoticeProject":"mediawiki","wgCiteReferencePreviewsActive":true,"wgMediaViewerOnClick":true, "wgMediaViewerEnabledByDefault":true,"wgVisualEditor":{"pageLanguageCode":"en","pageLanguageDir":"ltr","pageVariantFallbacks":"en"},"wgMFDisplayWikibaseDescriptions":{"search":true,"watchlist":true,"tagline":false,"nearby":true},"wgWMESchemaEditAttemptStepOversample":false,"wgWMEPageLength":0,"wgCentralAuthMobileDomain":false,"wgEditSubmitButtonLabelPublish":true};RLSTATE={"user.options":"loading","mediawiki.hlist":"ready","mediawiki.apipretty":"ready","mediawiki.skinning.interface":"ready","ext.visualEditor.desktopArticleTarget.noscript":"ready","ext.wikimediaBadges":"ready"};RLPAGEMODULES=["mediawiki.page.ready","ext.centralNotice.geoIP","ext.urlShortener.toolbar","ext.centralauth.centralautologin","ext.visualEditor.desktopArticleTarget.init","ext.visualEditor.targetLoader","ext.echo.centralauth","ext.eventLogging","ext.wikimediaEvents","ext.navigationTiming"];</script> <script>(RLQ=window.RLQ||[]).push(function(){mw.loader.impl(function(){return["user.options@12s5i",function($,jQuery,require,module){mw.user.tokens.set({"patrolToken":"+\\","watchToken":"+\\","csrfToken":"+\\"}); }];});});</script> <link rel="stylesheet" href="/w/load.php?lang=en&modules=ext.visualEditor.desktopArticleTarget.noscript%7Cext.wikimediaBadges%7Cmediawiki.apipretty%2Chlist%7Cmediawiki.skinning.interface&only=styles&skin=apioutput"> <script async="" src="/w/load.php?lang=en&modules=startup&only=scripts&raw=1&safemode=1&skin=apioutput"></script> <meta name="generator" content="MediaWiki 1.44.0-wmf.5"> <meta name="referrer" content="origin"> <meta name="referrer" content="origin-when-cross-origin"> <meta name="robots" content="noindex,nofollow,max-image-preview:standard"> <meta name="format-detection" content="telephone=no"> <meta name="viewport" content="width=1120"> <meta property="og:site_name" content="MediaWiki"> <meta property="og:title" content="MediaWiki API help - MediaWiki"> <meta property="og:type" content="website"> <link rel="alternate" media="only screen and (max-width: 640px)" href="//m.mediawiki.org/wiki/Special:ApiHelp"> <link rel="apple-touch-icon" href="/static/apple-touch/mediawiki.png"> <link rel="icon" href="/static/favicon/mediawiki.ico"> <link rel="search" type="application/opensearchdescription+xml" href="/w/rest.php/v1/search" title="MediaWiki (en)"> <link rel="EditURI" type="application/rsd+xml" href="//www.mediawiki.org/w/api.php?action=rsd"> <link rel="canonical" href="https://www.mediawiki.org/wiki/Special:ApiHelp"> <link rel="license" href="https://www.mediawiki.org/wiki/Special:MyLanguage/Copyright"> <link rel="alternate" type="application/atom+xml" title="MediaWiki Atom feed" href="/w/index.php?title=Special:RecentChanges&feed=atom"> <link rel="dns-prefetch" href="//login.wikimedia.org"> </head> <body class="mediawiki ltr sitedir-ltr mw-hide-empty-elt ns--1 ns-special mw-special-ApiHelp page-Special_ApiHelp rootpage-Special_ApiHelp skin-apioutput action-view"><div class="mw-body" role="main"> <h1 id="firstHeading">MediaWiki API help</h1> <div class="mw-body-content"> <div id="mw-content-text" class="mw-body-content">This is an auto-generated MediaWiki API documentation page. Documentation and examples: <a class="external free" href="https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page">https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page</a> <h2 class="apihelp-header" id="main">Main module</h2> <div class="apihelp-block apihelp-flags"><ul><li>Source: MediaWiki</li><li>License: <a href="/wiki/Special:Version/License/MediaWiki" title="Special:Version/License/MediaWiki">GPL-2.0-or-later</a></li></ul></div> <div class="hlist plainlinks api-main-links"> <ul><li><a href="/wiki/Special:MyLanguage/API:Main_page" title="Special:MyLanguage/API:Main page">Documentation</a></li> <li><a href="/wiki/Special:MyLanguage/API:Etiquette" title="Special:MyLanguage/API:Etiquette">Etiquette & usage guidelines</a></li> <li><a href="/wiki/Special:MyLanguage/API:FAQ" title="Special:MyLanguage/API:FAQ">FAQ</a></li> <li><a class="external text" href="https://lists.wikimedia.org/postorius/lists/mediawiki-api.lists.wikimedia.org/">Mailing list</a></li> <li><a class="external text" href="https://lists.wikimedia.org/postorius/lists/mediawiki-api-announce.lists.wikimedia.org/">API Announcements</a></li> <li><a class="external text" href="https://phabricator.wikimedia.org/maniphest/query/GebfyV4uCaLd/#R">Bugs & requests</a></li></ul> </div> 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 <a class="external text" href="https://lists.wikimedia.org/hyperkitty/list/mediawiki-api-announce@lists.wikimedia.org/">the mediawiki-api-announce mailing list</a> 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 <a href="/wiki/Special:MyLanguage/API:Errors_and_warnings" title="Special:MyLanguage/API:Errors and warnings">API: Errors and warnings</a>. Testing: For ease of testing API requests, see <a href="/wiki/Special:ApiSandbox" title="Special:ApiSandbox">Special:ApiSandbox</a>. <div class="apihelp-block apihelp-parameters"><div class="apihelp-block-head">Specific parameters:</div><dl><dt>action</dt><dd class="description">Which action to perform. <dl><dt><a href="/w/api.php?action=help&modules=abusefiltercheckmatch">abusefiltercheckmatch</a></dt> <dd>Check to see if an AbuseFilter matches a set of variables, an edit, or a logged AbuseFilter event.</dd> <dt><a href="/w/api.php?action=help&modules=abusefilterchecksyntax">abusefilterchecksyntax</a></dt> <dd>Check syntax of an AbuseFilter filter.</dd> <dt><a href="/w/api.php?action=help&modules=abusefilterevalexpression">abusefilterevalexpression</a></dt> <dd>Evaluates an AbuseFilter expression.</dd> <dt><a href="/w/api.php?action=help&modules=abusefilterunblockautopromote">abusefilterunblockautopromote</a></dt> <dd>Unblocks a user from receiving autopromotions due to an abusefilter consequence.</dd> <dt><a href="/w/api.php?action=help&modules=abuselogprivatedetails">abuselogprivatedetails</a></dt> <dd>View private details of an AbuseLog entry.</dd> <dt><a href="/w/api.php?action=help&modules=acquiretempusername">acquiretempusername</a></dt> <dd>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.</dd> <dt><a href="/w/api.php?action=help&modules=aggregategroups">aggregategroups</a></dt> <dd>Manage aggregate message groups.</dd> <dt><a href="/w/api.php?action=help&modules=antispoof">antispoof</a></dt> <dd>Check a username against AntiSpoof's normalisation checks.</dd> <dt><a href="/w/api.php?action=help&modules=block">block</a></dt> <dd>Block a user.</dd> <dt><a href="/w/api.php?action=help&modules=centralauthtoken">centralauthtoken</a></dt> <dd>Fetch a centralauthtoken for making an authenticated request to an attached wiki.</dd> <dt><a href="/w/api.php?action=help&modules=centralnoticecdncacheupdatebanner">centralnoticecdncacheupdatebanner</a></dt> <dd>Request the purge of banner content stored in the CDN (front-end) cache for anonymous users, for the requested banner and language</dd> <dt><a href="/w/api.php?action=help&modules=centralnoticechoicedata">centralnoticechoicedata</a></dt> <dd>Get data needed to choose a banner for a given project and language</dd> <dt><a href="/w/api.php?action=help&modules=centralnoticequerycampaign">centralnoticequerycampaign</a></dt> <dd>Get all configuration settings for a campaign.</dd> <dt><a href="/w/api.php?action=help&modules=changeauthenticationdata">changeauthenticationdata</a></dt> <dd>Change authentication data for the current user.</dd> <dt><a href="/w/api.php?action=help&modules=changecontentmodel">changecontentmodel</a></dt> <dd>Change the content model of a page</dd> <dt><a href="/w/api.php?action=help&modules=checktoken">checktoken</a></dt> <dd>Check the validity of a token from <kbd><a href="/w/api.php?action=help&modules=query%2Btokens">action=query&meta=tokens</a></kbd>.</dd> <dt><a href="/w/api.php?action=help&modules=cirrus-config-dump">cirrus-config-dump</a></dt> <dd>Dump of CirrusSearch configuration.</dd> <dt><a href="/w/api.php?action=help&modules=cirrus-mapping-dump">cirrus-mapping-dump</a></dt> <dd>Dump of CirrusSearch mapping for this wiki.</dd> <dt><a href="/w/api.php?action=help&modules=cirrus-profiles-dump">cirrus-profiles-dump</a></dt> <dd>Dump of CirrusSearch profiles for this wiki.</dd> <dt><a href="/w/api.php?action=help&modules=cirrus-settings-dump">cirrus-settings-dump</a></dt> <dd>Dump of CirrusSearch settings for this wiki.</dd> <dt><a href="/w/api.php?action=help&modules=clearhasmsg">clearhasmsg</a></dt> <dd>Clears the <code>hasmsg</code> flag for the current user.</dd> <dt><a href="/w/api.php?action=help&modules=clientlogin">clientlogin</a></dt> <dd>Log in to the wiki using the interactive flow.</dd> <dt><a href="/w/api.php?action=help&modules=compare">compare</a></dt> <dd>Get the difference between two pages.</dd> <dt><a href="/w/api.php?action=help&modules=createaccount">createaccount</a></dt> <dd>Create a new user account.</dd> <dt><a href="/w/api.php?action=help&modules=createlocalaccount">createlocalaccount</a></dt> <dd>Forcibly create a local account. The central account must exist.</dd> <dt><a href="/w/api.php?action=help&modules=delete">delete</a></dt> <dd>Delete a page.</dd> <dt><a href="/w/api.php?action=help&modules=deleteglobalaccount">deleteglobalaccount</a></dt> <dd>Delete a global user.</dd> <dt><a href="/w/api.php?action=help&modules=discussiontoolsedit">discussiontoolsedit</a></dt> <dd>Post a message on a discussion page.</dd> <dt><a href="/w/api.php?action=help&modules=discussiontoolsfindcomment">discussiontoolsfindcomment</a></dt> <dd>Find a comment by its ID or name.</dd> <dt><a href="/w/api.php?action=help&modules=discussiontoolsgetsubscriptions">discussiontoolsgetsubscriptions</a></dt> <dd>Get the subscription statuses of given topics.</dd> <dt><a href="/w/api.php?action=help&modules=discussiontoolssubscribe">discussiontoolssubscribe</a></dt> <dd>Subscribe (or unsubscribe) to receive notifications about a topic.</dd> <dt><a href="/w/api.php?action=help&modules=discussiontoolsthank">discussiontoolsthank</a></dt> <dd>Send a public thank-you notification for a comment.</dd> <dt><a href="/w/api.php?action=help&modules=echocreateevent">echocreateevent</a></dt> <dd>Manually trigger a notification to a user</dd> <dt><a href="/w/api.php?action=help&modules=echomarkread">echomarkread</a></dt> <dd>Mark notifications as read for the current user.</dd> <dt><a href="/w/api.php?action=help&modules=echomarkseen">echomarkseen</a></dt> <dd>Mark notifications as seen for the current user.</dd> <dt><a href="/w/api.php?action=help&modules=echomute">echomute</a></dt> <dd>Mute or unmute notifications from certain users or pages.</dd> <dt><a href="/w/api.php?action=help&modules=edit">edit</a></dt> <dd>Create and edit pages.</dd> <dt><a href="/w/api.php?action=help&modules=editmassmessagelist">editmassmessagelist</a></dt> <dd>Edit a mass message delivery list.</dd> <dt><a href="/w/api.php?action=help&modules=emailuser">emailuser</a></dt> <dd>Email a user.</dd> <dt><a href="/w/api.php?action=help&modules=expandtemplates">expandtemplates</a></dt> <dd>Expands all templates within wikitext.</dd> <dt><a href="/w/api.php?action=help&modules=featuredfeed">featuredfeed</a></dt> <dd>Returns a featured content feed.</dd> <dt><a href="/w/api.php?action=help&modules=feedcontributions">feedcontributions</a></dt> <dd>Returns a user's contributions feed.</dd> <dt><a href="/w/api.php?action=help&modules=feedrecentchanges">feedrecentchanges</a></dt> <dd>Returns a recent changes feed.</dd> <dt><a href="/w/api.php?action=help&modules=feedthreads">feedthreads</a></dt> <dd>Return a feed of discussion threads.</dd> <dt><a href="/w/api.php?action=help&modules=feedwatchlist">feedwatchlist</a></dt> <dd>Returns a watchlist feed.</dd> <dt><a href="/w/api.php?action=help&modules=filerevert">filerevert</a></dt> <dd>Revert a file to an old version.</dd> <dt><a href="/w/api.php?action=help&modules=flow">flow</a></dt> <dd>Allows actions to be taken on Structured Discussions pages.</dd> <dt><a href="/w/api.php?action=help&modules=flow-parsoid-utils">flow-parsoid-utils</a></dt> <dd>Convert text between wikitext and HTML.</dd> <dt><a href="/w/api.php?action=help&modules=flowthank">flowthank</a></dt> <dd>Send a public thank-you notification for a Flow comment.</dd> <dt><a href="/w/api.php?action=help&modules=globalblock">globalblock</a></dt> <dd>Globally block or unblock a user.</dd> <dt><a href="/w/api.php?action=help&modules=globalpreferenceoverrides">globalpreferenceoverrides</a></dt> <dd>Change local overrides for global preferences for the current user.</dd> <dt><a href="/w/api.php?action=help&modules=globalpreferences">globalpreferences</a></dt> <dd>Change global preferences of the current user.</dd> <dt><a href="/w/api.php?action=help&modules=globaluserrights">globaluserrights</a></dt> <dd>Add/remove a user to/from global groups.</dd> <dt><a href="/w/api.php?action=help&modules=groupreview">groupreview</a></dt> <dd>Set message group workflow states.</dd> <dt><a href="/w/api.php?action=help&modules=help">help</a></dt> <dd>Display help for the specified modules.</dd> <dt><a href="/w/api.php?action=help&modules=imagerotate">imagerotate</a></dt> <dd>This module has been disabled.</dd> <dt><a href="/w/api.php?action=help&modules=import">import</a></dt> <dd>Import a page from another wiki, or from an XML file.</dd> <dt><a href="/w/api.php?action=help&modules=jsonconfig">jsonconfig</a></dt> <dd>Allows direct access to JsonConfig subsystem.</dd> <dt><a href="/w/api.php?action=help&modules=languagesearch">languagesearch</a></dt> <dd>Search for language names in any script.</dd> <dt><a href="/w/api.php?action=help&modules=linkaccount">linkaccount</a></dt> <dd>Link an account from a third-party provider to the current user.</dd> <dt><a href="/w/api.php?action=help&modules=login">login</a></dt> <dd>Log in and get authentication cookies.</dd> <dt><a href="/w/api.php?action=help&modules=logout">logout</a></dt> <dd>Log out and clear session data.</dd> <dt><a href="/w/api.php?action=help&modules=managetags">managetags</a></dt> <dd>Perform management tasks relating to change tags.</dd> <dt><a href="/w/api.php?action=help&modules=markfortranslation">markfortranslation</a></dt> <dd>Mark a page for translation</dd> <dt><a href="/w/api.php?action=help&modules=massmessage">massmessage</a></dt> <dd>Send a message to a list of pages.</dd> <dt><a href="/w/api.php?action=help&modules=mergehistory">mergehistory</a></dt> <dd>Merge page histories.</dd> <dt><a href="/w/api.php?action=help&modules=move">move</a></dt> <dd>Move a page.</dd> <dt><a href="/w/api.php?action=help&modules=newslettersubscribe">newslettersubscribe</a></dt> <dd>Subscribe to or unsubscribe from a newsletter.</dd> <dt><a href="/w/api.php?action=help&modules=opensearch">opensearch</a></dt> <dd>Search the wiki using the OpenSearch protocol.</dd> <dt><a href="/w/api.php?action=help&modules=options">options</a></dt> <dd>Change preferences of the current user.</dd> <dt><a href="/w/api.php?action=help&modules=paraminfo">paraminfo</a></dt> <dd>Obtain information about API modules.</dd> <dt><a href="/w/api.php?action=help&modules=parse">parse</a></dt> <dd>Parses content and returns parser output.</dd> <dt><a href="/w/api.php?action=help&modules=patrol">patrol</a></dt> <dd>Patrol a page or revision.</dd> <dt><a href="/w/api.php?action=help&modules=protect">protect</a></dt> <dd>Change the protection level of a page.</dd> <dt><a href="/w/api.php?action=help&modules=purge">purge</a></dt> <dd>Purge the cache for the given titles.</dd> <dt><a href="/w/api.php?action=help&modules=query">query</a></dt> <dd>Fetch data from and about MediaWiki.</dd> <dt><a href="/w/api.php?action=help&modules=removeauthenticationdata">removeauthenticationdata</a></dt> <dd>Remove authentication data for the current user.</dd> <dt><a href="/w/api.php?action=help&modules=resetpassword">resetpassword</a></dt> <dd>Send a password reset email to a user.</dd> <dt><a href="/w/api.php?action=help&modules=revisiondelete">revisiondelete</a></dt> <dd>Delete and undelete revisions.</dd> <dt><a href="/w/api.php?action=help&modules=rollback">rollback</a></dt> <dd>Undo the last edit to the page.</dd> <dt><a href="/w/api.php?action=help&modules=rsd">rsd</a></dt> <dd>Export an RSD (Really Simple Discovery) schema.</dd> <dt><a href="/w/api.php?action=help&modules=searchtranslations">searchtranslations</a></dt> <dd>Search translations.</dd> <dt><a href="/w/api.php?action=help&modules=setglobalaccountstatus">setglobalaccountstatus</a></dt> <dd>Hide or lock (or unhide or unlock) a global user account.</dd> <dt><a href="/w/api.php?action=help&modules=setnotificationtimestamp">setnotificationtimestamp</a></dt> <dd>Update the notification timestamp for watched pages.</dd> <dt><a href="/w/api.php?action=help&modules=setpagelanguage">setpagelanguage</a></dt> <dd>Change the language of a page.</dd> <dt><a href="/w/api.php?action=help&modules=shortenurl">shortenurl</a></dt> <dd>Shorten a long URL into a shorter one.</dd> <dt><a href="/w/api.php?action=help&modules=sitematrix">sitematrix</a></dt> <dd>Get Wikimedia sites list.</dd> <dt><a href="/w/api.php?action=help&modules=spamblacklist">spamblacklist</a></dt> <dd>Validate one or more URLs against the spam block list.</dd> <dt><a href="/w/api.php?action=help&modules=streamconfigs">streamconfigs</a></dt> <dd>Exposes event stream config. Returns only format=json with formatversion=2.</dd> <dt><a href="/w/api.php?action=help&modules=strikevote">strikevote</a></dt> <dd>Allows admins to strike or unstrike a vote.</dd> <dt><a href="/w/api.php?action=help&modules=tag">tag</a></dt> <dd>Add or remove change tags from individual revisions or log entries.</dd> <dt><a href="/w/api.php?action=help&modules=templatedata">templatedata</a></dt> <dd>Fetch data stored by the TemplateData extension.</dd> <dt><a href="/w/api.php?action=help&modules=thank">thank</a></dt> <dd>Send a thank-you notification to an editor.</dd> <dt><a href="/w/api.php?action=help&modules=threadaction">threadaction</a></dt> <dd>Allows actions to be taken on threads and posts in threaded discussions.</dd> <dt><a href="/w/api.php?action=help&modules=titleblacklist">titleblacklist</a></dt> <dd>Validate a page title, filename, or username against the TitleBlacklist.</dd> <dt><a href="/w/api.php?action=help&modules=torblock">torblock</a></dt> <dd>Check if an IP address is blocked as a Tor exit node.</dd> <dt><a href="/w/api.php?action=help&modules=transcodereset">transcodereset</a></dt> <dd>Users with the 'transcode-reset' right can reset and re-run a transcode job.</dd> <dt><a href="/w/api.php?action=help&modules=translationaids">translationaids</a></dt> <dd>Query all translations aids.</dd> <dt><a href="/w/api.php?action=help&modules=translationreview">translationreview</a></dt> <dd>Mark translations reviewed.</dd> <dt><a href="/w/api.php?action=help&modules=translationstats">translationstats</a></dt> <dd>Fetch translation statistics</dd> <dt><a href="/w/api.php?action=help&modules=ttmserver">ttmserver</a></dt> <dd>Query suggestions from translation memories.</dd> <dt><a href="/w/api.php?action=help&modules=unblock">unblock</a></dt> <dd>Unblock a user.</dd> <dt><a href="/w/api.php?action=help&modules=undelete">undelete</a></dt> <dd>Undelete revisions of a deleted page.</dd> <dt><a href="/w/api.php?action=help&modules=unlinkaccount">unlinkaccount</a></dt> <dd>Remove a linked third-party account from the current user.</dd> <dt><a href="/w/api.php?action=help&modules=upload">upload</a></dt> <dd>Upload a file, or get the status of pending uploads.</dd> <dt><a href="/w/api.php?action=help&modules=userrights">userrights</a></dt> <dd>Change a user's group membership.</dd> <dt><a href="/w/api.php?action=help&modules=validatepassword">validatepassword</a></dt> <dd>Validate a password against the wiki's password policies.</dd> <dt><a href="/w/api.php?action=help&modules=watch">watch</a></dt> <dd>Add or remove pages from the current user's watchlist.</dd> <dt><a href="/w/api.php?action=help&modules=webapp-manifest">webapp-manifest</a></dt> <dd>Returns a webapp manifest.</dd> <dt><a href="/w/api.php?action=help&modules=webauthn">webauthn</a></dt> <dd>API Module to communicate between server and client during registration/authentication process.</dd> <dt><a href="/w/api.php?action=help&modules=wikilove">wikilove</a></dt> <dd>Give WikiLove to another user.</dd> <dt><a href="/w/api.php?action=help&modules=bouncehandler">bouncehandler</a></dt> <dd>Internal. Receive a bounce email and process it to handle the failing recipient.</dd> <dt><a href="/w/api.php?action=help&modules=categorytree">categorytree</a></dt> <dd>Internal. Internal module for the CategoryTree extension.</dd> <dt><a href="/w/api.php?action=help&modules=cirrus-check-sanity">cirrus-check-sanity</a></dt> <dd>Internal. Reports on the correctness of a range of page ids in the search index</dd> <dt><a href="/w/api.php?action=help&modules=collection">collection</a></dt> <dd>Internal. API module for performing various operations on a wiki user's collection.</dd> <dt><a href="/w/api.php?action=help&modules=cspreport">cspreport</a></dt> <dd>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.</dd> <dt><a href="/w/api.php?action=help&modules=discussiontoolscompare">discussiontoolscompare</a></dt> <dd>Internal. Get information about comment changes between two page revisions.</dd> <dt><a href="/w/api.php?action=help&modules=discussiontoolspageinfo">discussiontoolspageinfo</a></dt> <dd>Internal. Returns metadata required to initialize the discussion tools.</dd> <dt><a href="/w/api.php?action=help&modules=discussiontoolspreview">discussiontoolspreview</a></dt> <dd>Internal. Preview a message on a discussion page.</dd> <dt><a href="/w/api.php?action=help&modules=editcheckreferenceurl">editcheckreferenceurl</a></dt> <dd>Internal. Check the status of a URL for use as a reference.</dd> <dt><a href="/w/api.php?action=help&modules=fancycaptchareload">fancycaptchareload</a></dt> <dd>Internal. Get a new FancyCaptcha.</dd> <dt><a href="/w/api.php?action=help&modules=jsondata">jsondata</a></dt> <dd>Internal. Retrieve localized JSON data.</dd> <dt><a href="/w/api.php?action=help&modules=managegroupsynchronizationcache">managegroupsynchronizationcache</a></dt> <dd>Internal. Manage group synchronization cache.</dd> <dt><a href="/w/api.php?action=help&modules=managemessagegroups">managemessagegroups</a></dt> <dd>Internal. Add a message as a rename of an existing message or a new message in the group during imports</dd> <dt><a href="/w/api.php?action=help&modules=messagegroupsubscription">messagegroupsubscription</a></dt> <dd>Internal. Message group subscription related operations</dd> <dt><a href="/w/api.php?action=help&modules=oathvalidate">oathvalidate</a></dt> <dd>Internal. Validate a two-factor authentication (OATH) token.</dd> <dt><a href="/w/api.php?action=help&modules=parser-migration">parser-migration</a></dt> <dd>Internal. Parse a page with two different parser configurations.</dd> <dt><a href="/w/api.php?action=help&modules=readinglists">readinglists</a></dt> <dd>Internal. Reading list write operations.</dd> <dt><a href="/w/api.php?action=help&modules=sanitize-mapdata">sanitize-mapdata</a></dt> <dd>Internal. Performs data validation for Kartographer extension</dd> <dt><a href="/w/api.php?action=help&modules=scribunto-console">scribunto-console</a></dt> <dd>Internal. Internal module for servicing XHR requests from the Scribunto console.</dd> <dt><a href="/w/api.php?action=help&modules=securepollauth">securepollauth</a></dt> <dd>Internal. Allows a remote wiki to authenticate users before granting access to vote in the election.</dd> <dt><a href="/w/api.php?action=help&modules=stashedit">stashedit</a></dt> <dd>Internal. Prepare an edit in shared cache.</dd> <dt><a href="/w/api.php?action=help&modules=timedtext">timedtext</a></dt> <dd>Internal. Provides timed text content for usage by <track> elements</dd> <dt><a href="/w/api.php?action=help&modules=translationcheck">translationcheck</a></dt> <dd>Internal. Validate translations.</dd> <dt><a href="/w/api.php?action=help&modules=translationentitysearch">translationentitysearch</a></dt> <dd>Internal. Search for message groups and messages</dd> <dt><a href="/w/api.php?action=help&modules=ulslocalization">ulslocalization</a></dt> <dd>Internal. Get the localization of ULS in the given language.</dd> <dt><a href="/w/api.php?action=help&modules=ulssetlang">ulssetlang</a></dt> <dd>Internal. Update user's preferred interface language.</dd> <dt><a href="/w/api.php?action=help&modules=visualeditor">visualeditor</a></dt> <dd>Internal. Returns HTML5 for a page from the Parsoid service.</dd> <dt><a href="/w/api.php?action=help&modules=visualeditoredit">visualeditoredit</a></dt> <dd>Internal. Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).</dd> <dt><a href="/w/api.php?action=help&modules=wikimediaeventsblockededit">wikimediaeventsblockededit</a></dt> <dd>Internal. Log information about blocked edit attempts</dd></dl></dd><dd class="info">One of the following values: <a href="/w/api.php?action=help&modules=abusefiltercheckmatch">abusefiltercheckmatch</a>, <a href="/w/api.php?action=help&modules=abusefilterchecksyntax">abusefilterchecksyntax</a>, <a href="/w/api.php?action=help&modules=abusefilterevalexpression">abusefilterevalexpression</a>, <a href="/w/api.php?action=help&modules=abusefilterunblockautopromote">abusefilterunblockautopromote</a>, <a href="/w/api.php?action=help&modules=abuselogprivatedetails">abuselogprivatedetails</a>, <a href="/w/api.php?action=help&modules=acquiretempusername">acquiretempusername</a>, <a href="/w/api.php?action=help&modules=aggregategroups">aggregategroups</a>, <a href="/w/api.php?action=help&modules=antispoof">antispoof</a>, <a href="/w/api.php?action=help&modules=block">block</a>, <a href="/w/api.php?action=help&modules=centralauthtoken">centralauthtoken</a>, <a href="/w/api.php?action=help&modules=centralnoticecdncacheupdatebanner">centralnoticecdncacheupdatebanner</a>, <a href="/w/api.php?action=help&modules=centralnoticechoicedata">centralnoticechoicedata</a>, <a href="/w/api.php?action=help&modules=centralnoticequerycampaign">centralnoticequerycampaign</a>, <a href="/w/api.php?action=help&modules=changeauthenticationdata">changeauthenticationdata</a>, <a href="/w/api.php?action=help&modules=changecontentmodel">changecontentmodel</a>, <a href="/w/api.php?action=help&modules=checktoken">checktoken</a>, <a href="/w/api.php?action=help&modules=cirrus-config-dump">cirrus-config-dump</a>, <a href="/w/api.php?action=help&modules=cirrus-mapping-dump">cirrus-mapping-dump</a>, <a href="/w/api.php?action=help&modules=cirrus-profiles-dump">cirrus-profiles-dump</a>, <a href="/w/api.php?action=help&modules=cirrus-settings-dump">cirrus-settings-dump</a>, <a href="/w/api.php?action=help&modules=clearhasmsg">clearhasmsg</a>, <a href="/w/api.php?action=help&modules=clientlogin">clientlogin</a>, <a href="/w/api.php?action=help&modules=compare">compare</a>, <a href="/w/api.php?action=help&modules=createaccount">createaccount</a>, <a href="/w/api.php?action=help&modules=createlocalaccount">createlocalaccount</a>, <a href="/w/api.php?action=help&modules=delete">delete</a>, <a href="/w/api.php?action=help&modules=deleteglobalaccount">deleteglobalaccount</a>, <a href="/w/api.php?action=help&modules=discussiontoolsedit">discussiontoolsedit</a>, <a href="/w/api.php?action=help&modules=discussiontoolsfindcomment">discussiontoolsfindcomment</a>, <a href="/w/api.php?action=help&modules=discussiontoolsgetsubscriptions">discussiontoolsgetsubscriptions</a>, <a href="/w/api.php?action=help&modules=discussiontoolssubscribe">discussiontoolssubscribe</a>, <a href="/w/api.php?action=help&modules=discussiontoolsthank">discussiontoolsthank</a>, <a href="/w/api.php?action=help&modules=echocreateevent">echocreateevent</a>, <a href="/w/api.php?action=help&modules=echomarkread">echomarkread</a>, <a href="/w/api.php?action=help&modules=echomarkseen">echomarkseen</a>, <a href="/w/api.php?action=help&modules=echomute">echomute</a>, <a href="/w/api.php?action=help&modules=edit">edit</a>, <a href="/w/api.php?action=help&modules=editmassmessagelist">editmassmessagelist</a>, <a href="/w/api.php?action=help&modules=emailuser">emailuser</a>, <a href="/w/api.php?action=help&modules=expandtemplates">expandtemplates</a>, <a href="/w/api.php?action=help&modules=featuredfeed">featuredfeed</a>, <a href="/w/api.php?action=help&modules=feedcontributions">feedcontributions</a>, <a href="/w/api.php?action=help&modules=feedrecentchanges">feedrecentchanges</a>, <a href="/w/api.php?action=help&modules=feedthreads">feedthreads</a>, <a href="/w/api.php?action=help&modules=feedwatchlist">feedwatchlist</a>, <a href="/w/api.php?action=help&modules=filerevert">filerevert</a>, <a href="/w/api.php?action=help&modules=flow-parsoid-utils">flow-parsoid-utils</a>, <a href="/w/api.php?action=help&modules=flow">flow</a>, <a href="/w/api.php?action=help&modules=flowthank">flowthank</a>, <a href="/w/api.php?action=help&modules=globalblock">globalblock</a>, <a href="/w/api.php?action=help&modules=globalpreferenceoverrides">globalpreferenceoverrides</a>, <a href="/w/api.php?action=help&modules=globalpreferences">globalpreferences</a>, <a href="/w/api.php?action=help&modules=globaluserrights">globaluserrights</a>, <a href="/w/api.php?action=help&modules=groupreview">groupreview</a>, <a href="/w/api.php?action=help&modules=help">help</a>, <a href="/w/api.php?action=help&modules=imagerotate">imagerotate</a>, <a href="/w/api.php?action=help&modules=import">import</a>, <a href="/w/api.php?action=help&modules=jsonconfig">jsonconfig</a>, <a href="/w/api.php?action=help&modules=languagesearch">languagesearch</a>, <a href="/w/api.php?action=help&modules=linkaccount">linkaccount</a>, <a href="/w/api.php?action=help&modules=login">login</a>, <a href="/w/api.php?action=help&modules=logout">logout</a>, <a href="/w/api.php?action=help&modules=managetags">managetags</a>, <a href="/w/api.php?action=help&modules=markfortranslation">markfortranslation</a>, <a href="/w/api.php?action=help&modules=massmessage">massmessage</a>, <a href="/w/api.php?action=help&modules=mergehistory">mergehistory</a>, <a href="/w/api.php?action=help&modules=move">move</a>, <a href="/w/api.php?action=help&modules=newslettersubscribe">newslettersubscribe</a>, <a href="/w/api.php?action=help&modules=opensearch">opensearch</a>, <a href="/w/api.php?action=help&modules=options">options</a>, <a href="/w/api.php?action=help&modules=paraminfo">paraminfo</a>, <a href="/w/api.php?action=help&modules=parse">parse</a>, <a href="/w/api.php?action=help&modules=patrol">patrol</a>, <a href="/w/api.php?action=help&modules=protect">protect</a>, <a href="/w/api.php?action=help&modules=purge">purge</a>, <a href="/w/api.php?action=help&modules=query">query</a>, <a href="/w/api.php?action=help&modules=removeauthenticationdata">removeauthenticationdata</a>, <a href="/w/api.php?action=help&modules=resetpassword">resetpassword</a>, <a href="/w/api.php?action=help&modules=revisiondelete">revisiondelete</a>, <a href="/w/api.php?action=help&modules=rollback">rollback</a>, <a href="/w/api.php?action=help&modules=rsd">rsd</a>, <a href="/w/api.php?action=help&modules=searchtranslations">searchtranslations</a>, <a href="/w/api.php?action=help&modules=setglobalaccountstatus">setglobalaccountstatus</a>, <a href="/w/api.php?action=help&modules=setnotificationtimestamp">setnotificationtimestamp</a>, <a href="/w/api.php?action=help&modules=setpagelanguage">setpagelanguage</a>, <a href="/w/api.php?action=help&modules=shortenurl">shortenurl</a>, <a href="/w/api.php?action=help&modules=sitematrix">sitematrix</a>, <a href="/w/api.php?action=help&modules=spamblacklist">spamblacklist</a>, <a href="/w/api.php?action=help&modules=streamconfigs">streamconfigs</a>, <a href="/w/api.php?action=help&modules=strikevote">strikevote</a>, <a href="/w/api.php?action=help&modules=tag">tag</a>, <a href="/w/api.php?action=help&modules=templatedata">templatedata</a>, <a href="/w/api.php?action=help&modules=thank">thank</a>, <a href="/w/api.php?action=help&modules=threadaction">threadaction</a>, <a href="/w/api.php?action=help&modules=titleblacklist">titleblacklist</a>, <a href="/w/api.php?action=help&modules=torblock">torblock</a>, <a href="/w/api.php?action=help&modules=transcodereset">transcodereset</a>, <a href="/w/api.php?action=help&modules=translationaids">translationaids</a>, <a href="/w/api.php?action=help&modules=translationreview">translationreview</a>, <a href="/w/api.php?action=help&modules=translationstats">translationstats</a>, <a href="/w/api.php?action=help&modules=ttmserver">ttmserver</a>, <a href="/w/api.php?action=help&modules=unblock">unblock</a>, <a href="/w/api.php?action=help&modules=undelete">undelete</a>, <a href="/w/api.php?action=help&modules=unlinkaccount">unlinkaccount</a>, <a href="/w/api.php?action=help&modules=upload">upload</a>, <a href="/w/api.php?action=help&modules=userrights">userrights</a>, <a href="/w/api.php?action=help&modules=validatepassword">validatepassword</a>, <a href="/w/api.php?action=help&modules=watch">watch</a>, <a href="/w/api.php?action=help&modules=webapp-manifest">webapp-manifest</a>, <a href="/w/api.php?action=help&modules=webauthn">webauthn</a>, <a href="/w/api.php?action=help&modules=wikilove">wikilove</a>, <a href="/w/api.php?action=help&modules=bouncehandler">bouncehandler</a>, <a href="/w/api.php?action=help&modules=categorytree">categorytree</a>, <a href="/w/api.php?action=help&modules=cirrus-check-sanity">cirrus-check-sanity</a>, <a href="/w/api.php?action=help&modules=collection">collection</a>, <a href="/w/api.php?action=help&modules=cspreport">cspreport</a>, <a href="/w/api.php?action=help&modules=discussiontoolscompare">discussiontoolscompare</a>, <a href="/w/api.php?action=help&modules=discussiontoolspageinfo">discussiontoolspageinfo</a>, <a href="/w/api.php?action=help&modules=discussiontoolspreview">discussiontoolspreview</a>, <a href="/w/api.php?action=help&modules=editcheckreferenceurl">editcheckreferenceurl</a>, <a href="/w/api.php?action=help&modules=fancycaptchareload">fancycaptchareload</a>, <a href="/w/api.php?action=help&modules=jsondata">jsondata</a>, <a href="/w/api.php?action=help&modules=managegroupsynchronizationcache">managegroupsynchronizationcache</a>, <a href="/w/api.php?action=help&modules=managemessagegroups">managemessagegroups</a>, <a href="/w/api.php?action=help&modules=messagegroupsubscription">messagegroupsubscription</a>, <a href="/w/api.php?action=help&modules=oathvalidate">oathvalidate</a>, <a href="/w/api.php?action=help&modules=parser-migration">parser-migration</a>, <a href="/w/api.php?action=help&modules=readinglists">readinglists</a>, <a href="/w/api.php?action=help&modules=sanitize-mapdata">sanitize-mapdata</a>, <a href="/w/api.php?action=help&modules=scribunto-console">scribunto-console</a>, <a href="/w/api.php?action=help&modules=securepollauth">securepollauth</a>, <a href="/w/api.php?action=help&modules=stashedit">stashedit</a>, <a href="/w/api.php?action=help&modules=timedtext">timedtext</a>, <a href="/w/api.php?action=help&modules=translationcheck">translationcheck</a>, <a href="/w/api.php?action=help&modules=translationentitysearch">translationentitysearch</a>, <a href="/w/api.php?action=help&modules=ulslocalization">ulslocalization</a>, <a href="/w/api.php?action=help&modules=ulssetlang">ulssetlang</a>, <a href="/w/api.php?action=help&modules=visualeditor">visualeditor</a>, <a href="/w/api.php?action=help&modules=visualeditoredit">visualeditoredit</a>, <a href="/w/api.php?action=help&modules=wikimediaeventsblockededit">wikimediaeventsblockededit</a></dd><dd class="info">Default: help</dd><dt>format</dt><dd class="description">The format of the output. <dl><dt><a href="/w/api.php?action=help&modules=json">json</a></dt> <dd>Output data in JSON format.</dd> <dt><a href="/w/api.php?action=help&modules=jsonfm">jsonfm</a></dt> <dd>Output data in JSON format (pretty-print in HTML).</dd> <dt><a href="/w/api.php?action=help&modules=none">none</a></dt> <dd>Output nothing.</dd> <dt><a href="/w/api.php?action=help&modules=php">php</a></dt> <dd>Output data in serialized PHP format.</dd> <dt><a href="/w/api.php?action=help&modules=phpfm">phpfm</a></dt> <dd>Output data in serialized PHP format (pretty-print in HTML).</dd> <dt><a href="/w/api.php?action=help&modules=rawfm">rawfm</a></dt> <dd>Output data, including debugging elements, in JSON format (pretty-print in HTML).</dd> <dt><a href="/w/api.php?action=help&modules=xml">xml</a></dt> <dd>Output data in XML format.</dd> <dt><a href="/w/api.php?action=help&modules=xmlfm">xmlfm</a></dt> <dd>Output data in XML format (pretty-print in HTML).</dd></dl></dd><dd class="info">One of the following values: <a href="/w/api.php?action=help&modules=json">json</a>, <a href="/w/api.php?action=help&modules=jsonfm">jsonfm</a>, <a href="/w/api.php?action=help&modules=none">none</a>, <a href="/w/api.php?action=help&modules=php">php</a>, <a href="/w/api.php?action=help&modules=phpfm">phpfm</a>, <a href="/w/api.php?action=help&modules=rawfm">rawfm</a>, <a href="/w/api.php?action=help&modules=xml">xml</a>, <a href="/w/api.php?action=help&modules=xmlfm">xmlfm</a></dd><dd class="info">Default: jsonfm</dd><dt>maxlag</dt><dd class="description">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 <samp>maxlag</samp> is returned with a message like <samp>Waiting for $host: $lag seconds lagged</samp>. See <a href="/wiki/Special:MyLanguage/Manual:Maxlag_parameter" title="Special:MyLanguage/Manual:Maxlag parameter">Manual: Maxlag parameter</a> for more information. </dd><dd class="info">Type: integer</dd><dt>smaxage</dt><dd class="description">Set the <code>s-maxage</code> HTTP cache control header to this many seconds. Errors are never cached. </dd><dd class="info">Type: integer</dd><dd class="info">The value must be no less than 0.</dd><dd class="info">Default: 0</dd><dt>maxage</dt><dd class="description">Set the <code>max-age</code> HTTP cache control header to this many seconds. Errors are never cached. </dd><dd class="info">Type: integer</dd><dd class="info">The value must be no less than 0.</dd><dd class="info">Default: 0</dd><dt>assert</dt><dd class="description">Verify that the user is logged in (including possibly as a temporary user) if set to <kbd>user</kbd>, not logged in if set to <kbd>anon</kbd>, or has the bot user right if <kbd>bot</kbd>. </dd><dd class="info">One of the following values: anon, bot, user</dd><dt>assertuser</dt><dd class="description">Verify the current user is the named user. </dd><dd class="info">Type: user, by any of username and Temporary user</dd><dt>requestid</dt><dd class="description">Any value given here will be included in the response. May be used to distinguish requests. </dd><dt>servedby</dt><dd class="description">Include the hostname that served the request in the results. </dd><dd class="info">Type: boolean (<a href="#main/datatype/boolean">details</a>)</dd><dt>curtimestamp</dt><dd class="description">Include the current timestamp in the result. </dd><dd class="info">Type: boolean (<a href="#main/datatype/boolean">details</a>)</dd><dt>responselanginfo</dt><dd class="description">Include the languages used for <var>uselang</var> and <var>errorlang</var> in the result. </dd><dd class="info">Type: boolean (<a href="#main/datatype/boolean">details</a>)</dd><dt>origin</dt><dd class="description">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 <code>Origin</code> header exactly, so it has to be set to something like <kbd><a class="external free" href="https://en.wikipedia.org">https://en.wikipedia.org</a></kbd> or <kbd><a class="external free" href="https://meta.wikimedia.org">https://meta.wikimedia.org</a></kbd>. If this parameter does not match the <code>Origin</code> header, a 403 response will be returned. If this parameter matches the <code>Origin</code> header and the origin is allowed, the <code>Access-Control-Allow-Origin</code> and <code>Access-Control-Allow-Credentials</code> headers will be set. For non-authenticated requests, specify the value <kbd>*</kbd>. This will cause the <code>Access-Control-Allow-Origin</code> header to be set, but <code>Access-Control-Allow-Credentials</code> will be <code>false</code> and all user-specific data will be restricted. </dd><dt>uselang</dt><dd class="description">Language to use for message translations. <kbd><a href="/w/api.php?action=help&modules=query%2Bsiteinfo">action=query&meta=siteinfo&siprop=languages</a></kbd> returns a list of language codes. You can specify <kbd>user</kbd> to use the current user's language preference or <kbd>content</kbd> to use this wiki's content language. </dd><dd class="info">Default: user</dd><dt>variant</dt><dd class="description">Variant of the language. Only works if the base language supports variant conversion. </dd><dt>errorformat</dt><dd class="description">Format to use for warning and error text output <dl><dt>plaintext</dt> <dd>Wikitext with HTML tags removed and entities replaced.</dd> <dt>wikitext</dt> <dd>Unparsed wikitext.</dd> <dt>html</dt> <dd>HTML</dd> <dt>raw</dt> <dd>Message key and parameters.</dd> <dt>none</dt> <dd>No text output, only the error codes.</dd> <dt>bc</dt> <dd>Format used prior to MediaWiki 1.29. <var>errorlang</var> and <var>errorsuselocal</var> are ignored.</dd></dl></dd><dd class="info">One of the following values: bc, html, none, plaintext, raw, wikitext</dd><dd class="info">Default: bc</dd><dt>errorlang</dt><dd class="description">Language to use for warnings and errors. <kbd><a href="/w/api.php?action=help&modules=query%2Bsiteinfo">action=query&meta=siteinfo&siprop=languages</a></kbd> returns a list of language codes. Specify <kbd>content</kbd> to use this wiki's content language or <kbd>uselang</kbd> to use the same value as the <var>uselang</var> parameter. </dd><dd class="info">Default: uselang</dd><dt>errorsuselocal</dt><dd class="description">If given, error texts will use locally-customized messages from the MediaWiki namespace. </dd><dd class="info">Type: boolean (<a href="#main/datatype/boolean">details</a>)</dd><dt>centralauthtoken</dt><dd class="description">When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use <kbd><a href="/w/api.php?action=help&modules=centralauthtoken">action=centralauthtoken</a></kbd> 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). </dd></dl></div> <div class="apihelp-block apihelp-examples"><div class="apihelp-block-head">Examples:</div><dl><dt>Help for the main module.</dt><dd><a href="/w/api.php?action=help" dir="ltr" rel="nofollow">api.php?action=help</a> <a href="/wiki/Special:ApiSandbox#action=help">[open in sandbox]</a></dd><dt>All help in one page.</dt><dd><a href="/w/api.php?action=help&recursivesubmodules=1" dir="ltr" rel="nofollow">api.php?action=help&recursivesubmodules=1</a> <a href="/wiki/Special:ApiSandbox#action=help&recursivesubmodules=1">[open in sandbox]</a></dd></dl></div> <div class="apihelp-block apihelp-permissions"><div class="apihelp-block-head">Permission:</div><dl><dt>apihighlimits</dt><dd>Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.</dd><dd>Granted to: bot and sysop</dd></dl></div> <h3 class="apihelp-header" id="main/datatypes">Data types</h3>Input to MediaWiki should be NFC-normalized UTF-8. MediaWiki may attempt to convert other input, but this may cause some operations (such as <a href="/w/api.php?action=help&modules=edit">edits</a> with MD5 checks) to fail. Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g. <kbd>param=value1|value2</kbd> or <kbd>param=value1%7Cvalue2</kbd>. If a value must contain the pipe character, use U+001F (Unit Separator) as the separator and prefix the value with U+001F, e.g. <kbd>param=%1Fvalue1%1Fvalue2</kbd>. Some parameter types in API requests need further explanation: <dl><dt id="main/datatype/boolean">boolean</dt><dd>Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely. </dd><dt id="main/datatype/expiry">expiry</dt><dd>Expiry values may be relative (e.g. <kbd>5 months</kbd> or <kbd>2 weeks</kbd>) or absolute (e.g. <kbd>2014-09-18T12:34:56Z</kbd>). For no expiry, use <kbd>infinite</kbd>, <kbd>indefinite</kbd>, <kbd>infinity</kbd> or <kbd>never</kbd>. </dd><dt id="main/datatype/timestamp">timestamp</dt><dd>Timestamps may be specified in several formats, see <a href="/wiki/Special:MyLanguage/Timestamp" title="Special:MyLanguage/Timestamp">the Timestamp library input formats documented on mediawiki.org</a> for details. ISO 8601 date and time is recommended: <kbd><var>2001</var>-<var>01</var>-<var>15</var>T<var>14</var>:<var>56</var>:<var>00</var>Z</kbd>. Additionally, the string <kbd>now</kbd> may be used to specify the current timestamp. </dd></dl> <h3 class="apihelp-header" id="main/templatedparams">Templated parameters</h3>Templated parameters support cases where an API module needs a value for each value of some other parameter. For example, if there were an API module to request fruit, it might have a parameter <var>fruits</var> to specify which fruits are being requested and a templated parameter <var>{fruit}-quantity</var> to specify how many of each fruit to request. An API client that wants 1 apple, 5 bananas, and 20 strawberries could then make a request like <kbd>fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20</kbd>. <h3 class="apihelp-header" id="main/credits">Credits</h3>API developers: <ul><li>Yuri Astrakhan (creator, lead developer Sep 2006–Sep 2007)</li> <li>Roan Kattouw (lead developer Sep 2007–2009)</li> <li>Victor Vasiliev</li> <li>Bryan Tong Minh</li> <li>Sam Reed</li> <li>Brad Jorsch (lead developer 2013–2020)</li></ul> Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org or file a bug report at <a class="external free" href="https://phabricator.wikimedia.org/">https://phabricator.wikimedia.org/</a>. <noscript><img src="https://login.wikimedia.org/wiki/Special:CentralAutoLogin/start?type=1x1" alt="" width="1" height="1" style="border: none; position: absolute;"></noscript> <div class="printfooter" data-nosnippet="">Retrieved from "<a dir="ltr" href="https://www.mediawiki.org/wiki/Special:ApiHelp">https://www.mediawiki.org/wiki/Special:ApiHelp</a>"</div></div> </div> </div> <script>(RLQ=window.RLQ||[]).push(function(){mw.log.warn("This page is using the deprecated ResourceLoader module \"mediawiki.skinning.interface\".\n[1.43] The use of the `interface-message-box` feature with SkinModule is deprecated in favor of CodexModule. Please remove this feature.More information can be found at [[mw:Manual:ResourceLoaderSkinModule]]. ");mw.config.set({"wgHostname":"mw-api-ext.codfw.main-74d78f4769-ns6cb","wgBackendResponseTime":373});});</script> </body> </html>