User:Daniel Mietchen/Sandbox/API

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> MediaWiki API &lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt; &lt;api&gt;

&lt;error code=&quot;help&quot; info=&quot;&quot;&gt; ****************************************************************** **                                                              **  **  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 Bugs &amp; Requests: http://bugzilla.wikimedia.org/buglist.cgi?component=API&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;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 Default: xmlfm action        - What action you would like to perform One value: login, logout, query, expandtemplates, parse, opensearch, feedwatchlist, help, paraminfo 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

*** *** *** *** *** *** *** *** *** *** 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) Example: api.php?action=login&amp;lgname=user&amp;lgpassword=password

* action=logout * This module is used to logout and clear session data Parameters: 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 Query API interface currently available on all MediaWiki servers. All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites. Parameters: titles        - A list of titles to work on  pageids        - A list of page IDs to work on  revids         - A list of revision IDs to work on  prop           - Which properties to get for the titles/revisions/pageids Values (separate with '|'): info, revisions, links, langlinks, images, imageinfo, templates, categories, extlinks, categoryinfo list          - Which lists to get Values (separate with '|'): allimages, allpages, alllinks, allcategories, allusers, backlinks, blocks, categorymembers, deletedrevs, embeddedin, imageusage, logevents, recentchanges, search, usercontribs, watchlist, exturlusage, users, random meta          - Which meta data to get about the site Values (separate with '|'): siteinfo, userinfo, allmessages generator     - Use the output of a list as the input for other prop/list/meta items One value: links, images, templates, categories, allimages, allpages, alllinks, allcategories, backlinks, categorymembers, embeddedin, imageusage, search, watchlist, exturlusage, random redirects     - Automatically resolve redirects indexpageids  - Include an additional pageids section listing all returned page IDs. Example: api.php?action=query&amp;prop=revisions&amp;meta=siteinfo&amp;titles=Main%20Page&amp;rvprop=user|comment

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

* prop=info (in) * Get basic page information such as namespace, title, last touched date, ... Parameters: inprop        - Which additional properties to get: &quot;protection&quot;  - List the protection level of each page &quot;talkid&quot;      - The page ID of the talk page for each non-talk page &quot;subjectid&quot;    - The page ID of the parent page for each talk page Values (separate with '|'): protection, talkid, subjectid intoken       - Request a token to perform a data-modifying action on a page Values (separate with '|'): edit, delete, protect, move, block, unblock Examples: api.php?action=query&amp;prop=info&amp;titles=Main%20Page

api.php?action=query&amp;prop=info&amp;inprop=protection&amp;titles=Main%20Page</a>

* 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). Parameters:  rvprop         - Which properties to get for each revision.                   Values (separate with '|'): ids, flags, timestamp, user, size, comment, content                   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 &quot;newer&quot; or &quot;older&quot; revisions (enum)                   One value: newer, older Default: older rvuser        - only include revisions made by user rvexcludeuser - exclude revisions made by user rvexpandtemplates - expand templates in revision content rvsection     - only retrieve the content of this section rvtoken       - Which tokens to obtain for each revision Values (separate with '|'): rollback Examples: Get data with content for the last revision of titles &quot;API&quot; and &quot;Main Page&quot;: api.php?action=query&amp;prop=revisions&amp;titles=API|Main%20Page&amp;rvprop=timestamp|user|comment|content</a>

Get last 5 revisions of the &quot;Main Page&quot;: api.php?action=query&amp;prop=revisions&amp;titles=Main%20Page&amp;rvlimit=5&amp;rvprop=timestamp|user|comment</a> Get first 5 revisions of the &quot;Main Page&quot;: api.php?action=query&amp;prop=revisions&amp;titles=Main%20Page&amp;rvlimit=5&amp;rvprop=timestamp|user|comment&amp;rvdir=newer</a>

Get first 5 revisions of the &quot;Main Page&quot; made after 2006-05-01: api.php?action=query&amp;prop=revisions&amp;titles=Main%20Page&amp;rvlimit=5&amp;rvprop=timestamp|user|comment&amp;rvdir=newer&amp;rvstart=20060501000000</a> Get first 5 revisions of the &quot;Main Page&quot; that were not made made by anonymous user &quot;127.0.0.1&quot;

