API

<?xml version="1.0"?>
<api servedby="ap-s103">

```
 <error code="help" info="" xml:space="preserve">

 **                                                                                                      **
 **                      This is an auto-generated MediaWiki API documentation page                      **
 **                                                                                                      **
 **                                     Documentation and Examples:                                      **
 **                                  https://www.mediawiki.org/wiki/API                                  **
 **                                                                                                      **

 Status:                All features shown on this page should be working, but the API
                        is still in active development, and may change at any time.
                        Make sure to monitor our mailing list for any updates

 Erroneous requests:    When erroneous requests are sent to the API, a 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

                        In the case of an invalid action being passed, these will have a value
                        of "unknown_action"

                        For more information see https://www.mediawiki.org/wiki/API:Errors\_and\_warnings

 Documentation:         https://www.mediawiki.org/wiki/API:Main\_page
 FAQ                    https://www.mediawiki.org/wiki/API:FAQ
 Mailing list:          https://lists.wikimedia.org/mailman/listinfo/mediawiki-api
 Api Announcements:     https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce
 Bugs & Requests:       https://bugzilla.wikimedia.org/buglist.cgi?component=API&bug\_status=NEW&bug\_status=ASSIGNED&bug\_status=REOPENED&order=bugs.delta\_ts

```

Parameters:

```
 format              - The format of the output
                       One value: json, jsonfm, php, phpfm, wddx, wddxfm, xml, xmlfm, yaml, yamlfm, rawfm, txt, txtfm, dbg, dbgfm,
                           dump, dumpfm, push
                       Default: xmlfm
 action              - What action you would like to perform. See below for module help
                       One value: geocode, insert, update, delete, wdelete, awcreminder, runjob, fetchblob, licenses, imagecrop,
                           imageserving, tagsreport, blogs, titleblacklist, visualeditor, visualeditoredit, apimediasearch,
                           addmediatemporary, addmediapermanent, videopreview, templatesearch, templatesuggestions,
                           templateparameters, scribunto-console, infobox, login, logout, query, expandtemplates, parse,
                           opensearch, feedcontributions, feedwatchlist, help, paraminfo, rsd, compare, purge, rollback,
                           undelete, protect, block, unblock, move, edit, upload, filerevert, emailuser, watch, patrol, import,
                           userrights, options
                       Default: help
 version             - When showing help, include version for each module
 maxlag              - Maximum lag can be used when MediaWiki is installed on a database replicated cluster.
                       To save actions causing any more site replication lag, this parameter can make the client
                       wait until the replication lag is less than the specified value.
                       In case of a replag error, a HTTP 503 error is returned, with the message like
                       "Waiting for $host: $lag seconds lagged\n".
                       See https://www.mediawiki.org/wiki/Manual:Maxlag\_parameter for more information
 smaxage             - Set the s-maxage header to this many seconds. Errors are never cached
                       Default: 0
 maxage              - Set the max-age header to this many seconds. Errors are never cached
                       Default: 0
 requestid           - Request ID to distinguish requests. This will just be output back to you
 servedby            - Include the hostname that served the request in the results. Unconditionally shown on error

```

* + - \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* Modules \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\*

* action=geocode \*

```
 API module for geocoding.

```

This module requires read rights
Parameters:

```
 locations           - The locations to geocode
                       This parameter is required
                       Maximum number of values 50 (500 for bots)
 service             - The geocoding service to use
                       One value: google, geocoderus
 props               -
                       Values (separate with '|'): lat, lon, alt
                       Default: lat|lon

```

Examples:

```
 api.php?action=geocode&locations=new york
 api.php?action=geocode&locations=new york|brussels|london
 api.php?action=geocode&locations=new york&service=geonames

```

* action=insert \*

```
 Insert API module allows applications to add some data to the MediaWiki databases,
 and is loosely based on the Query API interface currently available on all MediaWiki servers.

```

Parameters:

```
 list                - Which lists to get
                       Maximum number of values 50 (500 for bots)
 wkXXXXX             - Wikia parameters. See list below to get Wikia parameters.
                       Maximum number of values 50 (500 for bots)
 redirects           - Automatically resolve redirects
 indexpageids        -
 converttitles       -
 iwurl               -
 export              -
 exportnowrap        -

```

Example:

```
 api.php?action=insert&list=wkvoteart&wkpage=0

```

--- --- --- --- --- --- --- --- Insert: List --- --- --- --- --- --- --- ---

* list=wkdomains \*

```
 Get domains handled by Wikia

```

This module requires read rights
Parameters:

```
 wkwikia             - Identifier in Wiki Factory
 wkactive            - Get only active domains [optional]
                       The value must be between 0 and 1
 wkfrom              - Begin of range - identifier in Wiki Factory
                       The value must be no less than 1
                       Default: 1
 wkto                - end of range - identifier in Wiki Factory
                       The value must be no less than 1
 wkcountonly         - return only number of Wikis
                       The value must be no less than 1
 wklang              - Wiki language
 wklimit             - How many results to return - default 10, max 100 for standard user, 1000 for bots
                       No more than 100 (1000 for bots) allowed
                       Default: 10

```

Examples:

```
 api.php?action=query&list=wkdomains
 api.php?action=query&list=wkdomains&wkactive=1
 api.php?action=query&list=wkdomains&wkwikia=177
 api.php?action=query&list=wkdomains&wkfrom=100&wkto=150
 api.php?action=query&list=wkdomains&wkfrom=10000&wkto=15000&wklang=de
 api.php?action=query&list=wkdomains&wkcountonly=1
 api.php?action=query&list=wkdomains&wkactive=1&wkcountonly=1
 api.php?action=query&list=wkdomains&wkactive=1&wklimit=25

```

* list=wkvoteart \*

```
 Add vote to article

```

This module requires read rights
Parameters:

```
 wkdbname            - Name of database
                       Maximum number of values 50 (500 for bots)
                       Default:
 wkpage              - Identifier of page
 wkvote              - Article rating.
                       Default: 0

```

Example:

```
 api.php?action=insert&list=wkvoteart&wkvote=5&wkpage=1750

```

* list=allusers \*

```
 Enumerate all registered users

```

This module requires read rights
Parameters:

```
 aufrom              - The user name to start enumerating from
 auto                - The user name to stop enumerating at
 auprefix            - Search for all users that begin with this value
 audir               - Direction to sort in
                       One value: ascending, descending
                       Default: ascending
 augroup             - Limit users to given group name(s)
                       Values (separate with '|'): bot, sysop, rollback, bureaucrat, staff, util, helper, vstf, bot-global, restricted-login,
                           restricted-login-exempt, content-moderator, council, authenticated, voldev, vanguard, checkuser,
                           oversight, threadmoderator, chatmoderator, content-reviewer, devboxpanel, translator, reviewer
 auexcludegroup      - Exclude users in given group name(s)
                       Values (separate with '|'): bot, sysop, rollback, bureaucrat, staff, util, helper, vstf, bot-global, restricted-login,
                           restricted-login-exempt, content-moderator, council, authenticated, voldev, vanguard, checkuser,
                           oversight, threadmoderator, chatmoderator, content-reviewer, devboxpanel, translator, reviewer
 aurights            - Limit users to given right(s)
                       Values (separate with '|'): apihighlimits, autoconfirmed, autopatrol, bigdelete, block, blockemail, bot, browsearchive,
                           createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deleterevision, edit,
                           editinterface, editmyoptions, editusercssjs, editusercss, edituserjs, hideuser, import,
                           importupload, ipblock-exempt, markbotedits, mergehistory, minoredit, move, movefile,
                           move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, patrol,
                           protect, proxyunbannable, purge, read, reupload, reupload-shared, rollback, sendemail, siteadmin,
                           suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload,
                           upload_by_url, userrights, userrights-interwiki, writeapi, canremovemap, wikifactory,
                           wikifactorymetrics, dumpsondemand, wikifeatures, MultiFileUploader, allowedtoblank, batchmove,
                           linkstoredirects, mobilesearches, soapfailures, moderatesotd, hiderevision, oversight,
                           abusefilter-modify, abusefilter-log-detail, abusefilter-view, abusefilter-log, abusefilter-private,
                           abusefilter-modify-restricted, abusefilter-revert, abusefilter-view-private, abusefilter-hidden-log,
                           abusefilter-hide-log, override-antispoof, checkuser, checkuser-log, geocode, nuke, refreshspecial,
                           spamregex, tboverride, tboverride-account, torunblocked, abusefilter-bypass, platinum,
                           sponsored-achievements, achievements-exempt, achievements-explicit, admindashboard, commentcreate,
                           commentmove, commentedit, commentdelete, becp_user, blog-comments-toggle, blog-comments-delete,
                           blog-articles-edit, blog-articles-move, blog-articles-protect, blog-auto-follow, skipcaptcha,
                           chatmoderator, chat, commentcsv, content-review, content-review-test-mode, coppatool, createnewwiki,
                           createwikilimitsexempt, finishcreate, devboxpanel, dmcarequestmanagement, editaccount,
                           emailsstorage, flags-administration, forum, boardedit, forumadmin, welcomeexempt, coppaimagereview,
                           imagereview, questionableimagereview, rejectedimagereview, imagereviewstats, imagereviewcontrols,
                           promoteimagereview, promoteimagereviewquestionableimagereview,
                           promoteimagereviewrejectedimagereview, promoteimagereviewstats, promoteimagereviewcontrols,
                           insights, listusers, lookupcontribs, lookupuser, minieditor-specialpage, multidelete, multiwikiedit,
                           multiwikifinder, phalanxexempt, phalanx, phalanxemailblock, piggyback,
                           places-enable-category-geolocation, metadata, powerdelete, quicktools, quickadopt, restrictsession,
                           scribeevents, performancestats, messagetool, forceview, edithub, InterwikiEdit, multilookup,
                           newwikislist, restricted_promote, protectsite, stafflog, unblockable, tagsreport, taskmanager,
                           taskmanager-action, tasks-user, template-bulk-classification, templatedraft, textregex,
                           themedesigner, usermanagement, removeavatar, renameuser, userrollback, specialvideohandler,
                           uploadpremiumvideo, wdacreview, WhereIsExtension, smwallowaskpage, council, authenticated,
                           editinterfacetrusted, deleteinterfacetrusted, voldev, wikianavglobal, wikianavlocal, videoupload,
                           mcachepurge, editrestrictedfields, viewedittab, createclass, first-edit-dialog-exempt,
                           hideblockername, clearuserprofile, smw-patternedit
 auprop              - What pieces of information to include.
                        blockinfo      - Adds the information about a current block on the user
                        groups         - Lists groups that the user is in. This uses more server resources and may return fewer results than the limit
                        implicitgroups - Lists all the groups the user is automatically in
                        rights         - Lists rights that the user has
                        editcount      - Adds the edit count of the user
                        registration   - Adds the timestamp of when the user registered if available (may be blank)
                       Values (separate with '|'): blockinfo, groups, implicitgroups, rights, editcount, registration
 aulimit             - How many total user names to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 auwitheditsonly     - Only list users who have made edits
 auactiveusers       - Only list users active in the last 30 days(s)
 aulocal             - Show users active on Wikia
                       Maximum number of values 50 (500 for bots)
                       Default: 0

```

Example:

```
 api.php?action=query&list=allusers&aufrom=Y

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Allusers

```

* list=checkuser \*

```
 Allows check which IPs are used by a given username and which usernames are used by a given IP

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 curequest           - Type of CheckUser request
                        userips - get IP of target user
                        edits   - get changes from target IP or range
                        ipusers - get users from target IP or range
                       This parameter is required
                       One value: userips, edits, ipusers
 cutarget            - Username or IP-address/range to perform check
                       This parameter is required
 cureason            - Reason to check
 culimit             - Limit of rows
                       No more than 500 (5000 for bots) allowed
                       Default: 1000
 cutimecond          - Time limit of user data (like "2 weeks")
                       Default: -2 weeks
 cuxff               - Use xff data instead of IP

```

Examples:

```
 api.php?action=query&list=checkuser&curequest=userips&cutarget=Jimbo_Wales
 api.php?action=query&list=checkuser&curequest=edits&cutarget=127.0.0.1/16&xff=1&cureason=Some_check

```

Help page:

```
 http://www.mediawiki.org/wiki/Extension:CheckUser#API

```

* list=checkuserlog \*

```
 Allows get entries of CheckUser log

```

This module requires read rights
Parameters:

```
 culuser             - Username of CheckUser
 cultarget           - Checked user or IP-address/range
 cullimit            - Limit of rows
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 culfrom             - The timestamp to start enumerating from
 culto               - The timestamp to end enumerating

```

Examples:

```
 api.php?action=query&list=checkuserlog&culuser=WikiSysop&limit=25
 api.php?action=query&list=checkuserlog&cultarget=127.0.0.1&culfrom=20111015230000

```

Help page:

```
 http://www.mediawiki.org/wiki/Extension:CheckUser#API

```

* list=firstcontributions \*

```
 Returns user name and first edit rev id and timestamp for new editors who first edited in the last 91 days

```

This module requires read rights
Parameters:

```
 fcafter             - Only get users who joined after this date.
 fcbefore            - Only get users who joined before this date. Can't be more than 91 days before the present date.
 fcdir               - In which direction to enumerate
                        newer          - List oldest first. Note: fcstart has to be before fcend.
                        older          - List newest first (default). Note: fcstart has to be later than fcend.
                       One value: newer, older
                       Default: older
 fclimit             - The maximum amount of entries to list
                       No more than 500 (5000 for bots) allowed
                       Default: 10

```

Examples:

```
 api.php?action=query&list=neweditors
 api.php?action=query&list=neweditors&fcdir=newer

```

--- --- --- --- --- --- --- --- end of List --- --- --- --- --- --- --- ---

* action=update \*

```
 Update API module allows applications to change some data in the MediaWiki databases,
 and is loosely based on the Query API interface currently available on all MediaWiki servers.

```

Parameters:

```
 list                - Which lists to get
                       Maximum number of values 50 (500 for bots)
 wkXXXXX             - Wikia parameters. See list below to get Wikia parameters.
                       Maximum number of values 50 (500 for bots)
 redirects           - Automatically resolve redirects
 indexpageids        -
 converttitles       -
 iwurl               -
 export              -
 exportnowrap        -

```

Example:

```
 api.php?action=update&list=wkvoteart&wkpage=0

```

--- --- --- --- --- --- --- --- Update: List --- --- --- --- --- --- --- ---

* list=wkdomains \*

```
 Get domains handled by Wikia

```

This module requires read rights
Parameters:

```
 wkwikia             - Identifier in Wiki Factory
 wkactive            - Get only active domains [optional]
                       The value must be between 0 and 1
 wkfrom              - Begin of range - identifier in Wiki Factory
                       The value must be no less than 1
                       Default: 1
 wkto                - end of range - identifier in Wiki Factory
                       The value must be no less than 1
 wkcountonly         - return only number of Wikis
                       The value must be no less than 1
 wklang              - Wiki language
 wklimit             - How many results to return - default 10, max 100 for standard user, 1000 for bots
                       No more than 100 (1000 for bots) allowed
                       Default: 10

```

Examples:

```
 api.php?action=query&list=wkdomains
 api.php?action=query&list=wkdomains&wkactive=1
 api.php?action=query&list=wkdomains&wkwikia=177
 api.php?action=query&list=wkdomains&wkfrom=100&wkto=150
 api.php?action=query&list=wkdomains&wkfrom=10000&wkto=15000&wklang=de
 api.php?action=query&list=wkdomains&wkcountonly=1
 api.php?action=query&list=wkdomains&wkactive=1&wkcountonly=1
 api.php?action=query&list=wkdomains&wkactive=1&wklimit=25

```

* list=wkvoteart \*

```
 Change rating of article

```

This module requires read rights
Parameters:

```
 wkdbname            - Name of database
                       Maximum number of values 50 (500 for bots)
                       Default:
 wkpage              - Identifier of page
 wkvote              - Article rating.
                       Default: 0

```

Example:

```
 api.php?action=update&list=wkvoteart&wkpage=1770&wkvote=2

```

* list=allusers \*

```
 Enumerate all registered users

```

This module requires read rights
Parameters:

```
 aufrom              - The user name to start enumerating from
 auto                - The user name to stop enumerating at
 auprefix            - Search for all users that begin with this value
 audir               - Direction to sort in
                       One value: ascending, descending
                       Default: ascending
 augroup             - Limit users to given group name(s)
                       Values (separate with '|'): bot, sysop, rollback, bureaucrat, staff, util, helper, vstf, bot-global, restricted-login,
                           restricted-login-exempt, content-moderator, council, authenticated, voldev, vanguard, checkuser,
                           oversight, threadmoderator, chatmoderator, content-reviewer, devboxpanel, translator, reviewer
 auexcludegroup      - Exclude users in given group name(s)
                       Values (separate with '|'): bot, sysop, rollback, bureaucrat, staff, util, helper, vstf, bot-global, restricted-login,
                           restricted-login-exempt, content-moderator, council, authenticated, voldev, vanguard, checkuser,
                           oversight, threadmoderator, chatmoderator, content-reviewer, devboxpanel, translator, reviewer
 aurights            - Limit users to given right(s)
                       Values (separate with '|'): apihighlimits, autoconfirmed, autopatrol, bigdelete, block, blockemail, bot, browsearchive,
                           createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deleterevision, edit,
                           editinterface, editmyoptions, editusercssjs, editusercss, edituserjs, hideuser, import,
                           importupload, ipblock-exempt, markbotedits, mergehistory, minoredit, move, movefile,
                           move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, patrol,
                           protect, proxyunbannable, purge, read, reupload, reupload-shared, rollback, sendemail, siteadmin,
                           suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload,
                           upload_by_url, userrights, userrights-interwiki, writeapi, canremovemap, wikifactory,
                           wikifactorymetrics, dumpsondemand, wikifeatures, MultiFileUploader, allowedtoblank, batchmove,
                           linkstoredirects, mobilesearches, soapfailures, moderatesotd, hiderevision, oversight,
                           abusefilter-modify, abusefilter-log-detail, abusefilter-view, abusefilter-log, abusefilter-private,
                           abusefilter-modify-restricted, abusefilter-revert, abusefilter-view-private, abusefilter-hidden-log,
                           abusefilter-hide-log, override-antispoof, checkuser, checkuser-log, geocode, nuke, refreshspecial,
                           spamregex, tboverride, tboverride-account, torunblocked, abusefilter-bypass, platinum,
                           sponsored-achievements, achievements-exempt, achievements-explicit, admindashboard, commentcreate,
                           commentmove, commentedit, commentdelete, becp_user, blog-comments-toggle, blog-comments-delete,
                           blog-articles-edit, blog-articles-move, blog-articles-protect, blog-auto-follow, skipcaptcha,
                           chatmoderator, chat, commentcsv, content-review, content-review-test-mode, coppatool, createnewwiki,
                           createwikilimitsexempt, finishcreate, devboxpanel, dmcarequestmanagement, editaccount,
                           emailsstorage, flags-administration, forum, boardedit, forumadmin, welcomeexempt, coppaimagereview,
                           imagereview, questionableimagereview, rejectedimagereview, imagereviewstats, imagereviewcontrols,
                           promoteimagereview, promoteimagereviewquestionableimagereview,
                           promoteimagereviewrejectedimagereview, promoteimagereviewstats, promoteimagereviewcontrols,
                           insights, listusers, lookupcontribs, lookupuser, minieditor-specialpage, multidelete, multiwikiedit,
                           multiwikifinder, phalanxexempt, phalanx, phalanxemailblock, piggyback,
                           places-enable-category-geolocation, metadata, powerdelete, quicktools, quickadopt, restrictsession,
                           scribeevents, performancestats, messagetool, forceview, edithub, InterwikiEdit, multilookup,
                           newwikislist, restricted_promote, protectsite, stafflog, unblockable, tagsreport, taskmanager,
                           taskmanager-action, tasks-user, template-bulk-classification, templatedraft, textregex,
                           themedesigner, usermanagement, removeavatar, renameuser, userrollback, specialvideohandler,
                           uploadpremiumvideo, wdacreview, WhereIsExtension, smwallowaskpage, council, authenticated,
                           editinterfacetrusted, deleteinterfacetrusted, voldev, wikianavglobal, wikianavlocal, videoupload,
                           mcachepurge, editrestrictedfields, viewedittab, createclass, first-edit-dialog-exempt,
                           hideblockername, clearuserprofile, smw-patternedit
 auprop              - What pieces of information to include.
                        blockinfo      - Adds the information about a current block on the user
                        groups         - Lists groups that the user is in. This uses more server resources and may return fewer results than the limit
                        implicitgroups - Lists all the groups the user is automatically in
                        rights         - Lists rights that the user has
                        editcount      - Adds the edit count of the user
                        registration   - Adds the timestamp of when the user registered if available (may be blank)
                       Values (separate with '|'): blockinfo, groups, implicitgroups, rights, editcount, registration
 aulimit             - How many total user names to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 auwitheditsonly     - Only list users who have made edits
 auactiveusers       - Only list users active in the last 30 days(s)
 aulocal             - Show users active on Wikia
                       Maximum number of values 50 (500 for bots)
                       Default: 0

```

Example:

```
 api.php?action=query&list=allusers&aufrom=Y

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Allusers

```

* list=checkuser \*

```
 Allows check which IPs are used by a given username and which usernames are used by a given IP

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 curequest           - Type of CheckUser request
                        userips - get IP of target user
                        edits   - get changes from target IP or range
                        ipusers - get users from target IP or range
                       This parameter is required
                       One value: userips, edits, ipusers
 cutarget            - Username or IP-address/range to perform check
                       This parameter is required
 cureason            - Reason to check
 culimit             - Limit of rows
                       No more than 500 (5000 for bots) allowed
                       Default: 1000
 cutimecond          - Time limit of user data (like "2 weeks")
                       Default: -2 weeks
 cuxff               - Use xff data instead of IP

```

Examples:

```
 api.php?action=query&list=checkuser&curequest=userips&cutarget=Jimbo_Wales
 api.php?action=query&list=checkuser&curequest=edits&cutarget=127.0.0.1/16&xff=1&cureason=Some_check

```

Help page:

```
 http://www.mediawiki.org/wiki/Extension:CheckUser#API

```

* list=checkuserlog \*

```
 Allows get entries of CheckUser log

```

This module requires read rights
Parameters:

```
 culuser             - Username of CheckUser
 cultarget           - Checked user or IP-address/range
 cullimit            - Limit of rows
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 culfrom             - The timestamp to start enumerating from
 culto               - The timestamp to end enumerating

```

Examples:

```
 api.php?action=query&list=checkuserlog&culuser=WikiSysop&limit=25
 api.php?action=query&list=checkuserlog&cultarget=127.0.0.1&culfrom=20111015230000

```

Help page:

```
 http://www.mediawiki.org/wiki/Extension:CheckUser#API

```

* list=firstcontributions \*

```
 Returns user name and first edit rev id and timestamp for new editors who first edited in the last 91 days

```

This module requires read rights
Parameters:

```
 fcafter             - Only get users who joined after this date.
 fcbefore            - Only get users who joined before this date. Can't be more than 91 days before the present date.
 fcdir               - In which direction to enumerate
                        newer          - List oldest first. Note: fcstart has to be before fcend.
                        older          - List newest first (default). Note: fcstart has to be later than fcend.
                       One value: newer, older
                       Default: older
 fclimit             - The maximum amount of entries to list
                       No more than 500 (5000 for bots) allowed
                       Default: 10

```

Examples:

```
 api.php?action=query&list=neweditors
 api.php?action=query&list=neweditors&fcdir=newer

```

--- --- --- --- --- --- --- --- end of List --- --- --- --- --- --- --- ---

* action=delete \*

```
 Delete a page

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 title               - Title of the page you want to delete. Cannot be used together with pageid
 pageid              - Page ID of the page you want to delete. Cannot be used together with title
 token               - A delete token previously retrieved through prop=info
 reason              - Reason for the deletion. If not set, an automatically generated reason will be used
 watch               - DEPRECATED! Add the page to your watchlist
 watchlist           - Unconditionally add or remove the page from your watchlist, use preferences or do not change watch
                       One value: watch, unwatch, preferences, nochange
                       Default: preferences
 unwatch             - DEPRECATED! Remove the page from your watchlist
 oldimage            - The name of the old image to delete as provided by iiprop=archivename

```

Examples:

```
 Delete the Main Page:
   api.php?action=delete&title=Main%20Page&token=123ABC
 Delete the Main Page with the reason "Preparing for move":
   api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Delete

```

* action=wdelete \*

Parameters:

```
 list                - Which lists to get
                       Maximum number of values 50 (500 for bots)
 wkXXXXX             - Wikia parameters. See list below to get Wikia parameters.
                       Maximum number of values 50 (500 for bots)
 redirects           - Automatically resolve redirects
 indexpageids        -
 converttitles       -
 iwurl               -
 export              -
 exportnowrap        -

```

Example:

```
 api.php?action=wdelete&list=wkvoteart&wkpage=0

```

--- --- --- --- --- --- --- --- Wdelete: List --- --- --- --- --- --- --- ---

* list=wkdomains \*

```
 Get domains handled by Wikia

```

This module requires read rights
Parameters:

```
 wkwikia             - Identifier in Wiki Factory
 wkactive            - Get only active domains [optional]
                       The value must be between 0 and 1
 wkfrom              - Begin of range - identifier in Wiki Factory
                       The value must be no less than 1
                       Default: 1
 wkto                - end of range - identifier in Wiki Factory
                       The value must be no less than 1
 wkcountonly         - return only number of Wikis
                       The value must be no less than 1
 wklang              - Wiki language
 wklimit             - How many results to return - default 10, max 100 for standard user, 1000 for bots
                       No more than 100 (1000 for bots) allowed
                       Default: 10

```

Examples:

```
 api.php?action=query&list=wkdomains
 api.php?action=query&list=wkdomains&wkactive=1
 api.php?action=query&list=wkdomains&wkwikia=177
 api.php?action=query&list=wkdomains&wkfrom=100&wkto=150
 api.php?action=query&list=wkdomains&wkfrom=10000&wkto=15000&wklang=de
 api.php?action=query&list=wkdomains&wkcountonly=1
 api.php?action=query&list=wkdomains&wkactive=1&wkcountonly=1
 api.php?action=query&list=wkdomains&wkactive=1&wklimit=25

```

* list=wkvoteart \*

```
 Remove vote of article. User have to be logged to use this option.

```

This module requires read rights
Parameters:

```
 wkdbname            - Name of database
                       Maximum number of values 50 (500 for bots)
                       Default:
 wkpage              - Identifier of page
 wkvote              - Article rating.
                       Default: 0

```

Example:

```
 api.php?action=delete&list=wkvoteart&wkpage=1770

```

* list=allusers \*

```
 Enumerate all registered users

```

This module requires read rights
Parameters:

```
 aufrom              - The user name to start enumerating from
 auto                - The user name to stop enumerating at
 auprefix            - Search for all users that begin with this value
 audir               - Direction to sort in
                       One value: ascending, descending
                       Default: ascending
 augroup             - Limit users to given group name(s)
                       Values (separate with '|'): bot, sysop, rollback, bureaucrat, staff, util, helper, vstf, bot-global, restricted-login,
                           restricted-login-exempt, content-moderator, council, authenticated, voldev, vanguard, checkuser,
                           oversight, threadmoderator, chatmoderator, content-reviewer, devboxpanel, translator, reviewer
 auexcludegroup      - Exclude users in given group name(s)
                       Values (separate with '|'): bot, sysop, rollback, bureaucrat, staff, util, helper, vstf, bot-global, restricted-login,
                           restricted-login-exempt, content-moderator, council, authenticated, voldev, vanguard, checkuser,
                           oversight, threadmoderator, chatmoderator, content-reviewer, devboxpanel, translator, reviewer
 aurights            - Limit users to given right(s)
                       Values (separate with '|'): apihighlimits, autoconfirmed, autopatrol, bigdelete, block, blockemail, bot, browsearchive,
                           createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deleterevision, edit,
                           editinterface, editmyoptions, editusercssjs, editusercss, edituserjs, hideuser, import,
                           importupload, ipblock-exempt, markbotedits, mergehistory, minoredit, move, movefile,
                           move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, patrol,
                           protect, proxyunbannable, purge, read, reupload, reupload-shared, rollback, sendemail, siteadmin,
                           suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload,
                           upload_by_url, userrights, userrights-interwiki, writeapi, canremovemap, wikifactory,
                           wikifactorymetrics, dumpsondemand, wikifeatures, MultiFileUploader, allowedtoblank, batchmove,
                           linkstoredirects, mobilesearches, soapfailures, moderatesotd, hiderevision, oversight,
                           abusefilter-modify, abusefilter-log-detail, abusefilter-view, abusefilter-log, abusefilter-private,
                           abusefilter-modify-restricted, abusefilter-revert, abusefilter-view-private, abusefilter-hidden-log,
                           abusefilter-hide-log, override-antispoof, checkuser, checkuser-log, geocode, nuke, refreshspecial,
                           spamregex, tboverride, tboverride-account, torunblocked, abusefilter-bypass, platinum,
                           sponsored-achievements, achievements-exempt, achievements-explicit, admindashboard, commentcreate,
                           commentmove, commentedit, commentdelete, becp_user, blog-comments-toggle, blog-comments-delete,
                           blog-articles-edit, blog-articles-move, blog-articles-protect, blog-auto-follow, skipcaptcha,
                           chatmoderator, chat, commentcsv, content-review, content-review-test-mode, coppatool, createnewwiki,
                           createwikilimitsexempt, finishcreate, devboxpanel, dmcarequestmanagement, editaccount,
                           emailsstorage, flags-administration, forum, boardedit, forumadmin, welcomeexempt, coppaimagereview,
                           imagereview, questionableimagereview, rejectedimagereview, imagereviewstats, imagereviewcontrols,
                           promoteimagereview, promoteimagereviewquestionableimagereview,
                           promoteimagereviewrejectedimagereview, promoteimagereviewstats, promoteimagereviewcontrols,
                           insights, listusers, lookupcontribs, lookupuser, minieditor-specialpage, multidelete, multiwikiedit,
                           multiwikifinder, phalanxexempt, phalanx, phalanxemailblock, piggyback,
                           places-enable-category-geolocation, metadata, powerdelete, quicktools, quickadopt, restrictsession,
                           scribeevents, performancestats, messagetool, forceview, edithub, InterwikiEdit, multilookup,
                           newwikislist, restricted_promote, protectsite, stafflog, unblockable, tagsreport, taskmanager,
                           taskmanager-action, tasks-user, template-bulk-classification, templatedraft, textregex,
                           themedesigner, usermanagement, removeavatar, renameuser, userrollback, specialvideohandler,
                           uploadpremiumvideo, wdacreview, WhereIsExtension, smwallowaskpage, council, authenticated,
                           editinterfacetrusted, deleteinterfacetrusted, voldev, wikianavglobal, wikianavlocal, videoupload,
                           mcachepurge, editrestrictedfields, viewedittab, createclass, first-edit-dialog-exempt,
                           hideblockername, clearuserprofile, smw-patternedit
 auprop              - What pieces of information to include.
                        blockinfo      - Adds the information about a current block on the user
                        groups         - Lists groups that the user is in. This uses more server resources and may return fewer results than the limit
                        implicitgroups - Lists all the groups the user is automatically in
                        rights         - Lists rights that the user has
                        editcount      - Adds the edit count of the user
                        registration   - Adds the timestamp of when the user registered if available (may be blank)
                       Values (separate with '|'): blockinfo, groups, implicitgroups, rights, editcount, registration
 aulimit             - How many total user names to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 auwitheditsonly     - Only list users who have made edits
 auactiveusers       - Only list users active in the last 30 days(s)
 aulocal             - Show users active on Wikia
                       Maximum number of values 50 (500 for bots)
                       Default: 0

```

Example:

```
 api.php?action=query&list=allusers&aufrom=Y

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Allusers

```

* list=checkuser \*

```
 Allows check which IPs are used by a given username and which usernames are used by a given IP

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 curequest           - Type of CheckUser request
                        userips - get IP of target user
                        edits   - get changes from target IP or range
                        ipusers - get users from target IP or range
                       This parameter is required
                       One value: userips, edits, ipusers
 cutarget            - Username or IP-address/range to perform check
                       This parameter is required
 cureason            - Reason to check
 culimit             - Limit of rows
                       No more than 500 (5000 for bots) allowed
                       Default: 1000
 cutimecond          - Time limit of user data (like "2 weeks")
                       Default: -2 weeks
 cuxff               - Use xff data instead of IP

```

Examples:

```
 api.php?action=query&list=checkuser&curequest=userips&cutarget=Jimbo_Wales
 api.php?action=query&list=checkuser&curequest=edits&cutarget=127.0.0.1/16&xff=1&cureason=Some_check

```

Help page:

```
 http://www.mediawiki.org/wiki/Extension:CheckUser#API

```

* list=checkuserlog \*

```
 Allows get entries of CheckUser log

```

This module requires read rights
Parameters:

```
 culuser             - Username of CheckUser
 cultarget           - Checked user or IP-address/range
 cullimit            - Limit of rows
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 culfrom             - The timestamp to start enumerating from
 culto               - The timestamp to end enumerating

```

Examples:

```
 api.php?action=query&list=checkuserlog&culuser=WikiSysop&limit=25
 api.php?action=query&list=checkuserlog&cultarget=127.0.0.1&culfrom=20111015230000

```

Help page:

```
 http://www.mediawiki.org/wiki/Extension:CheckUser#API

```

* list=firstcontributions \*

```
 Returns user name and first edit rev id and timestamp for new editors who first edited in the last 91 days

```

This module requires read rights
Parameters:

```
 fcafter             - Only get users who joined after this date.
 fcbefore            - Only get users who joined before this date. Can't be more than 91 days before the present date.
 fcdir               - In which direction to enumerate
                        newer          - List oldest first. Note: fcstart has to be before fcend.
                        older          - List newest first (default). Note: fcstart has to be later than fcend.
                       One value: newer, older
                       Default: older
 fclimit             - The maximum amount of entries to list
                       No more than 500 (5000 for bots) allowed
                       Default: 10

```

Examples:

```
 api.php?action=query&list=neweditors
 api.php?action=query&list=neweditors&fcdir=newer

```

--- --- --- --- --- --- --- --- end of List --- --- --- --- --- --- --- ---

* action=awcreminder \*

```
 Method called from TheSchwartz Queue to remind Wiki Creator about some options

```

This module requires read rights
Parameters:

```
 user_id             - user_id from user table
 token               - secret token

```

Example:

```
 api.php?action=awcreminder&user_id=51098&token=secret

```

* action=runjob \*

```
 Run jobs from jobs queue.

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 max                 - Max jobs done in request, not more than 100, default 1
 type                - Type of job, for example refreshLinks2

```

Examples:

```
 api.php?action=runjob
 api.php?action=runjob&max=5
 api.php?action=runjob&max=5&type=refreshLinks2

```

* action=fetchblob \*

```
 Fetch blob from blob store.

```

This module requires read rights
Parameters:

```
 store               - blob store
 token               - secret token
 id                  - identifier for blob

```

Example:

```
 api.php?action=fetchblob&store=archive1&id=34&token=secret-token

```

* action=licenses \*

```
 Get media license dropdown HTML.

```

This module requires read rights
Parameters:

```
 default             - The default (selected) value
                       Default: None selected
 id                  - The value for the "id" attribute
 name                - The value for the "name" attribute
                       This parameter is required

```

* action=imagecrop (img) \*

```
  This module is used to return one cropped image from specified article
 No example because article id is specific for every wikia

```

This module requires read rights
Parameters:

```
 imgId               - article Id (integer)
                       The value must be no less than 0
 imgSize             - size of cropped image (integer)
                       The value must be no less than 0
 imgHeight           - image Height used for right cropped image proportions (integer)
                       The value must be no less than 0
 imgFailOnFileNotFound - force API call to fail if image does not exist (boolean)
                       Maximum number of values 50 (500 for bots)

```

* action=imageserving (wis) \*

```
 This module is used to return one image from specified article given either the article id or article title (with prefix if applicable).

```

This module requires read rights
Parameters:

```
 wisId               - article Id (integer)
                       The value must be no less than 0
 wisTitle            - article Title (string)

```

Examples:

```
 api.php?action=imageserving&wisTitle=Cake
 api.php?action=imageserving&wisTitle=LyricWiki:Community_Portal
 api.php?action=imageserving&wisId=90286

```

* action=tagsreport \*

```
 This module provides tags report data for articles

```

This module requires read rights
Parameters:

```
 title               - Query by article title (string)
 tag                 - Query by tag type (string)
 limit               - How many tags to return
                       No more than 500 (5000 for bots) allowed
                       Default: 75
 continue            - When more results are available, use this to continue

```

Examples:

```
 api.php?action=tagsreport
 api.php?action=tagsreport&title=Tom_the_Cat_Wiki
 api.php?action=tagsreport&tag=gallery

```

* action=blogs \*
* action=titleblacklist (tb) \*

```
 Validate an article title, filename, or username against the TitleBlacklist.

```

This module requires read rights
Parameters:

```
 tbtitle             - The string to validate against the blacklist
                       This parameter is required
 tbaction            - The thing you're trying to do
                       One value: create, edit, upload, createtalk, createpage
                       Default: edit

```

Examples:

```
 api.php?action=titleblacklist&tbtitle=Foo
 api.php?action=titleblacklist&tbtitle=Bar&tbaction=create

```

* action=visualeditor \*

```
 Returns HTML5 for a page from the parsoid service.

```

This module requires read rights
This module requires write rights
Parameters:

```
 page                - The page to perform actions on.
                       This parameter is required
 format              -
                       One value: json, jsonfm
                       Default: json
 paction             - Action to perform
                       This parameter is required
                       One value: parse, parsefragment, serialize, serializeforcache, diff, getlanglinks
 wikitext            - Wikitext to send to Parsoid to convert to HTML (paction=parsefragment)
 basetimestamp       - When saving, set this to the timestamp of the revision that was edited. Used to detect edit conflicts.
 starttimestamp      - When saving, set this to the timestamp of when the page was loaded. Used to detect edit conflicts.
 oldid               - The revision number to use (defaults to latest version).
 html                - HTML to send to Parsoid to convert to wikitext
 cachekey            - For serialize or diff, use the result of a previous serializeforcache request with this key. Overrides html.
 pst                 - Pre-save transform wikitext before sending it to Parsoid (paction=parsefragment)

```

* action=visualeditoredit \*

```
 Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 page                - The page to perform actions on.
                       This parameter is required
 token               - Edit token
                       This parameter is required
 wikitext            -
 basetimestamp       - When saving, set this to the timestamp of the revision that was edited. Used to detect edit conflicts.
 starttimestamp      - When saving, set this to the timestamp of when the page was loaded. Used to detect edit conflicts.
 needcheck           - When saving, set this parameter if the revision might have roundtrip problems. This will result in the edit being tagged.
 oldid               - The revision number to use. Defaults to latest revision. Use 0 for new page.
 minor               - Flag for minor edit.
 watch               -
 html                - HTML to send to Parsoid in exchange for wikitext
 summary             - Edit summary
 cachekey            - Use the result of a previous serializeforcache request with this key.Overrides html.

```

* action=apimediasearch \*
* action=addmediatemporary \*
* action=addmediapermanent \*
* action=videopreview \*
* action=templatesearch \*
* action=templatesuggestions \*
* action=templateparameters \*
* action=scribunto-console \*

```
 Internal module for servicing XHR requests from the Scribunto console

```

This module requires read rights
Parameters:

```
 title               - The module title to test
 content             - The new content of the module
 session             -
 question            - The next line to evaluate as a script
                       This parameter is required
 clear               - Set this to true to clear the current session state

```

* action=infobox \*

```
 This module provides infobox parser

```

This module requires read rights
Parameters:

```
 text                - Infobox to parse (xml string)
 title               - Title of page the text belongs to
 args                - Variable list to use during parse (json format)

```

Examples:

```
 api.php?action=infobox
 api.php?action=infobox&text=

 API

&title=Test
 api.php?action=infobox&text=&args={"test": "test value"}

```

* action=login (lg) \*

```
 Log in and get the authentication tokens.
 In the event of a successful log-in, a cookie will be attached
 to your session. In the event of a failed log-in, you will not
 be able to attempt another log-in through this method for 5 seconds.
 This is to prevent password guessing by automated password crackers

```

This module only accepts POST requests
Parameters:

```
 lgname              - User Name
 lgpassword          - Password
 lgdomain            - Domain (optional)
 lgtoken             - Login token obtained in first request

```

Example:

```
 api.php?action=login&lgname=user&lgpassword=password

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Login

```

* action=logout \*

```
 Log out and clear session data

```

Example:

```
 Log the current user out:
   api.php?action=logout

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Logout

```

* action=query \*

```
 Query API module allows applications to get needed pieces of data from the MediaWiki databases,
 and is loosely based on the old query.php interface.
 All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites

```

This module requires read rights
Parameters:

```
 titles              - A list of titles to work on
 pageids             - A list of page IDs to work on
                       Maximum number of values 50 (500 for bots)
 revids              - A list of revision IDs to work on
                       Maximum number of values 50 (500 for bots)
 prop                - Which properties to get for the titles/revisions/pageids. Module help is available below
                       Values (separate with '|'): info, revisions, links, iwlinks, langlinks, images, imageinfo, stashimageinfo, templates,
                           categories, extlinks, categoryinfo, duplicatefiles, pageprops, wklasteditors, globalusage, infobox
 list                - Which lists to get. Module help is available below
                       Values (separate with '|'): allimages, allpages, alllinks, allcategories, allusers, backlinks, blocks, categorymembers,
                           deletedrevs, embeddedin, filearchive, imageusage, iwbacklinks, langbacklinks, logevents,
                           recentchanges, search, tags, usercontribs, watchlist, watchlistraw, exturlusage, users, random,
                           protectedtitles, querypage, wkdomains, wkpoppages, wkvoteart, wkaccessart, wkeditpage, wkedituser,
                           wkmostvisit, checkuser, checkuserlog, unconvertedinfoboxes, allinfoboxes, firstcontributions
 meta                - Which metadata to get about the site. Module help is available below
                       Values (separate with '|'): siteinfo, userinfo, allmessages
 generator           - Use the output of a list as the input for other prop/list/meta items
                       NOTE: generator parameter names must be prefixed with a 'g', see examples
                       One value: links, images, templates, categories, duplicatefiles, allimages, allpages, alllinks, allcategories,
                           backlinks, categorymembers, embeddedin, imageusage, iwbacklinks, langbacklinks, recentchanges,
                           search, watchlist, watchlistraw, exturlusage, random, protectedtitles, querypage
 redirects           - Automatically resolve redirects
 converttitles       - Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion.
                       Languages that support variant conversion include gan, iu, kk, ku, shi, sr, tg, zh
 indexpageids        - Include an additional pageids section listing all returned page IDs
 export              - Export the current revisions of all given or generated pages
 exportnowrap        - Return the export XML without wrapping it in an XML result (same format as Special:Export). Can only be used with export
 iwurl               - Whether to get the full URL if the title is an interwiki link

```

Examples:

```
 api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment
 api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions

```

Help pages:

```
 https://www.mediawiki.org/wiki/API:Meta
 https://www.mediawiki.org/wiki/API:Properties
 https://www.mediawiki.org/wiki/API:Lists

```

--- --- --- --- --- --- --- --- --- --- --- --- Query: Prop --- --- --- --- --- --- --- --- --- --- --- ---

* prop=info (in) \*

```
 Get basic page information such as namespace, title, last touched date, ...

```

This module requires read rights
Parameters:

```
 inprop              - Which additional properties to get:
                        protection   - List the protection level of each page
                        talkid       - The page ID of the talk page for each non-talk page
                        watched      - List the watched status of each page
                        subjectid    - The page ID of the parent page for each talk page
                        url          - Gives a full URL to the page, and also an edit URL
                        readable     - Whether the user can read this page
                        preload      - Gives the text returned by EditFormPreloadText
                        displaytitle - Gives the way the page title is actually displayed
                        "views"        - The number of pageviews of each page
                        "revcount"     - The number of all revisions of each page
                        "created"		 - Creation date of each page
                        "redirect"     - Name of redirected page
                       Values (separate with '|'): protection, talkid, watched, subjectid, url, readable, preload, displaytitle, views, revcount,
                           created, redirect
 intoken             - Request a token to perform a data-modifying action on a page
                       Values (separate with '|'): edit, delete, protect, move, block, unblock, email, import, watch
 incontinue          - When more results are available, use this to continue

```

Examples:

```
 api.php?action=query&prop=info&titles=Main%20Page
 api.php?action=query&prop=info&inprop=protection&titles=Main%20Page
 Get a pageviews of Main Page
   api.php?action=query&prop=info&titles=Main%20Page&inprop=views|revcount

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Properties#info\_.2F\_in

```

* prop=revisions (rv) \*

```
 Get revision information
 May be used in several ways:
  1) Get data about a set of pages (last revision), by setting titles or pageids parameter
  2) Get revisions for one given page, by using titles/pageids with start/end/limit params
  3) Get data about a set of revisions by setting their IDs with revids parameter
 All parameters marked as (enum) may only be used with a single page (#2)

```

This module requires read rights
Parameters:

```
 rvprop              - Which properties to get for each revision:
                        ids            - The ID of the revision
                        flags          - Revision flags (minor)
                        timestamp      - The timestamp of the revision
                        user           - User that made the revision
                        userid         - User id of revision creator
                        size           - Length (bytes) of the revision
                        sha1           - SHA-1 (base 16) of the revision
                        comment        - Comment by the user for revision
                        parsedcomment  - Parsed comment by the user for the revision
                        content        - Text of the revision
                        tags           - Tags for the revision
                       Values (separate with '|'): ids, flags, timestamp, user, userid, size, sha1, comment, parsedcomment, content, tags
 rvlimit             - Limit how many revisions will be returned (enum)
                       No more than 500 (5000 for bots) allowed
 rvstartid           - From which revision id to start enumeration (enum)
 rvendid             - Stop revision enumeration on this revid (enum)
 rvstart             - From which revision timestamp to start enumeration (enum)
 rvend               - Enumerate up to this timestamp (enum)
 rvdir               - In which direction to enumerate (enum)
                        newer          - List oldest first. Note: rvstart has to be before rvend.
                        older          - List newest first (default). Note: rvstart has to be later than rvend.
                       One value: newer, older
                       Default: older
 rvuser              - Only include revisions made by user (enum)
 rvexcludeuser       - Exclude revisions made by user (enum)
 rvtag               - Only list revisions tagged with this tag
 rvexpandtemplates   - Expand templates in revision content
 rvgeneratexml       - Generate XML parse tree for revision content
 rvparse             - Parse revision content. For performance reasons if this option is used, rvlimit is enforced to 1.
 rvsection           - Only retrieve the content of this section number
 rvtoken             - Which tokens to obtain for each revision
                       Values (separate with '|'): rollback
 rvcontinue          - When more results are available, use this to continue
 rvdiffto            - Revision ID to diff each revision to.
                       Use "prev", "next" and "cur" for the previous, next and current revision respectively
 rvdifftotext        - Text to diff each revision to. Only diffs a limited number of revisions.
                       Overrides rvdiffto. If rvsection is set, only that section will be diffed against this text

```

Examples:

```
 Get data with content for the last revision of titles "API" and "Main Page"
 Get last 5 revisions of the "Main Page"
   api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment
 Get first 5 revisions of the "Main Page"
   api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer
 Get first 5 revisions of the "Main Page" made after 2006-05-01
   api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=20060501000000
 Get first 5 revisions of the "Main Page" that were not made made by anonymous user "127.0.0.1"
   api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1
 Get first 5 revisions of the "Main Page" that were made by the user "MediaWiki default"
   api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvuser=MediaWiki%20default

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Properties#revisions\_.2F\_rv

```

* prop=links (pl) \*

```
 Returns all links from the given page(s)

```

This module requires read rights
Parameters:

```
 plnamespace         - Show links in this namespace(s) only
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
 pllimit             - How many links to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 plcontinue          - When more results are available, use this to continue
 pltitles            - Only list links to these titles. Useful for checking whether a certain page links to a certain title.
 pldir               - The direction in which to list
                       One value: ascending, descending
                       Default: ascending

```

Examples:

```
 Get links from the Main Page::
   api.php?action=query&prop=links&titles=Main%20Page
 Get information about the link pages in the Main Page::
   api.php?action=query&generator=links&titles=Main%20Page&prop=info
 Get links from the Main Page in the User and Template namespaces::
   api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Properties#links\_.2F\_pl

```

Generator:

```
 This module may be used as a generator

```

* prop=iwlinks (iw) \*

```
 Returns all interwiki links from the given page(s)

```

This module requires read rights
Parameters:

```
 iwurl               - Whether to get the full URL
 iwlimit             - How many interwiki links to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 iwcontinue          - When more results are available, use this to continue
 iwprefix            - Prefix for the interwiki
 iwtitle             - Interwiki link to search for. Must be used with iwprefix
 iwdir               - The direction in which to list
                       One value: ascending, descending
                       Default: ascending

```

Example:

```
 Get interwiki links from the Main Page:
   api.php?action=query&prop=iwlinks&titles=Main%20Page

```

* prop=langlinks (ll) \*

```
 Returns all interlanguage links from the given page(s)

```

This module requires read rights
Parameters:

```
 lllimit             - How many langlinks to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 llcontinue          - When more results are available, use this to continue
 llurl               - Whether to get the full URL
 lllang              - Language code
 lltitle             - Link to search for. Must be used with lllang
 lldir               - The direction in which to list
                       One value: ascending, descending
                       Default: ascending

```

Example:

```
 Get interlanguage links from the Main Page:
   api.php?action=query&prop=langlinks&titles=Main%20Page&redirects=

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Properties#langlinks\_.2F\_ll

```

* prop=images (im) \*

```
 Returns all images contained on the given page(s)

```

This module requires read rights
Parameters:

```
 imlimit             - How many images to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 imcontinue          - When more results are available, use this to continue
 imimages            - Only list these images. Useful for checking whether a certain page has a certain Image.
 imdir               - The direction in which to list
                       One value: ascending, descending
                       Default: ascending

```

Examples:

```
 Get a list of images used in the Main Page:
   api.php?action=query&prop=images&titles=Main%20Page
 Get information about all images used in the Main Page:
   api.php?action=query&generator=images&titles=Main%20Page&prop=info

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Properties#images\_.2F\_im

```

Generator:

```
 This module may be used as a generator

```

* prop=imageinfo (ii) \*

```
 Returns image information and upload history

```

This module requires read rights
Parameters:

```
 iiprop              - What image information to get:
                        timestamp     - Adds timestamp for the uploaded version
                        user          - Adds the user who uploaded the image version
                        userid        - Add the user ID that uploaded the image version
                        comment       - Comment on the version
                        parsedcomment - Parse the comment on the version
                        url           - Gives URL to the image and the description page
                        size          - Adds the size of the image in bytes and the height, width and page count (if applicable)
                        dimensions    - Alias for size
                        sha1          - Adds SHA-1 hash for the image
                        mime          - Adds MIME type of the image
                        thumbmime     - Adds MIME type of the image thumbnail (requires url)
                        mediatype     - Adds the media type of the image
                        metadata      - Lists EXIF metadata for the version of the image
                        archivename   - Adds the file name of the archive version for non-latest versions
                        bitdepth      - Adds the bit depth of the version
                       Values (separate with '|'): timestamp, user, userid, comment, parsedcomment, url, size, dimensions, sha1, mime, thumbmime,
                           mediatype, metadata, archivename, bitdepth
                       Default: timestamp|user
 iilimit             - How many image revisions to return
                       No more than 500 (5000 for bots) allowed
                       Default: 1
 iistart             - Timestamp to start listing from
 iiend               - Timestamp to stop listing at
 iiurlwidth          - If iiprop=url is set, a URL to an image scaled to this width will be returned.
                       Only the current version of the image can be scaled
                       Default: -1
 iiurlheight         - Similar to iiurlwidth. Cannot be used without iiurlwidth
                       Default: -1
 iimetadataversion   - Version of metadata to use. if 'latest' is specified, use latest version.
                       Defaults to '1' for backwards compatibility
                       Default: 1
 iiurlparam          - A handler specific parameter string. For example, pdf's
                       might use 'page15-100px'. iiurlwidth must be used and be consistent with iiurlparam
                       Default:
 iicontinue          - If the query response includes a continue value, use it here to get another page of results

```

Examples:

```
 api.php?action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo
 api.php?action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&iiend=20071231235959&iiprop=timestamp|user|url

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Properties#imageinfo\_.2F\_ii

```

* prop=stashimageinfo (sii) \*

```
 Returns image information for stashed images

```

This module requires read rights
Parameters:

```
 siifilekey          - Key that identifies a previous upload that was stashed temporarily.
 siisessionkey       - DEPRECATED! Alias for filekey, for backward compatibility.
 siiprop             - What image information to get:
                        timestamp     - Adds timestamp for the uploaded version
                        url           - Gives URL to the image and the description page
                        size          - Adds the size of the image in bytes and the height, width and page count (if applicable)
                        dimensions    - Alias for size
                        sha1          - Adds SHA-1 hash for the image
                        mime          - Adds MIME type of the image
                        thumbmime     - Adds MIME type of the image thumbnail (requires url)
                        metadata      - Lists EXIF metadata for the version of the image
                        bitdepth      - Adds the bit depth of the version
                       Values (separate with '|'): timestamp, url, size, dimensions, sha1, mime, thumbmime, metadata, bitdepth
                       Default: timestamp|url
 siiurlwidth         - If siiprop=url is set, a URL to an image scaled to this width will be returned.
                       Default: -1
 siiurlheight        - Similar to siiurlwidth. Cannot be used without siiurlwidth
                       Default: -1
 siiurlparam         - A handler specific parameter string. For example, pdf's
                       might use 'page15-100px'. siiurlwidth must be used and be consistent with siiurlparam
                       Default:

```

