<?xml version="1.0"?>
<api>
  <error code="notoken" info="The token parameter must be set" 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, none
                        Default: xmlfm
  action              - What action you would like to perform. See below for module help
                        One value: login, logout, createaccount, query, expandtemplates, parse, opensearch, feedcontributions,
                            feedrecentchanges, feedwatchlist, help, paraminfo, rsd, compare, tokens, purge,
                            setnotificationtimestamp, rollback, delete, undelete, protect, block, unblock, move, edit, upload,
                            filerevert, emailuser, watch, patrol, import, userrights, options, imagerotate, revisiondelete
                        Default: help
  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, error code "maxlag" 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
  assert              - Verify the user is logged in if set to "user", or has the bot userright if "bot"
                        One value: user, bot
  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
  origin              - When accessing the API using a cross-domain AJAX request (CORS), set this to the
                        originating domain. This must be included in any pre-flight request, and
                        therefore must be part of the request URI (not the POST body). This must match
                        one of the origins in the Origin: header exactly, so it has to be set to 
                        something like http://en.wikipedia.org or https://meta.wikimedia.org . If this
                        parameter does not match the Origin: header, a 403 response will be returned. If
                        this parameter matches the Origin: header and the origin is whitelisted, an
                        Access-Control-Allow-Origin header will be set.


*** *** *** *** *** *** *** *** *** *** *** *** *** ***  Modules  *** *** *** *** *** *** *** *** *** *** *** *** *** *** 

* 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.
  https://www.mediawiki.org/wiki/API:Login

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

* action=logout *
  Log out and clear session data.
  https://www.mediawiki.org/wiki/API:Logout
Example:
  Log the current user out:
    api.php?action=logout

* action=createaccount *
  Create a new user account.
  https://www.mediawiki.org/wiki/API:Account_creation

This module requires write rights
This module only accepts POST requests
Parameters:
  name                - Username
                        This parameter is required
  password            - Password (ignored if mailpassword is set)
  domain              - Domain for external authentication (optional)
  token               - Account creation token obtained in first request
  email               - Email address of user (optional)
  realname            - Real name of user (optional)
  mailpassword        - If set to any value, a random password will be emailed to the user
  reason              - Optional reason for creating the account to be put in the logs
  language            - Language code to set as default for the user (optional, defaults to content language)
  captchaword         - Answer to the CAPTCHA
  captchaid           - CAPTCHA ID from previous request
Examples:
  api.php?action=createaccount&name=testuser&password=test123
  api.php?action=createaccount&name=testmailuser&mailpassword=true&reason=MyReason

* 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.
  https://www.mediawiki.org/wiki/API:Query
  https://www.mediawiki.org/wiki/API:Meta
  https://www.mediawiki.org/wiki/API:Properties
  https://www.mediawiki.org/wiki/API:Lists

This module requires read rights
Parameters:
  prop                - Which properties to get for the titles/revisions/pageids. Module help is available below
                        Values (separate with '|'): categories, categoryinfo, contributors, duplicatefiles, extlinks, images, imageinfo, info, links,
                            iwlinks, langlinks, pageprops, redirects, revisions, stashimageinfo, templates
  list                - Which lists to get. Module help is available below
                        Values (separate with '|'): allcategories, allfileusages, allimages, alllinks, allpages, allredirects, alltransclusions,
                            allusers, backlinks, blocks, categorymembers, deletedrevs, embeddedin, exturlusage, filearchive,
                            imageusage, iwbacklinks, langbacklinks, logevents, pageswithprop, pagepropnames, prefixsearch,
                            protectedtitles, querypage, random, recentchanges, search, tags, usercontribs, users, watchlist,
                            watchlistraw
  meta                - Which metadata to get about the site. Module help is available below
                        Values (separate with '|'): allmessages, siteinfo, userinfo, filerepoinfo
  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
  continue            - When present, formats query-continue as key-value pairs that should simply be merged into the original request.
                        This parameter must be set to an empty string in the initial query.
                        This parameter is recommended for all new development, and will be made default in the next API version.
  titles              - A list of titles to work on
                        Separate values with '|'
                        Maximum number of values 50 (500 for bots)
  pageids             - A list of page IDs to work on
                        Separate values with '|'
                        Maximum number of values 50 (500 for bots)
  revids              - A list of revision IDs to work on
                        Separate values with '|'
                        Maximum number of values 50 (500 for bots)
  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, uz, zh
  generator           - Get the list of pages to work on by executing the specified query module.
                        NOTE: generator parameter names must be prefixed with a 'g', see examples
                        One value: allcategories, allfileusages, allimages, alllinks, allpages, allredirects, alltransclusions,
                            backlinks, categories, categorymembers, duplicatefiles, embeddedin, exturlusage, images, imageusage,
                            iwbacklinks, langbacklinks, links, pageswithprop, prefixsearch, protectedtitles, querypage, random,
                            recentchanges, redirects, search, templates, watchlist, watchlistraw