api.php?action=query&amp;prop=revisions&amp;titles=Main%20Page&amp;rvlimit=5&amp;rvprop=timestamp|user|comment&amp;rvexcludeuser=127.0.0.1</a> Get first 5 revisions of the &quot;Main Page&quot; that were made by the user &quot;MediaWiki default&quot; api.php?action=query&amp;prop=revisions&amp;titles=Main%20Page&amp;rvlimit=5&amp;rvprop=timestamp|user|comment&amp;rvuser=MediaWiki%20default</a>

* prop=links (pl) * Returns all links from the given page(s) 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, 100, 101, 102, 103, 104, 105 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 Examples: Get links from the Main Page: api.php?action=query&amp;prop=links&amp;titles=Main%20Page</a> Get information about the link pages in the Main Page: api.php?action=query&amp;generator=links&amp;titles=Main%20Page&amp;prop=info</a> Get links from the Main Page in the User and Template namespaces: api.php?action=query&amp;prop=links&amp;titles=Main%20Page&amp;plnamespace=2|10</a>

Generator: This module may be used as a generator

* prop=langlinks (ll) * Returns all interlanguage links from the given page(s) 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 Examples: Get interlanguage links from the Main Page: api.php?action=query&amp;prop=langlinks&amp;titles=Main%20Page&amp;redirects</a>

* prop=images (im) * Returns all images contained on the given page(s) 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&amp;prop=images&amp;titles=Main%20Page</a>

Get information about all images used in the Main Page: api.php?action=query&amp;generator=images&amp;titles=Main%20Page&amp;prop=info</a> Generator: This module may be used as a generator

* prop=imageinfo (ii) * Returns image information and upload history Parameters: iiprop        - What image information to get. Values (separate with '|'): timestamp, user, comment, url, size, sha1, mime, metadata, archivename 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 Examples: api.php?action=query&amp;titles=Image:Albert%20Einstein%20Head.jpg&amp;prop=imageinfo</a> api.php?action=query&amp;titles=Image:Test.jpg&amp;prop=imageinfo&amp;iilimit=50&amp;iiend=20071231235959&amp;iiprop=timestamp|user|url</a>

* prop=templates (tl) * Returns all templates from the given page(s) 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, 100, 101, 102, 103, 104, 105 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 Examples: Get templates from the Main Page: api.php?action=query&amp;prop=templates&amp;titles=Main%20Page</a> Get information about the template pages in the Main Page: <a href="api.php?action=query&amp;generator=templates&amp;titles=Main%20Page&amp;prop=info">api.php?action=query&amp;generator=templates&amp;titles=Main%20Page&amp;prop=info</a> Get templates from the Main Page in the User and Template namespaces: <a href="api.php?action=query&amp;prop=templates&amp;titles=Main%20Page&amp;tlnamespace=2|10">api.php?action=query&amp;prop=templates&amp;titles=Main%20Page&amp;tlnamespace=2|10</a>

Generator: This module may be used as a generator

* prop=categories (cl) * List all categories the page(s) belong to Parameters: clprop        - Which additional properties to get for each category. Values (separate with '|'): sortkey, timestamp 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 Examples: Get a list of categories Albert Einstein belongs to: <a href="api.php?action=query&amp;prop=categories&amp;titles=Albert%20Einstein">api.php?action=query&amp;prop=categories&amp;titles=Albert%20Einstein</a> Get information about all categories used in the Albert Einstein: <a href="api.php?action=query&amp;generator=categories&amp;titles=Albert%20Einstein&amp;prop=info">api.php?action=query&amp;generator=categories&amp;titles=Albert%20Einstein&amp;prop=info</a> Generator: This module may be used as a generator

* prop=extlinks (el) * Returns all external urls (not interwikies) from the given page(s) 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: <a href="api.php?action=query&amp;prop=extlinks&amp;titles=Main%20Page">api.php?action=query&amp;prop=extlinks&amp;titles=Main%20Page</a>

* prop=categoryinfo (ci) * Returns information about the given categories Example: <a href="api.php?action=query&amp;prop=categoryinfo&amp;titles=Category:Foo|Category:Bar">api.php?action=query&amp;prop=categoryinfo&amp;titles=Category:Foo|Category:Bar</a>

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