Examples:

```
 api.php?action=query&prop=stashimageinfo&siifilekey=124sd34rsdf567
 api.php?action=query&prop=stashimageinfo&siifilekey=b34edoe3|bceffd4&siiurlwidth=120&siiprop=url

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Properties#imageinfo\_.2F\_ii

```

* prop=templates (tl) \*

```
 Returns all templates from the given page(s)

```

This module requires read rights
Parameters:

```
 tlnamespace         - Show templates in this namespace(s) only
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
 tllimit             - How many templates to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 tlcontinue          - When more results are available, use this to continue
 tltemplates         - Only list these templates. Useful for checking whether a certain page uses a certain template.
 tldir               - The direction in which to list
                       One value: ascending, descending
                       Default: ascending

```

Examples:

```
 Get templates from the Main Page::
   api.php?action=query&prop=templates&titles=Main%20Page
 Get information about the template pages in the Main Page::
   api.php?action=query&generator=templates&titles=Main%20Page&prop=info
 Get templates from the Main Page in the User and Template namespaces::
   api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Properties#templates\_.2F\_tl

```

Generator:

```
 This module may be used as a generator

```

* prop=categories (cl) \*

```
 List all categories the page(s) belong to

```

This module requires read rights
Parameters:

```
 clprop              - Which additional properties to get for each category
                        sortkey    - Adds the sortkey (hexadecimal string) and sortkey prefix (human-readable part) for the category
                        timestamp  - Adds timestamp of when the category was added
                        hidden     - Tags categories that are hidden with
                       Values (separate with '|'): sortkey, timestamp, hidden
 clshow              - Which kind of categories to show
                       Values (separate with '|'): hidden, !hidden
 cllimit             - How many categories to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 clcontinue          - When more results are available, use this to continue
 clcategories        - Only list these categories. Useful for checking whether a certain page is in a certain category
 cldir               - The direction in which to list
                       One value: ascending, descending
                       Default: ascending

```

Examples:

```
 Get a list of categories Albert Einstein belongs to:
   api.php?action=query&prop=categories&titles=Albert%20Einstein
 Get information about all categories used in the Albert Einstein:
   api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Properties#categories\_.2F\_cl

```

Generator:

```
 This module may be used as a generator

```

* prop=extlinks (el) \*

```
 Returns all external urls (not interwikies) from the given page(s)

```

This module requires read rights
Parameters:

```
 ellimit             - How many links to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 eloffset            - When more results are available, use this to continue
 elprotocol          - Protocol of the url. If empty and elquery set, the protocol is http.
                       Leave both this and elquery empty to list all external links
                       Can be empty, or One value: http, https, ftp, irc, ircs, gopher, telnet, nntp, worldwind, mailto, news, svn, git, mms, xmpp
                       Default:
 elquery             - Search string without protocol. Useful for checking whether a certain page contains a certain external url

```

Example:

```
 Get a list of external links on the Main Page:
   api.php?action=query&prop=extlinks&titles=Main%20Page

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Properties#extlinks\_.2F\_el

```

* prop=categoryinfo (ci) \*

```
 Returns information about the given categories

```

This module requires read rights
Parameters:

```
 cicontinue          - When more results are available, use this to continue

```

Example:

```
 api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Properties#categoryinfo\_.2F\_ci

```

* prop=duplicatefiles (df) \*

```
 List all files that are duplicates of the given file(s)

```

This module requires read rights
Parameters:

```
 dflimit             - How many files to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 dfcontinue          - When more results are available, use this to continue
 dfdir               - The direction in which to list
                       One value: ascending, descending
                       Default: ascending

```

Examples:

```
 api.php?action=query&titles=File:Albert_Einstein_Head.jpg&prop=duplicatefiles
 api.php?action=query&generator=allimages&prop=duplicatefiles

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Properties#duplicatefiles\_.2F\_df

```

Generator:

```
 This module may be used as a generator

```

* prop=pageprops (pp) \*

```
 Get various properties defined in the page content

```

This module requires read rights
Parameters:

```
 ppcontinue          - When more results are available, use this to continue
 ppprop              - Page prop to look on the page for. Useful for checking whether a certain page uses a certain page prop.

```

Example:

```
 api.php?action=query&prop=pageprops&titles=Category:Foo

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Properties#pageprops\_.2F\_pp

```

* prop=wklasteditors \*

```
 Get the last contributors

```

This module requires read rights
Parameters:

```
 limit               - Limit records
                       The value must be no less than 25
                       Maximum number of values 50 (500 for bots)
                       Default: 25
 offset              - Limit offset
                       The value must be no less than 0
                       Maximum number of values 50 (500 for bots)
                       Default: 0
 bot                 - Return also bots ( if bot = 1 )
                       The value must be no less than 0
                       Maximum number of values 50 (500 for bots)
                       Default: 0
 content             - Check only editors of content namespaces
                       The value must be no less than 0
                       Maximum number of values 50 (500 for bots)
                       Default: 0
 anon                - Return also anons ( if anon = 1 )
                       The value must be no less than 0
                       Maximum number of values 50 (500 for bots)
                       Default: 0

```

Examples:

```
 Get last logged-in editors of content pages Wiki
   api.php?action=query&prop=wklasteditors&limit=25&bot=0&content=1&anon=0
 Get last editors
   api.php?action=query&prop=wklasteditors&limit=25

```

* prop=globalusage (gu) \*

```
 Returns global image usage for a certain image

```

This module requires read rights
Parameters:

```
 guprop              - What properties to return
                        url        - Adds url
                        pageid     - Adds page id
                        namespace  - Adds namespace id
                       Values (separate with '|'): url, pageid, namespace
                       Default: url
 gulimit             - How many links to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 gucontinue          - When more results are available, use this to continue
 gufilterlocal       - Filter local usage of the file

```

Examples:

```
 Get usage of File:Example.jpg:
   api.php?action=query&prop=globalusage&titles=File:Example.jpg

```

* prop=infobox (ib) \*

--- --- --- --- --- --- --- --- --- --- --- --- Query: List --- --- --- --- --- --- --- --- --- --- --- ---

* list=allimages (ai) \*

```
 Enumerate all images sequentially

```

This module requires read rights
Parameters:

```
 aifrom              - The image title to start enumerating from
 aito                - The image title to stop enumerating at
 aiprefix            - Search for all image titles that begin with this value
 aiminsize           - Limit to images with at least this many bytes
 aimaxsize           - Limit to images with at most this many bytes
 ailimit             - How many images in total to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 aidir               - The direction in which to list
                       One value: ascending, descending
                       Default: ascending
 aisha1              - SHA1 hash of image. Overrides aisha1base36
 aisha1base36        - SHA1 hash of image in base 36 (used in MediaWiki)
 aiprop              - What image information to get:
                        timestamp     - Adds timestamp for the uploaded version
                        user          - Adds the user who uploaded the image version
                        userid        - Add the user ID that uploaded the image version
                        comment       - Comment on the version
                        parsedcomment - Parse the comment on the version
                        url           - Gives URL to the image and the description page
                        size          - Adds the size of the image in bytes and the height, width and page count (if applicable)
                        dimensions    - Alias for size
                        sha1          - Adds SHA-1 hash for the image
                        mime          - Adds MIME type of the image
                        thumbmime     - Adds MIME type of the image thumbnail (requires url)
                        mediatype     - Adds the media type of the image
                        metadata      - Lists EXIF metadata for the version of the image
                        bitdepth      - Adds the bit depth of the version
                       Values (separate with '|'): timestamp, user, userid, comment, parsedcomment, url, size, dimensions, sha1, mime, thumbmime,
                           mediatype, metadata, bitdepth
                       Default: timestamp|url
 aimime              - What MIME type to search for. e.g. image/jpeg. Disabled in Miser Mode

```

Examples:

```
 Show a list of images starting at the letter "B":
   api.php?action=query&list=allimages&aifrom=B
 Show info about 4 images starting at the letter "T":
   api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Allimages

```

Generator:

```
 This module may be used as a generator

```

* list=allpages (ap) \*

```
 Enumerate all pages sequentially in a given namespace

```

This module requires read rights
Parameters:

```
 apfrom              - The page title to start enumerating from
 apto                - The page title to stop enumerating at
 apprefix            - Search for all page titles that begin with this value
 apnamespace         - The namespace to enumerate
                       One value: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Default: 0
 apfilterredir       - Which pages to list
                       One value: all, redirects, nonredirects
                       Default: all
 apminsize           - Limit to pages with at least this many bytes
 apmaxsize           - Limit to pages with at most this many bytes
 apprtype            - Limit to protected pages only
                       Values (separate with '|'): edit, move, upload
 apprlevel           - The protection level (must be used with apprtype= parameter)
                       Can be empty, or Values (separate with '|'): autoconfirmed, sysop
 apprfiltercascade   - Filter protections based on cascadingness (ignored when apprtype isn't set)
                       One value: cascading, noncascading, all
                       Default: all
 aplimit             - How many total pages to return.
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 apdir               - The direction in which to list
                       One value: ascending, descending
                       Default: ascending
 apfilterlanglinks   - Filter based on whether a page has langlinks
                       One value: withlanglinks, withoutlanglinks, all
                       Default: all
 apprexpiry          - Which protection expiry to filter the page on
                        indefinite - Get only pages with indefinite protection expiry
                        definite - Get only pages with a definite (specific) protection expiry
                        all - Get pages with any protections expiry
                       One value: indefinite, definite, all
                       Default: all

```

Examples:

```
 Show a list of pages starting at the letter "B":
   api.php?action=query&list=allpages&apfrom=B
 Show info about 4 pages starting at the letter "T":
   api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info
 Show content of first 2 non-redirect pages begining at "Re":
   api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Allpages

```

Generator:

```
 This module may be used as a generator

```

* list=alllinks (al) \*

```
 Enumerate all links that point to a given namespace

```

This module requires read rights
Parameters:

```
 alcontinue          - When more results are available, use this to continue
 alfrom              - The page title to start enumerating from
 alto                - The page title to stop enumerating at
 alprefix            - Search for all page titles that begin with this value
 alunique            - Only show unique links. Cannot be used with generator or alprop=ids
 alprop              - What pieces of information to include
                        ids    - Adds pageid of where the link is from (Cannot be used with alunique)
                        title  - Adds the title of the link
                       Values (separate with '|'): ids, title
                       Default: title
 alnamespace         - The namespace to enumerate
                       One value: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Default: 0
 allimit             - How many total links to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10

```

Example:

```
 api.php?action=query&list=alllinks&alunique=&alfrom=B

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Alllinks

```

Generator:

```
 This module may be used as a generator

```

* list=allcategories (ac) \*

```
 Enumerate all categories

```

This module requires read rights
Parameters:

```
 acfrom              - The category to start enumerating from
 acto                - The category to stop enumerating at
 acprefix            - Search for all category titles that begin with this value
 acdir               - Direction to sort in
                       One value: ascending, descending
                       Default: ascending
 acmin               - Minimum number of category members
 acmax               - Maximum number of category members
 aclimit             - How many categories to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 acprop              - Which properties to get
                        size    - Adds number of pages in the category
                        hidden  - Tags categories that are hidden with
                        id      - Adds Id of the category
                       Values (separate with '|'): size, hidden, id
                       Default:

```

Examples:

```
 api.php?action=query&list=allcategories&acprop=size
 api.php?action=query&generator=allcategories&gacprefix=List&prop=info

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Allcategories

```

Generator:

```
 This module may be used as a generator

```

* list=allusers (au) \*

```
 Enumerate all registered users

```

This module requires read rights
Parameters:

```
 aufrom              - The user name to start enumerating from
 auto                - The user name to stop enumerating at
 auprefix            - Search for all users that begin with this value
 audir               - Direction to sort in
                       One value: ascending, descending
                       Default: ascending
 augroup             - Limit users to given group name(s)
                       Values (separate with '|'): bot, sysop, rollback, bureaucrat, staff, util, helper, vstf, bot-global, restricted-login,
                           restricted-login-exempt, content-moderator, council, authenticated, voldev, vanguard, checkuser,
                           oversight, threadmoderator, chatmoderator, content-reviewer, devboxpanel, translator, reviewer
 auexcludegroup      - Exclude users in given group name(s)
                       Values (separate with '|'): bot, sysop, rollback, bureaucrat, staff, util, helper, vstf, bot-global, restricted-login,
                           restricted-login-exempt, content-moderator, council, authenticated, voldev, vanguard, checkuser,
                           oversight, threadmoderator, chatmoderator, content-reviewer, devboxpanel, translator, reviewer
 aurights            - Limit users to given right(s)
                       Values (separate with '|'): apihighlimits, autoconfirmed, autopatrol, bigdelete, block, blockemail, bot, browsearchive,
                           createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deleterevision, edit,
                           editinterface, editmyoptions, editusercssjs, editusercss, edituserjs, hideuser, import,
                           importupload, ipblock-exempt, markbotedits, mergehistory, minoredit, move, movefile,
                           move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, patrol,
                           protect, proxyunbannable, purge, read, reupload, reupload-shared, rollback, sendemail, siteadmin,
                           suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload,
                           upload_by_url, userrights, userrights-interwiki, writeapi, canremovemap, wikifactory,
                           wikifactorymetrics, dumpsondemand, wikifeatures, MultiFileUploader, allowedtoblank, batchmove,
                           linkstoredirects, mobilesearches, soapfailures, moderatesotd, hiderevision, oversight,
                           abusefilter-modify, abusefilter-log-detail, abusefilter-view, abusefilter-log, abusefilter-private,
                           abusefilter-modify-restricted, abusefilter-revert, abusefilter-view-private, abusefilter-hidden-log,
                           abusefilter-hide-log, override-antispoof, checkuser, checkuser-log, geocode, nuke, refreshspecial,
                           spamregex, tboverride, tboverride-account, torunblocked, abusefilter-bypass, platinum,
                           sponsored-achievements, achievements-exempt, achievements-explicit, admindashboard, commentcreate,
                           commentmove, commentedit, commentdelete, becp_user, blog-comments-toggle, blog-comments-delete,
                           blog-articles-edit, blog-articles-move, blog-articles-protect, blog-auto-follow, skipcaptcha,
                           chatmoderator, chat, commentcsv, content-review, content-review-test-mode, coppatool, createnewwiki,
                           createwikilimitsexempt, finishcreate, devboxpanel, dmcarequestmanagement, editaccount,
                           emailsstorage, flags-administration, forum, boardedit, forumadmin, welcomeexempt, coppaimagereview,
                           imagereview, questionableimagereview, rejectedimagereview, imagereviewstats, imagereviewcontrols,
                           promoteimagereview, promoteimagereviewquestionableimagereview,
                           promoteimagereviewrejectedimagereview, promoteimagereviewstats, promoteimagereviewcontrols,
                           insights, listusers, lookupcontribs, lookupuser, minieditor-specialpage, multidelete, multiwikiedit,
                           multiwikifinder, phalanxexempt, phalanx, phalanxemailblock, piggyback,
                           places-enable-category-geolocation, metadata, powerdelete, quicktools, quickadopt, restrictsession,
                           scribeevents, performancestats, messagetool, forceview, edithub, InterwikiEdit, multilookup,
                           newwikislist, restricted_promote, protectsite, stafflog, unblockable, tagsreport, taskmanager,
                           taskmanager-action, tasks-user, template-bulk-classification, templatedraft, textregex,
                           themedesigner, usermanagement, removeavatar, renameuser, userrollback, specialvideohandler,
                           uploadpremiumvideo, wdacreview, WhereIsExtension, smwallowaskpage, council, authenticated,
                           editinterfacetrusted, deleteinterfacetrusted, voldev, wikianavglobal, wikianavlocal, videoupload,
                           mcachepurge, editrestrictedfields, viewedittab, createclass, first-edit-dialog-exempt,
                           hideblockername, clearuserprofile, smw-patternedit
 auprop              - What pieces of information to include.
                        blockinfo      - Adds the information about a current block on the user
                        groups         - Lists groups that the user is in. This uses more server resources and may return fewer results than the limit
                        implicitgroups - Lists all the groups the user is automatically in
                        rights         - Lists rights that the user has
                        editcount      - Adds the edit count of the user
                        registration   - Adds the timestamp of when the user registered if available (may be blank)
                       Values (separate with '|'): blockinfo, groups, implicitgroups, rights, editcount, registration
 aulimit             - How many total user names to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 auwitheditsonly     - Only list users who have made edits
 auactiveusers       - Only list users active in the last 30 days(s)
 aulocal             - Show users active on Wikia
                       Maximum number of values 50 (500 for bots)
                       Default: 0

```

Example:

```
 api.php?action=query&list=allusers&aufrom=Y

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Allusers

```

* list=backlinks (bl) \*

```
 Find all pages that link to the given page

```

This module requires read rights
Parameters:

```
 bltitle             - Title to search
                       This parameter is required
 blcontinue          - When more results are available, use this to continue
 blnamespace         - The namespace to enumerate
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
 blfilterredir       - How to filter for redirects. If set to nonredirects when blredirect is enabled, this is only applied to the second level
                       One value: all, redirects, nonredirects
                       Default: all
 bllimit             - How many total pages to return. If blredirect is enabled, limit applies to each level separately (which means you may get up to 2 * limit results).
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 blcount             - Return only total number of backlinks
 blredirect          - If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.

```

Examples:

```
 api.php?action=query&list=backlinks&bltitle=Main%20Page
 api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Backlinks

```