Examples:
  api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment&continue=
  api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue=

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

* prop=categories (cl) *
  List all categories the page(s) belong to.
  https://www.mediawiki.org/wiki/API:Properties#categories_.2F_cl

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 __HIDDENCAT__
                        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
                        Separate values with '|'
                        Maximum number of values 50 (500 for bots)
  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
Generator:
  This module may be used as a generator

* prop=categoryinfo (ci) *
  Returns information about the given categories.
  https://www.mediawiki.org/wiki/API:Properties#categoryinfo_.2F_ci

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

* prop=contributors (pc) *
  Get the list of logged-in contributors and the count of anonymous contributors to a page.
  https://www.mediawiki.org/wiki/API:Properties#contributors_.2F_pc

This module requires read rights
Parameters:
  pcgroup             - Limit users to given group name(s)
                        Does not include implicit or auto-promoted groups like *, user, or autoconfirmed
                        Values (separate with '|'): bot, sysop, bureaucrat
  pcexcludegroup      - Exclude users in given group name(s)
                        Does not include implicit or auto-promoted groups like *, user, or autoconfirmed
                        Values (separate with '|'): bot, sysop, bureaucrat
  pcrights            - Limit users to those having given right(s)
                        Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed
                        Values (separate with '|'): apihighlimits, autoconfirmed, autopatrol, bigdelete, block, blockemail, bot, browsearchive,
                            createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deletelogentry,
                            deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions,
                            editmyprivateinfo, editmyusercss, editmyuserjs, editmywatchlist, editsemiprotected, editusercssjs,
                            editusercss, edituserjs, hideuser, import, importupload, ipblock-exempt, markbotedits, mergehistory,
                            minoredit, move, movefile, move-rootuserpages, move-subpages, nominornewtalk, noratelimit,
                            override-export-depth, passwordreset, patrol, patrolmarks, protect, proxyunbannable, purge, read,
                            reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, suppressionlog,
                            suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url,
                            userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, writeapi, skipcaptcha
                        Maximum number of values 50 (500 for bots)
  pcexcluderights     - Limit users to those not having given right(s)
                        Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed
                        Values (separate with '|'): apihighlimits, autoconfirmed, autopatrol, bigdelete, block, blockemail, bot, browsearchive,
                            createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deletelogentry,
                            deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions,
                            editmyprivateinfo, editmyusercss, editmyuserjs, editmywatchlist, editsemiprotected, editusercssjs,
                            editusercss, edituserjs, hideuser, import, importupload, ipblock-exempt, markbotedits, mergehistory,
                            minoredit, move, movefile, move-rootuserpages, move-subpages, nominornewtalk, noratelimit,
                            override-export-depth, passwordreset, patrol, patrolmarks, protect, proxyunbannable, purge, read,
                            reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, suppressionlog,
                            suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url,
                            userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, writeapi, skipcaptcha
                        Maximum number of values 50 (500 for bots)
  pclimit             - How many contributors to return
                        No more than 500 (5000 for bots) allowed
                        Default: 10
  pccontinue          - When more results are available, use this to continue
Example:
  api.php?action=query&prop=contributors&titles=Main_Page

* prop=duplicatefiles (df) *
  List all files that are duplicates of the given file(s) based on hash values.
  https://www.mediawiki.org/wiki/API:Properties#duplicatefiles_.2F_df

This module requires read rights
Parameters:
  dflimit             - How many duplicate 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
  dflocalonly         - Look only for files in the local repository
Examples:
  api.php?action=query&titles=File:Albert_Einstein_Head.jpg&prop=duplicatefiles
  api.php?action=query&generator=allimages&prop=duplicatefiles
Generator:
  This module may be used as a generator