* list=allimages (ai) * Enumerate all images sequentially Parameters: aifrom        - The image title to start enumerating from. 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 total images 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 aisha1base36  - SHA1 hash of image in base 36 (used in MediaWiki) aiprop        - Which properties to get Values (separate with '|'): timestamp, user, comment, url, size, dimensions, mime, sha1, metadata Default: timestamp|url Examples: Simple Use Show a list of images starting at the letter &quot;B&quot; <a href="api.php?action=query&amp;list=allimages&amp;aifrom=B">api.php?action=query&amp;list=allimages&amp;aifrom=B</a> Using as Generator Show info about 4 images starting at the letter &quot;T&quot;

<a href="api.php?action=query&amp;generator=allimages&amp;gailimit=4&amp;gaifrom=T&amp;prop=imageinfo">api.php?action=query&amp;generator=allimages&amp;gailimit=4&amp;gaifrom=T&amp;prop=imageinfo</a> Generator: This module may be used as a generator

* list=allpages (ap) * Enumerate all pages sequentially in a given namespace Parameters: apfrom        - The page title to start enumerating from. 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, 100, 101, 102, 103, 104, 105 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 apprlevel     - The protection level (must be used with apprtype= parameter) Can be empty, or Values (separate with '|'): autoconfirmed, sysop 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 &quot;B&quot; <a href="api.php?action=query&amp;list=allpages&amp;apfrom=B">api.php?action=query&amp;list=allpages&amp;apfrom=B</a>

Using as Generator Show info about 4 pages starting at the letter &quot;T&quot; <a href="api.php?action=query&amp;generator=allpages&amp;gaplimit=4&amp;gapfrom=T&amp;prop=info">api.php?action=query&amp;generator=allpages&amp;gaplimit=4&amp;gapfrom=T&amp;prop=info</a> Show content of first 2 non-redirect pages begining at &quot;Re&quot; <a href="api.php?action=query&amp;generator=allpages&amp;gaplimit=2&amp;gapfilterredir=nonredirects&amp;gapfrom=Re&amp;prop=revisions&amp;rvprop=content">api.php?action=query&amp;generator=allpages&amp;gaplimit=2&amp;gapfilterredir=nonredirects&amp;gapfrom=Re&amp;prop=revisions&amp;rvprop=content</a>

Generator: This module may be used as a generator

* list=alllinks (al) * Enumerate all links that point to a given namespace Parameters: alcontinue    - When more results are available, use this to continue. alfrom        - The page title to start enumerating from. alprefix      - Search for all page titles that begin with this value. alunique      - Only show unique links. Cannot be used with generator or prop=ids alprop        - What pieces of information to include 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, 100, 101, 102, 103, 104, 105 Default: 0 allimit       - How many total links to return. No more than 500 (5000 for bots) allowed. Default: 10 Example: <a href="api.php?action=query&amp;list=alllinks&amp;alunique&amp;alfrom=B">api.php?action=query&amp;list=alllinks&amp;alunique&amp;alfrom=B</a> Generator: This module may be used as a generator

* list=allcategories (ac) * Enumerate all categories Parameters: acfrom        - The category to start enumerating from. 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 Values (separate with '|'): size, hidden Default: Examples: <a href="api.php?action=query&amp;list=allcategories&amp;acprop=size">api.php?action=query&amp;list=allcategories&amp;acprop=size</a>

<a href="api.php?action=query&amp;generator=allcategories&amp;gacprefix=List&amp;prop=info">api.php?action=query&amp;generator=allcategories&amp;gacprefix=List&amp;prop=info</a> Generator: This module may be used as a generator