Generator:

```
 This module may be used as a generator

```

* list=blocks (bk) \*

```
 List all blocked users and IP addresses

```

This module requires read rights
Parameters:

```
 bkstart             - The timestamp to start enumerating from
 bkend               - The timestamp to stop enumerating at
 bkdir               - In which direction to enumerate
                        newer          - List oldest first. Note: bkstart has to be before bkend.
                        older          - List newest first (default). Note: bkstart has to be later than bkend.
                       One value: newer, older
                       Default: older
 bkids               - Pipe-separated list of block IDs to list (optional)
                       Maximum number of values 50 (500 for bots)
 bkusers             - Pipe-separated list of users to search for (optional)
 bkip                - Get all blocks applying to this IP or CIDR range, including range blocks.
                       Cannot be used together with bkusers. CIDR ranges broader than /16 are not accepted
 bklimit             - The maximum amount of blocks to list
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 bkprop              - Which properties to get
                        id         - Adds the ID of the block
                        user       - Adds the username of the blocked user
                        userid     - Adds the user ID of the blocked user
                        by         - Adds the username of the blocking user
                        byid       - Adds the user ID of the blocking user
                        timestamp  - Adds the timestamp of when the block was given
                        expiry     - Adds the timestamp of when the block expires
                        reason     - Adds the reason given for the block
                        range      - Adds the range of IPs affected by the block
                        flags      - Tags the ban with (autoblock, anononly, etc)
                       Values (separate with '|'): id, user, userid, by, byid, timestamp, expiry, reason, range, flags
 bkshow              - Show only items that meet this criteria.
                       For example, to see only indefinite blocks on IPs, set bkshow=ip|!temp
                       Values (separate with '|'): account, !account, temp, !temp, ip, !ip, range, !range

```

Examples:

```
 api.php?action=query&list=blocks
 api.php?action=query&list=blocks&bkusers=Alice|Bob

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Blocks

```

* list=categorymembers (cm) \*

```
 List all pages in a given category

```

This module requires read rights
Parameters:

```
 cmtitle             - Which category to enumerate (required). Must include Category: prefix. Cannot be used together with cmpageid
 cmpageid            - Page ID of the category to enumerate. Cannot be used together with cmtitle
 cmprop              - What pieces of information to include
                        ids           - Adds the page ID
                        title         - Adds the title and namespace ID of the page
                        sortkey       - Adds the sortkey used for sorting in the category (hexadecimal string)
                        sortkeyprefix - Adds the sortkey prefix used for sorting in the category (human-readable part of the sortkey)
                        type          - Adds the type that the page has been categorised as (page, subcat or file)
                        timestamp     - Adds the timestamp of when the page was included
                       Values (separate with '|'): ids, title, sortkey, sortkeyprefix, type, timestamp
                       Default: ids|title
 cmnamespace         - Only include pages in these namespaces
                       NOTE: Due to $wgMiserMode, using this may result in fewer than "cmlimit" results
                       returned before continuing; in extreme cases, zero results may be returned.
                       Note that you can use cmtype=subcat or cmtype=file instead of cmnamespace=14 or 6.
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
 cmtype              - What type of category members to include. Ignored when cmsort=timestamp is set
                       Values (separate with '|'): page, subcat, file
                       Default: page|subcat|file
 cmcontinue          - For large categories, give the value retured from previous query
 cmlimit             - The maximum number of pages to return.
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 cmsort              - Property to sort by
                       One value: sortkey, timestamp
                       Default: sortkey
 cmdir               - In which direction to sort
                       One value: asc, desc
                       Default: asc
 cmstart             - Timestamp to start listing from. Can only be used with cmsort=timestamp
 cmend               - Timestamp to end listing at. Can only be used with cmsort=timestamp
 cmstartsortkey      - Sortkey to start listing from. Must be given in binary format. Can only be used with cmsort=sortkey
 cmendsortkey        - Sortkey to end listing at. Must be given in binary format. Can only be used with cmsort=sortkey
 cmstartsortkeyprefix - Sortkey prefix to start listing from. Can only be used with cmsort=sortkey. Overrides cmstartsortkey
 cmendsortkeyprefix  - Sortkey prefix to end listing BEFORE (not at, if this value occurs it will not be included!). Can only be used with cmsort=sortkey. Overrides cmendsortkey

```

Examples:

```
 Get first 10 pages in:
   api.php?action=query&list=categorymembers&cmtitle=Category:Physics
 Get page info about first 10 pages in:
   api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Categorymembers

```

Generator:

```
 This module may be used as a generator

```

* list=deletedrevs (dr) \*

```
 List deleted revisions.
 Operates in three modes:
  1) List deleted revisions for the given title(s), sorted by timestamp
  2) List deleted contributions for the given user, sorted by timestamp (no titles specified)
  3) List all deleted revisions in the given namespace, sorted by title and timestamp (no titles specified, druser not set)
 Certain parameters only apply to some modes and are ignored in others.
 For instance, a parameter marked (1) only applies to mode 1 and is ignored in modes 2 and 3

```

This module requires read rights
Parameters:

```
 drstart             - The timestamp to start enumerating from (1,2)
 drend               - The timestamp to stop enumerating at (1,2)
 drdir               - In which direction to enumerate (1, 3)
                        newer          - List oldest first. Note: drstart has to be before drend.
                        older          - List newest first (default). Note: drstart has to be later than drend.
                       One value: newer, older
                       Default: older
 drfrom              - Start listing at this title (3)
 drto                - Stop listing at this title (3)
 drprefix            - Search for all page titles that begin with this value (3)
 drcontinue          - When more results are available, use this to continue (3)
 drunique            - List only one revision for each page (3)
 druser              - Only list revisions by this user
 drexcludeuser       - Don't list revisions by this user
 drnamespace         - Only list pages in this namespace (3)
                       One value: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Default: 0
 drlimit             - The maximum amount of revisions to list
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 drprop              - Which properties to get
                        revid          - Adds the revision ID of the deleted revision
                        parentid       - Adds the revision ID of the previous revision to the page
                        user           - Adds the user who made the revision
                        userid         - Adds the user ID whom made the revision
                        comment        - Adds the comment of the revision
                        parsedcomment  - Adds the parsed comment of the revision
                        minor          - Tags if the revision is minor
                        len            - Adds the length (bytes) of the revision
                        sha1           - Adds the SHA-1 (base 16) of the revision
                        content        - Adds the content of the revision
                        token          - Gives the edit token
                       Values (separate with '|'): revid, parentid, user, userid, comment, parsedcomment, minor, len, sha1, content, token
                       Default: user|comment

```

Examples:

```
 List the last deleted revisions of Main Page and Talk:Main Page, with content (mode 1):
   api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content
 List the last 50 deleted contributions by Bob (mode 2):
   api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50
 List the first 50 deleted revisions in the main namespace (mode 3):
   api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50
 List the first 50 deleted pages in the Talk namespace (mode 3)::
   api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique=

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Deletedrevs

```

* list=embeddedin (ei) \*

```
 Find all pages that embed (transclude) the given title

```

This module requires read rights
Parameters:

```
 eititle             - Title to search
                       This parameter is required
 eicontinue          - When more results are available, use this to continue
 einamespace         - The namespace to enumerate
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
 eifilterredir       - How to filter for redirects
                       One value: all, redirects, nonredirects
                       Default: all
 eilimit             - How many total pages to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 eicount             - Return only total number of backlinks

```

Examples:

```
 api.php?action=query&list=embeddedin&eititle=Template:Stub
 api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Embeddedin

```

Generator:

```
 This module may be used as a generator

```

* list=filearchive (fa) \*

```
 Enumerate all deleted files sequentially

```

This module requires read rights
Parameters:

```
 fafrom              - The image title to start enumerating from
 fato                - The image title to stop enumerating at
 faprefix            - Search for all image titles that begin with this value
 falimit             - How many images to return in total
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 fadir               - The direction in which to list
                       One value: ascending, descending
                       Default: ascending
 fasha1              - SHA1 hash of image. Overrides fasha1base36. Disabled in Miser Mode
 fasha1base36        - SHA1 hash of image in base 36 (used in MediaWiki). Disabled in Miser Mode
 faprop              - What image information to get:
                        sha1              - Adds SHA-1 hash for the image
                        timestamp         - Adds timestamp for the uploaded version
                        user              - Adds user who uploaded the image version
                        size              - Adds the size of the image in bytes and the height, width and page count (if applicable)
                        dimensions        - Alias for size
                        description       - Adds description the image version
                        parseddescription - Parse the description on the version
                        mime              - Adds MIME of the image
                        metadata          - Lists EXIF metadata for the version of the image
                        bitdepth          - Adds the bit depth of the version
                       Values (separate with '|'): sha1, timestamp, user, size, dimensions, description, parseddescription, mime, metadata, bitdepth
                       Default: timestamp

```

Example:

```
 Show a list of all deleted files:
   api.php?action=query&list=filearchive

```

* list=imageusage (iu) \*

```
 Find all pages that use the given image title.

```

This module requires read rights
Parameters:

```
 iutitle             - Title to search
                       This parameter is required
 iucontinue          - When more results are available, use this to continue
 iunamespace         - The namespace to enumerate
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
 iufilterredir       - How to filter for redirects. If set to nonredirects when iuredirect is enabled, this is only applied to the second level
                       One value: all, redirects, nonredirects
                       Default: all
 iulimit             - How many total pages to return. If iuredirect is enabled, limit applies to each level separately (which means you may get up to 2 * limit results).
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 iucount             - Return only total number of backlinks
 iuredirect          - If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.

```

Examples:

```
 api.php?action=query&list=imageusage&iutitle=File:Albert%20Einstein%20Head.jpg
 api.php?action=query&generator=imageusage&giutitle=File:Albert%20Einstein%20Head.jpg&prop=info

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Imageusage

```

Generator:

```
 This module may be used as a generator

```

* list=iwbacklinks (iwbl) \*

```
 Find all pages that link to the given interwiki link.
 Can be used to find all links with a prefix, or
 all links to a title (with a given prefix).
 Using neither parameter is effectively "All IW Links"

```

This module requires read rights
Parameters:

```
 iwblprefix          - Prefix for the interwiki
 iwbltitle           - Interwiki link to search for. Must be used with iwblprefix
 iwblcontinue        - When more results are available, use this to continue
 iwbllimit           - How many total pages to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 iwblprop            - Which properties to get
                        iwprefix       - Adds the prefix of the interwiki
                        iwtitle        - Adds the title of the interwiki
                       Values (separate with '|'): iwprefix, iwtitle
                       Default:

```

Examples:

```
 api.php?action=query&list=iwbacklinks&iwbltitle=Test&iwblprefix=wikibooks
 api.php?action=query&generator=iwbacklinks&giwbltitle=Test&iwblprefix=wikibooks&prop=info

```

Generator:

```
 This module may be used as a generator

```

* list=langbacklinks (lbl) \*

```
 Find all pages that link to the given language link.
 Can be used to find all links with a language code, or
 all links to a title (with a given language).
 Using neither parameter is effectively "All Language Links"

```

This module requires read rights
Parameters:

```
 lbllang             - Language for the language link
 lbltitle            - Language link to search for. Must be used with lbllang
 lblcontinue         - When more results are available, use this to continue
 lbllimit            - How many total pages to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 lblprop             - Which properties to get
                        lllang         - Adds the language code of the language link
                        lltitle        - Adds the title of the language ink
                       Values (separate with '|'): lllang, lltitle
                       Default:

```

Examples:

```
 api.php?action=query&list=langbacklinks&lbltitle=Test&lbllang=fr
 api.php?action=query&generator=langbacklinks&glbltitle=Test&lbllang=fr&prop=info

```

Generator:

```
 This module may be used as a generator

```

* list=logevents (le) \*

```
 Get events from logs

```

This module requires read rights
Parameters:

```
 leprop              - Which properties to get
                        ids            - Adds the ID of the log event
                        title          - Adds the title of the page for the log event
                        type           - Adds the type of log event
                        user           - Adds the user responsible for the log event
                        userid         - Adds the user ID who was responsible for the log event
                        timestamp      - Adds the timestamp for the event
                        comment        - Adds the comment of the event
                        parsedcomment  - Adds the parsed comment of the event
                        details        - Lists addtional details about the event
                        tags           - Lists tags for the event
                       Values (separate with '|'): ids, title, type, user, userid, timestamp, comment, parsedcomment, details, tags
 letype              - Filter log entries to only this type
                       Can be empty, or Values (separate with '|'): block, protect, rights, delete, upload, move, import, patrol, merge, suppress, piggyback,
                           useravatar, phalanx, phalanxemail, renameuser, chatban, chatconnect, wikifeatures,
                           templateclassification, newusers
 leaction            - Filter log actions to only this type. Overrides letype
                       One value: block/block, block/unblock, block/reblock, protect/protect, protect/modify, protect/unprotect,
                           protect/move_prot, rights/rights, rights/autopromote, upload/upload, upload/overwrite,
                           upload/revert, import/upload, import/interwiki, merge/merge, suppress/block, suppress/reblock,
                           useravatar/avatar_chn, useravatar/avatar_rem, phalanx/add, phalanx/edit, phalanx/delete,
                           phalanxemail/add, phalanxemail/edit, phalanxemail/delete, chatconnect/chatconnect
 lestart             - The timestamp to start enumerating from
 leend               - The timestamp to end enumerating
 ledir               - In which direction to enumerate
                        newer          - List oldest first. Note: lestart has to be before leend.
                        older          - List newest first (default). Note: lestart has to be later than leend.
                       One value: newer, older
                       Default: older
 leuser              - Filter entries to those made by the given user
 letitle             - Filter entries to those related to a page
 leprefix            - Filter entries that start with this prefix. Disabled in Miser Mode
 letag               - Only list event entries tagged with this tag
 lelimit             - How many total event entries to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10

```

Example:

```
 api.php?action=query&list=logevents

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Logevents

```

* list=recentchanges (rc) \*

```
 Enumerate recent changes

```

This module requires read rights
Parameters:

```
 rcstart             - The timestamp to start enumerating from
 rcend               - The timestamp to end enumerating
 rcdir               - In which direction to enumerate
                        newer          - List oldest first. Note: rcstart has to be before rcend.
                        older          - List newest first (default). Note: rcstart has to be later than rcend.
                       One value: newer, older
                       Default: older
 rcnamespace         - Filter log entries to only this namespace(s)
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
 rcuser              - Filter results per user name
 rcexcludeuser       - Don't list changes by this user
 rctag               - Only list changes tagged with this tag
 rcprop              - Include additional pieces of information
                        user           - Adds the user responsible for the edit and tags if they are an IP
                        userid         - Adds the user id responsible for the edit
                        comment        - Adds the comment for the edit
                        parsedcomment  - Adds the parsed comment for the edit
                        flags          - Adds flags for the edit
                        timestamp      - Adds timestamp of the edit
                        title          - Adds the page title of the edit
                        ids            - Adds the page ID, recent changes ID and the new and old revision ID
                        sizes          - Adds the new and old page length in bytes
                        redirect       - Tags edit if page is a redirect
                        patrolled      - Tags edits that have been patrolled
                        loginfo        - Adds log information (logid, logtype, etc) to log entries
                        tags           - Lists tags for the entry
                       Values (separate with '|'): user, userid, comment, parsedcomment, flags, timestamp, title, ids, sizes, redirect, patrolled,
                           loginfo, wikiamode, tags
                       Default: title|timestamp|ids
 rctoken             - Which tokens to obtain for each change
                       Values (separate with '|'): patrol
 rcshow              - Show only items that meet this criteria.
                       For example, to see only minor edits done by logged-in users, set rcshow=minor|!anon
                       Values (separate with '|'): minor, !minor, bot, !bot, anon, !anon, redirect, !redirect, patrolled, !patrolled
 rclimit             - How many total changes to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 rctype              - Which types of changes to show
                       Values (separate with '|'): edit, new, log
 rctoponly           - Only list changes which are the latest revision

```

Example:

```
 api.php?action=query&list=recentchanges

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Recentchanges

```

Generator:

```
 This module may be used as a generator

```

* list=search (sr) \*

```
 Perform a full text search

```

This module requires read rights
Parameters:

```
 srsearch            - Search for all page titles (or content) that has this value
                       This parameter is required
 srnamespace         - The namespace(s) to enumerate
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
                       Default: 0
 srwhat              - Search inside the text or titles
                       One value: title, text, nearmatch
 srinfo              - What metadata to return
                       Values (separate with '|'): totalhits, suggestion
                       Default: totalhits|suggestion
 srprop              - What properties to return
                        size             - Adds the size of the page in bytes
                        wordcount        - Adds the word count of the page
                        timestamp        - Adds the timestamp of when the page was last edited
                        score            - Adds the score (if any) from the search engine
                        snippet          - Adds a parsed snippet of the page
                        titlesnippet     - Adds a parsed snippet of the page title
                        redirectsnippet  - Adds a parsed snippet of the redirect title
                        redirecttitle    - Adds the title of the matching redirect
                        sectionsnippet   - Adds a parsed snippet of the matching section title
                        sectiontitle     - Adds the title of the matching section
                        hasrelated       - Indicates whether a related search is available
                       Values (separate with '|'): size, wordcount, timestamp, score, snippet, titlesnippet, redirecttitle, redirectsnippet,
                           sectiontitle, sectionsnippet, hasrelated
                       Default: size|wordcount|timestamp|snippet
 srredirects         - Include redirect pages in the search
 sroffset            - Use this value to continue paging (return by query)
                       Default: 0
 srlimit             - How many total pages to return
                       No more than 50 (500 for bots) allowed
                       Default: 10

```

Examples:

```
 api.php?action=query&list=search&srsearch=meaning
 api.php?action=query&list=search&srwhat=text&srsearch=meaning
 api.php?action=query&generator=search&gsrsearch=meaning&prop=info

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Search

```

Generator:

```
 This module may be used as a generator

```

* list=tags (tg) \*

```
 List change tags

```

