<?xml version="1.0" encoding="utf-8"?> <api> <error code="siunknown_siprop" info="Unrecognised value for parameter 'siprop'"> ****************************************************************** ** ** ** 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 & 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 Default: xmlfm action - What action you would like to perform One value: login, query, opensearch, feedwatchlist, help Default: help version - When showing help, include version for each module *** *** *** *** *** *** *** *** *** *** 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 60 seconds. This is to prevent password guessing by automated password crackers. Parameters: lgname - User Name lgpassword - Password lgdomain - Domain (optional) Example: api.php?action=login&lgname=user&lgpassword=password * 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 list - Which lists to get Values (separate with '|'): allpages, alllinks, allusers, backlinks, categorymembers, embeddedin, imageusage, logevents, recentchanges, search, usercontribs, watchlist, exturlusage meta - Which meta data to get about the site Values (separate with '|'): siteinfo, userinfo generator - Use the output of a list as the input for other prop/list/meta items One value: links, images, templates, categories, allpages, alllinks, backlinks, categorymembers, embeddedin, imageusage, search, watchlist, exturlusage redirects - Automatically resolve redirects indexpageids - Include an additional pageids section listing all returned page IDs. Example: api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&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: "protection" - List the protection level of each page Values (separate with '|'): protection intoken - Request a token to perform a data-modifying action on a page Values (separate with '|'): edit, delete, protect, move 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). 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 50 (500 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 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) 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, 106, 107 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=langlinks (ll) * Returns all interlanguage links from the given page(s) 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) 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 Parameters: iiprop - What image information to get. Values (separate with '|'): timestamp, user, comment, url, size, sha1 Default: timestamp|user iihistory - Include upload history Examples: api.php?action=query&titles=Image:Albert%20Einstein%20Head.jpg&prop=imageinfo api.php?action=query&titles=Image:Test.jpg&prop=imageinfo&iihistory&iiprop=timestamp|user|url * 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, 106, 107 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 Parameters: clprop - Which additional properties to get for each category. Values (separate with '|'): sortkey 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) Examples: Get a list of external links on the [[Main Page]]: api.php?action=query&prop=extlinks&titles=Main%20Page --- --- --- --- --- --- --- --- Query: List --- --- --- --- --- --- --- --- * 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, 106, 107 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 One value: edit, move apprlevel - The protection level (must be used with apprtype= parameter) Can be empty, or One value: autoconfirmed, sysop aplimit - How many total pages to return. No more than 500 (5000 for bots) allowed. Default: 10 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 Parameters: 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, 106, 107 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=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, nsinternRW, nsinternRO, nsintern_DiskussionRW, nsintern_DiskussionRO, nsMetaRW, nsMetaRO, nsMeta_DiskussionRW, nsMeta_DiskussionRO, nsOrtsgruppeRW, nsOrtsgruppeRO, nsOrtsgruppe_DiskussionRW, nsOrtsgruppe_DiskussionRO, nsBenutzerinRW, nsBenutzerinRO, nsBenutzerin_DiskussionRW, nsBenutzerin_DiskussionRO, editor, reviewer auprop - What pieces of information to include. `groups` property uses more server resources and may return fewer results than the limit. Values (separate with '|'): editcount, groups aulimit - How many total user names to return. No more than 500 (5000 for bots) allowed. Default: 10 Example: api.php?action=query&list=allusers&aufrom=Y * 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, 106, 107 blfilterredir - How to filter for redirects One value: all, redirects, nonredirects Default: all blredirect - If linking page is a redirect, find all pages that link to that redirect (not implemented) bllimit - How many total pages to return. No more than 500 (5000 for bots) allowed. Default: 10 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=categorymembers (cm) * List all pages in a given category Parameters: cmcategory - Which category to enumerate (required) 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, 106, 107 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 Examples: Get first 10 pages in the categories [[Physics]]: api.php?action=query&list=categorymembers&cmcategory=Physics Get page info about first 10 pages in the categories [[Physics]]: api.php?action=query&generator=categorymembers&gcmcategory=Physics&prop=info Generator: This module may be used as a generator * 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, 106, 107 eifilterredir - How to filter for redirects One value: all, redirects, nonredirects Default: all eiredirect - If linking page is a redirect, find all pages that link to that redirect (not implemented) 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=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, 106, 107 iufilterredir - How to filter for redirects One value: all, redirects, nonredirects Default: all iuredirect - If linking page is a redirect, find all pages that link to that redirect (not implemented) iulimit - How many total pages to return. No more than 500 (5000 for bots) allowed. Default: 10 Examples: api.php?action=query&list=imageusage&iutitle=Image:Albert%20Einstein%20Head.jpg api.php?action=query&generator=imageusage&giutitle=Image:Albert%20Einstein%20Head.jpg&prop=info Generator: This module may be used as a generator * list=logevents (le) * Get events from logs. Parameters: leprop - 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 Values (separate with '|'): block, protect, rights, delete, upload, move, import, patrol, usermerge, review, stable 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: api.php?action=query&list=logevents * 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, 106, 107 rcprop - Include additional pieces of information Values (separate with '|'): user, comment, flags, timestamp, title, ids, sizes 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 rclimit - How many total pages to return. No more than 500 (5000 for bots) allowed. Default: 10 Example: api.php?action=query&list=recentchanges * 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, 106, 107 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: 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=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. 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, 106, 107 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 Example: api.php?action=query&list=usercontribs&ucuser=YurikBot * list=watchlist (wl) * 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, 106, 107 wldir - In which direction to enumerate pages. One value: newer, older Default: older wllimit - How many total pages 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 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 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 "continue" euprotocol - Protocol of the url One value: http, https, ftp, irc, gopher, telnet, nntp, worldwind, mailto, news Default: http euquery - Search string without protocol. See [[Special:LinkSearch]] 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, 106, 107 eulimit - How many entries 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 --- --- --- --- --- --- --- --- Query: Meta --- --- --- --- --- --- --- --- * meta=siteinfo (si) * Return general information about the site. Parameters: siprop - Which sysinfo properties to get: "general" - Overall system information "namespaces" - List of registered namespaces (localized) "statistics" - Returns site statistics "interwikimap" - Returns interwiki map (optionally filtered) "dbrepllag" - Returns database server with the highest replication lag Values (separate with '|'): general, namespaces, interwikimap, dbrepllag, statistics 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: api.php?action=query&meta=siteinfo&siprop=general|namespaces|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 Parameters: uiprop - What pieces of information to include blockinfo - tags if the user is blocked, by whom, and for what reason hasmsg - adds a tag "message" if user has pending messages groups - lists all the groups the current user belongs to rights - lists of all rights the current user has Values (separate with '|'): blockinfo, hasmsg, groups, rights uioption - A list of user preference options to get Examples: api.php?action=query&meta=userinfo api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg api.php?action=query&meta=userinfo&uioption=rememberpassword * action=opensearch * This module implements OpenSearch protocol Parameters: search - Search string Example: api.php?action=opensearch&search=Te * 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 Example: api.php?action=feedwatchlist * action=help * Display this help screen. *** *** *** *** *** *** *** *** *** *** 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: api.php?action=query&meta=siteinfo&siprop=namespaces&format=json * 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: api.php?action=query&meta=siteinfo&siprop=namespaces&format=jsonfm * format=php * Output data in serialized PHP format Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=php * format=phpfm * Output data in serialized PHP format (pretty-print in HTML) Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=phpfm * format=wddx * Output data in WDDX format Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=wddx * format=wddxfm * Output data in WDDX format (pretty-print in HTML) Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=wddxfm * format=xml * Output data in XML format Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=xml * format=xmlfm * Output data in XML format (pretty-print in HTML) Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=xmlfm * format=yaml * Output data in YAML format Example: api.php?action=query&meta=siteinfo&siprop=namespaces&format=yaml * format=yamlfm * Output data in YAML format (pretty-print in HTML) 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) 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 *** Credits: *** This API is being implemented by Yuri Astrakhan [[User:Yurik]] / <Firstname><Lastname>@gmail.com Please leave your comments and suggestions at http://www.mediawiki.org/wiki/API </error> </api>