* list=allusers (au) * Enumerate all registered users Parameters: aufrom        - The user name to start enumerating from. auprefix      - Search for all page titles that begin with this value. augroup       - Limit users to a given group name One value: bot, sysop, bureaucrat, emailconfirmed, wikieditor, Dark Knight, epa, Linnaeus auprop        - What pieces of information to include. `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 Example: <a href="api.php?action=query&amp;list=allusers&amp;aufrom=Y">api.php?action=query&amp;list=allusers&amp;aufrom=Y</a>

* list=backlinks (bl) *

Find all pages that link to the given page Parameters: bltitle       - Title to search. If null, titles= parameter will be used instead, but will be obsolete soon. 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, 100, 101, 102, 103, 104, 105 blfilterredir - How to filter for redirects One value: all, redirects, nonredirects Default: all bllimit       - How many total pages to return. If blredirect is enabled, limit applies to each level separately. 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: <a href="api.php?action=query&amp;list=backlinks&amp;bltitle=Main%20Page">api.php?action=query&amp;list=backlinks&amp;bltitle=Main%20Page</a> <a href="api.php?action=query&amp;generator=backlinks&amp;gbltitle=Main%20Page&amp;prop=info">api.php?action=query&amp;generator=backlinks&amp;gbltitle=Main%20Page&amp;prop=info</a> Generator: This module may be used as a generator

* list=blocks (bk) * List all blocked users and IP addresses. 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) 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 Values (separate with '|'): id, user, by, timestamp, expiry, reason, range, flags Default: id|user|by|timestamp|expiry|reason|flags Examples: <a href="api.php?action=query&amp;list=blocks">api.php?action=query&amp;list=blocks</a>

<a href="api.php?action=query&amp;list=blocks&amp;bkusers=Alice|Bob">api.php?action=query&amp;list=blocks&amp;bkusers=Alice|Bob</a>

* list=categorymembers (cm) * List all pages in a given category Parameters: cmtitle       - Which category to enumerate (required). Must include Category: prefix cmprop        - What pieces of information to include Values (separate with '|'): ids, title, sortkey, 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, 100, 101, 102, 103, 104, 105 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 Examples: Get first 10 pages in : <a href="api.php?action=query&amp;list=categorymembers&amp;cmtitle=Category:Physics">api.php?action=query&amp;list=categorymembers&amp;cmtitle=Category:Physics</a> Get page info about first 10 pages in : <a href="api.php?action=query&amp;generator=categorymembers&amp;gcmtitle=Category:Physics&amp;prop=info">api.php?action=query&amp;generator=categorymembers&amp;gcmtitle=Category:Physics&amp;prop=info</a>

Generator: This module may be used as a generator

* list=deletedrevs (dr) * List deleted revisions. Parameters: drstart       - The timestamp to start enumerating from drend         - The timestamp to stop enumerating at  drdir          - The direction in which to enumerate One value: newer, older Default: older drlimit       - The maximum amount of revisions to list No more than 500 (5000 for bots) allowed. Default: 10 drprop        - Which properties to get Values (separate with '|'): revid, user, comment, minor, len, content, token Default: user|comment Examples: List the first 50 deleted revisions <a href="api.php?action=query&amp;list=deletedrevs&amp;drdir=newer&amp;drlimit=50">api.php?action=query&amp;list=deletedrevs&amp;drdir=newer&amp;drlimit=50</a> List the last deleted revisions of Main Page and Talk:Main Page, with content: <a href="api.php?action=query&amp;list=deletedrevs&amp;titles=Main%20Page|Talk:Main%20Page&amp;drprop=user|comment|content">api.php?action=query&amp;list=deletedrevs&amp;titles=Main%20Page|Talk:Main%20Page&amp;drprop=user|comment|content</a>

* list=embeddedin (ei) * Find all pages that embed (transclude) the given title Parameters: eititle       - Title to search. If null, titles= parameter will be used instead, but will be obsolete soon. 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, 100, 101, 102, 103, 104, 105 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: <a href="api.php?action=query&amp;list=embeddedin&amp;eititle=Template:Stub">api.php?action=query&amp;list=embeddedin&amp;eititle=Template:Stub</a> <a href="api.php?action=query&amp;generator=embeddedin&amp;geititle=Template:Stub&amp;prop=info">api.php?action=query&amp;generator=embeddedin&amp;geititle=Template:Stub&amp;prop=info</a> Generator: This module may be used as a generator

* list=imageusage (iu) *

Find all pages that use the given image title. Parameters: iutitle       - Title to search. If null, titles= parameter will be used instead, but will be obsolete soon. 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, 100, 101, 102, 103, 104, 105 iufilterredir - How to filter for redirects One value: all, redirects, nonredirects Default: all iulimit       - How many total pages to return. If iuredirect is enabled, limit applies to each level separately. 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: <a href="api.php?action=query&amp;list=imageusage&amp;iutitle=Image:Albert%20Einstein%20Head.jpg">api.php?action=query&amp;list=imageusage&amp;iutitle=Image:Albert%20Einstein%20Head.jpg</a> <a href="api.php?action=query&amp;generator=imageusage&amp;giutitle=Image:Albert%20Einstein%20Head.jpg&amp;prop=info">api.php?action=query&amp;generator=imageusage&amp;giutitle=Image:Albert%20Einstein%20Head.jpg&amp;prop=info</a> Generator: This module may be used as a generator

* list=logevents (le) * Get events from logs. Parameters: leprop        - Which properties to get Values (separate with '|'): ids, title, type, user, timestamp, comment, details 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, renameuser, newusers 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. lelimit       - How many total event entries to return. No more than 500 (5000 for bots) allowed. Default: 10 Example: <a href="api.php?action=query&amp;list=logevents">api.php?action=query&amp;list=logevents</a>

* list=recentchanges (rc) * Enumerate recent changes 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, 100, 101, 102, 103, 104, 105 rctitles      - Filter log entries to only these page titles rcprop        - Include additional pieces of information Values (separate with '|'): user, comment, flags, timestamp, title, ids, sizes, redirect, patrolled Default: title|timestamp|ids rcshow        - Show only items that meet this criteria. For example, to see only minor edits done by logged-in users, set show=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: <a href="api.php?action=query&amp;list=recentchanges">api.php?action=query&amp;list=recentchanges</a>

* list=search (sr) * Perform a full text search Parameters: srsearch      - Search for all page titles (or content) that has this value. 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, 100, 101, 102, 103, 104, 105 Default: 0 srwhat        - Search inside the text or titles. One value: title, text Default: title 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 500 (5000 for bots) allowed. Default: 10 Examples: <a href="api.php?action=query&amp;list=search&amp;srsearch=meaning">api.php?action=query&amp;list=search&amp;srsearch=meaning</a>

<a href="api.php?action=query&amp;list=search&amp;srwhat=text&amp;srsearch=meaning">api.php?action=query&amp;list=search&amp;srwhat=text&amp;srsearch=meaning</a> <a href="api.php?action=query&amp;generator=search&amp;gsrsearch=meaning&amp;prop=info">api.php?action=query&amp;generator=search&amp;gsrsearch=meaning&amp;prop=info</a> Generator: This module may be used as a generator

* list=usercontribs (uc) * Get all edits by a user 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. ucuser        - The user 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, 100, 101, 102, 103, 104, 105 ucprop        - Include additional pieces of information Values (separate with '|'): ids, title, timestamp, comment, flags Default: ids|title|timestamp|flags|comment ucshow        - Show only items that meet this criteria, e.g. non minor edits only: show=!minor Values (separate with '|'): minor, !minor Examples: <a href="api.php?action=query&amp;list=usercontribs&amp;ucuser=YurikBot">api.php?action=query&amp;list=usercontribs&amp;ucuser=YurikBot</a>

<a href="api.php?action=query&amp;list=usercontribs&amp;ucuserprefix=217.121.114.">api.php?action=query&amp;list=usercontribs&amp;ucuserprefix=217.121.114.</a>

* list=watchlist (wl) * Get all recent changes to pages in the logged in user's watchlist 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, 100, 101, 102, 103, 104, 105 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). Values (separate with '|'): ids, title, flags, user, comment, timestamp, patrol, sizes 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 show=minor|!anon Values (separate with '|'): minor, !minor, bot, !bot, anon, !anon Examples: <a href="api.php?action=query&amp;list=watchlist">api.php?action=query&amp;list=watchlist</a> <a href="api.php?action=query&amp;list=watchlist&amp;wlprop=ids|title|timestamp|user|comment">api.php?action=query&amp;list=watchlist&amp;wlprop=ids|title|timestamp|user|comment</a>

<a href="api.php?action=query&amp;list=watchlist&amp;wlallrev&amp;wlprop=ids|title|timestamp|user|comment">api.php?action=query&amp;list=watchlist&amp;wlallrev&amp;wlprop=ids|title|timestamp|user|comment</a> <a href="api.php?action=query&amp;generator=watchlist&amp;prop=info">api.php?action=query&amp;generator=watchlist&amp;prop=info</a> <a href="api.php?action=query&amp;generator=watchlist&amp;gwlallrev&amp;prop=revisions&amp;rvprop=timestamp|user">api.php?action=query&amp;generator=watchlist&amp;gwlallrev&amp;prop=revisions&amp;rvprop=timestamp|user</a>

Generator: This module may be used as a generator

* list=exturlusage (eu) * Enumerate pages that contain a given URL Parameters: euprop        - What pieces of information to include Values (separate with '|'): ids, title, url Default: ids|title|url euoffset      - Used for paging. Use the value returned for &quot;continue&quot; 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 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, 100, 101, 102, 103, 104, 105 eulimit       - How many pages to return. No more than 500 (5000 for bots) allowed. Default: 10 Example: <a href="api.php?action=query&amp;list=exturlusage&amp;euquery=www.mediawiki.org">api.php?action=query&amp;list=exturlusage&amp;euquery=www.mediawiki.org</a> Generator: This module may be used as a generator

* list=users (us) * Get information about a list of users 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 belongs to                     editcount - adds the user's edit count Values (separate with '|'): blockinfo, groups, editcount, registration ususers       - A list of users to obtain the same information for Example: <a href="api.php?action=query&amp;list=users&amp;ususers=brion|TimStarling&amp;usprop=groups|editcount">api.php?action=query&amp;list=users&amp;ususers=brion|TimStarling&amp;usprop=groups|editcount</a>

* 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, &quot;Main Page&quot; is the first random page on your list, &quot;List of fictional monkeys&quot; will *always* be second, &quot;List of people on stamps of Vanuatu&quot; 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. 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, 100, 101, 102, 103, 104, 105 rnlimit       - Limit how many random pages will be returned No more than 10 (20 for bots) allowed. Default: 1 Example: <a href="api.php?action=query&amp;list=random&amp;rnnamespace=0&amp;rnlimit=2">api.php?action=query&amp;list=random&amp;rnnamespace=0&amp;rnlimit=2</a>

Generator: This module may be used as a generator

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

* meta=siteinfo (si) * Return general information about the site. Parameters: siprop        - Which sysinfo properties to get: &quot;general&quot;     - Overall system information &quot;namespaces&quot;  - List of registered namespaces (localized) &quot;namespacealiases&quot; - List of registered namespace aliases &quot;specialpagealiases&quot; - List of special page aliases &quot;statistics&quot;  - Returns site statistics &quot;interwikimap&quot; - Returns interwiki map (optionally filtered) &quot;dbrepllag&quot;   - Returns database server with the highest replication lag &quot;usergroups&quot;  - Returns user groups and the associated permissions Values (separate with '|'): general, namespaces, namespacealiases, specialpagealiases, interwikimap, dbrepllag, statistics, usergroups 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 Examples: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=general|namespaces|namespacealiases|statistics">api.php?action=query&amp;meta=siteinfo&amp;siprop=general|namespaces|namespacealiases|statistics</a>

<a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=interwikimap&amp;sifilteriw=local">api.php?action=query&amp;meta=siteinfo&amp;siprop=interwikimap&amp;sifilteriw=local</a> <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=dbrepllag&amp;sishowalldb">api.php?action=query&amp;meta=siteinfo&amp;siprop=dbrepllag&amp;sishowalldb</a>

* meta=userinfo (ui) * Get information about the current user 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 &quot;message&quot; if the current user has pending messages groups    - lists all the groups the current user belongs to                     rights     - lists of all rights the current user has 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 Values (separate with '|'): blockinfo, hasmsg, groups, rights, options, editcount, ratelimits Examples: <a href="api.php?action=query&amp;meta=userinfo">api.php?action=query&amp;meta=userinfo</a>

<a href="api.php?action=query&amp;meta=userinfo&amp;uiprop=blockinfo|groups|rights|hasmsg">api.php?action=query&amp;meta=userinfo&amp;uiprop=blockinfo|groups|rights|hasmsg</a>

* meta=allmessages (am) * Return messages from this site. Parameters: ammessages    - Which messages to output. &quot;*&quot; means all messages Default: * amfilter      - Return only messages that contain this string amlang        - Return messages in this language Examples: <a href="api.php?action=query&amp;meta=allmessages&amp;amfilter=ipb-">api.php?action=query&amp;meta=allmessages&amp;amfilter=ipb-</a>

<a href="api.php?action=query&amp;meta=allmessages&amp;ammessages=august|mainpage&amp;amlang=de">api.php?action=query&amp;meta=allmessages&amp;ammessages=august|mainpage&amp;amlang=de</a>

*** *** *** *** *** *** *** *** *** *** Modules: continuation  *** *** *** *** *** *** *** *** *** ***

* action=expandtemplates * This module expand all templates in wikitext Parameters: title         - Title of page Default: API text          - Wikitext to convert generatexml   - Generate XML parse tree Example: <a href="api.php?action=expandtemplates&amp;text=">api.php?action=expandtemplates&amp;text=</a>

* action=parse * This module parses wikitext and returns parser output Parameters: title         - Title of page the text belongs to                   Default: API text          - Wikitext to parse page          - Parse the content of this page. Cannot be used together with text and title oldid         - Parse the content of this revision. Overrides page prop          - Which pieces of information to get. NOTE: Section tree is only generated if there are more than 4 sections, or if the keyword is present Values (separate with '|'): text, langlinks, categories, links, templates, images, externallinks, sections, revid Default: text|langlinks|categories|links|templates|images|externallinks|sections|revid Example: <a href="api.php?action=parse&amp;text=">api.php?action=parse&amp;text=</a>

* action=opensearch * This module implements OpenSearch protocol 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, 100, 101, 102, 103, 104, 105 Default: 0 Example: <a href="api.php?action=opensearch&amp;search=Te">api.php?action=opensearch&amp;search=Te</a>

* action=feedwatchlist * This module returns a watchlist feed 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. Example: <a href="api.php?action=feedwatchlist">api.php?action=feedwatchlist</a>

* action=help * Display this help screen.

* action=paraminfo * Obtain information about certain API parameters Parameters: modules       - List of module names (value of the action= parameter) querymodules  - List of query module names (value of prop=, meta= or list= parameter) Example: <a href="api.php?action=paraminfo&amp;modules=parse&amp;querymodules=allpages|siteinfo">api.php?action=paraminfo&amp;modules=parse&amp;querymodules=allpages|siteinfo</a>

*** *** *** *** *** *** *** *** *** *** Formats  *** *** *** *** *** *** *** *** *** ***

* format=json * Output data in JSON format Parameters: callback      - If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted. Example: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=json">api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=json</a>

* format=jsonfm * Output data in JSON format (pretty-print in HTML) Parameters: callback      - If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted. Example: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=jsonfm">api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=jsonfm</a>

* format=php * Output data in serialized PHP format Example: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=php">api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=php</a>

* format=phpfm * Output data in serialized PHP format (pretty-print in HTML) Example: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=phpfm">api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=phpfm</a>

* format=wddx * Output data in WDDX format Example: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=wddx">api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=wddx</a>

* format=wddxfm * Output data in WDDX format (pretty-print in HTML) Example: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=wddxfm">api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=wddxfm</a>

* format=xml * Output data in XML format Parameters: xmldoublequote - If specified, double quotes all attributes and content. Example: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=xml">api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=xml</a>

* format=xmlfm * Output data in XML format (pretty-print in HTML) Parameters: xmldoublequote - If specified, double quotes all attributes and content. Example: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=xmlfm">api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=xmlfm</a>

* format=yaml * Output data in YAML format Example: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=yaml">api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=yaml</a>

* format=yamlfm * Output data in YAML format (pretty-print in HTML) Example: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=yamlfm">api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=yamlfm</a>

* format=rawfm * Output data with the debuging elements in JSON format (pretty-print in HTML) Parameters: callback      - If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted. Example: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=rawfm">api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=rawfm</a>

* format=txt * Output data in PHP's print_r format Example: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=txt">api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=txt</a>

* format=txtfm * Output data in PHP's print_r format (pretty-print in HTML) Example: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=txtfm">api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=txtfm</a>

* format=dbg * Output data in PHP's var_export format Example: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=dbg">api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=dbg</a>

* format=dbgfm * Output data in PHP's var_export format (pretty-print in HTML) Example: <a href="api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=dbgfm">api.php?action=query&amp;meta=siteinfo&amp;siprop=namespaces&amp;format=dbgfm</a>

*** Credits: *** API developers: Roan Kattouw &lt;Firstname&gt;.&lt;Lastname&gt;@home.nl (lead developer Sep 2007-present) Victor Vasiliev - vasilvv at gee mail dot com Yuri Astrakhan &lt;Firstname&gt;&lt;Lastname&gt;@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 <a href="http://bugzilla.wikimedia.org/">http://bugzilla.wikimedia.org/</a>

&lt;/error&gt; &lt;/api&gt;