<?xml version="1.0"?> <api servedby="Megawiki"> <error code="unknown_action" info="Unrecognized value for parameter 'action': https://hosting-saitov-kupit.ru/" xml:space="preserve"> ****************************************************************************************** ** ** ** This is an auto-generated MediaWiki API documentation page ** ** ** ** Documentation and Examples: ** ** http://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 Documentation: http://www.mediawiki.org/wiki/API Mailing list: http://lists.wikimedia.org/mailman/listinfo/mediawiki-api Api Announcements: http://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce Bugs & Requests: http://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 Default: xmlfm action - What action you would like to perform. See below for module help One value: login, logout, query, expandtemplates, parse, opensearch, feedwatchlist, help, paraminfo, rsd, purge, rollback, delete, undelete, protect, block, unblock, move, edit, upload, emailuser, watch, patrol, import, userrights Default: help version - When showing help, include version for each module maxlag - Maximum lag 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=login (lg) * This module is used to login 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 * action=logout * This module is used to logout and clear session data Example: api.php?action=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 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, logevents, recentchanges, search, tags, usercontribs, watchlist, watchlistraw, exturlusage, users, random, protectedtitles, abuselog, abusefilters 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, search, watchlist, watchlistraw, exturlusage, random, protectedtitles 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 kk, ku, gan, tg, sr, 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 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 --- --- --- --- --- --- --- --- 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 Values (separate with '|'): protection, talkid, watched, 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 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=revisions (rv) * Get revision information This module 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 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, comment, parsedcomment, content, tags Default: ids|timestamp|flags|comment|user 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 - Direction of enumeration - towards "newer" or "older" revisions (enum) One value: newer, older Default: older rvuser - Only include revisions made by user rvexcludeuser - Exclude revisions made by user 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": api.php?action=query&prop=revisions&titles=API|Main%20Page&rvprop=timestamp|user|comment|content 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 * 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 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. 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 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 Examples: 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 Examples: Get interlanguage links from the [[Main Page]]: api.php?action=query&prop=langlinks&titles=Main%20Page&redirects= * 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 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=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 and width dimensions - Alias for size sha1 - Adds sha1 hash for the image mime - Adds MIME of the image thumbmime - Adss MIME of the image thumbnail (requires url) 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, 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 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 * prop=stashimageinfo (sii) * Returns image information for stashed images This module requires read rights Parameters: siisessionkey - Session key that identifies a previous upload that was stashed temporarily. This parameter is required 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 and width dimensions - Alias for size sha1 - Adds sha1 hash for the image mime - Adds MIME of the image thumbmime - Adss MIME 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 Examples: api.php?action=query&prop=stashimageinfo&siisessionkey=124sd34rsdf567 api.php?action=query&prop=stashimageinfo&siisessionkey=b34edoe3|bceffd4&siiurlwidth=120&siiprop=url * 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 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. 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 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 __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 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=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 Examples: Get a list of external links on the [[Main Page]]: api.php?action=query&prop=extlinks&titles=Main%20Page * 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 * 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 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=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 Example: api.php?action=query&prop=pageprops&titles=Category:Foo --- --- --- --- --- --- --- --- 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 - Which properties to get timestamp - Adds the timestamp when the image was upload user - Adds the username of the last uploader userid - Adds the user id of the last uploader comment - Adds the comment of the last upload url - Adds the URL of the image and its description page size - Adds the size of the image in bytes and its height and width dimensions - Alias of size sha1 - Adds the sha1 of the image mime - Adds the MIME of the image thumbmime - Adds the MIME of the tumbnail for 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, metadata, archivename, bitdepth Default: timestamp|url Examples: Simple Use Show a list of images starting at the letter "B" api.php?action=query&list=allimages&aifrom=B Using as Generator Show info about 4 images starting at the letter "T" api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo 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 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 Examples: Simple Use Show a list of pages starting at the letter "B" api.php?action=query&list=allpages&apfrom=B Using as Generator 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 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 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 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 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 __HIDDENCAT__ Values (separate with '|'): size, hidden Default: Examples: api.php?action=query&list=allcategories&acprop=size api.php?action=query&generator=allcategories&gacprefix=List&prop=info 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 augroup - Limit users to a given group name One value: bot, sysop, bureaucrat 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 editcount - Adds the edit count of the user registration - Adds the timestamp of when the user registered `groups` property uses more server resources and may return fewer results than the limit Values (separate with '|'): blockinfo, groups, 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 Example: api.php?action=query&list=allusers&aufrom=Y * 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 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 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 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 - The direction in which to enumerate 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 by - Adds the username of the blocking admin 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, by, timestamp, expiry, reason, range, flags Default: id|user|by|timestamp|expiry|reason|flags Examples: api.php?action=query&list=blocks api.php?action=query&list=blocks&bkusers=Alice|Bob * 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 This parameter is required 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 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) 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. Can only be used with cmsort=sortkey cmendsortkey - Sortkey to end listing at. Can only be used with cmsort=sortkey Examples: Get first 10 pages in [[Category:Physics]]: api.php?action=query&list=categorymembers&cmtitle=Category:Physics Get page info about first 10 pages in [[Category:Physics]]: api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info Generator: This module may be used as a generator * list=deletedrevs (dr) * List deleted revisions. This module 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 - The direction in which to enumerate (1,2) One value: newer, older Default: older drfrom - Start listing at this title (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 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 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 of the revision content - Adds the content of the revision token - Gives the edit token Values (separate with '|'): revid, user, userid, comment, parsedcomment, minor, len, 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= * 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 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 Examples: api.php?action=query&list=embeddedin&eititle=Template:Stub api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info 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 faprefix - Search for all image titles that begin with this value falimit - How many total images to return No more than 500 (5000 for bots) allowed Default: 10 fadir - The direction in which to list One value: ascending, descending Default: ascending faprop - What image information to get: sha1 - Adds sha1 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 dimensions - Adds the height and width of the image description - Adds description the image 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, mime, metadata, bitdepth Default: timestamp Examples: Simple Use 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 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 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 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=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 Default: ids|title|type|user|timestamp|comment|details letype - Filter log entries to only this type(s) Can be empty, or One value: block, protect, rights, delete, upload, move, import, patrol, merge, suppress, interwiki, renameuser, abusefilter, 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/disable, delete/delete, delete/restore, delete/revision, delete/event, upload/upload, upload/overwrite, upload/revert, move/move, move/move_redir, import/upload, import/interwiki, merge/merge, suppress/revision, suppress/file, suppress/event, suppress/delete, suppress/block, suppress/reblock, patrol/patrol, interwiki/interwiki, interwiki/iw_add, interwiki/iw_delete, interwiki/iw_edit, suppress/hide-afl, suppress/unhide-afl, newusers/newusers, newusers/create, newusers/create2, newusers/autocreate lestart - The timestamp to start enumerating from leend - The timestamp to end enumerating ledir - In which direction to enumerate 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 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 * 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 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 Maximum number of values 50 (500 for bots) rcuser - Only list changes by this user 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 have 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, 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 Example: api.php?action=query&list=recentchanges * 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 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 redirecttitle - Adds a parsed snippet of the redirect title sectionsnippet - Adds a parsed snippet of the matching section sectiontitle - Adds a parsed snippet of the matching section title 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 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 - The direction to search (older or newer) 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 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, tags Default: ids|title|timestamp|comment|size|flags 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 7862400 won\'t be shown Values (separate with '|'): minor, !minor, patrolled, !patrolled uctag - Only list revisions tagged with this tag Examples: api.php?action=query&list=usercontribs&ucuser=YurikBot api.php?action=query&list=usercontribs&ucuserprefix=217.121.114. * 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 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 pages 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 size - Adds the old and new lengths of the page notificationtimestamp - Adds timestamp of when the user was last notified about the edit Values (separate with '|'): ids, title, flags, user, userid, comment, parsedcomment, timestamp, patrol, sizes, notificationtimestamp 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&list=watchlist&wlprop=ids|title|timestamp|user|comment api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment 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 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 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, gopher, telnet, nntp, worldwind, mailto, news, svn, git, mms Default: euquery - Search string without protocol. See [[Special:LinkSearch]]. Leave empty to list all external links eunamespace - The page namespace(s) to enumerate. 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) 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 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 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, groups, editcount, registration, emailable, gender ususers - A list of users to obtain the same information for ustoken - Which tokens to obtain for each user Values (separate with '|'): userrights Example: api.php?action=query&list=users&ususers=brion|TimStarling&usprop=groups|editcount|gender * 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 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 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 - The direction in which to list One value: older, newer 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 to add the protection userid - Adds the user id to add 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 Generator: This module may be used as a generator * list=abuselog (afl) * Show events that were caught by one of the abuse filters. This module requires read rights Parameters: aflstart - The timestamp to start enumerating from aflend - The timestamp to stop enumerating at afldir - The direction in which to enumerate One value: newer, older Default: older afluser - Show only entries done by a given user or IP address. afltitle - Show only entries occurring on a given page. aflfilter - Show only entries that were caught by a given filter ID afllimit - The maximum amount of entries to list No more than 500 (5000 for bots) allowed Default: 10 aflprop - Which properties to get Values (separate with '|'): ids, filter, user, ip, title, action, details, result, timestamp, hidden Default: ids|user|title|action|result|timestamp|hidden Examples: api.php?action=query&list=abuselog api.php?action=query&list=abuselog&afltitle=API * list=abusefilters (abf) * Show details of the abuse filters. This module requires read rights Parameters: abfstartid - The filter id to start enumerating from abfendid - The filter id to stop enumerating at abfdir - The direction in which to enumerate One value: older, newer Default: newer abfshow - Show only filters which meet these criteria Values (separate with '|'): enabled, !enabled, deleted, !deleted, private, !private abflimit - The maximum number of filters to list No more than 500 (5000 for bots) allowed Default: 10 abfprop - Which properties to get Values (separate with '|'): id, description, pattern, actions, hits, comments, lasteditor, lastedittime, status, private Default: id|description|actions|status Examples: api.php?action=query&list=abusefilters&abfshow=enabled|!private api.php?action=query&list=abusefilters&abfprop=id|description|pattern --- --- --- --- --- --- --- --- 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) 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 Values (separate with '|'): general, namespaces, namespacealiases, specialpagealiases, magicwords, interwikimap, dbrepllag, statistics, usergroups, extensions, fileextensions, rightsinfo, languages 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 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= * 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 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 editcount - Adds the current user's edit count ratelimits - Lists all rate limits applying to the current user 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 Values (separate with '|'): blockinfo, hasmsg, groups, rights, changeablegroups, options, preferencestoken, editcount, ratelimits, email, acceptlang Examples: api.php?action=query&meta=userinfo api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg * meta=allmessages (am) * Return messages from this site This module requires read rights Parameters: ammessages - Which messages to output. "*" 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. amargs - Arguments to be substituted into message amfilter - Return only messages that contain this string amlang - Return messages in this language amfrom - Return messages starting at this message amto - Return messages ending at this message Examples: api.php?action=query&meta=allmessages&amfilter=ipb- api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de *** *** *** *** *** *** *** *** *** *** Modules: continuation *** *** *** *** *** *** *** *** *** *** * action=expandtemplates * This module expand all templates in wikitext This module requires read rights Parameters: title - Title of page Default: API text - Wikitext to convert generatexml - Generate XML parse tree Example: api.php?action=expandtemplates&text={{Project:Sandbox}} * action=parse * This module 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 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 langlinks the parsed wikitext categories - Gives the categories of the parsed wikitext categorieshtml - Gives the html version of the categories languageshtml - Gives the html version of the languagelinks 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 Default: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle 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={{Project:Sandbox}} * action=opensearch * This module implements 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 Maximum number of values 50 (500 for bots) Default: 0 suggest - Do nothing if $wgEnableOpenSearchSuggest is false Example: api.php?action=opensearch&search=Te * action=feedwatchlist * This module 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 token if it's not you) wltoken - Security token that requested user set in their preferences linktodiffs - Link to change differences instead of article pages Examples: api.php?action=feedwatchlist api.php?action=feedwatchlist&allrev=allrev&linktodiffs=&hours=6 * 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 * action=paraminfo * Obtain information about certain API parameters and errors Parameters: modules - List of module names (value of the action= parameter) querymodules - List of query module names (value of prop=, meta= or list= parameter) mainmodule - Get information about the main (top-level) module as well pagesetmodule - Get information about the pageset module (providing titles= and friends) as well Example: api.php?action=paraminfo&modules=parse&querymodules=allpages|siteinfo * action=rsd * Export an RSD schema This module requires read rights Example: api.php?action=rsd * action=purge * Purge the cache for the given titles. This module 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 This parameter is required Example: api.php?action=purge&titles=Main_Page|API * 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 * 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: api.php?action=delete&title=Main%20Page&token=123ABC api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move * 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. 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×tamps=20070703220045|20070702194856 * 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 * 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 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= * 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 * 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= * 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 text - Page content token - Edit token. You can get one of these through prop=info 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 (gotten 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 captchaword - Answer to the CAPTCHA captchaid - CAPTCHA ID from previous request 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 __NOTOC__ to a page (anonymous user): api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%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\ * 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 "sessionkey" parameter Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when sending the "file". Note also that queries using session keys must be done in the same login session as the query that originally returned the key (i.e. do not log out and then log back in). 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 sessionkey - Session key that identifies a previous upload that was stashed temporarily. stash - If set, the server will not add the file to the repository and stash it temporarily. 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&sessionkey=sessionkey&ignorewarnings=1 * 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: api.php?action=emailuser&target=WikiSysop&text=Content * action=watch * Add or remove a page from/to the current user's watchlist This module requires read rights This module requires write rights Parameters: title - The page to (un)watch This parameter is required unwatch - If set the page will be unwatched rather than watched Examples: api.php?action=watch&title=Main_Page api.php?action=watch&title=Main_Page&unwatch= * 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 * action=import * Import a page from another wiki, or an XML file 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 Examples: Import [[meta:Help:Parserfunctions]] to namespace 100 with full history: api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory=&token=123ABC * 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, bureaucrat remove - Remove the user from these groups Values (separate with '|'): bot, sysop, bureaucrat 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 *** *** *** *** *** *** *** *** *** *** Permissions *** *** *** *** *** *** *** *** *** *** * writeapi * Use of the write API Granted to: user, bot * 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 *** *** *** *** *** *** *** *** *** *** 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: api.php?action=query&meta=siteinfo&siprop=namespaces&format=json * 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: api.php?action=query&meta=siteinfo&siprop=namespaces&format=jsonfm * format=php * Output data in serialized PHP format This module requires read rights Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=php * format=phpfm * Output data in serialized PHP format (pretty-print in HTML) This module requires read rights Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=phpfm * format=wddx * Output data in WDDX format This module requires read rights Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=wddx * format=wddxfm * Output data in WDDX format (pretty-print in HTML) This module requires read rights Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=wddxfm * 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 Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=xml * 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 Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=xmlfm * format=yaml * Output data in YAML format This module requires read rights Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=yaml * format=yamlfm * Output data in YAML format (pretty-print in HTML) This module requires read rights Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=yamlfm * 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: api.php?action=query&meta=siteinfo&siprop=namespaces&format=rawfm * format=txt * Output data in PHP's print_r() format This module requires read rights Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=txt * format=txtfm * Output data in PHP's print_r() format (pretty-print in HTML) This module requires read rights Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=txtfm * format=dbg * Output data in PHP's var_export() format This module requires read rights Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbg * format=dbgfm * Output data in PHP's var_export() format (pretty-print in HTML) This module requires read rights Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbgfm * format=dump * Output data in PHP's var_dump() format This module requires read rights Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=dump * format=dumpfm * Output data in PHP's var_dump() format (pretty-print in HTML) This module requires read rights Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=dumpfm *** Credits: *** API developers: Roan Kattouw <Firstname>.<Lastname>@home.nl (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 http://bugzilla.wikimedia.org/ </error> </api>