* prop=extlinks (el) *
  Returns all external URLs (not interwikis) from the given page(s).
  https://www.mediawiki.org/wiki/API:Properties#extlinks_.2F_el

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, ftps, ssh, sftp, irc, ircs, xmpp, sip, sips, gopher, telnet, nntp, worldwind,
                            mailto, tel, sms, news, svn, git, mms, bitcoin, magnet, urn, geo
                        Default: 
  elquery             - Search string without protocol. Useful for checking whether a certain page contains a certain external url
  elexpandurl         - Expand protocol-relative URLs with the canonical protocol
Example:
  Get a list of external links on the [[Main Page]]:
    api.php?action=query&prop=extlinks&titles=Main%20Page

* prop=imageinfo (ii) *
  Returns image information and upload history.
  https://www.mediawiki.org/wiki/API:Properties#imageinfo_.2F_ii

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
                         canonicaltitle - Adds the canonical title of the image file
                         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 and param iiurlwidth)
                         mediatype     - Adds the media type of the image
                         metadata      - Lists Exif metadata for the version of the image
                         commonmetadata - Lists file format generic metadata for the version of the image
                         extmetadata   - Lists formatted metadata combined from multiple sources. Results are HTML formatted.
                         archivename   - Adds the file name of the archive version for non-latest versions
                         bitdepth      - Adds the bit depth of the version
                         uploadwarning - Used by the Special:Upload page to get information about an existing file. Not intended for use outside MediaWiki core
                        Values (separate with '|'): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime,
                            thumbmime, mediatype, metadata, commonmetadata, extmetadata, archivename, bitdepth, uploadwarning
                        Default: timestamp|user
  iilimit             - How many image revisions to return per image
                        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.
                        For performance reasons if this option is used, no more than 50 scaled images will be returned.
                        Default: -1
  iiurlheight         - Similar to iiurlwidth.
                        Default: -1
  iimetadataversion   - Version of metadata to use. if 'latest' is specified, use latest version.
                        Defaults to '1' for backwards compatibility
                        Default: 1
  iiextmetadatalanguage - What language to fetch extmetadata in. This affects both which
                        translation to fetch, if multiple are available, as well as how things
                        like numbers and various values are formatted.
                        Default: es
  iiextmetadatamultilang - If translations for extmetadata property are available, fetch all of them.
  iiextmetadatafilter - If specified and non-empty, only these keys will be returned for iiprop=extmetadata
                        Separate values with '|'
                        Maximum number of values 50 (500 for bots)
  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
  iilocalonly         - Look only for files in the local repository
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

* prop=images (im) *
  Returns all images contained on the given page(s).
  https://www.mediawiki.org/wiki/API:Properties#images_.2F_im

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.
                        Separate values with '|'
                        Maximum number of values 50 (500 for bots)
  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
Generator:
  This module may be used as a generator

* prop=info (in) *
  Get basic page information such as namespace, title, last touched date, ...
  https://www.mediawiki.org/wiki/API:Properties#info_.2F_in

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
                         watchers              - The number of watchers, if allowed
                         notificationtimestamp - The watchlist notification timestamp 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
                        Values (separate with '|'): protection, talkid, watched, watchers, notificationtimestamp, subjectid, url, readable, preload,
                            displaytitle
  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

* prop=iwlinks (iw) *
  Returns all interwiki links from the given page(s).
  https://www.mediawiki.org/wiki/API:Iwlinks

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).
  https://www.mediawiki.org/wiki/API:Properties#langlinks_.2F_ll

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               - DEPRECATED! Whether to get the full URL (Cannot be used with llprop)
  llprop              - Which additional properties to get for each interlanguage link
                         url      - Adds the full URL
                         langname - Adds the localised language name (best effort, use CLDR extension)
                                    Use llinlanguagecode to control the language
                         autonym  - Adds the native language name
                        Values (separate with '|'): url, langname, autonym
  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
  llinlanguagecode    - Language code for localised language names
                        Default: es
Example:
  Get interlanguage links from the [[Main Page]]:
    api.php?action=query&prop=langlinks&titles=Main%20Page&redirects=

* prop=links (pl) *
  Returns all links from the given page(s).
  https://www.mediawiki.org/wiki/API:Properties#links_.2F_pl

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
                        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.
                        Separate values with '|'
                        Maximum number of values 50 (500 for bots)
  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