This module requires read rights
Parameters:

```
 tgcontinue          - When more results are available, use this to continue
 tglimit             - The maximum number of tags to list
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 tgprop              - Which properties to get
                        name         - Adds name of tag
                        displayname  - Adds system messsage for the tag
                        description  - Adds description of the tag
                        hitcount     - Adds the amount of revisions that have this tag
                       Values (separate with '|'): name, displayname, description, hitcount
                       Default: name

```

Example:

```
 api.php?action=query&list=tags&tgprop=displayname|description|hitcount

```

* list=usercontribs (uc) \*

```
 Get all edits by a user

```

This module requires read rights
Parameters:

```
 uclimit             - The maximum number of contributions to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 ucstart             - The start timestamp to return from
 ucend               - The end timestamp to return to
 uccontinue          - When more results are available, use this to continue
 ucuser              - The users to retrieve contributions for
 ucuserprefix        - Retrieve contibutions for all users whose names begin with this value. Overrides ucuser
 ucdir               - In which direction to enumerate
                        newer          - List oldest first. Note: ucstart has to be before ucend.
                        older          - List newest first (default). Note: ucstart has to be later than ucend.
                       One value: newer, older
                       Default: older
 ucnamespace         - Only list contributions in these namespaces
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
 ucprop              - Include additional pieces of information
                        ids            - Adds the page ID and revision ID
                        title          - Adds the title and namespace ID of the page
                        timestamp      - Adds the timestamp of the edit
                        comment        - Adds the comment of the edit
                        parsedcomment  - Adds the parsed comment of the edit
                        size           - Adds the size of the page
                        flags          - Adds flags of the edit
                        patrolled      - Tags patrolled edits
                        tags           - Lists tags for the edit
                       Values (separate with '|'): ids, title, timestamp, comment, parsedcomment, size, flags, patrolled, wikiamode, tags
 ucshow              - Show only items that meet this criteria, e.g. non minor edits only: ucshow=!minor
                       NOTE: if ucshow=patrolled or ucshow=!patrolled is set, revisions older than $wgRCMaxAge (7862400) won't be shown
                       Values (separate with '|'): minor, !minor, patrolled, !patrolled
 uctag               - Only list revisions tagged with this tag
 uctoponly           - Only list changes which are the latest revision

```

Examples:

```
 api.php?action=query&list=usercontribs&ucuser=YurikBot
 api.php?action=query&list=usercontribs&ucuserprefix=217.121.114.

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Usercontribs

```

* list=watchlist (wl) \*

```
 Get all recent changes to pages in the logged in user's watchlist

```

This module requires read rights
Parameters:

```
 wlallrev            - Include multiple revisions of the same page within given timeframe
 wlstart             - The timestamp to start enumerating from
 wlend               - The timestamp to end enumerating
 wlnamespace         - Filter changes to only the given namespace(s)
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
 wluser              - Only list changes by this user
 wlexcludeuser       - Don't list changes by this user
 wldir               - In which direction to enumerate
                        newer          - List oldest first. Note: wlstart has to be before wlend.
                        older          - List newest first (default). Note: wlstart has to be later than wlend.
                       One value: newer, older
                       Default: older
 wllimit             - How many total results to return per request
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 wlprop              - Which additional items to get (non-generator mode only).
                        ids                    - Adds revision ids and page ids
                        title                  - Adds title of the page
                        flags                  - Adds flags for the edit
                        user                   - Adds the user who made the edit
                        userid                 - Adds user id of whom made the edit
                        comment                - Adds comment of the edit
                        parsedcomment          - Adds parsed comment of the edit
                        timestamp              - Adds timestamp of the edit
                        patrol                 - Tags edits that are patrolled
                        sizes                  - Adds the old and new lengths of the page
                        notificationtimestamp  - Adds timestamp of when the user was last notified about the edit
                        loginfo                - Adds log information where appropriate
                       Values (separate with '|'): ids, title, flags, user, userid, comment, parsedcomment, timestamp, patrol, sizes, wikiamode,
                           notificationtimestamp, loginfo
                       Default: ids|title|flags
 wlshow              - Show only items that meet this criteria.
                       For example, to see only minor edits done by logged-in users, set wlshow=minor|!anon
                       Values (separate with '|'): minor, !minor, bot, !bot, anon, !anon, patrolled, !patrolled
 wlowner             - The name of the user whose watchlist you'd like to access
 wltoken             - Give a security token (settable in preferences) to allow access to another user's watchlist

```

Examples:

```
 api.php?action=query&list=watchlist
 api.php?action=query&generator=watchlist&prop=info
 api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user
 api.php?action=query&list=watchlist&wlowner=Bob_Smith&wltoken=d8d562e9725ea1512894cdab28e5ceebc7f20237

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Watchlist

```

Generator:

```
 This module may be used as a generator

```

* list=watchlistraw (wr) \*

```
 Get all pages on the logged in user's watchlist

```

This module requires read rights
Parameters:

```
 wrcontinue          - When more results are available, use this to continue
 wrnamespace         - Only list pages in the given namespace(s)
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
 wrlimit             - How many total results to return per request
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 wrprop              - Which additional properties to get (non-generator mode only)
                        changed  - Adds timestamp of when the user was last notified about the edit
                       Values (separate with '|'): changed
 wrshow              - Only list items that meet these criteria
                       Values (separate with '|'): changed, !changed
 wrowner             - The name of the user whose watchlist you'd like to access
 wrtoken             - Give a security token (settable in preferences) to allow access to another user's watchlist

```

Examples:

```
 api.php?action=query&list=watchlistraw
 api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=revisions

```

Generator:

```
 This module may be used as a generator

```

* list=exturlusage (eu) \*

```
 Enumerate pages that contain a given URL

```

This module requires read rights
Parameters:

```
 euprop              - What pieces of information to include
                        ids    - Adds the ID of page
                        title  - Adds the title and namespace ID of the page
                        url    - Adds the URL used in the page
                       Values (separate with '|'): ids, title, url
                       Default: ids|title|url
 euoffset            - Used for paging. Use the value returned for "continue"
 euprotocol          - Protocol of the url. If empty and euquery set, the protocol is http.
                       Leave both this and euquery empty to list all external links
                       Can be empty, or One value: http, https, ftp, irc, ircs, gopher, telnet, nntp, worldwind, mailto, news, svn, git, mms, xmpp
                       Default:
 euquery             - Search string without protocol. See Special:LinkSearch. Leave empty to list all external links
 eunamespace         - The page namespace(s) to enumerate.
                       NOTE: Due to $wgMiserMode, using this may result in fewer than "eulimit" results
                       returned before continuing; in extreme cases, zero results may be returned
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
 eulimit             - How many pages to return.
                       No more than 500 (5000 for bots) allowed
                       Default: 10

```

Example:

```
 api.php?action=query&list=exturlusage&euquery=www.mediawiki.org

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Exturlusage

```

Generator:

```
 This module may be used as a generator

```

* list=users (us) \*

```
 Get information about a list of users

```

This module requires read rights
Parameters:

```
 usprop              - What pieces of information to include
                         blockinfo      - Tags if the user is blocked, by whom, and for what reason
                         groups         - Lists all the groups the user(s) belongs to
                         implicitgroups - Lists all the groups a user is automatically a member of
                         rights         - Lists all the rights the user(s) has
                         editcount      - Adds the user's edit count
                         registration   - Adds the user's registration timestamp
                         emailable      - Tags if the user can and wants to receive e-mail through Special:Emailuser
                         gender         - Tags the gender of the user. Returns "male", "female", or "unknown"
                       Values (separate with '|'): blockinfo, localblockinfo, groups, implicitgroups, rights, editcount, registration, emailable,
                           gender
 ususers             - A list of user names to obtain the same information for
 usids               - A list of user IDs to obtain the same information for
 ustoken             - Which tokens to obtain for each user
                       Values (separate with '|'): userrights

```

Examples:

```
 api.php?action=query&list=users&ususers=brion|TimStarling&usprop=groups|editcount|gender
 api.php?action=query&list=users&usids=1|2&usprop=groups|editcount|gender

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Users

```

* list=random (rn) \*

```
 Get a set of random pages
 NOTE: Pages are listed in a fixed sequence, only the starting point is random. This means that if, for example, "Main Page" is the first
       random page on your list, "List of fictional monkeys" will *always* be second, "List of people on stamps of Vanuatu" third, etc
 NOTE: If the number of pages in the namespace is lower than rnlimit, you will get fewer pages. You will not get the same page twice

```

This module requires read rights
Parameters:

```
 rnnamespace         - Return pages in these namespaces only
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
 rnlimit             - Limit how many random pages will be returned
                       No more than 10 (20 for bots) allowed
                       Default: 1
 rnredirect          - Load a random redirect instead of a random page

```

Example:

```
 api.php?action=query&list=random&rnnamespace=0&rnlimit=2

```

Generator:

```
 This module may be used as a generator

```

* list=protectedtitles (pt) \*

```
 List all titles protected from creation

```

This module requires read rights
Parameters:

```
 ptnamespace         - Only list titles in these namespaces
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
 ptlevel             - Only list titles with these protection levels
                       Values (separate with '|'): autoconfirmed, sysop
 ptlimit             - How many total pages to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 ptdir               - In which direction to enumerate
                        newer          - List oldest first. Note: ptstart has to be before ptend.
                        older          - List newest first (default). Note: ptstart has to be later than ptend.
                       One value: newer, older
                       Default: older
 ptstart             - Start listing at this protection timestamp
 ptend               - Stop listing at this protection timestamp
 ptprop              - Which properties to get
                        timestamp      - Adds the timestamp of when protection was added
                        user           - Adds the user that added the protection
                        userid         - Adds the user id that added the protection
                        comment        - Adds the comment for the protection
                        parsedcomment  - Adds the parsed comment for the protection
                        expiry         - Adds the timestamp of when the protection will be lifted
                        level          - Adds the protection level
                       Values (separate with '|'): timestamp, user, userid, comment, parsedcomment, expiry, level
                       Default: timestamp|level

```

Example:

```
 api.php?action=query&list=protectedtitles

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Protectedtitles

```

Generator:

```
 This module may be used as a generator

```

* list=querypage (qp) \*

```
 Get a list provided by a QueryPage-based special page

```

This module requires read rights
Parameters:

```
 qppage              - The name of the special page. Note, this is case sensitive
                       This parameter is required
                       One value: Ancientpages, BrokenRedirects, Deadendpages, Disambiguations, DoubleRedirects, Listredirects,
                           Lonelypages, Longpages, Mostcategories, Mostimages, Mostlinkedcategories, Mostlinkedtemplates,
                           Mostlinked, Mostrevisions, Fewestrevisions, Shortpages, Uncategorizedcategories, Uncategorizedpages,
                           Uncategorizedimages, Uncategorizedtemplates, Unusedcategories, Unusedimages, Wantedcategories,
                           Wantedfiles, Wantedpages, Wantedtemplates, Unwatchedpages, Unusedtemplates, Withoutinterwiki,
                           Mostpopularcategories, MostLinkedFilesInContent, UnusedVideos, Withoutimages, Nonportableinfoboxes,
                           Popularpages, Pageswithoutinfobox, Templateswithouttype, AllInfoboxes
 qpoffset            - When more results are available, use this to continue
                       Default: 0
 qplimit             - Number of results to return
                       No more than 500 (5000 for bots) allowed
                       Default: 10

```

Example:

```
 api.php?action=query&list=querypage&qppage=Ancientpages

```

Generator:

```
 This module may be used as a generator

```

* list=wkdomains (wk) \*

```
 Get domains handled by Wikia

```

This module requires read rights
Parameters:

```
 wkwikia             - Identifier in Wiki Factory
 wkactive            - Get only active domains [optional]
                       The value must be between 0 and 1
 wkfrom              - Begin of range - identifier in Wiki Factory
                       The value must be no less than 1
                       Default: 1
 wkto                - end of range - identifier in Wiki Factory
                       The value must be no less than 1
 wkcountonly         - return only number of Wikis
                       The value must be no less than 1
 wklang              - Wiki language
 wklimit             - How many results to return - default 10, max 100 for standard user, 1000 for bots
                       No more than 100 (1000 for bots) allowed
                       Default: 10

```

Examples:

```
 api.php?action=query&list=wkdomains
 api.php?action=query&list=wkdomains&wkactive=1
 api.php?action=query&list=wkdomains&wkwikia=177
 api.php?action=query&list=wkdomains&wkfrom=100&wkto=150
 api.php?action=query&list=wkdomains&wkfrom=10000&wkto=15000&wklang=de
 api.php?action=query&list=wkdomains&wkcountonly=1
 api.php?action=query&list=wkdomains&wkactive=1&wkcountonly=1
 api.php?action=query&list=wkdomains&wkactive=1&wklimit=25

```

* list=wkpoppages (wk) \*

```
 Get Wikia most "Popular pages"

```

This module requires read rights
Parameters:

```
 wkdbname            - Name of database
                       Maximum number of values 50 (500 for bots)
                       Default:
 wklimit             - This parameter allow to get correct package with items and means "limit" in SQL statement.
                       No more than 50 (500 for bots) allowed
                       Maximum number of values 50 (500 for bots)
                       Default: 25
 wkoffset            - Number of elements in items' package. This parameter means "limit limit, offset" in SQL statement.
                       The value must be no less than 0
                       Maximum number of values 50 (500 for bots)
                       Default: 0
 wkctime             - Cache entry lifetime timeout (in seconds)
                       The value must be no less than 5
                       Maximum number of values 50 (500 for bots)
                       Default: 900
 wkpage              - Identifier of page

```

Examples:

```
 api.php?action=query&list=wkpoppages
 api.php?action=query&list=wkpoppages&wkpage=11&wkctime=60

```

* list=wkvoteart (wk) \*

```
 Get most rating articles

```

This module requires read rights
Parameters:

```
 wkdbname            - Name of database
                       Maximum number of values 50 (500 for bots)
                       Default:
 wklimit             - This parameter allow to get correct package with items and means "limit" in SQL statement.
                       No more than 50 (500 for bots) allowed
                       Maximum number of values 50 (500 for bots)
                       Default: 25
 wkoffset            - Number of elements in items' package. This parameter means "limit limit, offset" in SQL statement.
                       The value must be no less than 0
                       Maximum number of values 50 (500 for bots)
                       Default: 0
 wkctime             - Cache entry lifetime timeout (in seconds)
                       The value must be no less than 5
                       Maximum number of values 50 (500 for bots)
                       Default: 900
 wkpage              - Identifier of page
 wktopvoted          - It can be one of values: '1' - if user want to take the more rated article or '0' otherwise
                       Default: 0
 wkuservote          - It can be one of values: '1' - if user want to take vote of article for selected user or '0' otherwise. User have to be logged to use this option.
 wktimestamps        - It can be one of values: '1' - returns a list of vote timestamps for the selected article or '0' otherwise, page parameter must be supplied.
 wk0                 -
                       Default: integer

```

Examples:

```
 api.php?action=query&list=wkvoteart
 api.php?action=query&list=wkvoteart&wktopvoted=1&wklimit=25&wkctime=1800
 api.php?action=query&list=wkvoteart&wkpage=1778&wkuservote=2
 api.php?action=query&list=wkvoteart&wktopvoted=1&wklimit=10
 api.php?action=query&list=wkvoteart&wktopvoted=1&wklimit=10

```

* list=wkaccessart (wk) \*

```
 Get most changes pages

```

This module requires read rights
Parameters:

```
 wkdbname            - Name of database
                       Maximum number of values 50 (500 for bots)
                       Default:
 wklimit             - This parameter allow to get correct package with items and means "limit" in SQL statement.
                       No more than 50 (500 for bots) allowed
                       Maximum number of values 50 (500 for bots)
                       Default: 25
 wkoffset            - Number of elements in items' package. This parameter means "limit limit, offset" in SQL statement.
                       The value must be no less than 0
                       Maximum number of values 50 (500 for bots)
                       Default: 0
 wkctime             - Cache entry lifetime timeout (in seconds)
                       The value must be no less than 5
                       Maximum number of values 50 (500 for bots)
                       Default: 900
 wkpage              - Identifier of page
 wknspace            - List of identifiers of namespace. Every element of this list is separated by "," (urlencode(n1,n2,n3,n4...))
 wkuser              - Identifier of user
 wkdate              -

```

Examples:

```
 api.php?action=query&list=wkaccessart&wknspace=0
 api.php?action=query&list=wkaccessart&wkdate=2007-03-21
 api.php?action=query&list=wkaccessart&wknspace=0%2C2%2C4&wkdate=2007-03-21
 api.php?action=query&list=wkaccessart&wknspace=1%2C3%2C5&wkdate=2007-03-21

```

* list=wkeditpage (wk) \*

```
 Get last edited pages

```

This module requires read rights
Parameters:

```
 wkdbname            - Name of database
                       Maximum number of values 50 (500 for bots)
                       Default:
 wklimit             - This parameter allow to get correct package with items and means "limit" in SQL statement.
                       No more than 50 (500 for bots) allowed
                       Maximum number of values 50 (500 for bots)
                       Default: 25
 wkoffset            - Number of elements in items' package. This parameter means "limit limit, offset" in SQL statement.
                       The value must be no less than 0
                       Maximum number of values 50 (500 for bots)
                       Default: 0
 wkctime             - Cache entry lifetime timeout (in seconds)
                       The value must be no less than 5
                       Maximum number of values 50 (500 for bots)
                       Default: 900
 wkpage              - Identifier of page
 wknspace            - List of identifiers of namespace. Every element of this list is separated by "," (urlencode(n1,n2,n3,n4...))

```

Examples:

```
 api.php?action=query&list=wkeditpage
 api.php?action=query&list=wkeditpage&wknspace=0
 api.php?action=query&list=wkeditpage&wknspace=0%2C2%2C4

```

* list=wkedituser (wk) \*

```
 Get list of users with most edited pages

```

This module requires read rights
Parameters:

```
 wkdbname            - Name of database
                       Maximum number of values 50 (500 for bots)
                       Default:
 wklimit             - This parameter allow to get correct package with items and means "limit" in SQL statement.
                       No more than 50 (500 for bots) allowed
                       Maximum number of values 50 (500 for bots)
                       Default: 25
 wkoffset            - Number of elements in items' package. This parameter means "limit limit, offset" in SQL statement.
                       The value must be no less than 0
                       Maximum number of values 50 (500 for bots)
                       Default: 0
 wkctime             - Cache entry lifetime timeout (in seconds)
                       The value must be no less than 5
                       Maximum number of values 50 (500 for bots)
                       Default: 900
 wkuser              - Identifier of user

```

Examples:

```
 api.php?action=query&list=wkedituser
 api.php?action=query&list=wkedituser&wklimit=10

```

* list=wkmostvisit (wk) \*

```
 Get most visited pages

```

This module requires read rights
Parameters:

```
 wkdbname            - Name of database
                       Maximum number of values 50 (500 for bots)
                       Default:
 wklimit             - This parameter allow to get correct package with items and means "limit" in SQL statement.
                       No more than 50 (500 for bots) allowed
                       Maximum number of values 50 (500 for bots)
                       Default: 25
 wkoffset            - Number of elements in items' package. This parameter means "limit limit, offset" in SQL statement.
                       The value must be no less than 0
                       Maximum number of values 50 (500 for bots)
                       Default: 0
 wkctime             - Cache entry lifetime timeout (in seconds)
                       The value must be no less than 5
                       Maximum number of values 50 (500 for bots)
                       Default: 900
 wkpagename          - Name of page with "most visited articles"

```

Examples:

```
 api.php?action=query&list=wkmostvisit&wkpagename=Most_popular_articles
 api.php?action=query&list=wkmostvisit&wkpagename=Most_popular_articles&wklimit=10

```

* list=checkuser (cu) \*

```
 Allows check which IPs are used by a given username and which usernames are used by a given IP

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 curequest           - Type of CheckUser request
                        userips - get IP of target user
                        edits   - get changes from target IP or range
                        ipusers - get users from target IP or range
                       This parameter is required
                       One value: userips, edits, ipusers
 cutarget            - Username or IP-address/range to perform check
                       This parameter is required
 cureason            - Reason to check
 culimit             - Limit of rows
                       No more than 500 (5000 for bots) allowed
                       Default: 1000
 cutimecond          - Time limit of user data (like "2 weeks")
                       Default: -2 weeks
 cuxff               - Use xff data instead of IP

```

Examples:

```
 api.php?action=query&list=checkuser&curequest=userips&cutarget=Jimbo_Wales
 api.php?action=query&list=checkuser&curequest=edits&cutarget=127.0.0.1/16&xff=1&cureason=Some_check

```

Help page:

```
 http://www.mediawiki.org/wiki/Extension:CheckUser#API

```

* list=checkuserlog (cul) \*

```
 Allows get entries of CheckUser log

```

This module requires read rights
Parameters:

```
 culuser             - Username of CheckUser
 cultarget           - Checked user or IP-address/range
 cullimit            - Limit of rows
                       No more than 500 (5000 for bots) allowed
                       Default: 10
 culfrom             - The timestamp to start enumerating from
 culto               - The timestamp to end enumerating

```

Examples:

```
 api.php?action=query&list=checkuserlog&culuser=WikiSysop&limit=25
 api.php?action=query&list=checkuserlog&cultarget=127.0.0.1&culfrom=20111015230000

```

Help page:

```
 http://www.mediawiki.org/wiki/Extension:CheckUser#API

```

* list=unconvertedinfoboxes \*
* list=allinfoboxes \*
* list=firstcontributions (fc) \*

```
 Returns user name and first edit rev id and timestamp for new editors who first edited in the last 91 days

```

This module requires read rights
Parameters:

```
 fcafter             - Only get users who joined after this date.
 fcbefore            - Only get users who joined before this date. Can't be more than 91 days before the present date.
 fcdir               - In which direction to enumerate
                        newer          - List oldest first. Note: fcstart has to be before fcend.
                        older          - List newest first (default). Note: fcstart has to be later than fcend.
                       One value: newer, older
                       Default: older
 fclimit             - The maximum amount of entries to list
                       No more than 500 (5000 for bots) allowed
                       Default: 10

```

Examples:

```
 api.php?action=query&list=neweditors
 api.php?action=query&list=neweditors&fcdir=newer

```

--- --- --- --- --- --- --- --- --- --- --- --- Query: Meta --- --- --- --- --- --- --- --- --- --- --- ---

* meta=siteinfo (si) \*

```
 Return general information about the site.

```

This module requires read rights
Parameters:

```
 siprop              - Which sysinfo properties to get:
                        general               - Overall system information
                        namespaces            - List of registered namespaces and their canonical names
                        namespacealiases      - List of registered namespace aliases
                        specialpagealiases    - List of special page aliases
                        magicwords            - List of magic words and their aliases
                        statistics            - Returns site statistics
                        interwikimap          - Returns interwiki map (optionally filtered, (optionally localised by using siinlanguagecode))
                        dbrepllag             - Returns database server with the highest replication lag
                        usergroups            - Returns user groups and the associated permissions
                        extensions            - Returns extensions installed on the wiki
                        fileextensions        - Returns list of file extensions allowed to be uploaded
                        rightsinfo            - Returns wiki rights (license) information if available
                        languages             - Returns a list of languages MediaWiki supports (optionally localised by using siinlanguagecode)
                        skins                 - Returns a list of all enabled skins
                        extensiontags         - Returns a list of parser extension tags
                        functionhooks         - Returns a list of parser function hooks
                        showhooks             - Returns a list of all subscribed hooks (contents of $wgHooks)
                        protocols             - Returns a list of protocols that are allowed in external links.
                        "category"     - Returns name of category of selected Wikia
                        "variables"    - Returns values of main global variables
                        "wikidesc"     - Returns wiki description (such as Mediawiki:pagetitle)
                       Values (separate with '|'): general, namespaces, namespacealiases, specialpagealiases, magicwords, interwikimap, dbrepllag,
                           statistics, usergroups, extensions, fileextensions, rightsinfo, languages, skins, extensiontags,
                           functionhooks, showhooks, protocols, category, variables, wikidesc
                       Default: general
 sifilteriw          - Return only local or only nonlocal entries of the interwiki map
                       One value: local, !local
 sishowalldb         - List all database servers, not just the one lagging the most
 sinumberingroup     - Lists the number of users in user groups
 siinlanguagecode    - Language code for localised language names (best effort, use CLDR extension)

```

Examples:

```
 api.php?action=query&meta=siteinfo&siprop=general|namespaces|namespacealiases|statistics
 api.php?action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local
 api.php?action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb=

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Meta#siteinfo\_.2F\_si

```

* meta=userinfo (ui) \*

```
 Get information about the current user

```

This module requires read rights
Parameters:

```
 uiprop              - What pieces of information to include
                         blockinfo        - Tags if the current user is blocked, by whom, and for what reason
                         hasmsg           - Adds a tag "message" if the current user has pending messages
                         groups           - Lists all the groups the current user belongs to
                         implicitgroups   - Lists all the groups the current user is automatically a member of
                         rights           - Lists all the rights the current user has
                         changeablegroups - Lists the groups the current user can add to and remove from
                         options          - Lists all preferences the current user has set
                         preferencestoken - Get a token to change current user's preferences
                         editcount        - Adds the current user's edit count
                         ratelimits       - Lists all rate limits applying to the current user
                         realname         - Adds the user's real name
                         email            - Adds the user's email address and email authentication date
                         acceptlang       - Echoes the Accept-Language header sent by the client in a structured format
                         registrationdate - Adds the user's registration date
                       Values (separate with '|'): blockinfo, hasmsg, groups, implicitgroups, rights, changeablegroups, options, preferencestoken,
                           editcount, ratelimits, email, realname, acceptlang, registrationdate

```

Examples:

```
 api.php?action=query&meta=userinfo
 api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Meta#userinfo\_.2F\_ui

```

* meta=allmessages (am) \*

```
 Return messages from this site

```

This module requires read rights
Parameters:

```
 ammessages          - Which messages to output. "*" (default) means all messages
                       Default: *
 amprop              - Which properties to get
                       Values (separate with '|'): default
 amenableparser      - Set to enable parser, will preprocess the wikitext of message
                       Will substitute magic words, handle templates etc.
 amnocontent         - If set, do not include the content of the messages in the output.
 amincludelocal      - Also include local messages, i.e. messages that don't exist in the software but do exist as a MediaWiki: page.
                       This lists all MediaWiki: pages, so it will also list those that aren't 'really' messages such as Common.js
 amargs              - Arguments to be substituted into message
 amfilter            - Return only messages with names that contain this string
 amcustomised        - Return only messages in this customisation state
                       One value: all, modified, unmodified
                       Default: all
 amlang              - Return messages in this language
 amfrom              - Return messages starting at this message
 amto                - Return messages ending at this message
 amtitle             - Page name to use as context when parsing message (for enableparser option)
 amprefix            - Return messages with this prefix

```

Examples:

```
 api.php?action=query&meta=allmessages&amprefix=ipb-
 api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Meta#allmessages\_.2F\_am

```

* + - \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* Modules: continuation \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\*

* action=expandtemplates \*

```
 Expands all templates in wikitext

```

This module requires read rights
Parameters:

```
 title               - Title of page
                       Default: API
 text                - Wikitext to convert
                       This parameter is required
 generatexml         - Generate XML parse tree
 includecomments     - Whether to include HTML comments in the output

```

Example:

```
 api.php?action=expandtemplates&text=Tom the Cat Wiki:Sandbox

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Parsing\_wikitext#expandtemplates

```

* action=parse \*

```
 Parses wikitext and returns parser output

```

This module requires read rights
Parameters:

```
 title               - Title of page the text belongs to
                       Default: API
 text                - Wikitext to parse
 summary             - Summary to parse
 page                - Parse the content of this page. Cannot be used together with text and title
 pageid              - Parse the content of this page. Overrides page
 redirects           - If the page or the pageid parameter is set to a redirect, resolve it
 oldid               - Parse the content of this revision. Overrides page and pageid
 prop                - Which pieces of information to get
                        text           - Gives the parsed text of the wikitext
                        langlinks      - Gives the language links in the parsed wikitext
                        categories     - Gives the categories in the parsed wikitext
                        categorieshtml - Gives the HTML version of the categories
                        languageshtml  - Gives the HTML version of the language links
                        links          - Gives the internal links in the parsed wikitext
                        templates      - Gives the templates in the parsed wikitext
                        images         - Gives the images in the parsed wikitext
                        externallinks  - Gives the external links in the parsed wikitext
                        sections       - Gives the sections in the parsed wikitext
                        revid          - Adds the revision ID of the parsed page
                        displaytitle   - Adds the title of the parsed wikitext
                        headitems      - Gives items to put in the <head> of the page
                        headhtml       - Gives parsed <head> of the page
                        iwlinks        - Gives interwiki links in the parsed wikitext
                        wikitext       - Gives the original wikitext that was parsed
                       Values (separate with '|'): text, langlinks, languageshtml, categories, categorieshtml, links, templates, images, externallinks,
                           sections, revid, displaytitle, headitems, headhtml, iwlinks, wikitext
 pst                 - Do a pre-save transform on the input before parsing it
                       Ignored if page, pageid or oldid is used
 onlypst             - Do a pre-save transform (PST) on the input, but don't parse it
                       Returns the same wikitext, after a PST has been applied. Ignored if page, pageid or oldid is used
 uselang             - Which language to parse the request in
 section             - Only retrieve the content of this section number
 disablepp           - Disable the PP Report from the parser output

```

Example:

```
 api.php?action=parse&text=Tom the Cat Wiki:Sandbox

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Parsing\_wikitext#parse

```

* action=opensearch \*

```
 Search the wiki using the OpenSearch protocol

```

This module requires read rights
Parameters:

```
 search              - Search string
 limit               - Maximum amount of results to return
                       No more than 100 (100 for bots) allowed
                       Default: 10
 namespace           - Namespaces to search
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
                       Default: 0
 suggest             - Do nothing if $wgEnableOpenSearchSuggest is false

```

Example:

```
 api.php?action=opensearch&search=Te

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Opensearch

```

* action=feedcontributions \*

```
 Returns a user contributions feed

```

This module requires read rights
Parameters:

```
 feedformat          - The format of the feed
                       One value: rss, atom
                       Default: rss
 user                - What users to get the contributions for
                       This parameter is required
 namespace           - What namespace to filter the contributions by
                       Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829
                       Maximum number of values 50 (500 for bots)
 year                - From year (and earlier)
 month               - From month (and earlier)
 tagfilter           - Filter contributions that have these tags
                       Values (separate with '|'): tor, visualeditor, visualeditor-needcheck, visualeditor-switched
                       Default:
 deletedonly         - Show only deleted contributions
 toponly             - Only show edits that are latest revisions
 showsizediff        - Show the size difference between revisions. Disabled in Miser Mode

```

Example:

```
 api.php?action=feedcontributions&user=Reedy

```

* action=feedwatchlist \*

```
 Returns a watchlist feed

```

This module requires read rights
Parameters:

```
 feedformat          - The format of the feed
                       One value: rss, atom
                       Default: rss
 hours               - List pages modified within this many hours from now
                       The value must be between 1 and 72
                       Default: 24
 allrev              - Include multiple revisions of the same page within given timeframe
 wlowner             - The user whose watchlist you want (must be accompanied by wltoken if it's not you)
 wltoken             - Security token that requested user set in their preferences
 wlexcludeuser       - A user whose edits should not be shown in the watchlist
 linktodiffs         - Link to change differences instead of article pages

```

Examples:

```
 api.php?action=feedwatchlist
 api.php?action=feedwatchlist&allrev=&linktodiffs=&hours=6

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Watchlist\_feed

```

* action=help \*

```
 Display this help screen. Or the help screen for the specified module

```

Parameters:

```
 modules             - List of module names (value of the action= parameter)
 querymodules        - List of query module names (value of prop=, meta= or list= parameter)

```

Examples:

```
 Whole help page:
   api.php?action=help
 Module (action) help page:
   api.php?action=help&modules=protect
 Query (list) modules help page:
   api.php?action=help&querymodules=categorymembers
 Query (prop) modules help page:
   api.php?action=help&querymodules=info
 Query (meta) modules help page:
   api.php?action=help&querymodules=siteinfo

```

Help pages:

```
 https://www.mediawiki.org/wiki/API:Main\_page
 https://www.mediawiki.org/wiki/API:FAQ
 https://www.mediawiki.org/wiki/API:Quick\_start\_guide

```

* action=paraminfo \*

```
 Obtain information about certain API parameters and errors

```

Parameters:

```
 modules             - List of module names (value of the action= parameter)
                       Values (separate with '|'): addmediapermanent, addmediatemporary, apimediasearch, awcreminder, block, blogs, compare, delete,
                           edit, emailuser, expandtemplates, feedcontributions, feedwatchlist, fetchblob, filerevert, geocode,
                           help, imagecrop, imageserving, import, infobox, insert, licenses, login, logout, move, opensearch,
                           options, paraminfo, parse, patrol, protect, purge, query, rollback, rsd, runjob, scribunto-console,
                           tagsreport, templateparameters, templatesearch, templatesuggestions, titleblacklist, unblock,
                           undelete, update, upload, userrights, videopreview, visualeditor, visualeditoredit, watch, wdelete
 querymodules        - List of query module names (value of prop=, meta= or list= parameter)
                       Values (separate with '|'): allcategories, allimages, allinfoboxes, alllinks, allmessages, allpages, allusers, backlinks,
                           blocks, categories, categoryinfo, categorymembers, checkuser, checkuserlog, deletedrevs,
                           duplicatefiles, embeddedin, extlinks, exturlusage, filearchive, firstcontributions, globalusage,
                           imageinfo, images, imageusage, info, infobox, iwbacklinks, iwlinks, langbacklinks, langlinks, links,
                           logevents, pageprops, protectedtitles, querypage, random, recentchanges, revisions, search,
                           siteinfo, stashimageinfo, tags, templates, unconvertedinfoboxes, usercontribs, userinfo, users,
                           watchlist, watchlistraw, wkaccessart, wkdomains, wkeditpage, wkedituser, wklasteditors, wkmostvisit,
                           wkpoppages, wkvoteart
 mainmodule          - Get information about the main (top-level) module as well
 pagesetmodule       - Get information about the pageset module (providing titles= and friends) as well
 formatmodules       - List of format module names (value of format= parameter)
                       Values (separate with '|'): dbg, dbgfm, dump, dumpfm, json, jsonfm, php, phpfm, push, rawfm, txt, txtfm, wddx, wddxfm, xml,
                           xmlfm, yaml, yamlfm

```

Example:

```
 api.php?action=paraminfo&modules=parse&querymodules=allpages|siteinfo

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Parameter\_information

```

* action=rsd \*

```
 Export an RSD (Really Simple Discovery) schema

```

This module requires read rights
Example:

```
 api.php?action=rsd

```

* action=compare \*

```
 Get the difference between 2 pages
 You must pass a revision number or a page title for each part (1 and 2)

```

This module requires read rights
Parameters:

```
 fromtitle           - First title to compare
 fromrev             - First revision to compare
 totitle             - Second title to compare
 torev               - Second revision to compare

```

Example:

```
 Create a diff between revision 1 and 2:
   api.php?action=compare&fromrev=1&torev=2

```

* action=purge \*

```
 Purge the cache for the given titles.
 Requires a POST request if the user is not logged in.

```

This module requires read rights
This module requires write rights
Parameters:

```
 titles              - A list of titles to work on
 pageids             - A list of page IDs to work on
                       Maximum number of values 50 (500 for bots)
 revids              - A list of revision IDs to work on
                       Maximum number of values 50 (500 for bots)
 forcelinkupdate     - Update the links tables

```

Example:

```
 Purge the "Main Page" and the "API" page:
   api.php?action=purge&titles=Main_Page|API

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Purge

```

* action=rollback \*

```
 Undo the last edit to the page. If the last user who edited the page made multiple edits in a row,
 they will all be rolled back

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 title               - Title of the page you want to rollback.
                       This parameter is required
 user                - Name of the user whose edits are to be rolled back. If set incorrectly, you'll get a badtoken error.
                       This parameter is required
 token               - A rollback token previously retrieved through prop=revisions
 summary             - Custom edit summary. If not set, default summary will be used
 markbot             - Mark the reverted edits and the revert as bot edits
 watchlist           - Unconditionally add or remove the page from your watchlist, use preferences or do not change watch
                       One value: watch, unwatch, preferences, nochange
                       Default: preferences

```

Examples:

```
 api.php?action=rollback&title=Main%20Page&user=Catrope&token=123ABC
 api.php?action=rollback&title=Main%20Page&user=217.121.114.116&token=123ABC&summary=Reverting%20vandalism&markbot=1

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Rollback

```

* action=undelete \*

```
 Restore certain revisions of a deleted page. A list of deleted revisions (including timestamps) can be
 retrieved through list=deletedrevs

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 title               - Title of the page you want to restore
                       This parameter is required
 token               - An undelete token previously retrieved through list=deletedrevs
 reason              - Reason for restoring (optional)
                       Default:
 timestamps          - Timestamps of the revisions to restore. If not set, all revisions will be restored.
                       Maximum number of values 50 (500 for bots)
 watchlist           - Unconditionally add or remove the page from your watchlist, use preferences or do not change watch
                       One value: watch, unwatch, preferences, nochange
                       Default: preferences

```

Examples:

```
 api.php?action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page
 api.php?action=undelete&title=Main%20Page&token=123ABC&timestamps=20070703220045|20070702194856

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Undelete

```

* action=protect \*

```
 Change the protection level of a page

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 title               - Title of the page you want to (un)protect
                       This parameter is required
 token               - A protect token previously retrieved through prop=info
 protections         - Pipe-separated list of protection levels, formatted action=group (e.g. edit=sysop)
                       This parameter is required
 expiry              - Expiry timestamps. If only one timestamp is set, it'll be used for all protections.
                       Use 'infinite', 'indefinite' or 'never', for a neverexpiring protection.
                       Default: infinite
 reason              - Reason for (un)protecting (optional)
                       Default:
 cascade             - Enable cascading protection (i.e. protect pages included in this page)
                       Ignored if not all protection levels are 'sysop' or 'protect'
 watch               - DEPRECATED! If set, add the page being (un)protected to your watchlist
 watchlist           - Unconditionally add or remove the page from your watchlist, use preferences or do not change watch
                       One value: watch, unwatch, preferences, nochange
                       Default: preferences

```

Examples:

```
 api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never
 api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=all|move=all&reason=Lifting%20restrictions

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Protect

```

* action=block \*

```
 Block a user

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 user                - Username, IP address or IP range you want to block
                       This parameter is required
 token               - A block token previously obtained through the gettoken parameter or prop=info
 gettoken            - If set, a block token will be returned, and no other action will be taken
 expiry              - Relative expiry time, e.g. '5 months' or '2 weeks'. If set to 'infinite', 'indefinite' or 'never', the block will never expire.
                       Default: never
 reason              - Reason for block (optional)
 anononly            - Block anonymous users only (i.e. disable anonymous edits for this IP)
 nocreate            - Prevent account creation
 autoblock           - Automatically block the last used IP address, and any subsequent IP addresses they try to login from
 noemail             - Prevent user from sending e-mail through the wiki. (Requires the "blockemail" right.)
 hidename            - Hide the username from the block log. (Requires the "hideuser" right.)
 allowusertalk       - Allow the user to edit their own talk page (depends on $wgBlockAllowsUTEdit)
 reblock             - If the user is already blocked, overwrite the existing block
 watchuser           - Watch the user/IP's user and talk pages

```

Examples:

```
 api.php?action=block&user=123.5.5.12&expiry=3%20days&reason=First%20strike
 api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Block

```

* action=unblock \*

```
 Unblock a user

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 id                  - ID of the block you want to unblock (obtained through list=blocks). Cannot be used together with user
 user                - Username, IP address or IP range you want to unblock. Cannot be used together with id
 token               - An unblock token previously obtained through the gettoken parameter or prop=info
 gettoken            - If set, an unblock token will be returned, and no other action will be taken
 reason              - Reason for unblock (optional)

```

Examples:

```
 api.php?action=unblock&id=105
 api.php?action=unblock&user=Bob&reason=Sorry%20Bob

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Block

```

* action=move \*

```
 Move a page

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 from                - Title of the page you want to move. Cannot be used together with fromid
 fromid              - Page ID of the page you want to move. Cannot be used together with from
 to                  - Title you want to rename the page to
                       This parameter is required
 token               - A move token previously retrieved through prop=info
 reason              - Reason for the move (optional)
 movetalk            - Move the talk page, if it exists
 movesubpages        - Move subpages, if applicable
 noredirect          - Don't create a redirect
 watch               - DEPRECATED! Add the page and the redirect to your watchlist
 unwatch             - DEPRECATED! Remove the page and the redirect from your watchlist
 watchlist           - Unconditionally add or remove the page from your watchlist, use preferences or do not change watch
                       One value: watch, unwatch, preferences, nochange
                       Default: preferences
 ignorewarnings      - Ignore any warnings

```

Example:

```
 api.php?action=move&from=Exampel&to=Example&token=123ABC&reason=Misspelled%20title&movetalk=&noredirect=

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Move

```

* action=edit \*

```
 Create and edit pages.

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 title               - Page title
                       This parameter is required
 section             - Section number. 0 for the top section, 'new' for a new section
 sectiontitle        - The title for a new section
 text                - Page content
 token               - Edit token. You can get one of these through prop=info.
                       The token should always be sent as the last parameter, or at least, after the text parameter
 summary             - Edit summary. Also section title when section=new
 minor               - Minor edit
 notminor            - Non-minor edit
 bot                 - Mark this edit as bot
 basetimestamp       - Timestamp of the base revision (obtained through prop=revisions&rvprop=timestamp).
                       Used to detect edit conflicts; leave unset to ignore conflicts.
 starttimestamp      - Timestamp when you obtained the edit token.
                       Used to detect edit conflicts; leave unset to ignore conflicts
 recreate            - Override any errors about the article having been deleted in the meantime
 createonly          - Don't edit the page if it exists already
 nocreate            - Throw an error if the page doesn't exist
 watch               - DEPRECATED! Add the page to your watchlist
 unwatch             - DEPRECATED! Remove the page from your watchlist
 watchlist           - Unconditionally add or remove the page from your watchlist, use preferences or do not change watch
                       One value: watch, unwatch, preferences, nochange
                       Default: preferences
 md5                 - The MD5 hash of the text parameter, or the prependtext and appendtext parameters concatenated.
                       If set, the edit won't be done unless the hash is correct
 prependtext         - Add this text to the beginning of the page. Overrides text
 appendtext          - Add this text to the end of the page. Overrides text
 undo                - Undo this revision. Overrides text, prependtext and appendtext
 undoafter           - Undo all revisions from undo to this one. If not set, just undo one revision
 redirect            - Automatically resolve redirects

```

Examples:

```
 Edit a page (anonymous user):
   api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&basetimestamp=20070824123454&token=%2B\
 Prepend  to a page (anonymous user):
   api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=%0A&basetimestamp=20070824123454&token=%2B\
 Undo r13579 through r13585 with autosummary (anonymous user):
   api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=20070824123454&token=%2B\

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Edit

```

* action=upload \*

```
 Upload a file, or get the status of pending uploads. Several methods are available:
  * Upload file contents directly, using the "file" parameter
  * Have the MediaWiki server fetch a file from a URL, using the "url" parameter
  * Complete an earlier upload that failed due to warnings, using the "filekey" parameter
 Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when
 sending the "file".  Also you must get and send an edit token before doing any upload stuff

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 filename            - Target filename
 comment             - Upload comment. Also used as the initial page text for new files if "text" is not specified
                       Default:
 text                - Initial page text for new files
 token               - Edit token. You can get one of these through prop=info
 watch               - DEPRECATED! Watch the page
 watchlist           - Unconditionally add or remove the page from your watchlist, use preferences or do not change watch
                       One value: watch, preferences, nochange
                       Default: preferences
 ignorewarnings      - Ignore any warnings
 file                - File contents
 url                 - URL to fetch the file from
 filekey             - Key that identifies a previous upload that was stashed temporarily.
 sessionkey          - DEPRECATED! Same as filekey, maintained for backward compatibility.
 stash               - If set, the server will not add the file to the repository and stash it temporarily.
 filesize            - Filesize of entire upload
                       The value must be between 0 and 10485760
 offset              - Offset of chunk in bytes
                       The value must be no less than 0
 chunk               - Chunk contents
 asyncdownload       - Make fetching a URL asynchronous
 leavemessage        - If asyncdownload is used, leave a message on the user talk page if finished
 statuskey           - Fetch the upload status for this file key

```

Examples:

```
 Upload from a URL:
   api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png
 Complete an upload that failed due to warnings:
   api.php?action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Upload

```

* action=filerevert \*

```
 Revert a file to an old version

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 filename            - Target filename
                       This parameter is required
 comment             - Upload comment
                       Default:
 archivename         - Archive name of the revision to revert to
                       This parameter is required
 token               - Edit token. You can get one of these through prop=info

```

Example:

```
 Revert Wiki.png to the version of 20110305152740:
   api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=+\

```

* action=emailuser \*

```
 Email a user.

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 target              - User to send email to
                       This parameter is required
 subject             - Subject header
 text                - Mail body
                       This parameter is required
 token               - A token previously acquired via prop=info
 ccme                - Send a copy of this mail to me

```

Example:

```
 Send an email to the User "WikiSysop" with the text "Content":
   api.php?action=emailuser&target=WikiSysop&text=Content

```

Help page:

```
 https://www.mediawiki.org/wiki/API:E-mail

```

* action=watch \*

```
 Add or remove a page from/to the current user's watchlist

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 title               - The page to (un)watch
                       This parameter is required
 unwatch             - If set the page will be unwatched rather than watched
 token               - A token previously acquired via prop=info

```

Examples:

```
 Watch the page "Main Page":
   api.php?action=watch&title=Main_Page
 Unwatch the page "Main Page":
   api.php?action=watch&title=Main_Page&unwatch=

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Watch

```

* action=patrol \*

```
 Patrol a page or revision

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 token               - Patrol token obtained from list=recentchanges
 rcid                - Recentchanges ID to patrol
                       This parameter is required

```

Example:

```
 api.php?action=patrol&token=123abc&rcid=230672766

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Patrol

```

* action=import \*

```
 Import a page from another wiki, or an XML file.
 Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when
 sending a file for the "xml" parameter.

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 token               - Import token obtained through prop=info
 summary             - Import summary
 xml                 - Uploaded XML file
 interwikisource     - For interwiki imports: wiki to import from
                       One value:
 interwikipage       - For interwiki imports: page to import
 fullhistory         - For interwiki imports: import the full history, not just the current version
 templates           - For interwiki imports: import all included templates as well
 namespace           - For interwiki imports: import to this namespace
                       One value: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 1200, 1201, 1202, 500, 501, 502,
                           503, 420, 421, 828, 829

```

Example:

```
 Import meta:Help:Parserfunctions to namespace 100 with full history:
   api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory=&token=123ABC

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Import

```

* action=userrights \*

```
 Add/remove a user to/from groups

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 user                - User name
                       This parameter is required
 add                 - Add the user to these groups
                       Values (separate with '|'): bot, sysop, rollback, bureaucrat, staff, util, helper, vstf, bot-global, restricted-login,
                           restricted-login-exempt, content-moderator, council, authenticated, voldev, vanguard, checkuser,
                           oversight, threadmoderator, chatmoderator, content-reviewer, devboxpanel, translator, reviewer
 remove              - Remove the user from these groups
                       Values (separate with '|'): bot, sysop, rollback, bureaucrat, staff, util, helper, vstf, bot-global, restricted-login,
                           restricted-login-exempt, content-moderator, council, authenticated, voldev, vanguard, checkuser,
                           oversight, threadmoderator, chatmoderator, content-reviewer, devboxpanel, translator, reviewer
 token               - A userrights token previously retrieved through list=users
 reason              - Reason for the change
                       Default:

```

Example:

```
 api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC

```

Help page:

```
 https://www.mediawiki.org/wiki/API:User\_group\_membership

```

* action=options \*

```
 Change preferences of the current user.
 Only options which are registered in core or in one of installed extensions,
 or as options with keys prefixed with 'userjs-' (intended to be used by user
 scripts), can be set.

```

This module requires read rights
This module requires write rights
This module only accepts POST requests
Parameters:

```
 reset               - Resets preferences to the site defaults
 change              - List of changes, formatted name=value (e.g. skin=monobook), value cannot contain pipe characters. If no value is given (not
                       even an equals sign), e.g., optionname|otheroption|..., the option will be reset to its default value
 optionname          - A name of a option which should have an optionvalue set
 optionvalue         - A value of the option specified by the optionname, can contain pipe characters

```

Examples:

```
 api.php?action=options&reset=&token=123ABC
 api.php?action=options&change=skin=monobook|hideminor=1&token=123ABC
 api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=Beau%20(talk)&token=123ABC

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Options

```

* + - \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* Permissions \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\*

* writeapi \*

```
 Use of the write API

```

Granted to:

```
 all, user, bot, staff

```

* apihighlimits \*

```
 Use higher limits in API queries (Slow queries: 500 results; Fast queries: 5000 results). The limits for slow queries also apply to multivalue parameters.

```

Granted to:

```
 bot, sysop, staff, helper, vstf

```

* + - \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* Formats \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\* \*\*\*

* format=json \*

```
 Output data in JSON format

```

This module requires read rights
Parameters:

```
 callback            - If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

```

Example:

```
 Format the query result in the json format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=json

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=jsonfm \*

```
 Output data in JSON format (pretty-print in HTML)

```

This module requires read rights
Parameters:

```
 callback            - If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

```

Example:

```
 Format the query result in the jsonfm format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=jsonfm

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=php \*

```
 Output data in serialized PHP format

```

This module requires read rights
Example:

```
 Format the query result in the php format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=php

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=phpfm \*

```
 Output data in serialized PHP format (pretty-print in HTML)

```

This module requires read rights
Example:

```
 Format the query result in the phpfm format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=phpfm

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=wddx \*

```
 Output data in WDDX format

```

This module requires read rights
Example:

```
 Format the query result in the wddx format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=wddx

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=wddxfm \*

```
 Output data in WDDX format (pretty-print in HTML)

```

This module requires read rights
Example:

```
 Format the query result in the wddxfm format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=wddxfm

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=xml \*

```
 Output data in XML format

```

This module requires read rights
Parameters:

```
 xmldoublequote      - If specified, double quotes all attributes and content
 xslt                - If specified, adds <xslt> as stylesheet
 includexmlnamespace - If specified, adds an XML namespace

```

Example:

```
 Format the query result in the xml format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=xml

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=xmlfm \*

```
 Output data in XML format (pretty-print in HTML)

```

This module requires read rights
Parameters:

```
 xmldoublequote      - If specified, double quotes all attributes and content
 xslt                - If specified, adds <xslt> as stylesheet
 includexmlnamespace - If specified, adds an XML namespace

```

Example:

```
 Format the query result in the xmlfm format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=xmlfm

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=yaml \*

```
 Output data in YAML formatOutput data in JSON format

```

This module requires read rights
Parameters:

```
 callback            - If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

```

Example:

```
 Format the query result in the yaml format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=yaml

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=yamlfm \*

```
 Output data in YAML formatOutput data in JSON format (pretty-print in HTML)

```

This module requires read rights
Parameters:

```
 callback            - If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

```

Example:

```
 Format the query result in the yamlfm format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=yamlfm

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=rawfm \*

```
 Output data with the debuging elements in JSON format (pretty-print in HTML)

```

This module requires read rights
Parameters:

```
 callback            - If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

```

Example:

```
 Format the query result in the rawfm format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=rawfm

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=txt \*

```
 Output data in PHP's print_r() format

```

This module requires read rights
Example:

```
 Format the query result in the txt format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=txt

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=txtfm \*

```
 Output data in PHP's print_r() format (pretty-print in HTML)

```

This module requires read rights
Example:

```
 Format the query result in the txtfm format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=txtfm

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=dbg \*

```
 Output data in PHP's var_export() format

```

This module requires read rights
Example:

```
 Format the query result in the dbg format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbg

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=dbgfm \*

```
 Output data in PHP's var_export() format (pretty-print in HTML)

```

This module requires read rights
Example:

```
 Format the query result in the dbgfm format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbgfm

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=dump \*

```
 Output data in PHP's var_dump() format

```

This module requires read rights
Example:

```
 Format the query result in the dump format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=dump

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=dumpfm \*

```
 Output data in PHP's var_dump() format (pretty-print in HTML)

```

This module requires read rights
Example:

```
 Format the query result in the dumpfm format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=dumpfm

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* format=push \*

```
 Output data in PUSH format

```

This module requires read rights
Example:

```
 Format the query result in the push format:
   api.php?action=query&meta=siteinfo&siprop=namespaces&format=push

```

Help page:

```
 https://www.mediawiki.org/wiki/API:Data\_formats

```

* + - Credits: \*\*\*

```
  API developers:
      Roan Kattouw <Firstname>.<Lastname>@gmail.com (lead developer Sep 2007-present)
      Victor Vasiliev - vasilvv at gee mail dot com
      Bryan Tong Minh - bryan . tongminh @ gmail . com
      Sam Reed - sam @ reedyboy . net
      Yuri Astrakhan <Firstname><Lastname>@gmail.com (creator, lead developer Sep 2006-Sep 2007)

  Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org
  or file a bug report at https://bugzilla.wikimedia.org/</error>

```

</api>