CINXE.COM

<!DOCTYPE html> <html class="client-nojs" lang="en" dir="ltr"> <head> <meta charset="UTF-8"> <title>MediaWiki API help - Wikipedia</title> <script>document.documentElement.className="client-js";RLCONF={"wgBreakFrames":true,"wgSeparatorTransformTable":["",""],"wgDigitTransformTable":["",""],"wgDefaultDateFormat":"dmy","wgMonthNames":["","January","February","March","April","May","June","July","August","September","October","November","December"],"wgRequestId":"8226a3c1-8d04-412c-8925-f7cce358a11e","wgCanonicalNamespace":"Special","wgCanonicalSpecialPageName":"ApiHelp","wgNamespaceNumber":-1,"wgPageName":"Special:ApiHelp","wgTitle":"ApiHelp","wgCurRevisionId":0,"wgRevisionId":0,"wgArticleId":0,"wgIsArticle":false,"wgIsRedirect":false,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":[],"wgPageViewLanguage":"en","wgPageContentLanguage":"en","wgPageContentModel":"wikitext","wgRelevantPageName":"Special:ApiHelp","wgRelevantArticleId":0,"wgIsProbablyEditable":false,"wgRelevantPageIsProbablyEditable":false,"wgNoticeProject":"wikipedia","wgCiteReferencePreviewsActive":false,"wgFlaggedRevsParams":{"tags":{"status":{ "levels":1}}},"wgMediaViewerOnClick":true,"wgMediaViewerEnabledByDefault":true,"wgPopupsFlags":0,"wgVisualEditor":{"pageLanguageCode":"en","pageLanguageDir":"ltr","pageVariantFallbacks":"en"},"wgMFDisplayWikibaseDescriptions":{"search":true,"watchlist":true,"tagline":false,"nearby":true},"wgWMESchemaEditAttemptStepOversample":false,"wgWMEPageLength":0,"wgCentralAuthMobileDomain":false,"wgEditSubmitButtonLabelPublish":true,"GEHomepageSuggestedEditsEnableTopics":true,"wgGETopicsMatchModeEnabled":false,"wgGEStructuredTaskRejectionReasonTextInputEnabled":false,"wgGELevelingUpEnabledForUser":false};RLSTATE={"user.options":"loading","mediawiki.hlist":"ready","mediawiki.apipretty":"ready","mediawiki.skinning.interface":"ready","ext.visualEditor.desktopArticleTarget.noscript":"ready","ext.wikimediaBadges":"ready"};RLPAGEMODULES=["mediawiki.page.ready","ext.centralNotice.geoIP","ext.urlShortener.toolbar","ext.centralauth.centralautologin","ext.popups", "ext.visualEditor.desktopArticleTarget.init","ext.visualEditor.targetLoader","ext.echo.centralauth","ext.eventLogging","ext.wikimediaEvents","ext.navigationTiming","ext.cx.eventlogging.campaigns"];</script> <script>(RLQ=window.RLQ||[]).push(function(){mw.loader.impl(function(){return["user.options@12s5i",function($,jQuery,require,module){mw.user.tokens.set({"patrolToken":"+\\","watchToken":"+\\","csrfToken":"+\\"}); }];});});</script> <link rel="stylesheet" href="/w/load.php?lang=en&modules=ext.visualEditor.desktopArticleTarget.noscript%7Cext.wikimediaBadges%7Cmediawiki.apipretty%2Chlist%7Cmediawiki.skinning.interface&only=styles&skin=apioutput"> <script async="" src="/w/load.php?lang=en&modules=startup&only=scripts&raw=1&safemode=1&skin=apioutput"></script> <meta name="generator" content="MediaWiki 1.44.0-wmf.4"> <meta name="referrer" content="origin"> <meta name="referrer" content="origin-when-cross-origin"> <meta name="robots" content="noindex,nofollow,max-image-preview:standard"> <meta name="format-detection" content="telephone=no"> <meta name="viewport" content="width=1120"> <meta property="og:title" content="MediaWiki API help - Wikipedia"> <meta property="og:type" content="website"> <link rel="alternate" media="only screen and (max-width: 640px)" href="//en.m.wikipedia.org/wiki/Special:ApiHelp"> <link rel="apple-touch-icon" href="/static/apple-touch/wikipedia.png"> <link rel="icon" href="/static/favicon/wikipedia.ico"> <link rel="search" type="application/opensearchdescription+xml" href="/w/rest.php/v1/search" title="Wikipedia (en)"> <link rel="EditURI" type="application/rsd+xml" href="//en.wikipedia.org/w/api.php?action=rsd"> <link rel="canonical" href="https://en.wikipedia.org/wiki/Special:ApiHelp"> <link rel="license" href="https://www.mediawiki.org/wiki/Special:MyLanguage/Copyright"> <link rel="alternate" type="application/atom+xml" title="Wikipedia Atom feed" href="/w/index.php?title=Special:RecentChanges&feed=atom"> <link rel="dns-prefetch" href="//login.wikimedia.org"> </head> <body class="mediawiki ltr sitedir-ltr mw-hide-empty-elt ns--1 ns-special mw-special-ApiHelp page-Special_ApiHelp rootpage-Special_ApiHelp skin-apioutput action-view"><div class="mw-body" role="main"> <h1 id="firstHeading">MediaWiki API help</h1> <div class="mw-body-content"> <div id="mw-content-text" class="mw-body-content">This is an auto-generated MediaWiki API documentation page. Documentation and examples: <a class="external free" href="https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page">https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page</a> <h2 class="apihelp-header apihelp-module-name" dir="ltr" lang="en" id="parse">action=parse</h2><div class="apihelp-linktrail">(<a href="/wiki/Special:ApiHelp/main" class="apihelp-linktrail" dir="ltr" lang="en">main</a> | parse)</div> <div class="apihelp-block apihelp-flags"><ul><li>This module requires read rights.</li><li>Source: MediaWiki</li><li>License: <a href="/wiki/Special:Version/License/MediaWiki" title="Special:Version/License/MediaWiki">GPL-2.0-or-later</a></li></ul></div> Parses content and returns parser output. See the various prop-modules of <kbd><a href="/w/api.php?action=help&modules=query">action=query</a></kbd> to get information from the current version of a page. There are several ways to specify the text to parse: <ol><li>Specify a page or revision, using <var>page</var>, <var>pageid</var>, or <var>oldid</var>.</li> <li>Specify content explicitly, using <var>text</var>, <var>title</var>, <var>revid</var>, and <var>contentmodel</var>.</li> <li>Specify only a summary to parse. <var>prop</var> should be given an empty value.</li></ol> <div class="apihelp-block apihelp-help-urls"><ul><li><a href="https://www.mediawiki.org/wiki/Special:MyLanguage/API:Parsing_wikitext" dir="ltr">https://www.mediawiki.org/wiki/Special:MyLanguage/API:Parsing_wikitext</a></li></ul></div> <div class="apihelp-block apihelp-parameters"><div class="apihelp-block-head">Specific parameters:</div><div class="apihelp-block-header">Other general parameters are available.</div><dl><dt>title</dt><dd class="description">Title of page the text belongs to. If omitted, <var>contentmodel</var> must be specified, and <a href="/wiki/API" title="API">API</a> will be used as the title. </dd><dt>text</dt><dd class="description">Text to parse. Use <var>title</var> or <var>contentmodel</var> to control the content model. </dd><dt>revid</dt><dd class="description">Revision ID, for <code>{{REVISIONID}}</code> and similar variables. </dd><dd class="info">Type: integer</dd><dt>summary</dt><dd class="description">Summary to parse. </dd><dt>page</dt><dd class="description">Parse the content of this page. Cannot be used together with <var>text</var> and <var>title</var>. </dd><dt>pageid</dt><dd class="description">Parse the content of this page. Overrides <var>page</var>. </dd><dd class="info">Type: integer</dd><dt>redirects</dt><dd class="description">If <var>page</var> or <var>pageid</var> is set to a redirect, resolve it. </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>oldid</dt><dd class="description">Parse the content of this revision. Overrides <var>page</var> and <var>pageid</var>. </dd><dd class="info">Type: integer</dd><dt>prop</dt><dd class="description">Which pieces of information to get: <dl><dt>text</dt> <dd>Gives the parsed text of the wikitext.</dd> <dt>langlinks</dt> <dd>Gives the language links in the parsed wikitext.</dd> <dt>categories</dt> <dd>Gives the categories in the parsed wikitext.</dd> <dt>categorieshtml</dt> <dd>Gives the HTML version of the categories.</dd> <dt>links</dt> <dd>Gives the internal links in the parsed wikitext.</dd> <dt>templates</dt> <dd>Gives the templates in the parsed wikitext.</dd> <dt>images</dt> <dd>Gives the images in the parsed wikitext.</dd> <dt>externallinks</dt> <dd>Gives the external links in the parsed wikitext.</dd> <dt>sections</dt> <dd>Gives the sections in the parsed wikitext.</dd> <dt>revid</dt> <dd>Adds the revision ID of the parsed page.</dd> <dt>displaytitle</dt> <dd>Adds the title of the parsed wikitext.</dd> <dt>subtitle</dt> <dd>Adds the page subtitle for the parsed page.</dd> <dt>headhtml</dt> <dd>Gives parsed doctype, opening <code><html></code>, <code><head></code> element and opening <code><body></code> of the page.</dd> <dt>modules</dt> <dd>Gives the ResourceLoader modules used on the page. To load, use <code>mw.loader.using()</code>. Either <kbd>jsconfigvars</kbd> or <kbd>encodedjsconfigvars</kbd> must be requested jointly with <kbd>modules</kbd>.</dd> <dt>jsconfigvars</dt> <dd>Gives the JavaScript configuration variables specific to the page. To apply, use <code>mw.config.set()</code>.</dd> <dt>encodedjsconfigvars</dt> <dd>Gives the JavaScript configuration variables specific to the page as a JSON string.</dd> <dt>indicators</dt> <dd>Gives the HTML of page status indicators used on the page.</dd> <dt>iwlinks</dt> <dd>Gives interwiki links in the parsed wikitext.</dd> <dt>wikitext</dt> <dd>Gives the original wikitext that was parsed.</dd> <dt>properties</dt> <dd>Gives various properties defined in the parsed wikitext.</dd> <dt>limitreportdata</dt> <dd>Gives the limit report in a structured way. Gives no data, when <var>disablelimitreport</var> is set.</dd> <dt>limitreporthtml</dt> <dd>Gives the HTML version of the limit report. Gives no data, when <var>disablelimitreport</var> is set.</dd> <dt>parsetree</dt> <dd>The XML parse tree of revision content (requires content model <code>wikitext</code>)</dd> <dt>parsewarnings</dt> <dd>Gives the warnings that occurred while parsing content (as wikitext).</dd> <dt>parsewarningshtml</dt> <dd>Gives the warnings that occurred while parsing content (as HTML).</dd> <dt>headitems</dt> <dd>Deprecated. Gives items to put in the <code><head></code> of the page.</dd></dl></dd><dd class="info">Values (separate with <kbd>|</kbd> or <a href="/w/api.php?action=help&modules=main#main/datatypes">alternative</a>): categories, categorieshtml, displaytitle, encodedjsconfigvars, externallinks, headhtml, images, indicators, iwlinks, jsconfigvars, langlinks, limitreportdata, limitreporthtml, links, modules, parsetree, parsewarnings, parsewarningshtml, properties, revid, sections, subtitle, templates, text, wikitext, headitems</dd><dd class="info">Default: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings</dd><dt>wrapoutputclass</dt><dd class="description">CSS class to use to wrap the parser output. </dd><dd class="info">Default: mw-parser-output</dd><dt>usearticle</dt><dd class="description">Use the ArticleParserOptions hook to ensure the options used match those used for article page views </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>parsoid</dt><dd class="description">Generate HTML conforming to the <a href="https://www.mediawiki.org/wiki/Specs/HTML" class="extiw" title="mw:Specs/HTML">MediaWiki DOM spec</a> using <a href="https://www.mediawiki.org/wiki/Parsoid" class="extiw" title="mw:Parsoid">Parsoid</a>. </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>pst</dt><dd class="description">Do a pre-save transform on the input before parsing it. Only valid when used with text. </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>onlypst</dt><dd class="description">Do a pre-save transform (PST) on the input, but don't parse it. Returns the same wikitext, after a PST has been applied. Only valid when used with <var>text</var>. </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>effectivelanglinks</dt><dd class="info">Deprecated.</dd><dd class="description">Includes language links supplied by extensions (for use with <kbd>prop=langlinks</kbd>). </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>section</dt><dd class="description">Only parse the content of the section with this identifier. When <kbd>new</kbd>, parse <var>text</var> and <var>sectiontitle</var> as if adding a new section to the page. <kbd>new</kbd> is allowed only when specifying <var>text</var>. </dd><dt>sectiontitle</dt><dd class="description">New section title when <var>section</var> is <kbd>new</kbd>. Unlike page editing, this does not fall back to <var>summary</var> when omitted or empty. </dd><dt>disablepp</dt><dd class="info">Deprecated.</dd><dd class="description">Use <var>disablelimitreport</var> instead. </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>disablelimitreport</dt><dd class="description">Omit the limit report ("NewPP limit report") from the parser output. </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>disableeditsection</dt><dd class="description">Omit edit section links from the parser output. </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>disablestylededuplication</dt><dd class="description">Do not deduplicate inline stylesheets in the parser output. </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>showstrategykeys</dt><dd class="description">Whether to include internal merge strategy information in jsconfigvars. </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>generatexml</dt><dd class="info">Deprecated.</dd><dd class="description">Generate XML parse tree (requires content model <code>wikitext</code>; replaced by <kbd>prop=parsetree</kbd>). </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>preview</dt><dd class="description">Parse in preview mode. </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>sectionpreview</dt><dd class="description">Parse in section preview mode (enables preview mode too). </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>disabletoc</dt><dd class="description">Omit table of contents in output. </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>useskin</dt><dd class="description">Apply the selected skin to the parser output. May affect the following properties: <kbd>text</kbd>, <kbd>langlinks</kbd>, <kbd>headitems</kbd>, <kbd>modules</kbd>, <kbd>jsconfigvars</kbd>, <kbd>indicators</kbd>. </dd><dd class="info">One of the following values: apioutput, authentication-popup, cologneblue, contenttranslation, fallback, json, minerva, modern, monobook, timeless, vector, vector-2022</dd><dt>contentformat</dt><dd class="description">Content serialization format used for the input text. Only valid when used with text. </dd><dd class="info">One of the following values: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown</dd><dt>contentmodel</dt><dd class="description">Content model of the input text. If omitted, title must be specified, and default will be the model of the specified title. Only valid when used with text. </dd><dd class="info">One of the following values: GadgetDefinition, JsonSchema, MassMessageListContent, Scribunto, SecurePoll, css, javascript, json, sanitized-css, text, unknown, wikitext</dd><dt>mobileformat</dt><dd class="description">Return parse output in a format suitable for mobile devices. </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>templatesandboxprefix</dt><dd class="description">Template sandbox prefix, as with <a href="/wiki/Special:TemplateSandbox" title="Special:TemplateSandbox">Special:TemplateSandbox</a>. </dd><dd class="info">Separate values with <kbd>|</kbd> or <a href="/w/api.php?action=help&modules=main#main/datatypes">alternative</a>.</dd><dd class="info">Maximum number of values is 50 (500 for clients that are allowed higher limits).</dd><dt>templatesandboxtitle</dt><dd class="description">Parse the page using <var>templatesandboxtext</var> in place of the contents of the page named here. </dd><dt>templatesandboxtext</dt><dd class="description">Parse the page using this page content in place of the page named by <var>templatesandboxtitle</var>. </dd><dt>templatesandboxcontentmodel</dt><dd class="description">Content model of <var>templatesandboxtext</var>. </dd><dd class="info">One of the following values: GadgetDefinition, JsonSchema, MassMessageListContent, Scribunto, SecurePoll, css, javascript, json, sanitized-css, text, unknown, wikitext</dd><dt>templatesandboxcontentformat</dt><dd class="description">Content format of <var>templatesandboxtext</var>. </dd><dd class="info">One of the following values: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown</dd></dl></div> <div class="apihelp-block apihelp-examples"><div class="apihelp-block-head">Examples:</div><dl><dt>Parse a page.</dt><dd><a href="/w/api.php?action=parse&page=Project:Sandbox" dir="ltr" rel="nofollow">api.php?action=parse&page=Project:Sandbox</a> <a href="/wiki/Special:ApiSandbox#action=parse&page=Project:Sandbox">[open in sandbox]</a></dd><dt>Parse wikitext.</dt><dd><a href="/w/api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext" dir="ltr" rel="nofollow">api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext</a> <a href="/wiki/Special:ApiSandbox#action=parse&text={{Project:Sandbox}}&contentmodel=wikitext">[open in sandbox]</a></dd><dt>Parse wikitext, specifying the page title.</dt><dd><a href="/w/api.php?action=parse&text={{PAGENAME}}&title=Test" dir="ltr" rel="nofollow">api.php?action=parse&text={{PAGENAME}}&title=Test</a> <a href="/wiki/Special:ApiSandbox#action=parse&text={{PAGENAME}}&title=Test">[open in sandbox]</a></dd><dt>Parse a summary.</dt><dd><a href="/w/api.php?action=parse&summary=Some+[[link]]&prop=" dir="ltr" rel="nofollow">api.php?action=parse&summary=Some+[[link]]&prop=</a> <a href="/wiki/Special:ApiSandbox#action=parse&summary=Some+[[link]]&prop=">[open in sandbox]</a></dd></dl></div> <noscript><img src="https://login.wikimedia.org/wiki/Special:CentralAutoLogin/start?type=1x1" alt="" width="1" height="1" style="border: none; position: absolute;"></noscript> <div class="printfooter" data-nosnippet="">Retrieved from "<a dir="ltr" href="https://en.wikipedia.org/wiki/Special:ApiHelp">https://en.wikipedia.org/wiki/Special:ApiHelp</a>"</div></div> </div> </div> <script>(RLQ=window.RLQ||[]).push(function(){mw.log.warn("This page is using the deprecated ResourceLoader module \"mediawiki.skinning.interface\".\n[1.43] The use of the `interface-message-box` feature with SkinModule is deprecated in favor of CodexModule. Please remove this feature.More information can be found at [[mw:Manual:ResourceLoaderSkinModule]]. ");mw.config.set({"wgHostname":"mw-api-ext.codfw.main-7556f8b5dd-l6nm6","wgBackendResponseTime":170});});</script> </body> </html>