CINXE.COM

<!DOCTYPE html> <html class="client-nojs vector-feature-language-in-header-disabled vector-feature-language-in-main-page-header-disabled vector-feature-page-tools-pinned-disabled vector-feature-toc-pinned-clientpref-1 vector-feature-main-menu-pinned-disabled vector-feature-limited-width-clientpref-1 vector-feature-limited-width-content-enabled vector-feature-custom-font-size-clientpref-1 vector-feature-appearance-pinned-clientpref-1 vector-feature-night-mode-disabled skin-theme-clientpref-day vector-sticky-header-enabled vector-toc-available" lang="en" dir="ltr"> <head> <meta charset="UTF-8"> <title>API:Main page - MediaWiki</title> <script>(function(){var className="client-js vector-feature-language-in-header-disabled vector-feature-language-in-main-page-header-disabled vector-feature-page-tools-pinned-disabled vector-feature-toc-pinned-clientpref-1 vector-feature-main-menu-pinned-disabled vector-feature-limited-width-clientpref-1 vector-feature-limited-width-content-enabled vector-feature-custom-font-size-clientpref-1 vector-feature-appearance-pinned-clientpref-1 vector-feature-night-mode-disabled skin-theme-clientpref-day vector-sticky-header-enabled vector-toc-available";var cookie=document.cookie.match(/(?:^|; )mediawikiwikimwclientpreferences=([^;]+)/);if(cookie){cookie[1].split('%2C').forEach(function(pref){className=className.replace(new RegExp('(^| )'+pref.replace(/-clientpref-\w+$|[^\w-]+/g,'')+'-clientpref-\\w+( |$)'),'$1'+pref+'$2');});}document.documentElement.className=className;}());RLCONF={"wgBreakFrames":true,"wgSeparatorTransformTable":["",""],"wgDigitTransformTable":["",""],"wgDefaultDateFormat":"dmy", "wgMonthNames":["","January","February","March","April","May","June","July","August","September","October","November","December"],"wgRequestId":"aea20715-e329-4623-9aa9-ace176f97efe","wgCanonicalNamespace":"API","wgCanonicalSpecialPageName":false,"wgNamespaceNumber":104,"wgPageName":"API:Main_page","wgTitle":"Main page","wgCurRevisionId":6703085,"wgRevisionId":6703085,"wgArticleId":14588,"wgIsArticle":true,"wgIsRedirect":false,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":["MediaWiki action API","MediaWiki development","Manual","Documentation","New contributors"],"wgPageViewLanguage":"en","wgPageContentLanguage":"en","wgPageContentModel":"wikitext","wgRelevantPageName":"API:Main_page","wgRelevantArticleId":14588,"wgIsProbablyEditable":false,"wgRelevantPageIsProbablyEditable":false,"wgRestrictionEdit":["autoconfirmed"],"wgRestrictionMove":["sysop"],"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":4000,"wgTranslatePageTranslation":"source","wgEditSubmitButtonLabelPublish":true,"wgULSPosition":"personal","wgULSisCompactLinksEnabled":true,"wgVector2022LanguageInHeader":false,"wgULSisLanguageSelectorEmpty":false,"wgWikibaseItemId":"Q53409818","wgCheckUserClientHintsHeadersJsApi":["brands","architecture","bitness","fullVersionList","mobile","model","platform","platformVersion"]};RLSTATE={"ext.globalCssJs.user.styles":"ready","site.styles":"ready","user.styles":"ready","ext.globalCssJs.user":"ready","user":"ready","user.options":"loading","ext.translate.tag.languages":"ready","mediawiki.codex.messagebox.styles":"ready","mediawiki.hlist":"ready","mediawiki.apipretty":"ready", "skins.vector.search.codex.styles":"ready","skins.vector.styles":"ready","skins.vector.icons":"ready","ext.translate.edit.documentation.styles":"ready","ext.translate":"ready","ext.wikimediamessages.styles":"ready","ext.visualEditor.desktopArticleTarget.noscript":"ready","ext.uls.pt":"ready","wikibase.client.init":"ready","ext.wikimediaBadges":"ready"};RLPAGEMODULES=["site","mediawiki.page.ready","mediawiki.toc","skins.vector.js","ext.centralNotice.geoIP","ext.centralNotice.startUp","ext.translate.pagetranslation.uls","ext.urlShortener.toolbar","ext.centralauth.centralautologin","mmv.bootstrap","ext.visualEditor.desktopArticleTarget.init","ext.visualEditor.targetLoader","ext.echo.centralauth","ext.eventLogging","ext.wikimediaEvents","ext.navigationTiming","ext.uls.compactlinks","ext.uls.interface","wikibase.client.vector-2022","ext.checkUser.clientHints"];</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.translate%2CwikimediaBadges%7Cext.translate.edit.documentation.styles%7Cext.translate.tag.languages%7Cext.uls.pt%7Cext.visualEditor.desktopArticleTarget.noscript%7Cext.wikimediamessages.styles%7Cmediawiki.apipretty%2Chlist%7Cmediawiki.codex.messagebox.styles%7Cskins.vector.icons%2Cstyles%7Cskins.vector.search.codex.styles%7Cwikibase.client.init&only=styles&skin=vector-2022"> <script async="" src="/w/load.php?lang=en&modules=startup&only=scripts&raw=1&skin=vector-2022"></script> <meta name="ResourceLoaderDynamicStyles" content=""> <link rel="stylesheet" href="/w/load.php?lang=en&modules=site.styles&only=styles&skin=vector-2022"> <meta name="generator" content="MediaWiki 1.44.0-wmf.17"> <meta name="referrer" content="origin"> <meta name="referrer" content="origin-when-cross-origin"> <meta name="robots" content="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="API:Main page - MediaWiki"> <meta property="og:type" content="website"> <link rel="preconnect" href="//upload.wikimedia.org"> <link rel="alternate" media="only screen and (max-width: 640px)" href="//m.mediawiki.org/wiki/API:Main_page"> <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/API:Main_page"> <link rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/"> <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="//meta.wikimedia.org" /> <link rel="dns-prefetch" href="login.wikimedia.org"> </head> <body class="skin--responsive skin-vector skin-vector-search-vue mediawiki ltr sitedir-ltr mw-hide-empty-elt ns-104 ns-subject page-API_Main_page rootpage-API_Main_page skin-vector-2022 action-view"><a class="mw-jump-link" href="#bodyContent">Jump to content</a> <div class="vector-header-container"> <header class="vector-header mw-header"> <div class="vector-header-start"> <nav class="vector-main-menu-landmark" aria-label="Site"> <div id="vector-main-menu-dropdown" class="vector-dropdown vector-main-menu-dropdown vector-button-flush-left vector-button-flush-right" title="Main menu" > <input type="checkbox" id="vector-main-menu-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-main-menu-dropdown" class="vector-dropdown-checkbox " aria-label="Main menu" > <label id="vector-main-menu-dropdown-label" for="vector-main-menu-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" ><span class="vector-icon mw-ui-icon-menu mw-ui-icon-wikimedia-menu"></span> <span class="vector-dropdown-label-text">Main menu</span> </label> <div class="vector-dropdown-content"> <div id="vector-main-menu-unpinned-container" class="vector-unpinned-container"> <div id="vector-main-menu" class="vector-main-menu vector-pinnable-element"> <div class="vector-pinnable-header vector-main-menu-pinnable-header vector-pinnable-header-unpinned" data-feature-name="main-menu-pinned" data-pinnable-element-id="vector-main-menu" data-pinned-container-id="vector-main-menu-pinned-container" data-unpinned-container-id="vector-main-menu-unpinned-container" > <div class="vector-pinnable-header-label">Main menu</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-main-menu.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-main-menu.unpin">hide</button> </div> <div id="p-navigation" class="vector-menu mw-portlet mw-portlet-navigation" > <div class="vector-menu-heading"> Navigation </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-mainpage-description" class="mw-list-item"><a href="/wiki/MediaWiki" title="Visit the main page [z]" accesskey="z"><span>Main page</span></a></li><li id="n-mw-download" class="mw-list-item"><a href="/wiki/Download"><span>Get MediaWiki</span></a></li><li id="n-mw-extensions" class="mw-list-item"><a href="/wiki/Special:MyLanguage/Category:Extensions"><span>Get extensions</span></a></li><li id="n-blog-text" class="mw-list-item"><a href="https://techblog.wikimedia.org/"><span>Tech blog</span></a></li><li id="n-mw-contribute" class="mw-list-item"><a href="/wiki/Special:MyLanguage/How_to_contribute"><span>Contribute</span></a></li> </ul> </div> </div> <div id="p-support" class="vector-menu mw-portlet mw-portlet-support" > <div class="vector-menu-heading"> Support </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-help" class="mw-list-item"><a href="/wiki/Special:MyLanguage/Help:Contents" title="The place to find out"><span>User help</span></a></li><li id="n-mw-faq" class="mw-list-item"><a href="/wiki/Special:MyLanguage/Manual:FAQ"><span>FAQ</span></a></li><li id="n-mw-manual" class="mw-list-item"><a href="/wiki/Special:MyLanguage/Manual:Contents"><span>Technical manual</span></a></li><li id="n-mw-supportdesk" class="mw-list-item"><a href="/wiki/Project:Support_desk"><span>Support desk</span></a></li><li id="n-mw-communication" class="mw-list-item"><a href="/wiki/Special:MyLanguage/Communication"><span>Communication</span></a></li> </ul> </div> </div> <div id="p-development" class="vector-menu mw-portlet mw-portlet-development" > <div class="vector-menu-heading"> Development </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-mw-developerportal" class="mw-list-item"><a href="https://developer.wikimedia.org/"><span>Developer portal</span></a></li><li id="n-svn-statistics" class="mw-list-item"><a href="/wiki/Development_statistics"><span>Code statistics</span></a></li> </ul> </div> </div> <div id="p-mediawiki.org" class="vector-menu mw-portlet mw-portlet-mediawiki_org" > <div class="vector-menu-heading"> mediawiki.org </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-portal" class="mw-list-item"><a href="/wiki/Project:Help" title="About the project, what you can do, where to find things"><span>Community portal</span></a></li><li id="n-recentchanges" class="mw-list-item"><a href="/wiki/Special:RecentChanges" title="A list of recent changes in the wiki [r]" accesskey="r"><span>Recent changes</span></a></li><li id="n-mw-translate" class="mw-list-item"><a href="/wiki/Special:LanguageStats"><span>Translate content</span></a></li><li id="n-specialpages" class="mw-list-item"><a href="/wiki/Special:SpecialPages"><span>Special pages</span></a></li><li id="n-randompage" class="mw-list-item"><a href="/wiki/Special:Random" title="Load a random page [x]" accesskey="x"><span>Random page</span></a></li><li id="n-mw-discussion" class="mw-list-item"><a href="/wiki/Project:Village_Pump"><span>Village pump</span></a></li><li id="n-Sandboxlink-portlet-label" class="mw-list-item"><a href="/wiki/Project:Sandbox"><span>Sandbox</span></a></li> </ul> </div> </div> <div id="p-lang" class="vector-menu mw-portlet mw-portlet-lang" > <div class="vector-menu-heading"> In other languages </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li class="interlanguage-link interwiki-en mw-list-item"><a href="https://en.wikipedia.org/wiki/Help:API" title="Help:API – English" lang="en" hreflang="en" data-title="Help:API" data-language-autonym="English" data-language-local-name="English" class="interlanguage-link-target"><span>English</span></a></li><li class="interlanguage-link interwiki-fr mw-list-item"><a href="https://fr.wikipedia.org/wiki/Aide:Interface_de_programmation" title="Aide:Interface de programmation – French" lang="fr" hreflang="fr" data-title="Aide:Interface de programmation" data-language-autonym="Français" data-language-local-name="French" class="interlanguage-link-target"><span>Français</span></a></li> </ul> <div class="after-portlet after-portlet-lang"><span class="wb-langlinks-edit wb-langlinks-link"><a href="https://www.wikidata.org/wiki/Special:EntityPage/Q53409818#sitelinks-wikipedia" title="Edit interlanguage links" class="wbc-editpage">Edit links</a></span></div> </div> </div> </div> </div> </div> </div> </nav> <a href="/wiki/MediaWiki" class="mw-logo"> <img class="mw-logo-icon" src="/static/images/icons/mediawikiwiki.svg" alt="" aria-hidden="true" height="50" width="50"> <span class="mw-logo-container skin-invert"> <img class="mw-logo-wordmark" alt="MediaWiki" src="/static/images/mobile/copyright/mediawikiwiki-wordmark.svg" style="width: 7.5em; height: 1.125em;"> </span> </a> </div> <div class="vector-header-end"> <div id="p-search" role="search" class="vector-search-box-vue vector-search-box-collapses vector-search-box-show-thumbnail vector-search-box-auto-expand-width vector-search-box"> <a href="/wiki/Special:Search" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only search-toggle" title="Search MediaWiki [f]" accesskey="f"><span class="vector-icon mw-ui-icon-search mw-ui-icon-wikimedia-search"></span> <span>Search</span> </a> <div class="vector-typeahead-search-container"> <div class="cdx-typeahead-search cdx-typeahead-search--show-thumbnail cdx-typeahead-search--auto-expand-width"> <form action="/w/index.php" id="searchform" class="cdx-search-input cdx-search-input--has-end-button"> <div id="simpleSearch" class="cdx-search-input__input-wrapper" data-search-loc="header-moved"> <div class="cdx-text-input cdx-text-input--has-start-icon"> <input class="cdx-text-input__input" type="search" name="search" placeholder="Search mediawiki.org" aria-label="Search mediawiki.org" autocapitalize="sentences" title="Search MediaWiki [f]" accesskey="f" id="searchInput" > <span class="cdx-text-input__icon cdx-text-input__start-icon"></span> </div> <input type="hidden" name="title" value="Special:Search"> </div> <button class="cdx-button cdx-search-input__end-button">Search</button> </form> </div> </div> </div> <nav class="vector-user-links vector-user-links-wide" aria-label="Personal tools"> <div class="vector-user-links-main"> <div id="p-vector-user-menu-preferences" class="vector-menu mw-portlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-uls" class="mw-list-item active user-links-collapsible-item"><a data-mw="interface" href="#" class="uls-trigger cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet"><span class="vector-icon mw-ui-icon-wikimedia-language mw-ui-icon-wikimedia-wikimedia-language"></span> <span>English</span></a> </li> </ul> </div> </div> <div id="p-vector-user-menu-userpage" class="vector-menu mw-portlet emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> <nav class="vector-appearance-landmark" aria-label="Appearance"> <div id="vector-appearance-dropdown" class="vector-dropdown " title="Change the appearance of the page's font size, width, and color" > <input type="checkbox" id="vector-appearance-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-appearance-dropdown" class="vector-dropdown-checkbox " aria-label="Appearance" > <label id="vector-appearance-dropdown-label" for="vector-appearance-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" ><span class="vector-icon mw-ui-icon-appearance mw-ui-icon-wikimedia-appearance"></span> <span class="vector-dropdown-label-text">Appearance</span> </label> <div class="vector-dropdown-content"> <div id="vector-appearance-unpinned-container" class="vector-unpinned-container"> </div> </div> </div> </nav> <div id="p-vector-user-menu-notifications" class="vector-menu mw-portlet emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> <div id="p-vector-user-menu-overflow" class="vector-menu mw-portlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-sitesupport-2" class="user-links-collapsible-item mw-list-item user-links-collapsible-item"><a data-mw="interface" href="https://donate.wikimedia.org/?wmf_source=donate&wmf_medium=sidebar&wmf_campaign=www.mediawiki.org&uselang=en" class=""><span>Donate</span></a> </li> <li id="pt-createaccount-2" class="user-links-collapsible-item mw-list-item user-links-collapsible-item"><a data-mw="interface" href="/w/index.php?title=Special:CreateAccount&returnto=API%3AMain+page" title="You are encouraged to create an account and log in; however, it is not mandatory" class=""><span>Create account</span></a> </li> <li id="pt-login-2" class="user-links-collapsible-item mw-list-item user-links-collapsible-item"><a data-mw="interface" href="/w/index.php?title=Special:UserLogin&returnto=API%3AMain+page" title="You are encouraged to log in; however, it is not mandatory [o]" accesskey="o" class=""><span>Log in</span></a> </li> </ul> </div> </div> </div> <div id="vector-user-links-dropdown" class="vector-dropdown vector-user-menu vector-button-flush-right vector-user-menu-logged-out" title="More options" > <input type="checkbox" id="vector-user-links-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-user-links-dropdown" class="vector-dropdown-checkbox " aria-label="Personal tools" > <label id="vector-user-links-dropdown-label" for="vector-user-links-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" ><span class="vector-icon mw-ui-icon-ellipsis mw-ui-icon-wikimedia-ellipsis"></span> <span class="vector-dropdown-label-text">Personal tools</span> </label> <div class="vector-dropdown-content"> <div id="p-personal" class="vector-menu mw-portlet mw-portlet-personal user-links-collapsible-item" title="User menu" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-sitesupport" class="user-links-collapsible-item mw-list-item"><a href="https://donate.wikimedia.org/?wmf_source=donate&wmf_medium=sidebar&wmf_campaign=www.mediawiki.org&uselang=en"><span>Donate</span></a></li><li id="pt-createaccount" class="user-links-collapsible-item mw-list-item"><a href="/w/index.php?title=Special:CreateAccount&returnto=API%3AMain+page" title="You are encouraged to create an account and log in; however, it is not mandatory"><span class="vector-icon mw-ui-icon-userAdd mw-ui-icon-wikimedia-userAdd"></span> <span>Create account</span></a></li><li id="pt-login" class="user-links-collapsible-item mw-list-item"><a href="/w/index.php?title=Special:UserLogin&returnto=API%3AMain+page" title="You are encouraged to log in; however, it is not mandatory [o]" accesskey="o"><span class="vector-icon mw-ui-icon-logIn mw-ui-icon-wikimedia-logIn"></span> <span>Log in</span></a></li> </ul> </div> </div> <div id="p-user-menu-anon-editor" class="vector-menu mw-portlet mw-portlet-user-menu-anon-editor" > <div class="vector-menu-heading"> Pages for logged out editors <a href="/wiki/Help:Introduction" aria-label="Learn more about editing"><span>learn more</span></a> </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-anoncontribs" class="mw-list-item"><a href="/wiki/Special:MyContributions" title="A list of edits made from this IP address [y]" accesskey="y"><span>Contributions</span></a></li><li id="pt-anontalk" class="mw-list-item"><a href="/wiki/Special:MyTalk" title="Discussion about edits from this IP address [n]" accesskey="n"><span>Talk</span></a></li> </ul> </div> </div> </div> </div> </nav> </div> </header> </div> <div class="mw-page-container"> <div class="mw-page-container-inner"> <div class="vector-sitenotice-container"> <div id="siteNotice"></div> </div> <div class="vector-column-start"> <div class="vector-main-menu-container"> <div id="mw-navigation"> <nav id="mw-panel" class="vector-main-menu-landmark" aria-label="Site"> <div id="vector-main-menu-pinned-container" class="vector-pinned-container"> </div> </nav> </div> </div> <div class="vector-sticky-pinned-container"> <nav id="mw-panel-toc" aria-label="Contents" data-event-name="ui.sidebar-toc" class="mw-table-of-contents-container vector-toc-landmark"> <div id="vector-toc-pinned-container" class="vector-pinned-container"> <div id="vector-toc" class="vector-toc vector-pinnable-element"> <div class="vector-pinnable-header vector-toc-pinnable-header vector-pinnable-header-pinned" data-feature-name="toc-pinned" data-pinnable-element-id="vector-toc" > <h2 class="vector-pinnable-header-label">Contents</h2> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-toc.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-toc.unpin">hide</button> </div> <ul class="vector-toc-contents" id="mw-panel-toc-list"> <li id="toc-mw-content-text" class="vector-toc-list-item vector-toc-level-1"> <a href="#" class="vector-toc-link"> <div class="vector-toc-text">Beginning</div> </a> </li> <li id="toc-Quick_Start" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#Quick_Start"> <div class="vector-toc-text"> <span class="vector-toc-numb">1</span> <span>Quick Start</span> </div> </a> <button aria-controls="toc-Quick_Start-sublist" class="cdx-button cdx-button--weight-quiet cdx-button--icon-only vector-toc-toggle"> <span class="vector-icon mw-ui-icon-wikimedia-expand"></span> <span>Toggle Quick Start subsection</span> </button> <ul id="toc-Quick_Start-sublist" class="vector-toc-list"> <li id="toc-Endpoint" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Endpoint"> <div class="vector-toc-text"> <span class="vector-toc-numb">1.1</span> <span>Endpoint</span> </div> </a> <ul id="toc-Endpoint-sublist" class="vector-toc-list"> </ul> </li> </ul> </li> <li id="toc-Introduction" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#Introduction"> <div class="vector-toc-text"> <span class="vector-toc-numb">2</span> <span>Introduction</span> </div> </a> <button aria-controls="toc-Introduction-sublist" class="cdx-button cdx-button--weight-quiet cdx-button--icon-only vector-toc-toggle"> <span class="vector-icon mw-ui-icon-wikimedia-expand"></span> <span>Toggle Introduction subsection</span> </button> <ul id="toc-Introduction-sublist" class="vector-toc-list"> <li id="toc-Uses_for_the_MediaWiki_Action_API" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Uses_for_the_MediaWiki_Action_API"> <div class="vector-toc-text"> <span class="vector-toc-numb">2.1</span> <span>Uses for the MediaWiki Action API</span> </div> </a> <ul id="toc-Uses_for_the_MediaWiki_Action_API-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Getting_started_with_MediaWiki_Action_API" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Getting_started_with_MediaWiki_Action_API"> <div class="vector-toc-text"> <span class="vector-toc-numb">2.2</span> <span>Getting started with MediaWiki Action API</span> </div> </a> <ul id="toc-Getting_started_with_MediaWiki_Action_API-sublist" class="vector-toc-list"> </ul> </li> </ul> </li> <li id="toc-API_documentation" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#API_documentation"> <div class="vector-toc-text"> <span class="vector-toc-numb">3</span> <span>API documentation</span> </div> </a> <ul id="toc-API_documentation-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Other_APIs" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#Other_APIs"> <div class="vector-toc-text"> <span class="vector-toc-numb">4</span> <span>Other APIs</span> </div> </a> <ul id="toc-Other_APIs-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Code_stewardship" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#Code_stewardship"> <div class="vector-toc-text"> <span class="vector-toc-numb">5</span> <span>Code stewardship</span> </div> </a> <ul id="toc-Code_stewardship-sublist" class="vector-toc-list"> </ul> </li> </ul> </div> </div> </nav> </div> </div> <div class="mw-content-container"> <main id="content" class="mw-body"> <header class="mw-body-header vector-page-titlebar"> <nav aria-label="Contents" class="vector-toc-landmark"> <div id="vector-page-titlebar-toc" class="vector-dropdown vector-page-titlebar-toc vector-button-flush-left" title="Table of Contents" > <input type="checkbox" id="vector-page-titlebar-toc-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-page-titlebar-toc" class="vector-dropdown-checkbox " aria-label="Toggle the table of contents" > <label id="vector-page-titlebar-toc-label" for="vector-page-titlebar-toc-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" ><span class="vector-icon mw-ui-icon-listBullet mw-ui-icon-wikimedia-listBullet"></span> <span class="vector-dropdown-label-text">Toggle the table of contents</span> </label> <div class="vector-dropdown-content"> <div id="vector-page-titlebar-toc-unpinned-container" class="vector-unpinned-container"> </div> </div> </div> </nav> <h1 id="firstHeading" class="firstHeading mw-first-heading"><span class="mw-page-title-namespace">API</span><span class="mw-page-title-separator">:</span><span class="mw-page-title-main">Main page</span></h1> <div class="mw-indicators"> </div> </header> <div class="vector-page-toolbar"> <div class="vector-page-toolbar-container"> <div id="left-navigation"> <nav aria-label="Namespaces"> <div id="p-associated-pages" class="vector-menu vector-menu-tabs mw-portlet mw-portlet-associated-pages" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-nstab-api" class="selected vector-tab-noicon mw-list-item"><a href="/wiki/API:Main_page" title="View the subject page [c]" accesskey="c"><span>API</span></a></li><li id="ca-talk" class="vector-tab-noicon mw-list-item"><a href="/wiki/API_talk:Main_page" rel="discussion" title="Discussion about the content page [t]" accesskey="t"><span>Discussion</span></a></li> </ul> </div> </div> <div id="vector-variants-dropdown" class="vector-dropdown emptyPortlet" > <input type="checkbox" id="vector-variants-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-variants-dropdown" class="vector-dropdown-checkbox " aria-label="Change language variant" > <label id="vector-variants-dropdown-label" for="vector-variants-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet" aria-hidden="true" ><span class="vector-dropdown-label-text">English</span> </label> <div class="vector-dropdown-content"> <div id="p-variants" class="vector-menu mw-portlet mw-portlet-variants emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> </div> </div> </nav> </div> <div id="right-navigation" class="vector-collapsible"> <nav aria-label="Views"> <div id="p-views" class="vector-menu vector-menu-tabs mw-portlet mw-portlet-views" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-view" class="selected vector-tab-noicon mw-list-item"><a href="/wiki/API:Main_page"><span>Read</span></a></li><li id="ca-viewsource" class="vector-tab-noicon mw-list-item"><a href="/w/index.php?title=API:Main_page&action=edit" title="This page is protected.
You can view its source [e]" accesskey="e"><span>View source</span></a></li><li id="ca-history" class="vector-tab-noicon mw-list-item"><a href="/w/index.php?title=API:Main_page&action=history" title="Past revisions of this page [h]" accesskey="h"><span>View history</span></a></li> </ul> </div> </div> </nav> <nav class="vector-page-tools-landmark" aria-label="Page tools"> <div id="vector-page-tools-dropdown" class="vector-dropdown vector-page-tools-dropdown" > <input type="checkbox" id="vector-page-tools-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-page-tools-dropdown" class="vector-dropdown-checkbox " aria-label="Tools" > <label id="vector-page-tools-dropdown-label" for="vector-page-tools-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet" aria-hidden="true" ><span class="vector-dropdown-label-text">Tools</span> </label> <div class="vector-dropdown-content"> <div id="vector-page-tools-unpinned-container" class="vector-unpinned-container"> <div id="vector-page-tools" class="vector-page-tools vector-pinnable-element"> <div class="vector-pinnable-header vector-page-tools-pinnable-header vector-pinnable-header-unpinned" data-feature-name="page-tools-pinned" data-pinnable-element-id="vector-page-tools" data-pinned-container-id="vector-page-tools-pinned-container" data-unpinned-container-id="vector-page-tools-unpinned-container" > <div class="vector-pinnable-header-label">Tools</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-page-tools.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-page-tools.unpin">hide</button> </div> <div id="p-cactions" class="vector-menu mw-portlet mw-portlet-cactions emptyPortlet vector-has-collapsible-items" title="More options" > <div class="vector-menu-heading"> Actions </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-more-view" class="selected vector-more-collapsible-item mw-list-item"><a href="/wiki/API:Main_page"><span>Read</span></a></li><li id="ca-more-viewsource" class="vector-more-collapsible-item mw-list-item"><a href="/w/index.php?title=API:Main_page&action=edit"><span>View source</span></a></li><li id="ca-more-history" class="vector-more-collapsible-item mw-list-item"><a href="/w/index.php?title=API:Main_page&action=history"><span>View history</span></a></li> </ul> </div> </div> <div id="p-tb" class="vector-menu mw-portlet mw-portlet-tb" > <div class="vector-menu-heading"> General </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="t-whatlinkshere" class="mw-list-item"><a href="/wiki/Special:WhatLinksHere/API:Main_page" title="A list of all wiki pages that link here [j]" accesskey="j"><span>What links here</span></a></li><li id="t-recentchangeslinked" class="mw-list-item"><a href="/wiki/Special:RecentChangesLinked/API:Main_page" rel="nofollow" title="Recent changes in pages linked from this page [k]" accesskey="k"><span>Related changes</span></a></li><li id="t-upload" class="mw-list-item"><a href="//commons.wikimedia.org/wiki/Special:UploadWizard" title="Upload files [u]" accesskey="u"><span>Upload file</span></a></li><li id="t-permalink" class="mw-list-item"><a href="/w/index.php?title=API:Main_page&oldid=6703085" title="Permanent link to this revision of this page"><span>Permanent link</span></a></li><li id="t-info" class="mw-list-item"><a href="/w/index.php?title=API:Main_page&action=info" title="More information about this page"><span>Page information</span></a></li><li id="t-cite" class="mw-list-item"><a href="/w/index.php?title=Special:CiteThisPage&page=API%3AMain_page&id=6703085&wpFormIdentifier=titleform" title="Information on how to cite this page"><span>Cite this page</span></a></li><li id="t-urlshortener" class="mw-list-item"><a href="/w/index.php?title=Special:UrlShortener&url=https%3A%2F%2Fwww.mediawiki.org%2Fwiki%2FAPI%3AMain_page"><span>Get shortened URL</span></a></li><li id="t-urlshortener-qrcode" class="mw-list-item"><a href="/w/index.php?title=Special:QrCode&url=https%3A%2F%2Fwww.mediawiki.org%2Fwiki%2FAPI%3AMain_page"><span>Download QR code</span></a></li> </ul> </div> </div> <div id="p-coll-print_export" class="vector-menu mw-portlet mw-portlet-coll-print_export" > <div class="vector-menu-heading"> Print/export </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="coll-create_a_book" class="mw-list-item"><a href="/w/index.php?title=Special:Book&bookcmd=book_creator&referer=API%3AMain+page"><span>Create a book</span></a></li><li id="coll-download-as-rl" class="mw-list-item"><a href="/w/index.php?title=Special:DownloadAsPdf&page=API%3AMain_page&action=show-download-screen"><span>Download as PDF</span></a></li><li id="t-print" class="mw-list-item"><a href="/w/index.php?title=API:Main_page&printable=yes" title="Printable version of this page [p]" accesskey="p"><span>Printable version</span></a></li> </ul> </div> </div> <div id="p-wikibase-otherprojects" class="vector-menu mw-portlet mw-portlet-wikibase-otherprojects" > <div class="vector-menu-heading"> In other projects </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li class="wb-otherproject-link wb-otherproject-wikipedia mw-list-item"><a href="https://en.wikipedia.org/wiki/Help:API" hreflang="en"><span>Wikipedia</span></a></li><li id="t-wikibase" class="wb-otherproject-link wb-otherproject-wikibase-dataitem mw-list-item"><a href="https://www.wikidata.org/wiki/Special:EntityPage/Q53409818" title="Link to connected data repository item [g]" accesskey="g"><span>Wikidata item</span></a></li> </ul> </div> </div> </div> </div> </div> </div> </nav> </div> </div> </div> <div class="vector-column-end"> <div class="vector-sticky-pinned-container"> <nav class="vector-page-tools-landmark" aria-label="Page tools"> <div id="vector-page-tools-pinned-container" class="vector-pinned-container"> </div> </nav> <nav class="vector-appearance-landmark" aria-label="Appearance"> <div id="vector-appearance-pinned-container" class="vector-pinned-container"> <div id="vector-appearance" class="vector-appearance vector-pinnable-element"> <div class="vector-pinnable-header vector-appearance-pinnable-header vector-pinnable-header-pinned" data-feature-name="appearance-pinned" data-pinnable-element-id="vector-appearance" data-pinned-container-id="vector-appearance-pinned-container" data-unpinned-container-id="vector-appearance-unpinned-container" > <div class="vector-pinnable-header-label">Appearance</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-appearance.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-appearance.unpin">hide</button> </div> </div> </div> </nav> </div> </div> <div id="bodyContent" class="vector-body" aria-labelledby="firstHeading" data-mw-ve-target-container> <div class="vector-body-before-content"> <div id="siteSub" class="noprint">From mediawiki.org</div> </div> <div id="contentSub"><div id="mw-content-subtitle"></div></div> <div id="mw-content-text" class="mw-body-content"><div class="mw-pt-translate-header noprint nomobile" dir="ltr" lang="en"><a href="/w/index.php?title=Special:Translate&group=page-API%3AMain+page&action=page&filter=&action_source=translate_page" title="Special:Translate">Translate this page</a></div><div class="mw-content-ltr mw-parser-output" lang="en" dir="ltr"><div class="mw-pt-languages noprint navigation-not-searchable" lang="en" dir="ltr"><div class="mw-pt-languages-label">Languages:</div><ul class="mw-pt-languages-list"><li><a href="/wiki/API:Main_page/id" class="mw-pt-progress mw-pt-progress--complete" title="Halaman utama (100% translated)" lang="id" dir="ltr">Bahasa Indonesia</a></li> <li><a href="/wiki/API:Main_page/ms" class="mw-pt-progress mw-pt-progress--low" title="API:Main page/ms (13% translated)" lang="ms" dir="ltr">Bahasa Melayu</a></li> <li><a href="/wiki/API:Main_page/cy" class="mw-pt-progress mw-pt-progress--low" title="API:Hafan (3% translated)" lang="cy" dir="ltr">Cymraeg</a></li> <li><a href="/wiki/API:Main_page/de" class="mw-pt-progress mw-pt-progress--complete" title="API:Hauptseite (100% translated)" lang="de" dir="ltr">Deutsch</a></li> <li><span class="mw-pt-languages-ui mw-pt-languages-selected mw-pt-progress mw-pt-progress--complete" lang="en" dir="ltr">English</span></li> <li><a href="/wiki/API:Main_page/eo" class="mw-pt-progress mw-pt-progress--med" title="API:Ĉefa paĝo (23% translated)" lang="eo" dir="ltr">Esperanto</a></li> <li><a href="/wiki/API:Main_page/nl" class="mw-pt-progress mw-pt-progress--complete" title="API:Hoofdpagina (100% translated)" lang="nl" dir="ltr">Nederlands</a></li> <li><a href="/wiki/API:Main_page/kab" class="mw-pt-progress mw-pt-progress--low" title="API:Page principale (3% translated)" lang="kab" dir="ltr">Taqbaylit</a></li> <li><a href="/wiki/API:Main_page/vi" class="mw-pt-progress mw-pt-progress--complete" title="API:Trang chính (100% translated)" lang="vi" dir="ltr">Tiếng Việt</a></li> <li><a href="/wiki/API:Main_page/tr" class="mw-pt-progress mw-pt-progress--complete" title="API:Anasayfa (100% translated)" lang="tr" dir="ltr">Türkçe</a></li> <li><a href="/wiki/API:Main_page/az" class="mw-pt-progress mw-pt-progress--low" title="API:Əsas səhifə (3% translated)" lang="az" dir="ltr">azərbaycanca</a></li> <li><a href="/wiki/API:Main_page/ca" class="mw-pt-progress mw-pt-progress--high" title="API:Portada (93% translated)" lang="ca" dir="ltr">català</a></li> <li><a href="/wiki/API:Main_page/da" class="mw-pt-progress mw-pt-progress--high" title="API:Forside (80% translated)" lang="da" dir="ltr">dansk</a></li> <li><a href="/wiki/API:Main_page/es" class="mw-pt-progress mw-pt-progress--complete" title="API:Portada (100% translated)" lang="es" dir="ltr">español</a></li> <li><a href="/wiki/API:Main_page/fr" class="mw-pt-progress mw-pt-progress--complete" title="API:Page d'accueil (100% translated)" lang="fr" dir="ltr">français</a></li> <li><a href="/wiki/API:Main_page/it" class="mw-pt-progress mw-pt-progress--high" title="API:Pagina principale (97% translated)" lang="it" dir="ltr">italiano</a></li> <li><a href="/wiki/API:Main_page/lv" class="mw-pt-progress mw-pt-progress--low" title="API:Main page/lv (0% translated)" lang="lv" dir="ltr">latviešu</a></li> <li><a href="/wiki/API:Main_page/lt" class="mw-pt-progress mw-pt-progress--low" title="API:Pagrindinis puslapis (7% translated)" lang="lt" dir="ltr">lietuvių</a></li> <li><a href="/wiki/API:Main_page/pl" class="mw-pt-progress mw-pt-progress--high" title="API:Strona główna (77% translated)" lang="pl" dir="ltr">polski</a></li> <li><a href="/wiki/API:Main_page/pt" class="mw-pt-progress mw-pt-progress--high" title="API:Página principal (90% translated)" lang="pt" dir="ltr">português</a></li> <li><a href="/wiki/API:Main_page/pt-br" class="mw-pt-progress mw-pt-progress--complete" title="API:Página principal (100% translated)" lang="pt-BR" dir="ltr">português do Brasil</a></li> <li><a href="/wiki/API:Main_page/ro" class="mw-pt-progress mw-pt-progress--high" title="API:Pagina principală (80% translated)" lang="ro" dir="ltr">română</a></li> <li><a href="/wiki/API:Main_page/sv" class="mw-pt-progress mw-pt-progress--complete" title="API:Huvudsida (100% translated)" lang="sv" dir="ltr">svenska</a></li> <li><a href="/wiki/API:Main_page/cs" class="mw-pt-progress mw-pt-progress--complete" title="API:Hlavní stránka (100% translated)" lang="cs" dir="ltr">čeština</a></li> <li><a href="/wiki/API:Main_page/bg" class="mw-pt-progress mw-pt-progress--med" title="API:Начална страница (40% translated)" lang="bg" dir="ltr">български</a></li> <li><a href="/wiki/API:Main_page/ru" class="mw-pt-progress mw-pt-progress--complete" title="API:Главная страница (100% translated)" lang="ru" dir="ltr">русский</a></li> <li><a href="/wiki/API:Main_page/sr" class="mw-pt-progress mw-pt-progress--low" title="API:Main page/sr (0% translated)" lang="sr" dir="ltr">српски / srpski</a></li> <li><a href="/wiki/API:Main_page/uk" class="mw-pt-progress mw-pt-progress--complete" title="API:Головна сторінка (100% translated)" lang="uk" dir="ltr">українська</a></li> <li><a href="/wiki/API:Main_page/he" class="mw-pt-progress mw-pt-progress--high" title="API:עמוד ראשי (97% translated)" lang="he" dir="rtl">עברית</a></li> <li><a href="/wiki/API:Main_page/ur" class="mw-pt-progress mw-pt-progress--low" title="API:Main page/ur (3% translated)" lang="ur" dir="rtl">اردو</a></li> <li><a href="/wiki/API:Main_page/ar" class="mw-pt-progress mw-pt-progress--complete" title="واجهة برمجة التطبيقات:الصفحة الرئيسية (100% translated)" lang="ar" dir="rtl">العربية</a></li> <li><a href="/wiki/API:Main_page/azb" class="mw-pt-progress mw-pt-progress--med" title="API:آنا صفحه (17% translated)" lang="azb" dir="rtl">تۆرکجه</a></li> <li><a href="/wiki/API:Main_page/fa" class="mw-pt-progress mw-pt-progress--low" title="API:صفحهٔ اصلی (10% translated)" lang="fa" dir="rtl">فارسی</a></li> <li><a href="/wiki/API:Main_page/ps" class="mw-pt-progress mw-pt-progress--low" title="API:لومړی مخ (10% translated)" lang="ps" dir="rtl">پښتو</a></li> <li><a href="/wiki/API:Main_page/ckb" class="mw-pt-progress mw-pt-progress--med" title="API:Main page/ckb (17% translated)" lang="ckb" dir="rtl">کوردی</a></li> <li><a href="/wiki/API:Main_page/mr" class="mw-pt-progress mw-pt-progress--low" title="API:Main page/mr (3% translated)" lang="mr" dir="ltr">मराठी</a></li> <li><a href="/wiki/API:Main_page/hi" class="mw-pt-progress mw-pt-progress--high" title="API:मुखपृष्ठ (97% translated)" lang="hi" dir="ltr">हिन्दी</a></li> <li><a href="/wiki/API:Main_page/bn" class="mw-pt-progress mw-pt-progress--high" title="API:প্রধান পৃষ্ঠা (97% translated)" lang="bn" dir="ltr">বাংলা</a></li> <li><a href="/wiki/API:Main_page/kn" class="mw-pt-progress mw-pt-progress--low" title="API:Main page/kn (3% translated)" lang="kn" dir="ltr">ಕನ್ನಡ</a></li> <li><a href="/wiki/API:Main_page/th" class="mw-pt-progress mw-pt-progress--complete" title="API:หน้าหลัก (100% translated)" lang="th" dir="ltr">ไทย</a></li> <li><a href="/wiki/API:Main_page/my" class="mw-pt-progress mw-pt-progress--complete" title="API:အဓိက စာမျက်နှာ (100% translated)" lang="my" dir="ltr">မြန်မာဘာသာ</a></li> <li><a href="/wiki/API:Main_page/chr" class="mw-pt-progress mw-pt-progress--low" title="API:ᎤᎵᎮᎵᏍᏗ (3% translated)" lang="chr" dir="ltr">ᏣᎳᎩ</a></li> <li><a href="/wiki/API:Main_page/zh" class="mw-pt-progress mw-pt-progress--complete" title="API:首页 (100% translated)" lang="zh" dir="ltr">中文</a></li> <li><a href="/wiki/API:Main_page/lzh" class="mw-pt-progress mw-pt-progress--high" title="API:卷首 (90% translated)" lang="lzh" dir="ltr">文言</a></li> <li><a href="/wiki/API:Main_page/ja" class="mw-pt-progress mw-pt-progress--complete" title="API:メインページ (100% translated)" lang="ja" dir="ltr">日本語</a></li> <li><a href="/wiki/API:Main_page/yue" class="mw-pt-progress mw-pt-progress--low" title="API:Main page/yue (0% translated)" lang="yue" dir="ltr">粵語</a></li> <li><a href="/wiki/API:Main_page/mni" class="mw-pt-progress mw-pt-progress--low" title="API:Main page (13% translated)" lang="mni" dir="ltr">ꯃꯤꯇꯩ ꯂꯣꯟ</a></li> <li><a href="/wiki/API:Main_page/ko" class="mw-pt-progress mw-pt-progress--complete" title="API:대문 (100% translated)" lang="ko" dir="ltr">한국어</a></li></ul></div> <style data-mw-deduplicate="TemplateStyles:r6987009">.mw-parser-output table.ombox{margin:4px 10%;border-collapse:collapse;border:1px solid #a2a9b1;background-color:#f8f9fa;color:#333;box-sizing:border-box}.mw-parser-output .ombox td.mbox-empty-cell{border:none;padding:0;width:1px}.mw-parser-output .ombox th.mbox-text,.mw-parser-output .ombox td.mbox-text{border:none;padding:0.25em 0.9em;width:100%}.mw-parser-output .ombox td.mbox-image{border:none;text-align:center;padding:2px 0 2px 0.9em}.mw-parser-output .ombox td.mbox-imageright{border:none;text-align:center;padding:2px 0.9em 2px 0}.mw-parser-output table.ombox-notice{border-color:#a2a9b1}.mw-parser-output table.ombox-speedy{background-color:#fee7e6;color:#333}.mw-parser-output table.ombox-speedy,.mw-parser-output table.ombox-delete{border-color:#b32424;border-width:2px}.mw-parser-output table.ombox-content{border-color:#f28500}.mw-parser-output table.ombox-style{border-color:#fc3}.mw-parser-output table.ombox-move{border-color:#9932cc}.mw-parser-output table.ombox-protection{border-color:#a2a9b1;border-width:2px}html body.mediawiki .mw-parser-output .ombox.mbox-small{clear:right;float:right;margin:4px 0 4px 1em;box-sizing:border-box;width:238px;font-size:88%;line-height:1.25em}@media screen{html.skin-theme-clientpref-night .mw-parser-output table.ombox{background-color:transparent;color:inherit}}@media screen and (prefers-color-scheme:dark){html.skin-theme-clientpref-os .mw-parser-output table.ombox{background-color:transparent;color:inherit}}@media screen and (max-width:720px){.mw-parser-output table.ombox{margin:4px auto}}</style><table class="skin-nightmode-reset-color ombox ombox-content plainlinks" role="presentation" style="display: block; color:#222; border:solid 1px #A8A8A8; padding: .5em 1em; margin:0.5em 0em;"><tbody><tr><td class="mbox-image"><span class="skin-invert-image" typeof="mw:File"><span><img alt="" src="//upload.wikimedia.org/wikipedia/commons/thumb/f/f6/API_-_The_Noun_Project.svg/30px-API_-_The_Noun_Project.svg.png" decoding="async" width="30" height="30" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/commons/thumb/f/f6/API_-_The_Noun_Project.svg/45px-API_-_The_Noun_Project.svg.png 1.5x, //upload.wikimedia.org/wikipedia/commons/thumb/f/f6/API_-_The_Noun_Project.svg/60px-API_-_The_Noun_Project.svg.png 2x" data-file-width="512" data-file-height="512" /></span></span></td><td class="mbox-text">This page is part of the <a href="/wiki/Special:MyLanguage/API:Main_page" title="Special:MyLanguage/API:Main page">MediaWiki Action API</a> documentation.</td></tr></tbody></table> <style data-mw-deduplicate="TemplateStyles:r6605224">.mw-parser-output .tpl-sidebar{background-color:var(--background-color-interactive-subtle,#f8f9fa);border:1px solid var(--border-color-divider,#a2a9b1);color:var(--color-base,#202122);width:22em;padding:.2em;text-align:center;line-height:1.4em;font-size:88%}.mw-parser-output .tpl-sidebar-pagedir-ltr,.mw-parser-output .tpl-sidebar.tpl-sidebar-floatright{float:right;clear:right;margin:.5em 0 1em 1em}.mw-parser-output .tpl-sidebar-pagedir-rtl,.mw-parser-output .tpl-sidebar.tpl-sidebar-floatleft{float:left;clear:left;margin:.5em 1em 1em 0}.mw-parser-output .tpl-sidebar.tpl-sidebar-floatnone{float:none;clear:both;margin:.5em 0 1em 1em}.mw-parser-output .tpl-sidebar>caption{padding-bottom:.2em;font-size:125%;line-height:1.2em;font-weight:bold}.mw-parser-output .tpl-sidebar>tbody>tr>th,.mw-parser-output .tpl-sidebar>tbody>tr>td{padding:0}.mw-parser-output .tpl-sidebar .tpl-sidebar-topimage>td{padding:.4em 0}.mw-parser-output .tpl-sidebar-imagecaption{padding-top:.2em;line-height:1.2em}.mw-parser-output .tpl-sidebar .tpl-sidebar-pretitle>td{padding-top:.4em;line-height:1.2em}.mw-parser-output .tpl-sidebar .tpl-sidebar-topimage+.tpl-sidebar-pretitle>td{padding-top:.2em}.mw-parser-output .tpl-sidebar .tpl-sidebar-title>th{padding:.2em .4em .2em;font-size:145%;line-height:1.2em}.mw-parser-output .tpl-sidebar .tpl-sidebar-pretitle+.tpl-sidebar-title>th{padding-top:0}.mw-parser-output .tpl-sidebar .tpl-sidebar-image>td{padding:.2em 0 .4em}.mw-parser-output .tpl-sidebar .tpl-sidebar-abovebelow>td{padding:.3em .4em;font-weight:bold}.mw-parser-output .tpl-sidebar .tpl-sidebar-heading>th{padding-top:.2em}.mw-parser-output .tpl-sidebar .tpl-sidebar-image~.tpl-sidebar-heading-first>th{padding-top:.4em}.mw-parser-output .tpl-sidebar .tpl-sidebar-content>td{padding-bottom:.2em}.mw-parser-output .tpl-sidebar :not(.tpl-sidebar-heading)+.tpl-sidebar-content-first>td{padding-top:.2em}.mw-parser-output .tpl-sidebar-navbar>td{font-size:115%}.mw-parser-output .tpl-sidebar-pagedir-ltr .tpl-sidebar-navbar>td{text-align:right}.mw-parser-output .tpl-sidebar-pagedir-rtl .tpl-sidebar-navbar>td{text-align:left}</style><table class="vertical-navbox tpl-sidebar tpl-sidebar-pagedir-ltr nowraplinks noprint" role="navigation" style="width:22em; border-spacing: 0.4em 0; text-align: left; padding: 1.5em; padding: min(1.5em, 2%); margin: 0 0 2em 2em; width: 320px; max-width: 40%;"><tbody><tr class="tpl-sidebar-title"> <th class="" style="font-size: 19px; font-weight: 700; padding: 0;"><b><a href="/wiki/Special:MyLanguage/API:Main_page" title="Special:MyLanguage/API:Main page">MediaWiki Action API</a></b><span style="display:none"><a class="mw-selflink selflink"> </a></span></th> </tr><tr class="tpl-sidebar-heading tpl-sidebar-heading-first"> <th class="" style="font-size: 16px; font-weight: 700; padding-top: 1em;;">Basics</th> </tr><tr class="tpl-sidebar-content tpl-sidebar-content-first"> <td class="" style=";"> <ul><li><a href="/wiki/Special:MyLanguage/API:Etiquette" title="Special:MyLanguage/API:Etiquette">Etiquette and usage guidelines</a><span style="display:none"><a href="/wiki/API:Etiquette" title="API:Etiquette"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Query" title="Special:MyLanguage/API:Query">All query modules</a><span style="display:none"><a href="/wiki/API:Query" title="API:Query"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Properties" title="Special:MyLanguage/API:Properties">All page properties</a><span style="display:none"><a href="/wiki/API:Properties" title="API:Properties"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Lists" title="Special:MyLanguage/API:Lists">All list modules</a><span style="display:none"><a href="/wiki/API:Lists" title="API:Lists"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Meta" title="Special:MyLanguage/API:Meta">All meta modules</a><span style="display:none"><a href="/wiki/API:Meta" title="API:Meta"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Data_formats" title="Special:MyLanguage/API:Data formats">Output formats</a><span style="display:none"><a href="/wiki/API:Data_formats" title="API:Data formats"> </a></span></li></ul></td> </tr><tr class="tpl-sidebar-heading"> <th class="" style="font-size: 16px; font-weight: 700; padding-top: 1em;;">Authentication</th> </tr><tr class="tpl-sidebar-content"> <td class="" style=";"> <ul><li><a href="/wiki/Special:MyLanguage/API:Tokens" title="Special:MyLanguage/API:Tokens">Get tokens for data modifying operations</a><span style="display:none"><a href="/wiki/API:Tokens" title="API:Tokens"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Login" title="Special:MyLanguage/API:Login">Login</a><span style="display:none"><a href="/wiki/API:Login" title="API:Login"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Logout" title="Special:MyLanguage/API:Logout">Logout</a><span style="display:none"><a href="/wiki/API:Logout" title="API:Logout"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Assert" title="Special:MyLanguage/API:Assert">Verifying authentication (assertions)</a><span style="display:none"><a href="/wiki/API:Assert" title="API:Assert"> </a></span></li></ul></td> </tr><tr class="tpl-sidebar-heading"> <th class="" style="font-size: 16px; font-weight: 700; padding-top: 1em;;">Accounts and Users</th> </tr><tr class="tpl-sidebar-content"> <td class="" style=";"> <ul><li><a href="/wiki/Special:MyLanguage/API:Account_creation" title="Special:MyLanguage/API:Account creation">Create an account</a><span style="display:none"><a href="/wiki/API:Account_creation" title="API:Account creation"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Block" title="Special:MyLanguage/API:Block">Block or unblock a user</a><span style="display:none"><a href="/wiki/API:Block" title="API:Block"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Userinfo" title="Special:MyLanguage/API:Userinfo">Get info about the current user</a><span style="display:none"><a href="/wiki/API:Userinfo" title="API:Userinfo"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Watchlist_feed" title="Special:MyLanguage/API:Watchlist feed">Get the current user's watchlist as a feed</a><span style="display:none"><a href="/wiki/API:Watchlist_feed" title="API:Watchlist feed"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Options" title="Special:MyLanguage/API:Options">Change user options</a><span style="display:none"><a href="/wiki/API:Options" title="API:Options"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:User_group_membership" title="Special:MyLanguage/API:User group membership">Change user group membership</a><span style="display:none"><a href="/wiki/API:User_group_membership" title="API:User group membership"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Emailuser" title="Special:MyLanguage/API:Emailuser">Send an email</a><span style="display:none"><a href="/wiki/API:Emailuser" title="API:Emailuser"> </a></span></li></ul></td> </tr><tr class="tpl-sidebar-heading"> <th class="" style="font-size: 16px; font-weight: 700; padding-top: 1em;;">Page Operations</th> </tr><tr class="tpl-sidebar-content"> <td class="" style=";"> <ul><li><a href="/wiki/Special:MyLanguage/API:Edit" title="Special:MyLanguage/API:Edit">Create and edit a page</a><span style="display:none"><a href="/wiki/API:Edit" title="API:Edit"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Get_the_contents_of_a_page" title="Special:MyLanguage/API:Get the contents of a page">Get the contents of a page</a><span style="display:none"><a href="/wiki/API:Get_the_contents_of_a_page" title="API:Get the contents of a page"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Upload" title="Special:MyLanguage/API:Upload">Upload a file</a><span style="display:none"><a href="/wiki/API:Upload" title="API:Upload"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Import" title="Special:MyLanguage/API:Import">Import a page</a><span style="display:none"><a href="/wiki/API:Import" title="API:Import"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Delete" title="Special:MyLanguage/API:Delete">Delete a page</a><span style="display:none"><a href="/wiki/API:Delete" title="API:Delete"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Parsing_wikitext" title="Special:MyLanguage/API:Parsing wikitext">Parse content of a page</a><span style="display:none"><a href="/wiki/API:Parsing_wikitext" title="API:Parsing wikitext"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Watch" title="Special:MyLanguage/API:Watch">Watch or unwatch a page</a><span style="display:none"><a href="/wiki/API:Watch" title="API:Watch"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Purge" title="Special:MyLanguage/API:Purge">Purge cache for page(s)</a><span style="display:none"><a href="/wiki/API:Purge" title="API:Purge"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Rollback" title="Special:MyLanguage/API:Rollback">Rollback a page</a><span style="display:none"><a href="/wiki/API:Rollback" title="API:Rollback"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Move" title="Special:MyLanguage/API:Move">Move a page</a><span style="display:none"><a href="/wiki/API:Move" title="API:Move"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Patrol" title="Special:MyLanguage/API:Patrol">Patrol a page or revision</a><span style="display:none"><a href="/wiki/API:Patrol" title="API:Patrol"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Undelete" title="Special:MyLanguage/API:Undelete">Restore revisions of a deleted page</a><span style="display:none"><a href="/wiki/API:Undelete" title="API:Undelete"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Protect" title="Special:MyLanguage/API:Protect">Change a page's protection level</a><span style="display:none"><a href="/wiki/API:Protect" title="API:Protect"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:SetPageLanguage" title="Special:MyLanguage/API:SetPageLanguage">Change a page's language</a><span style="display:none"><a href="/wiki/API:SetPageLanguage" title="API:SetPageLanguage"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Changing_wiki_content" title="Special:MyLanguage/API:Changing wiki content">More...</a><span style="display:none"><a href="/wiki/API:Changing_wiki_content" title="API:Changing wiki content"> </a></span></li></ul></td> </tr><tr class="tpl-sidebar-heading"> <th class="" style="font-size: 16px; font-weight: 700; padding-top: 1em;;">Search</th> </tr><tr class="tpl-sidebar-content"> <td class="" style=";"> <ul><li><a href="/wiki/Special:MyLanguage/API:Opensearch" title="Special:MyLanguage/API:Opensearch">Search wiki pages by title (OpenSearch)</a><span style="display:none"><a href="/wiki/API:Opensearch" title="API:Opensearch"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Search" title="Special:MyLanguage/API:Search">Advanced search for wiki pages by title or text</a><span style="display:none"><a href="/wiki/API:Search" title="API:Search"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Geosearch" title="Special:MyLanguage/API:Geosearch">Search wiki pages near a location</a><span style="display:none"><a href="/wiki/API:Geosearch" title="API:Geosearch"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Languagesearch" title="Special:MyLanguage/API:Languagesearch">Search for a language name</a><span style="display:none"><a href="/wiki/API:Languagesearch" title="API:Languagesearch"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Prefixsearch" title="Special:MyLanguage/API:Prefixsearch">Perform a prefix search for page titles</a><span style="display:none"><a href="/wiki/API:Prefixsearch" title="API:Prefixsearch"> </a></span></li></ul></td> </tr><tr class="tpl-sidebar-heading"> <th class="" style="font-size: 16px; font-weight: 700; padding-top: 1em;;">Developer Utilities</th> </tr><tr class="tpl-sidebar-content"> <td class="" style=";"> <ul><li><a href="/wiki/Special:MyLanguage/API:Client_code" title="Special:MyLanguage/API:Client code">Access libraries</a><span style="display:none"><a href="/wiki/API:Client_code" title="API:Client code"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Cross-site_requests" title="Special:MyLanguage/API:Cross-site requests">Cross-site requests</a><span style="display:none"><a href="/wiki/API:Cross-site_requests" title="API:Cross-site requests"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Extensions" title="Special:MyLanguage/API:Extensions">Creating an API module in an extension</a><span style="display:none"><a href="/wiki/API:Extensions" title="API:Extensions"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Calling_internally" title="Special:MyLanguage/API:Calling internally">Using the API in MediaWiki and extensions</a><span style="display:none"><a href="/wiki/API:Calling_internally" title="API:Calling internally"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Restricting_API_usage" title="Special:MyLanguage/API:Restricting API usage">Restricting API usage</a><span style="display:none"><a href="/wiki/API:Restricting_API_usage" title="API:Restricting API usage"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Localisation" title="Special:MyLanguage/API:Localisation">Localisation</a><span style="display:none"><a href="/wiki/API:Localisation" title="API:Localisation"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Implementation_Strategy" title="Special:MyLanguage/API:Implementation Strategy">Implementation Strategy</a><span style="display:none"><a href="/wiki/API:Implementation_Strategy" title="API:Implementation Strategy"> </a></span></li></ul></td> </tr><tr class="tpl-sidebar-heading"> <th class="" style="font-size: 16px; font-weight: 700; padding-top: 1em;;">Tutorials</th> </tr><tr class="tpl-sidebar-content"> <td class="" style=";"> <ul><li><a href="/wiki/Special:MyLanguage/API:Tutorial" title="Special:MyLanguage/API:Tutorial">Action API Tutorial</a><span style="display:none"><a href="/wiki/API:Tutorial" title="API:Tutorial"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Article_ideas_generator" title="Special:MyLanguage/API:Article ideas generator">Article ideas generator</a><span style="display:none"><a href="/wiki/API:Article_ideas_generator" title="API:Article ideas generator"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Nearby_places_viewer" title="Special:MyLanguage/API:Nearby places viewer">Nearby places viewer</a><span style="display:none"><a href="/wiki/API:Nearby_places_viewer" title="API:Nearby places viewer"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Picture_of_the_day_viewer" title="Special:MyLanguage/API:Picture of the day viewer">Picture of the day viewer</a><span style="display:none"><a href="/wiki/API:Picture_of_the_day_viewer" title="API:Picture of the day viewer"> </a></span></li> <li><a href="/wiki/Special:MyLanguage/API:Holidays_viewer" title="Special:MyLanguage/API:Holidays viewer">Holidays viewer</a><span style="display:none"><a href="/wiki/API:Holidays_viewer" title="API:Holidays viewer"> </a></span></li></ul></td> </tr><tr class="tpl-sidebar-navbar"> <td style=""><style data-mw-deduplicate="TemplateStyles:r4692751">.mw-parser-output .navbar{display:inline;font-size:88%;font-weight:normal}.mw-parser-output .navbar ul{display:inline;white-space:nowrap}.mw-parser-output .navbar li{word-spacing:-0.125em}.mw-parser-output .navbox .navbar{display:block;font-size:100%}.mw-parser-output .navbox-title .navbar{float:left;text-align:left;margin-right:0.5em;width:6em}</style><span class="noprint plainlinks navbar" style=""><small><span style="white-space:nowrap;word-spacing:-.12em;"><a href="/wiki/Template:API" title="Template:API"><span style="" title="View this template">v</span></a><span style=""> <b>·</b> </span><a class="external text" href="https://www.mediawiki.org/wiki/Template_talk:API"><span style="" title="Discuss this template">d</span></a><span style=""> <b>·</b> </span><a class="external text" href="https://www.mediawiki.org/w/index.php?title=Template:API&action=edit"><span style="" title="Edit this template">e</span></a></span></small></span></td> </tr> </tbody></table> <p>This page provides an overview of the MediaWiki <b>Action API</b>, represented by the <code>api.php</code> endpoint. This page is intended for technical contributors and software developers who wish to understand and use the MediaWiki Action API. </p> <meta property="mw:PageProp/toc" /> <div class="mw-heading mw-heading2"><h2 id="Quick_Start">Quick Start</h2></div> <p>Get the contents of an article on English Wikipedia in HTML: </p> <div class="plainlinks" style="margin-bottom: 0.3em"><b><a class="external text" href="https://en.wikipedia.org/w/api.php?action=parse&page=Pet_door&format=json">api.php<span style="margin:0 0.5em">?</span><wbr />action=parse<span style="margin:0 0.5em">&</span><wbr />page=Pet_door<span style="margin:0 0.5em">&</span><wbr />format=json</a></b> <a class="external text" href="https://en.wikipedia.org/wiki/Special:ApiSandbox#action=parse&page=Pet_door&format=json">[try in ApiSandbox]</a></div> <div class="mw-heading mw-heading3"><h3 id="Endpoint">Endpoint</h3></div> <p><b>All Wikimedia wikis have endpoints that follow this pattern:</b> <code>https://www.example.org/w/api.php</code> </p> <table class="wikitable"> <caption>Examples of Wikimedia Wiki Endpoints </caption> <tbody><tr> <th>API Endpoint </th> <th>Wiki </th></tr> <tr> <td><code> <a class="external free" href="https://www.mediawiki.org/w/api.php">https://www.mediawiki.org/w/api.php</a> </code> </td> <td>MediaWiki API </td></tr> <tr> <td><code> <a class="external free" href="https://meta.wikimedia.org/w/api.php">https://meta.wikimedia.org/w/api.php</a> </code> </td> <td>Meta-Wiki API </td></tr> <tr> <td><code> <a class="external free" href="https://en.wikipedia.org/w/api.php">https://en.wikipedia.org/w/api.php</a> </code> </td> <td>English Wikipedia API </td></tr> <tr> <td><code> <a class="external free" href="https://nl.wikipedia.org/w/api.php">https://nl.wikipedia.org/w/api.php</a> </code> </td> <td>Dutch Wikipedia API </td></tr> <tr> <td><code> <a class="external free" href="https://commons.wikimedia.org/w/api.php">https://commons.wikimedia.org/w/api.php</a> </code> </td> <td>Wikimedia Commons API </td></tr> <tr> <td><code><a class="external free" href="https://test.wikipedia.org/w/api.php">https://test.wikipedia.org/w/api.php</a></code> </td> <td>Test Wiki API </td></tr></tbody></table> <p>To see the endpoint URL on a particular wiki, see section "Entry point URLs" on the Special:Version page. </p> <div class="mw-heading mw-heading2"><h2 id="Introduction">Introduction</h2></div> <p>The MediaWiki Action API is a <a href="https://en.wikipedia.org/wiki/Web_service" class="extiw" title="w:Web service">web service</a> that allows access to some wiki features like authentication, page operations, and search. It can provide <a href="/wiki/Special:MyLanguage/API:Meta" title="Special:MyLanguage/API:Meta">meta information</a> about the wiki and the logged-in user. </p> <div class="mw-heading mw-heading3"><h3 id="Uses_for_the_MediaWiki_Action_API">Uses for the MediaWiki Action API</h3></div> <ul><li>Monitor a MediaWiki installation</li> <li><a href="https://en.wikipedia.org/wiki/Wikipedia:Creating_a_bot" class="extiw" title="w:Wikipedia:Creating a bot">Create a bot</a> to maintain a MediaWiki installation</li> <li>Log in to a wiki, access data, and post changes by making HTTP requests to the web service</li></ul> <div class="mw-heading mw-heading3"><h3 id="Getting_started_with_MediaWiki_Action_API">Getting started with MediaWiki Action API</h3></div> <p>Before you start using the MediaWiki Action API, you should review the following pages: </p> <ul><li><a href="/wiki/Special:MyLanguage/API:Etiquette" title="Special:MyLanguage/API:Etiquette">API etiquette and usage guidelines</a></li> <li><a href="/wiki/Special:MyLanguage/API:FAQ" title="Special:MyLanguage/API:FAQ">Frequently asked questions</a></li> <li><a href="/wiki/Special:MyLanguage/API:Data_formats" title="Special:MyLanguage/API:Data formats">Input and output formats</a></li> <li><a href="/wiki/Special:MyLanguage/API:Errors_and_warnings" title="Special:MyLanguage/API:Errors and warnings">Errors and warnings</a></li> <li>Any policies that apply to the wiki you want to access, such as Wikimedia Foundation wikis' <a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Terms_of_Use" class="extiw" title="wmf:Special:MyLanguage/Terms of Use">terms of use</a> and <a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/trademark_policy" class="extiw" title="wmf:Special:MyLanguage/trademark policy">trademark policy</a>. These terms apply to you when you access or edit using the API, just as they do when you use your web browser.</li></ul> <div class="mw-heading mw-heading2"><h2 id="API_documentation">API documentation</h2></div> <div class="skin-nightmode-reset-color" style="clear:both; background-color:#f8f9fa; padding:20px; border:1px solid #a2a9b1;"> <p><br /> </p> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r6987009"><table class="ombox ombox-notice plainlinks" role="presentation"><tbody><tr><td class="mbox-image"><span typeof="mw:File"><a href="/wiki/File:Oxygen480-categories-preferences-system.svg" class="mw-file-description"><img src="//upload.wikimedia.org/wikipedia/commons/thumb/0/00/Oxygen480-categories-preferences-system.svg/20px-Oxygen480-categories-preferences-system.svg.png" decoding="async" width="20" height="20" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/commons/thumb/0/00/Oxygen480-categories-preferences-system.svg/30px-Oxygen480-categories-preferences-system.svg.png 1.5x, //upload.wikimedia.org/wikipedia/commons/thumb/0/00/Oxygen480-categories-preferences-system.svg/40px-Oxygen480-categories-preferences-system.svg.png 2x" data-file-width="128" data-file-height="128" /></a></span></td><td class="mbox-text">The following documentation is the output of <a href="/wiki/Special:ApiHelp/main" title="Special:ApiHelp/main">Special:<wbr />ApiHelp/<wbr />main</a>, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org).</td></tr></tbody></table> <div style="word-wrap:break-word; overflow-wrap:break-word"><h2 class="apihelp-header" id="main">Main module</h2> <div class="apihelp-block apihelp-flags"><ul><li><span class="apihelp-source">Source: <span dir="ltr" lang="en">MediaWiki</span></span></li><li><span class="apihelp-license">License: <a href="/wiki/Special:Version/License/MediaWiki" title="Special:Version/License/MediaWiki"><span dir="ltr" lang="en">GPL-2.0-or-later</span></a></span></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> <p><strong>Status:</strong> 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. </p><p><strong>Erroneous requests:</strong> 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>. </p> <p class="mw-apisandbox-link"><strong>Testing:</strong> For ease of testing API requests, see <a href="/wiki/Special:ApiSandbox" title="Special:ApiSandbox">Special:ApiSandbox</a>.</p> <div class="apihelp-block apihelp-parameters"><div class="apihelp-block-head">Specific parameters:</div><dl><dt><span dir="ltr" lang="en" id="main:action">action</span></dt><dd class="description"><p>Which action to perform. </p><dl><dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=abusefiltercheckmatch">abusefiltercheckmatch</a></span></dt> <dd>Check to see if an AbuseFilter matches a set of variables, an edit, or a logged AbuseFilter event.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=abusefilterchecksyntax">abusefilterchecksyntax</a></span></dt> <dd>Check syntax of an AbuseFilter filter.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=abusefilterevalexpression">abusefilterevalexpression</a></span></dt> <dd>Evaluates an AbuseFilter expression.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=abusefilterunblockautopromote">abusefilterunblockautopromote</a></span></dt> <dd>Unblocks a user from receiving autopromotions due to an abusefilter consequence.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=abuselogprivatedetails">abuselogprivatedetails</a></span></dt> <dd>View private details of an AbuseLog entry.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=acquiretempusername">acquiretempusername</a></span></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><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=aggregategroups">aggregategroups</a></span></dt> <dd>Manage aggregate message groups.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=antispoof">antispoof</a></span></dt> <dd>Check a username against AntiSpoof's normalisation checks.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=block">block</a></span></dt> <dd>Block a user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=centralauthtoken">centralauthtoken</a></span></dt> <dd>Fetch a centralauthtoken for making an authenticated request to an attached wiki.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=centralnoticecdncacheupdatebanner">centralnoticecdncacheupdatebanner</a></span></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><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=centralnoticechoicedata">centralnoticechoicedata</a></span></dt> <dd>Get data needed to choose a banner for a given project and language</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=centralnoticequerycampaign">centralnoticequerycampaign</a></span></dt> <dd>Get all configuration settings for a campaign.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=changeauthenticationdata">changeauthenticationdata</a></span></dt> <dd>Change authentication data for the current user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=changecontentmodel">changecontentmodel</a></span></dt> <dd>Change the content model of a page</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=checktoken">checktoken</a></span></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><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=cirrus-config-dump">cirrus-config-dump</a></span></dt> <dd>Dump of CirrusSearch configuration.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=cirrus-mapping-dump">cirrus-mapping-dump</a></span></dt> <dd>Dump of CirrusSearch mapping for this wiki.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=cirrus-profiles-dump">cirrus-profiles-dump</a></span></dt> <dd>Dump of CirrusSearch profiles for this wiki.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=cirrus-settings-dump">cirrus-settings-dump</a></span></dt> <dd>Dump of CirrusSearch settings for this wiki.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=clearhasmsg">clearhasmsg</a></span></dt> <dd>Clears the <code>hasmsg</code> flag for the current user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=clientlogin">clientlogin</a></span></dt> <dd>Log in to the wiki using the interactive flow.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=communityconfigurationedit">communityconfigurationedit</a></span></dt> <dd>Change the content of a configuration provider in Community configuration</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=compare">compare</a></span></dt> <dd>Get the difference between two pages.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=createaccount">createaccount</a></span></dt> <dd>Create a new user account.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=createlocalaccount">createlocalaccount</a></span></dt> <dd>Forcibly create a local account. The central account must exist.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=delete">delete</a></span></dt> <dd>Delete a page.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=deleteglobalaccount">deleteglobalaccount</a></span></dt> <dd>Delete a global user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=discussiontoolsedit">discussiontoolsedit</a></span></dt> <dd>Post a message on a discussion page.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=discussiontoolsfindcomment">discussiontoolsfindcomment</a></span></dt> <dd>Find a comment by its ID or name.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=discussiontoolsgetsubscriptions">discussiontoolsgetsubscriptions</a></span></dt> <dd>Get the subscription statuses of given topics.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=discussiontoolssubscribe">discussiontoolssubscribe</a></span></dt> <dd>Subscribe (or unsubscribe) to receive notifications about a topic.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=discussiontoolsthank">discussiontoolsthank</a></span></dt> <dd>Send a public thank-you notification for a comment.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=echocreateevent">echocreateevent</a></span></dt> <dd>Manually trigger a notification to a user</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=echomarkread">echomarkread</a></span></dt> <dd>Mark notifications as read for the current user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=echomarkseen">echomarkseen</a></span></dt> <dd>Mark notifications as seen for the current user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=echomute">echomute</a></span></dt> <dd>Mute or unmute notifications from certain users or pages.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=edit">edit</a></span></dt> <dd>Create and edit pages.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=editmassmessagelist">editmassmessagelist</a></span></dt> <dd>Edit a mass message delivery list.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=emailuser">emailuser</a></span></dt> <dd>Email a user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=expandtemplates">expandtemplates</a></span></dt> <dd>Expands all templates within wikitext.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=featuredfeed">featuredfeed</a></span></dt> <dd>Returns a featured content feed.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=feedcontributions">feedcontributions</a></span></dt> <dd>Returns a user's contributions feed.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=feedrecentchanges">feedrecentchanges</a></span></dt> <dd>Returns a recent changes feed.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=feedthreads">feedthreads</a></span></dt> <dd>Return a feed of discussion threads.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=feedwatchlist">feedwatchlist</a></span></dt> <dd>Returns a watchlist feed.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=filerevert">filerevert</a></span></dt> <dd>Revert a file to an old version.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=flow">flow</a></span></dt> <dd>Allows actions to be taken on Structured Discussions pages.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=flow-parsoid-utils">flow-parsoid-utils</a></span></dt> <dd>Convert text between wikitext and HTML.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=flowthank">flowthank</a></span></dt> <dd>Send a public thank-you notification for a Flow comment.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=globalblock">globalblock</a></span></dt> <dd>Globally block or unblock a user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=globalpreferenceoverrides">globalpreferenceoverrides</a></span></dt> <dd>Change local overrides for global preferences for the current user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=globalpreferences">globalpreferences</a></span></dt> <dd>Change global preferences of the current user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=globaluserrights">globaluserrights</a></span></dt> <dd>Add/remove a user to/from global groups.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=groupreview">groupreview</a></span></dt> <dd>Set message group workflow states.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=help">help</a></span></dt> <dd>Display help for the specified modules.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=imagerotate">imagerotate</a></span></dt> <dd>This module has been disabled.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=import">import</a></span></dt> <dd>Import a page from another wiki, or from an XML file.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=jsonconfig">jsonconfig</a></span></dt> <dd>Allows direct access to JsonConfig subsystem.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=languagesearch">languagesearch</a></span></dt> <dd>Search for language names in any script.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=linkaccount">linkaccount</a></span></dt> <dd>Link an account from a third-party provider to the current user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=login">login</a></span></dt> <dd>Log in and get authentication cookies.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=logout">logout</a></span></dt> <dd>Log out and clear session data.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=managetags">managetags</a></span></dt> <dd>Perform management tasks relating to change tags.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=markfortranslation">markfortranslation</a></span></dt> <dd>Mark a page for translation</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=massmessage">massmessage</a></span></dt> <dd>Send a message to a list of pages.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=mergehistory">mergehistory</a></span></dt> <dd>Merge page histories.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=move">move</a></span></dt> <dd>Move a page.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=newslettersubscribe">newslettersubscribe</a></span></dt> <dd>Subscribe to or unsubscribe from a newsletter.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=opensearch">opensearch</a></span></dt> <dd>Search the wiki using the OpenSearch protocol.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=options">options</a></span></dt> <dd>Change preferences of the current user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=paraminfo">paraminfo</a></span></dt> <dd>Obtain information about API modules.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=parse">parse</a></span></dt> <dd>Parses content and returns parser output.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=patrol">patrol</a></span></dt> <dd>Patrol a page or revision.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=protect">protect</a></span></dt> <dd>Change the protection level of a page.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=purge">purge</a></span></dt> <dd>Purge the cache for the given titles.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=query">query</a></span></dt> <dd>Fetch data from and about MediaWiki.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=removeauthenticationdata">removeauthenticationdata</a></span></dt> <dd>Remove authentication data for the current user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=resetpassword">resetpassword</a></span></dt> <dd>Send a password reset email to a user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=revisiondelete">revisiondelete</a></span></dt> <dd>Delete and undelete revisions.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=rollback">rollback</a></span></dt> <dd>Undo the last edit to the page.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=rsd">rsd</a></span></dt> <dd>Export an RSD (Really Simple Discovery) schema.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=searchtranslations">searchtranslations</a></span></dt> <dd>Search translations.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=setglobalaccountstatus">setglobalaccountstatus</a></span></dt> <dd>Hide or lock (or unhide or unlock) a global user account.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=setnotificationtimestamp">setnotificationtimestamp</a></span></dt> <dd>Update the notification timestamp for watched pages.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=setpagelanguage">setpagelanguage</a></span></dt> <dd>Change the language of a page.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=shortenurl">shortenurl</a></span></dt> <dd>Shorten a long URL into a shorter one.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=sitematrix">sitematrix</a></span></dt> <dd>Get Wikimedia sites list.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=spamblacklist">spamblacklist</a></span></dt> <dd>Validate one or more URLs against the spam block list.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=streamconfigs">streamconfigs</a></span></dt> <dd>Exposes event stream config. Returns only format=json with formatversion=2.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=strikevote">strikevote</a></span></dt> <dd>Allows admins to strike or unstrike a vote.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=tag">tag</a></span></dt> <dd>Add or remove change tags from individual revisions or log entries.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=templatedata">templatedata</a></span></dt> <dd>Fetch data stored by the TemplateData extension.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=thank">thank</a></span></dt> <dd>Send a thank-you notification to an editor.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=threadaction">threadaction</a></span></dt> <dd>Allows actions to be taken on threads and posts in threaded discussions.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=titleblacklist">titleblacklist</a></span></dt> <dd>Validate a page title, filename, or username against the TitleBlacklist.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=torblock">torblock</a></span></dt> <dd>Check if an IP address is blocked as a Tor exit node.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=transcodereset">transcodereset</a></span></dt> <dd>Users with the 'transcode-reset' right can reset and re-run a transcode job.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=translationaids">translationaids</a></span></dt> <dd>Query all translations aids.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=translationreview">translationreview</a></span></dt> <dd>Mark translations reviewed.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=translationstats">translationstats</a></span></dt> <dd>Fetch translation statistics</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=ttmserver">ttmserver</a></span></dt> <dd>Query suggestions from translation memories.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=unblock">unblock</a></span></dt> <dd>Unblock a user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=undelete">undelete</a></span></dt> <dd>Undelete revisions of a deleted page.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=unlinkaccount">unlinkaccount</a></span></dt> <dd>Remove a linked third-party account from the current user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=upload">upload</a></span></dt> <dd>Upload a file, or get the status of pending uploads.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=userrights">userrights</a></span></dt> <dd>Change a user's group membership.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=validatepassword">validatepassword</a></span></dt> <dd>Validate a password against the wiki's password policies.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=watch">watch</a></span></dt> <dd>Add or remove pages from the current user's watchlist.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=webapp-manifest">webapp-manifest</a></span></dt> <dd>Returns a webapp manifest.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=webauthn">webauthn</a></span></dt> <dd>API Module to communicate between server and client during registration/authentication process.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=wikilove">wikilove</a></span></dt> <dd>Give WikiLove to another user.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=bouncehandler">bouncehandler</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Receive a bounce email and process it to handle the failing recipient.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=categorytree">categorytree</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Internal module for the CategoryTree extension.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=cirrus-check-sanity">cirrus-check-sanity</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Reports on the correctness of a range of page ids in the search index</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=collection">collection</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> API module for performing various operations on a wiki user's collection.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=cspreport">cspreport</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> 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><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=discussiontoolscompare">discussiontoolscompare</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Get information about comment changes between two page revisions.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=discussiontoolspageinfo">discussiontoolspageinfo</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Returns metadata required to initialize the discussion tools.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=discussiontoolspreview">discussiontoolspreview</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Preview a message on a discussion page.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=editcheckreferenceurl">editcheckreferenceurl</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Check the status of a URL for use as a reference.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=fancycaptchareload">fancycaptchareload</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Get a new FancyCaptcha.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=jsondata">jsondata</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Retrieve localized JSON data.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=managegroupsynchronizationcache">managegroupsynchronizationcache</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Manage group synchronization cache.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=managemessagegroups">managemessagegroups</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Add a message as a rename of an existing message or a new message in the group during imports</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=messagegroupsubscription">messagegroupsubscription</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Message group subscription related operations</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=oathvalidate">oathvalidate</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Validate a two-factor authentication (OATH) token.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=parser-migration">parser-migration</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Parse a page with two different parser configurations.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=readinglists">readinglists</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Reading list write operations.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=sanitize-mapdata">sanitize-mapdata</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Performs data validation for Kartographer extension</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=scribunto-console">scribunto-console</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Internal module for servicing XHR requests from the Scribunto console.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=securepollauth">securepollauth</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Allows a remote wiki to authenticate users before granting access to vote in the election.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=stashedit">stashedit</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Prepare an edit in shared cache.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=timedtext">timedtext</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Provides timed text content for usage by <track> elements</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=translationcheck">translationcheck</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Validate translations.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=translationentitysearch">translationentitysearch</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Search for message groups and messages</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=ulslocalization">ulslocalization</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Get the localization of ULS in the given language.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=ulssetlang">ulssetlang</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Update user's preferred interface language.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=visualeditor">visualeditor</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Returns HTML5 for a page from the Parsoid service.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=visualeditoredit">visualeditoredit</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=wikimediaeventsblockededit">wikimediaeventsblockededit</a></span></dt> <dd><span class="apihelp-internal">Internal.</span> 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"><span dir="ltr" lang="en">abusefiltercheckmatch</span></a>, <a href="/w/api.php?action=help&modules=abusefilterchecksyntax"><span dir="ltr" lang="en">abusefilterchecksyntax</span></a>, <a href="/w/api.php?action=help&modules=abusefilterevalexpression"><span dir="ltr" lang="en">abusefilterevalexpression</span></a>, <a href="/w/api.php?action=help&modules=abusefilterunblockautopromote"><span dir="ltr" lang="en">abusefilterunblockautopromote</span></a>, <a href="/w/api.php?action=help&modules=abuselogprivatedetails"><span dir="ltr" lang="en">abuselogprivatedetails</span></a>, <a href="/w/api.php?action=help&modules=acquiretempusername"><span dir="ltr" lang="en">acquiretempusername</span></a>, <a href="/w/api.php?action=help&modules=aggregategroups"><span dir="ltr" lang="en">aggregategroups</span></a>, <a href="/w/api.php?action=help&modules=antispoof"><span dir="ltr" lang="en">antispoof</span></a>, <a href="/w/api.php?action=help&modules=block"><span dir="ltr" lang="en">block</span></a>, <a href="/w/api.php?action=help&modules=centralauthtoken"><span dir="ltr" lang="en">centralauthtoken</span></a>, <a href="/w/api.php?action=help&modules=centralnoticecdncacheupdatebanner"><span dir="ltr" lang="en">centralnoticecdncacheupdatebanner</span></a>, <a href="/w/api.php?action=help&modules=centralnoticechoicedata"><span dir="ltr" lang="en">centralnoticechoicedata</span></a>, <a href="/w/api.php?action=help&modules=centralnoticequerycampaign"><span dir="ltr" lang="en">centralnoticequerycampaign</span></a>, <a href="/w/api.php?action=help&modules=changeauthenticationdata"><span dir="ltr" lang="en">changeauthenticationdata</span></a>, <a href="/w/api.php?action=help&modules=changecontentmodel"><span dir="ltr" lang="en">changecontentmodel</span></a>, <a href="/w/api.php?action=help&modules=checktoken"><span dir="ltr" lang="en">checktoken</span></a>, <a href="/w/api.php?action=help&modules=cirrus-config-dump"><span dir="ltr" lang="en">cirrus-config-dump</span></a>, <a href="/w/api.php?action=help&modules=cirrus-mapping-dump"><span dir="ltr" lang="en">cirrus-mapping-dump</span></a>, <a href="/w/api.php?action=help&modules=cirrus-profiles-dump"><span dir="ltr" lang="en">cirrus-profiles-dump</span></a>, <a href="/w/api.php?action=help&modules=cirrus-settings-dump"><span dir="ltr" lang="en">cirrus-settings-dump</span></a>, <a href="/w/api.php?action=help&modules=clearhasmsg"><span dir="ltr" lang="en">clearhasmsg</span></a>, <a href="/w/api.php?action=help&modules=clientlogin"><span dir="ltr" lang="en">clientlogin</span></a>, <a href="/w/api.php?action=help&modules=communityconfigurationedit"><span dir="ltr" lang="en">communityconfigurationedit</span></a>, <a href="/w/api.php?action=help&modules=compare"><span dir="ltr" lang="en">compare</span></a>, <a href="/w/api.php?action=help&modules=createaccount"><span dir="ltr" lang="en">createaccount</span></a>, <a href="/w/api.php?action=help&modules=createlocalaccount"><span dir="ltr" lang="en">createlocalaccount</span></a>, <a href="/w/api.php?action=help&modules=delete"><span dir="ltr" lang="en">delete</span></a>, <a href="/w/api.php?action=help&modules=deleteglobalaccount"><span dir="ltr" lang="en">deleteglobalaccount</span></a>, <a href="/w/api.php?action=help&modules=discussiontoolsedit"><span dir="ltr" lang="en">discussiontoolsedit</span></a>, <a href="/w/api.php?action=help&modules=discussiontoolsfindcomment"><span dir="ltr" lang="en">discussiontoolsfindcomment</span></a>, <a href="/w/api.php?action=help&modules=discussiontoolsgetsubscriptions"><span dir="ltr" lang="en">discussiontoolsgetsubscriptions</span></a>, <a href="/w/api.php?action=help&modules=discussiontoolssubscribe"><span dir="ltr" lang="en">discussiontoolssubscribe</span></a>, <a href="/w/api.php?action=help&modules=discussiontoolsthank"><span dir="ltr" lang="en">discussiontoolsthank</span></a>, <a href="/w/api.php?action=help&modules=echocreateevent"><span dir="ltr" lang="en">echocreateevent</span></a>, <a href="/w/api.php?action=help&modules=echomarkread"><span dir="ltr" lang="en">echomarkread</span></a>, <a href="/w/api.php?action=help&modules=echomarkseen"><span dir="ltr" lang="en">echomarkseen</span></a>, <a href="/w/api.php?action=help&modules=echomute"><span dir="ltr" lang="en">echomute</span></a>, <a href="/w/api.php?action=help&modules=edit"><span dir="ltr" lang="en">edit</span></a>, <a href="/w/api.php?action=help&modules=editmassmessagelist"><span dir="ltr" lang="en">editmassmessagelist</span></a>, <a href="/w/api.php?action=help&modules=emailuser"><span dir="ltr" lang="en">emailuser</span></a>, <a href="/w/api.php?action=help&modules=expandtemplates"><span dir="ltr" lang="en">expandtemplates</span></a>, <a href="/w/api.php?action=help&modules=featuredfeed"><span dir="ltr" lang="en">featuredfeed</span></a>, <a href="/w/api.php?action=help&modules=feedcontributions"><span dir="ltr" lang="en">feedcontributions</span></a>, <a href="/w/api.php?action=help&modules=feedrecentchanges"><span dir="ltr" lang="en">feedrecentchanges</span></a>, <a href="/w/api.php?action=help&modules=feedthreads"><span dir="ltr" lang="en">feedthreads</span></a>, <a href="/w/api.php?action=help&modules=feedwatchlist"><span dir="ltr" lang="en">feedwatchlist</span></a>, <a href="/w/api.php?action=help&modules=filerevert"><span dir="ltr" lang="en">filerevert</span></a>, <a href="/w/api.php?action=help&modules=flow-parsoid-utils"><span dir="ltr" lang="en">flow-parsoid-utils</span></a>, <a href="/w/api.php?action=help&modules=flow"><span dir="ltr" lang="en">flow</span></a>, <a href="/w/api.php?action=help&modules=flowthank"><span dir="ltr" lang="en">flowthank</span></a>, <a href="/w/api.php?action=help&modules=globalblock"><span dir="ltr" lang="en">globalblock</span></a>, <a href="/w/api.php?action=help&modules=globalpreferenceoverrides"><span dir="ltr" lang="en">globalpreferenceoverrides</span></a>, <a href="/w/api.php?action=help&modules=globalpreferences"><span dir="ltr" lang="en">globalpreferences</span></a>, <a href="/w/api.php?action=help&modules=globaluserrights"><span dir="ltr" lang="en">globaluserrights</span></a>, <a href="/w/api.php?action=help&modules=groupreview"><span dir="ltr" lang="en">groupreview</span></a>, <a href="/w/api.php?action=help&modules=help"><span dir="ltr" lang="en">help</span></a>, <a href="/w/api.php?action=help&modules=imagerotate"><span dir="ltr" lang="en">imagerotate</span></a>, <a href="/w/api.php?action=help&modules=import"><span dir="ltr" lang="en">import</span></a>, <a href="/w/api.php?action=help&modules=jsonconfig"><span dir="ltr" lang="en">jsonconfig</span></a>, <a href="/w/api.php?action=help&modules=languagesearch"><span dir="ltr" lang="en">languagesearch</span></a>, <a href="/w/api.php?action=help&modules=linkaccount"><span dir="ltr" lang="en">linkaccount</span></a>, <a href="/w/api.php?action=help&modules=login"><span dir="ltr" lang="en">login</span></a>, <a href="/w/api.php?action=help&modules=logout"><span dir="ltr" lang="en">logout</span></a>, <a href="/w/api.php?action=help&modules=managetags"><span dir="ltr" lang="en">managetags</span></a>, <a href="/w/api.php?action=help&modules=markfortranslation"><span dir="ltr" lang="en">markfortranslation</span></a>, <a href="/w/api.php?action=help&modules=massmessage"><span dir="ltr" lang="en">massmessage</span></a>, <a href="/w/api.php?action=help&modules=mergehistory"><span dir="ltr" lang="en">mergehistory</span></a>, <a href="/w/api.php?action=help&modules=move"><span dir="ltr" lang="en">move</span></a>, <a href="/w/api.php?action=help&modules=newslettersubscribe"><span dir="ltr" lang="en">newslettersubscribe</span></a>, <a href="/w/api.php?action=help&modules=opensearch"><span dir="ltr" lang="en">opensearch</span></a>, <a href="/w/api.php?action=help&modules=options"><span dir="ltr" lang="en">options</span></a>, <a href="/w/api.php?action=help&modules=paraminfo"><span dir="ltr" lang="en">paraminfo</span></a>, <a href="/w/api.php?action=help&modules=parse"><span dir="ltr" lang="en">parse</span></a>, <a href="/w/api.php?action=help&modules=patrol"><span dir="ltr" lang="en">patrol</span></a>, <a href="/w/api.php?action=help&modules=protect"><span dir="ltr" lang="en">protect</span></a>, <a href="/w/api.php?action=help&modules=purge"><span dir="ltr" lang="en">purge</span></a>, <a href="/w/api.php?action=help&modules=query"><span dir="ltr" lang="en">query</span></a>, <a href="/w/api.php?action=help&modules=removeauthenticationdata"><span dir="ltr" lang="en">removeauthenticationdata</span></a>, <a href="/w/api.php?action=help&modules=resetpassword"><span dir="ltr" lang="en">resetpassword</span></a>, <a href="/w/api.php?action=help&modules=revisiondelete"><span dir="ltr" lang="en">revisiondelete</span></a>, <a href="/w/api.php?action=help&modules=rollback"><span dir="ltr" lang="en">rollback</span></a>, <a href="/w/api.php?action=help&modules=rsd"><span dir="ltr" lang="en">rsd</span></a>, <a href="/w/api.php?action=help&modules=searchtranslations"><span dir="ltr" lang="en">searchtranslations</span></a>, <a href="/w/api.php?action=help&modules=setglobalaccountstatus"><span dir="ltr" lang="en">setglobalaccountstatus</span></a>, <a href="/w/api.php?action=help&modules=setnotificationtimestamp"><span dir="ltr" lang="en">setnotificationtimestamp</span></a>, <a href="/w/api.php?action=help&modules=setpagelanguage"><span dir="ltr" lang="en">setpagelanguage</span></a>, <a href="/w/api.php?action=help&modules=shortenurl"><span dir="ltr" lang="en">shortenurl</span></a>, <a href="/w/api.php?action=help&modules=sitematrix"><span dir="ltr" lang="en">sitematrix</span></a>, <a href="/w/api.php?action=help&modules=spamblacklist"><span dir="ltr" lang="en">spamblacklist</span></a>, <a href="/w/api.php?action=help&modules=streamconfigs"><span dir="ltr" lang="en">streamconfigs</span></a>, <a href="/w/api.php?action=help&modules=strikevote"><span dir="ltr" lang="en">strikevote</span></a>, <a href="/w/api.php?action=help&modules=tag"><span dir="ltr" lang="en">tag</span></a>, <a href="/w/api.php?action=help&modules=templatedata"><span dir="ltr" lang="en">templatedata</span></a>, <a href="/w/api.php?action=help&modules=thank"><span dir="ltr" lang="en">thank</span></a>, <a href="/w/api.php?action=help&modules=threadaction"><span dir="ltr" lang="en">threadaction</span></a>, <a href="/w/api.php?action=help&modules=titleblacklist"><span dir="ltr" lang="en">titleblacklist</span></a>, <a href="/w/api.php?action=help&modules=torblock"><span dir="ltr" lang="en">torblock</span></a>, <a href="/w/api.php?action=help&modules=transcodereset"><span dir="ltr" lang="en">transcodereset</span></a>, <a href="/w/api.php?action=help&modules=translationaids"><span dir="ltr" lang="en">translationaids</span></a>, <a href="/w/api.php?action=help&modules=translationreview"><span dir="ltr" lang="en">translationreview</span></a>, <a href="/w/api.php?action=help&modules=translationstats"><span dir="ltr" lang="en">translationstats</span></a>, <a href="/w/api.php?action=help&modules=ttmserver"><span dir="ltr" lang="en">ttmserver</span></a>, <a href="/w/api.php?action=help&modules=unblock"><span dir="ltr" lang="en">unblock</span></a>, <a href="/w/api.php?action=help&modules=undelete"><span dir="ltr" lang="en">undelete</span></a>, <a href="/w/api.php?action=help&modules=unlinkaccount"><span dir="ltr" lang="en">unlinkaccount</span></a>, <a href="/w/api.php?action=help&modules=upload"><span dir="ltr" lang="en">upload</span></a>, <a href="/w/api.php?action=help&modules=userrights"><span dir="ltr" lang="en">userrights</span></a>, <a href="/w/api.php?action=help&modules=validatepassword"><span dir="ltr" lang="en">validatepassword</span></a>, <a href="/w/api.php?action=help&modules=watch"><span dir="ltr" lang="en">watch</span></a>, <a href="/w/api.php?action=help&modules=webapp-manifest"><span dir="ltr" lang="en">webapp-manifest</span></a>, <a href="/w/api.php?action=help&modules=webauthn"><span dir="ltr" lang="en">webauthn</span></a>, <a href="/w/api.php?action=help&modules=wikilove"><span dir="ltr" lang="en">wikilove</span></a>, <a href="/w/api.php?action=help&modules=bouncehandler"><span dir="ltr" lang="en" class="apihelp-internal-value">bouncehandler</span></a>, <a href="/w/api.php?action=help&modules=categorytree"><span dir="ltr" lang="en" class="apihelp-internal-value">categorytree</span></a>, <a href="/w/api.php?action=help&modules=cirrus-check-sanity"><span dir="ltr" lang="en" class="apihelp-internal-value">cirrus-check-sanity</span></a>, <a href="/w/api.php?action=help&modules=collection"><span dir="ltr" lang="en" class="apihelp-internal-value">collection</span></a>, <a href="/w/api.php?action=help&modules=cspreport"><span dir="ltr" lang="en" class="apihelp-internal-value">cspreport</span></a>, <a href="/w/api.php?action=help&modules=discussiontoolscompare"><span dir="ltr" lang="en" class="apihelp-internal-value">discussiontoolscompare</span></a>, <a href="/w/api.php?action=help&modules=discussiontoolspageinfo"><span dir="ltr" lang="en" class="apihelp-internal-value">discussiontoolspageinfo</span></a>, <a href="/w/api.php?action=help&modules=discussiontoolspreview"><span dir="ltr" lang="en" class="apihelp-internal-value">discussiontoolspreview</span></a>, <a href="/w/api.php?action=help&modules=editcheckreferenceurl"><span dir="ltr" lang="en" class="apihelp-internal-value">editcheckreferenceurl</span></a>, <a href="/w/api.php?action=help&modules=fancycaptchareload"><span dir="ltr" lang="en" class="apihelp-internal-value">fancycaptchareload</span></a>, <a href="/w/api.php?action=help&modules=jsondata"><span dir="ltr" lang="en" class="apihelp-internal-value">jsondata</span></a>, <a href="/w/api.php?action=help&modules=managegroupsynchronizationcache"><span dir="ltr" lang="en" class="apihelp-internal-value">managegroupsynchronizationcache</span></a>, <a href="/w/api.php?action=help&modules=managemessagegroups"><span dir="ltr" lang="en" class="apihelp-internal-value">managemessagegroups</span></a>, <a href="/w/api.php?action=help&modules=messagegroupsubscription"><span dir="ltr" lang="en" class="apihelp-internal-value">messagegroupsubscription</span></a>, <a href="/w/api.php?action=help&modules=oathvalidate"><span dir="ltr" lang="en" class="apihelp-internal-value">oathvalidate</span></a>, <a href="/w/api.php?action=help&modules=parser-migration"><span dir="ltr" lang="en" class="apihelp-internal-value">parser-migration</span></a>, <a href="/w/api.php?action=help&modules=readinglists"><span dir="ltr" lang="en" class="apihelp-internal-value">readinglists</span></a>, <a href="/w/api.php?action=help&modules=sanitize-mapdata"><span dir="ltr" lang="en" class="apihelp-internal-value">sanitize-mapdata</span></a>, <a href="/w/api.php?action=help&modules=scribunto-console"><span dir="ltr" lang="en" class="apihelp-internal-value">scribunto-console</span></a>, <a href="/w/api.php?action=help&modules=securepollauth"><span dir="ltr" lang="en" class="apihelp-internal-value">securepollauth</span></a>, <a href="/w/api.php?action=help&modules=stashedit"><span dir="ltr" lang="en" class="apihelp-internal-value">stashedit</span></a>, <a href="/w/api.php?action=help&modules=timedtext"><span dir="ltr" lang="en" class="apihelp-internal-value">timedtext</span></a>, <a href="/w/api.php?action=help&modules=translationcheck"><span dir="ltr" lang="en" class="apihelp-internal-value">translationcheck</span></a>, <a href="/w/api.php?action=help&modules=translationentitysearch"><span dir="ltr" lang="en" class="apihelp-internal-value">translationentitysearch</span></a>, <a href="/w/api.php?action=help&modules=ulslocalization"><span dir="ltr" lang="en" class="apihelp-internal-value">ulslocalization</span></a>, <a href="/w/api.php?action=help&modules=ulssetlang"><span dir="ltr" lang="en" class="apihelp-internal-value">ulssetlang</span></a>, <a href="/w/api.php?action=help&modules=visualeditor"><span dir="ltr" lang="en" class="apihelp-internal-value">visualeditor</span></a>, <a href="/w/api.php?action=help&modules=visualeditoredit"><span dir="ltr" lang="en" class="apihelp-internal-value">visualeditoredit</span></a>, <a href="/w/api.php?action=help&modules=wikimediaeventsblockededit"><span dir="ltr" lang="en" class="apihelp-internal-value">wikimediaeventsblockededit</span></a></dd><dd class="info">Default: help</dd><dt><span dir="ltr" lang="en" id="main:format">format</span></dt><dd class="description"><p>The format of the output. </p><dl><dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=json">json</a></span></dt> <dd>Output data in JSON format.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=jsonfm">jsonfm</a></span></dt> <dd>Output data in JSON format (pretty-print in HTML).</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=none">none</a></span></dt> <dd>Output nothing.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=php">php</a></span></dt> <dd>Output data in serialized PHP format.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=phpfm">phpfm</a></span></dt> <dd>Output data in serialized PHP format (pretty-print in HTML).</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=rawfm">rawfm</a></span></dt> <dd>Output data, including debugging elements, in JSON format (pretty-print in HTML).</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=xml">xml</a></span></dt> <dd>Output data in XML format.</dd> <dt><span dir="ltr" lang="en"><a href="/w/api.php?action=help&modules=xmlfm">xmlfm</a></span></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"><span dir="ltr" lang="en">json</span></a>, <a href="/w/api.php?action=help&modules=jsonfm"><span dir="ltr" lang="en">jsonfm</span></a>, <a href="/w/api.php?action=help&modules=none"><span dir="ltr" lang="en">none</span></a>, <a href="/w/api.php?action=help&modules=php"><span dir="ltr" lang="en">php</span></a>, <a href="/w/api.php?action=help&modules=phpfm"><span dir="ltr" lang="en">phpfm</span></a>, <a href="/w/api.php?action=help&modules=rawfm"><span dir="ltr" lang="en">rawfm</span></a>, <a href="/w/api.php?action=help&modules=xml"><span dir="ltr" lang="en">xml</span></a>, <a href="/w/api.php?action=help&modules=xmlfm"><span dir="ltr" lang="en">xmlfm</span></a></dd><dd class="info">Default: jsonfm</dd><dt><span dir="ltr" lang="en" id="main:maxlag">maxlag</span></dt><dd class="description"><p>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>.<br />See <a href="/wiki/Special:MyLanguage/Manual:Maxlag_parameter" title="Special:MyLanguage/Manual:Maxlag parameter">Manual: Maxlag parameter</a> for more information. </p></dd><dd class="info">Type: integer</dd><dt><span dir="ltr" lang="en" id="main:smaxage">smaxage</span></dt><dd class="description"><p>Set the <code>s-maxage</code> HTTP cache control header to this many seconds. Errors are never cached. </p></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><span dir="ltr" lang="en" id="main:maxage">maxage</span></dt><dd class="description"><p>Set the <code>max-age</code> HTTP cache control header to this many seconds. Errors are never cached. </p></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><span dir="ltr" lang="en" id="main:assert">assert</span></dt><dd class="description"><p>Verify that the user is logged in (including possibly as a temporary user) if set to <kbd>user</kbd>, <em>not</em> logged in if set to <kbd>anon</kbd>, or has the bot user right if <kbd>bot</kbd>. </p></dd><dd class="info">One of the following values: anon, bot, user</dd><dt><span dir="ltr" lang="en" id="main:assertuser">assertuser</span></dt><dd class="description"><p>Verify the current user is the named user. </p></dd><dd class="info">Type: user, by any of username and Temporary user</dd><dt><span dir="ltr" lang="en" id="main:requestid">requestid</span></dt><dd class="description"><p>Any value given here will be included in the response. May be used to distinguish requests. </p></dd><dt><span dir="ltr" lang="en" id="main:servedby">servedby</span></dt><dd class="description"><p>Include the hostname that served the request in the results. </p></dd><dd class="info">Type: boolean (<a href="#main/datatype/boolean">details</a>)</dd><dt><span dir="ltr" lang="en" id="main:curtimestamp">curtimestamp</span></dt><dd class="description"><p>Include the current timestamp in the result. </p></dd><dd class="info">Type: boolean (<a href="#main/datatype/boolean">details</a>)</dd><dt><span dir="ltr" lang="en" id="main:responselanginfo">responselanginfo</span></dt><dd class="description"><p>Include the languages used for <var>uselang</var> and <var>errorlang</var> in the result. </p></dd><dd class="info">Type: boolean (<a href="#main/datatype/boolean">details</a>)</dd><dt><span dir="ltr" lang="en" id="main:origin">origin</span></dt><dd class="description"><p>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). </p><p>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. </p><p>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. </p></dd><dt><span dir="ltr" lang="en" id="main:crossorigin">crossorigin</span></dt><dd class="description"><p>When accessing the API using a cross-domain AJAX request (CORS) and using a session provider that is safe against cross-site request forgery (CSRF) attacks (such as OAuth), use this instead of <code>origin=*</code> to make the request authenticated (i.e., not logged out). This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). </p><p>Note that most session providers, including standard cookie-based sessions, do not support authenticated CORS and cannot be used with this parameter. </p></dd><dd class="info">Type: boolean (<a href="#main/datatype/boolean">details</a>)</dd><dt><span dir="ltr" lang="en" id="main:uselang">uselang</span></dt><dd class="description"><p>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. </p></dd><dd class="info">Default: user</dd><dt><span dir="ltr" lang="en" id="main:variant">variant</span></dt><dd class="description"><p>Variant of the language. Only works if the base language supports variant conversion. </p></dd><dt><span dir="ltr" lang="en" id="main:errorformat">errorformat</span></dt><dd class="description"><p>Format to use for warning and error text output </p><dl><dt><span dir="ltr" lang="en">plaintext</span></dt> <dd>Wikitext with HTML tags removed and entities replaced.</dd> <dt><span dir="ltr" lang="en">wikitext</span></dt> <dd>Unparsed wikitext.</dd> <dt><span dir="ltr" lang="en">html</span></dt> <dd>HTML</dd> <dt><span dir="ltr" lang="en">raw</span></dt> <dd>Message key and parameters.</dd> <dt><span dir="ltr" lang="en">none</span></dt> <dd>No text output, only the error codes.</dd> <dt><span dir="ltr" lang="en">bc</span></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><span dir="ltr" lang="en" id="main:errorlang">errorlang</span></dt><dd class="description"><p>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. </p></dd><dd class="info">Default: uselang</dd><dt><span dir="ltr" lang="en" id="main:errorsuselocal">errorsuselocal</span></dt><dd class="description"><p>If given, error texts will use locally-customized messages from the MediaWiki namespace. </p></dd><dd class="info">Type: boolean (<a href="#main/datatype/boolean">details</a>)</dd><dt><span dir="ltr" lang="en" id="main:centralauthtoken">centralauthtoken</span></dt><dd class="description"><p>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). </p></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"><small>[open in sandbox]</small></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"><small>[open in sandbox]</small></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> <p><br /> </p> </div> <p><br /> </p> </div> <p><br /> </p> <div class="mw-heading mw-heading2"><h2 id="Other_APIs">Other APIs</h2></div> <p>If you do not find what you are looking for in this API documentation, there are many other APIs related to Wikimedia projects. </p><p>For the REST API included with MediaWiki 1.35 and later, see <a href="/wiki/Special:MyLanguage/API:REST_API" title="Special:MyLanguage/API:REST API">API:REST API</a><span style="display:none"><a href="/wiki/API:REST_API" title="API:REST API"> </a></span>. </p> <table class="wikitable"> <caption><link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r4692751"><span class="noprint plainlinks navbar" style="float:right"><small><span style="">This table: </span><span style="white-space:nowrap;word-spacing:-.12em;"><a href="/wiki/Template:API_comparison" title="Template:API comparison"><span style="" title="View this template">view</span></a><span style=""> <b>·</b> </span><a class="external text" href="https://www.mediawiki.org/wiki/Template_talk:API_comparison"><span style="" title="Discuss this template">talk</span></a><span style=""> <b>·</b> </span><a class="external text" href="https://www.mediawiki.org/w/index.php?title=Template:API_comparison&action=edit"><span style="" title="Edit this template">edit</span></a></span></small></span> </caption> <tbody><tr> <th>API </th> <th>Availability </th> <th>URL base </th> <th>Example </th></tr> <tr> <td><span typeof="mw:File"><a href="/wiki/File:MediaWiki-2020-small-icon.svg" class="mw-file-description"><img src="//upload.wikimedia.org/wikipedia/commons/thumb/c/c6/MediaWiki-2020-small-icon.svg/18px-MediaWiki-2020-small-icon.svg.png" decoding="async" width="18" height="18" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/commons/thumb/c/c6/MediaWiki-2020-small-icon.svg/27px-MediaWiki-2020-small-icon.svg.png 1.5x, //upload.wikimedia.org/wikipedia/commons/thumb/c/c6/MediaWiki-2020-small-icon.svg/36px-MediaWiki-2020-small-icon.svg.png 2x" data-file-width="25" data-file-height="25" /></a></span> <b><b><a href="/wiki/Special:MyLanguage/API:Main_page" title="Special:MyLanguage/API:Main page">MediaWiki Action API</a></b><span style="display:none"><a class="mw-selflink selflink"> </a></span></b> </td> <td>Included with MediaWiki <p>Enabled on <a href="https://meta.wikimedia.org/wiki/Special:MyLanguage/Wikimedia_projects" class="extiw" title="m:Special:MyLanguage/Wikimedia projects">Wikimedia projects</a> </p> </td> <td>/api.php </td> <td><a class="external free" href="https://en.wikipedia.org/w/api.php?action=query&prop=info&titles=Earth">https://en.wikipedia.org/w/api.php?action=query&prop=info&titles=Earth</a> </td></tr> <tr> <td><span typeof="mw:File"><a href="/wiki/File:MediaWiki-2020-small-icon.svg" class="mw-file-description"><img src="//upload.wikimedia.org/wikipedia/commons/thumb/c/c6/MediaWiki-2020-small-icon.svg/18px-MediaWiki-2020-small-icon.svg.png" decoding="async" width="18" height="18" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/commons/thumb/c/c6/MediaWiki-2020-small-icon.svg/27px-MediaWiki-2020-small-icon.svg.png 1.5x, //upload.wikimedia.org/wikipedia/commons/thumb/c/c6/MediaWiki-2020-small-icon.svg/36px-MediaWiki-2020-small-icon.svg.png 2x" data-file-width="25" data-file-height="25" /></a></span> <b><a href="/wiki/Special:MyLanguage/API:REST_API" title="Special:MyLanguage/API:REST API">MediaWiki REST API</a><span style="display:none"><a href="/wiki/API:REST_API" title="API:REST API"> </a></span></b> </td> <td>Included with MediaWiki 1.35+ <p>Enabled on <a href="https://meta.wikimedia.org/wiki/Special:MyLanguage/Wikimedia_projects" class="extiw" title="m:Special:MyLanguage/Wikimedia projects">Wikimedia projects</a> </p> </td> <td>/rest.php </td> <td><a class="external free" href="https://en.wikipedia.org/w/rest.php/v1/page/Earth">https://en.wikipedia.org/w/rest.php/v1/page/Earth</a> </td></tr> <tr> <td><span typeof="mw:File"><a href="/wiki/File:Wikimedia-logo.svg" class="mw-file-description"><img src="//upload.wikimedia.org/wikipedia/commons/thumb/8/81/Wikimedia-logo.svg/18px-Wikimedia-logo.svg.png" decoding="async" width="18" height="18" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/commons/thumb/8/81/Wikimedia-logo.svg/27px-Wikimedia-logo.svg.png 1.5x, //upload.wikimedia.org/wikipedia/commons/thumb/8/81/Wikimedia-logo.svg/36px-Wikimedia-logo.svg.png 2x" data-file-width="1024" data-file-height="1024" /></a></span> <b><a href="/wiki/Special:MyLanguage/Wikimedia_REST_API" title="Special:MyLanguage/Wikimedia REST API">Wikimedia REST API</a><span style="display:none"><a href="/wiki/Wikimedia_REST_API" title="Wikimedia REST API"> </a></span></b> </td> <td>Not included with MediaWiki <p>Available for <a href="https://meta.wikimedia.org/wiki/Special:MyLanguage/Wikimedia_projects" class="extiw" title="m:Special:MyLanguage/Wikimedia projects">Wikimedia projects</a> only </p> </td> <td>/api/rest </td> <td><a class="external free" href="https://en.wikipedia.org/api/rest_v1/page/title/Earth">https://en.wikipedia.org/api/rest_v1/page/title/Earth</a> </td></tr> <tr> <td colspan="4" style="text-align:center"><span typeof="mw:File"><a href="/wiki/File:Wikimedia_Enterprise_squirrel.svg" class="mw-file-description"><img src="//upload.wikimedia.org/wikipedia/commons/thumb/8/84/Wikimedia_Enterprise_squirrel.svg/18px-Wikimedia_Enterprise_squirrel.svg.png" decoding="async" width="18" height="23" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/commons/thumb/8/84/Wikimedia_Enterprise_squirrel.svg/27px-Wikimedia_Enterprise_squirrel.svg.png 1.5x, //upload.wikimedia.org/wikipedia/commons/thumb/8/84/Wikimedia_Enterprise_squirrel.svg/36px-Wikimedia_Enterprise_squirrel.svg.png 2x" data-file-width="110" data-file-height="142" /></a></span> For commercial-scale APIs for Wikimedia projects, see <b><a href="/wiki/Special:MyLanguage/Wikimedia_Enterprise" title="Special:MyLanguage/Wikimedia Enterprise">Wikimedia Enterprise</a><span style="display:none"><a href="/wiki/Wikimedia_Enterprise" title="Wikimedia Enterprise"> </a></span></b> </td></tr></tbody></table> <div class="mw-heading mw-heading2"><h2 id="Code_stewardship">Code stewardship</h2></div> <ul><li>Maintained by <a href="/wiki/Special:MyLanguage/MediaWiki_Interfaces_Team" title="Special:MyLanguage/MediaWiki Interfaces Team">MediaWiki Interfaces Team</a>.</li> <li>Live chat (<a href="/wiki/Special:MyLanguage/MediaWiki_on_IRC" title="Special:MyLanguage/MediaWiki on IRC">IRC</a>): <style data-mw-deduplicate="TemplateStyles:r6651115">.mw-parser-output .irc-connect>a{color:green}@media screen{html.skin-theme-clientpref-night .mw-parser-output .irc-connect>a{color:#12c812}}@media screen and (prefers-color-scheme:dark){html.skin-theme-clientpref-os .mw-parser-output .irc-connect>a{color:#12c812}}</style><span class="plainlinks" style="font-family: monospace,Courier; white-space: pre-wrap !important; word-wrap: break-word; max-width: 1200px; overflow: auto;" title="#mediawiki-core on Libera.Chat IRC"><a rel="nofollow" class="external text" href="ircs://irc.libera.chat:6697/mediawiki-core">#mediawiki-core</a></span> <sup class="plainlinks irc-connect"><a rel="nofollow" class="external text" href="https://web.libera.chat/?channel=#mediawiki-core">connect</a></sup></li> <li>Issue tracker: <a class="external text" href="https://phabricator.wikimedia.org/tag/mediawiki-action-api/">Phabricator MediaWiki-Action-API</a> (<a class="external text" href="https://phabricator.wikimedia.org/maniphest/task/edit/form/1/?projects=mediawiki-action-api">Report an issue</a>)</li></ul>    </div><noscript><img src="https://login.wikimedia.org/wiki/Special:CentralAutoLogin/start?useformat=desktop&type=1x1&usesul3=0" 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/w/index.php?title=API:Main_page&oldid=6703085">https://www.mediawiki.org/w/index.php?title=API:Main_page&oldid=6703085</a>"</div></div> <div id="catlinks" class="catlinks" data-mw="interface"><div id="mw-normal-catlinks" class="mw-normal-catlinks"><a href="/wiki/Special:Categories" title="Special:Categories">Categories</a>: <ul><li><a href="/wiki/Category:MediaWiki_action_API" title="Category:MediaWiki action API">MediaWiki action API</a></li><li><a href="/wiki/Category:MediaWiki_development" title="Category:MediaWiki development">MediaWiki development</a></li><li><a href="/wiki/Category:Manual" title="Category:Manual">Manual</a></li><li><a href="/wiki/Category:Documentation" title="Category:Documentation">Documentation</a></li><li><a href="/wiki/Category:New_contributors" title="Category:New contributors">New contributors</a></li></ul></div></div> </div> </main> </div> <div class="mw-footer-container"> <footer id="footer" class="mw-footer" > <ul id="footer-info"> <li id="footer-info-lastmod"> This page was last edited on 16 August 2024, at 20:08.</li> <li id="footer-info-copyright">Text is available under the <a rel="nofollow" class="external text" href="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike License</a>; additional terms may apply. Text in <a class="external text" href="https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents">the Help: namespace</a> is available under the <a rel="nofollow" class="external text" href="https://creativecommons.org/publicdomain/zero/1.0/">Creative Commons CC0 License</a>. By using this site, you agree to the <a class="external text" href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Terms_of_Use">Terms of Use</a> and <a class="external text" href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Privacy_policy">Privacy Policy</a>.</li> </ul> <ul id="footer-places"> <li id="footer-places-privacy"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Privacy_policy">Privacy policy</a></li> <li id="footer-places-about"><a href="/wiki/Project:About">About mediawiki.org</a></li> <li id="footer-places-disclaimers"><a href="/wiki/Project:General_disclaimer">Disclaimers</a></li> <li id="footer-places-wm-codeofconduct"><a href="https://www.mediawiki.org/wiki/Special:MyLanguage/Code_of_Conduct">Code of Conduct</a></li> <li id="footer-places-developers"><a href="https://developer.wikimedia.org">Developers</a></li> <li id="footer-places-statslink"><a href="https://stats.wikimedia.org/#/www.mediawiki.org">Statistics</a></li> <li id="footer-places-cookiestatement"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Cookie_statement">Cookie statement</a></li> <li id="footer-places-mobileview"><a href="//m.mediawiki.org/w/index.php?title=API:Main_page&mobileaction=toggle_view_mobile" class="noprint stopMobileRedirectToggle">Mobile view</a></li> </ul> <ul id="footer-icons" class="noprint"> <li id="footer-copyrightico"><a href="https://wikimediafoundation.org/" class="cdx-button cdx-button--fake-button cdx-button--size-large cdx-button--fake-button--enabled"><img src="/static/images/footer/wikimedia-button.svg" width="84" height="29" alt="Wikimedia Foundation" lang="en" loading="lazy"></a></li> <li id="footer-poweredbyico"><a href="https://www.mediawiki.org/" class="cdx-button cdx-button--fake-button cdx-button--size-large cdx-button--fake-button--enabled"><picture><source media="(min-width: 500px)" srcset="/w/resources/assets/poweredby_mediawiki.svg" width="88" height="31"><img src="/w/resources/assets/mediawiki_compact.svg" alt="Powered by MediaWiki" width="25" height="25" loading="lazy"></picture></a></li> </ul> </footer> </div> </div> </div> <div class="vector-header-container vector-sticky-header-container"> <div id="vector-sticky-header" class="vector-sticky-header"> <div class="vector-sticky-header-start"> <div class="vector-sticky-header-icon-start vector-button-flush-left vector-button-flush-right" aria-hidden="true"> <button class="cdx-button cdx-button--weight-quiet cdx-button--icon-only vector-sticky-header-search-toggle" tabindex="-1" data-event-name="ui.vector-sticky-search-form.icon"><span class="vector-icon mw-ui-icon-search mw-ui-icon-wikimedia-search"></span> <span>Search</span> </button> </div> <div role="search" class="vector-search-box-vue vector-search-box-show-thumbnail vector-search-box"> <div class="vector-typeahead-search-container"> <div class="cdx-typeahead-search cdx-typeahead-search--show-thumbnail"> <form action="/w/index.php" id="vector-sticky-search-form" class="cdx-search-input cdx-search-input--has-end-button"> <div class="cdx-search-input__input-wrapper" data-search-loc="header-moved"> <div class="cdx-text-input cdx-text-input--has-start-icon"> <input class="cdx-text-input__input" type="search" name="search" placeholder="Search mediawiki.org"> <span class="cdx-text-input__icon cdx-text-input__start-icon"></span> </div> <input type="hidden" name="title" value="Special:Search"> </div> <button class="cdx-button cdx-search-input__end-button">Search</button> </form> </div> </div> </div> <div class="vector-sticky-header-context-bar"> <nav aria-label="Contents" class="vector-toc-landmark"> <div id="vector-sticky-header-toc" class="vector-dropdown mw-portlet mw-portlet-sticky-header-toc vector-sticky-header-toc vector-button-flush-left" > <input type="checkbox" id="vector-sticky-header-toc-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-sticky-header-toc" class="vector-dropdown-checkbox " aria-label="Toggle the table of contents" > <label id="vector-sticky-header-toc-label" for="vector-sticky-header-toc-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" ><span class="vector-icon mw-ui-icon-listBullet mw-ui-icon-wikimedia-listBullet"></span> <span class="vector-dropdown-label-text">Toggle the table of contents</span> </label> <div class="vector-dropdown-content"> <div id="vector-sticky-header-toc-unpinned-container" class="vector-unpinned-container"> </div> </div> </div> </nav> <div class="vector-sticky-header-context-bar-primary" aria-hidden="true" ><span class="mw-page-title-namespace">API</span><span class="mw-page-title-separator">:</span><span class="mw-page-title-main">Main page</span></div> </div> </div> <div class="vector-sticky-header-end" aria-hidden="true"> <div class="vector-sticky-header-icons"> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only" id="ca-talk-sticky-header" tabindex="-1" data-event-name="talk-sticky-header"><span class="vector-icon mw-ui-icon-speechBubbles mw-ui-icon-wikimedia-speechBubbles"></span> <span></span> </a> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only" id="ca-subject-sticky-header" tabindex="-1" data-event-name="subject-sticky-header"><span class="vector-icon mw-ui-icon-article mw-ui-icon-wikimedia-article"></span> <span></span> </a> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only" id="ca-history-sticky-header" tabindex="-1" data-event-name="history-sticky-header"><span class="vector-icon mw-ui-icon-wikimedia-history mw-ui-icon-wikimedia-wikimedia-history"></span> <span></span> </a> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only mw-watchlink" id="ca-watchstar-sticky-header" tabindex="-1" data-event-name="watch-sticky-header"><span class="vector-icon mw-ui-icon-wikimedia-star mw-ui-icon-wikimedia-wikimedia-star"></span> <span></span> </a> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only" id="ca-edit-sticky-header" tabindex="-1" data-event-name="wikitext-edit-sticky-header"><span class="vector-icon mw-ui-icon-wikimedia-wikiText mw-ui-icon-wikimedia-wikimedia-wikiText"></span> <span></span> </a> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only" id="ca-ve-edit-sticky-header" tabindex="-1" data-event-name="ve-edit-sticky-header"><span class="vector-icon mw-ui-icon-wikimedia-edit mw-ui-icon-wikimedia-wikimedia-edit"></span> <span></span> </a> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only" id="ca-viewsource-sticky-header" tabindex="-1" data-event-name="ve-edit-protected-sticky-header"><span class="vector-icon mw-ui-icon-wikimedia-editLock mw-ui-icon-wikimedia-wikimedia-editLock"></span> <span></span> </a> </div> <div class="vector-sticky-header-buttons"> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--action-progressive" id="ca-addsection-sticky-header" tabindex="-1" data-event-name="addsection-sticky-header"><span class="vector-icon mw-ui-icon-speechBubbleAdd-progressive mw-ui-icon-wikimedia-speechBubbleAdd-progressive"></span> <span>Add topic</span> </a> </div> <div class="vector-sticky-header-icon-end"> <div class="vector-user-links"> </div> </div> </div> </div> </div> <div class="vector-settings" id="p-dock-bottom"> <ul></ul> </div><script>(RLQ=window.RLQ||[]).push(function(){mw.config.set({"wgHostname":"mw-web.codfw.main-86895b65cb-h99gd","wgBackendResponseTime":1414,"wgPageParseReport":{"limitreport":{"cputime":"1.002","walltime":"1.224","ppvisitednodes":{"value":4038,"limit":1000000},"postexpandincludesize":{"value":53996,"limit":2097152},"templateargumentsize":{"value":22208,"limit":2097152},"expansiondepth":{"value":16,"limit":100},"expensivefunctioncount":{"value":24,"limit":500},"unstrip-depth":{"value":0,"limit":20},"unstrip-size":{"value":72273,"limit":5000000},"entityaccesscount":{"value":0,"limit":400},"timingprofile":["100.00% 774.207 1 -total"," 55.98% 433.364 1 Template:Api_help"," 54.65% 423.134 1 Special:ApiHelp/main"," 29.90% 231.521 1 Template:API"," 24.94% 193.052 57 Template:Ll"," 23.71% 183.593 1 Template:Sidebar"," 14.58% 112.912 114 Template:Translatable"," 13.09% 101.343 58 Template:Pagelang"," 5.46% 42.295 1 Template:API_comparison"," 5.42% 41.955 1 Template:Mbox"]},"scribunto":{"limitreport-timeusage":{"value":"0.116","limit":"10.000"},"limitreport-memusage":{"value":1561719,"limit":52428800}},"cachereport":{"origin":"mw-web.codfw.main-86895b65cb-h99gd","timestamp":"20250219085914","ttl":3600,"transientcontent":true}}});});</script> </body> </html>