API:Info
| MediaWiki Action API |
|---|
| Basics |
| Authentication |
| Accounts and Users |
| Page Operations |
|
| Search |
| Developer Utilities |
| Tutorials |
| v · d · e |
GET request to display basic information about the given page(s).
API documentation
[edit ]prop=info (in)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0-or-later
Get basic page information.
- inprop
Which additional properties to get:
- protection
- List the protection level of each page.
- talkid
- The page ID of the talk page for each non-talk page.
- watched
- List the watched status of each page.
- watchers
- The number of watchers, if allowed.
- visitingwatchers
- The number of watchers of each page who have visited recent edits to that page, if allowed.
- notificationtimestamp
- The watchlist notification timestamp of each page.
- subjectid
- The page ID of the parent page for each talk page.
- associatedpage
- The prefixed title of the associated subject or talk page.
- url
- Gives a full URL, an edit URL, and the canonical URL for each page.
- readable
- Deprecated. Whether the user can read this page. Use intestactions=read instead.
- preload
- Deprecated. Gives the text returned by EditFormPreloadText. Use preloadcontent instead, which supports other kinds of preloaded text too.
- preloadcontent
- Gives the content to be shown in the editor when the page does not exist or while adding a new section.
- editintro
- Gives the intro messages that should be shown to the user while editing this page or revision, as HTML.
- displaytitle
- Gives the manner in which the page title is actually displayed.
- varianttitles
- Gives the display title in all variants of the site content language.
- linkclasses
- Gives the additional CSS classes (e.g. link colors) used for links to this page if they were to appear on the page named by inlinkcontext.
- Values (separate with | or alternative): associatedpage, displaytitle, editintro, linkclasses, notificationtimestamp, preloadcontent, protection, subjectid, talkid, url, varianttitles, visitingwatchers, watched, watchers, preload, readable
- inlinkcontext
The context title to use when determining extra CSS classes (e.g. link colors) when inprop contains linkclasses.
- Type: page title
- Accepts non-existent pages.
- Default: MediaWiki
- intestactions
Test whether the current user can perform certain actions on the page.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- intestactionsdetail
Detail level for intestactions. Use the main module's errorformat and errorlang parameters to control the format of the messages returned.
- boolean
- Return a boolean value for each action.
- full
- Return messages describing why the action is disallowed, or an empty array if it is allowed.
- quick
- Like full but skipping expensive checks.
- One of the following values: boolean, full, quick
- Default: boolean
- intestactionsautocreate
Test whether performing intestactions would automatically create a temporary account.
- Type: boolean (details)
- inpreloadcustom
Title of a custom page to use as preloaded content.
- Only used when inprop contains preloadcontent.
- inpreloadparams
Parameters for the custom page being used as preloaded content.
- Only used when inprop contains preloadcontent.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- inpreloadnewsection
Return preloaded content for a new section on the page, rather than a new page.
- Only used when inprop contains preloadcontent.
- Type: boolean (details)
- ineditintrostyle
Some intro messages come with optional wrapper frames. Use moreframes to include them or lessframes to omit them.
- Only used when inprop contains editintro.
- One of the following values: lessframes, moreframes
- Default: moreframes
- ineditintroskip
List of intro messages to remove from the response. Use this if a specific message is not relevant to your tool, or if the information is conveyed in a different way.
- Only used when inprop contains editintro.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- ineditintrocustom
Title of a custom page to use as an additional intro message.
- Only used when inprop contains editintro.
- incontinue
When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.
- Get information about the page MediaWiki.
- api.php?action=query&prop=info&titles=MediaWiki [open in sandbox]
- Get general and protection information about the page MediaWiki.
- api.php?action=query&prop=info&inprop=protection&titles=MediaWiki [open in sandbox]
Example
[edit ]GET request
[edit ]Response
[edit ]{ "batchcomplete":"", "query":{ "pages":{ "736":{ "pageid":736, "ns":0, "title":"Albert Einstein", "contentmodel":"wikitext", "pagelanguage":"en", "pagelanguagehtmlcode":"en", "pagelanguagedir":"ltr", "touched":"2018年12月13日T11:58:27Z", "lastrevid":873382746, "length":154728, "talkid":21091085, "fullurl":"https://en.wikipedia.org/wiki/Albert_Einstein", "editurl":"https://en.wikipedia.org/w/index.php?title=Albert_Einstein&action=edit", "canonicalurl":"https://en.wikipedia.org/wiki/Albert_Einstein" } } } }
Sample code
[edit ]Python
[edit ]#!/usr/bin/python3 """ get_info.py MediaWiki API Demos Demo of `Info` module: Send a GET request to display information about a page. MIT License """ importrequests S = requests.Session() URL = "https://en.wikipedia.org/w/api.php" PARAMS = { "action": "query", "format": "json", "titles": "Albert Einstein", "prop": "info", "inprop": "url|talkid" } R = S.get(url=URL, params=PARAMS) DATA = R.json() PAGES = DATA["query"]["pages"] for k, v in PAGES.items(): print(v["title"] + " has " + str(v["length"]) + " bytes.")
PHP
[edit ]<?php /* get_info.php MediaWiki API Demos Demo of `Info` module: Send a GET request to display information about a page. MIT License */ $endPoint = "https://en.wikipedia.org/w/api.php"; $params = [ "action" => "query", "format" => "json", "titles" => "Albert Einstein", "prop" => "info", "inprop" => "url|talkid" ]; $url = $endPoint . "?" . http_build_query( $params ); $ch = curl_init( $url ); curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true ); $output = curl_exec( $ch ); curl_close( $ch ); $result = json_decode( $output, true ); foreach( $result["query"]["pages"] as $k => $v ) { echo( $v["title"] . " has " . $v["length"] . " bytes." . "\n" ); }
JavaScript
[edit ]/* get_info.js MediaWiki API Demos Demo of `Info` module: Send a GET request to display information about a page. MIT License */ varurl="https://en.wikipedia.org/w/api.php"; varparams={ action:"query", format:"json", titles:"Albert Einstein", prop:"info", inprop:"url|talkid" }; url=url+"?origin=*"; Object.keys(params).forEach(function(key){url+="&"+key+"="+params[key];}); fetch(url) .then(function(response){returnresponse.json();}) .then(function(response){ varpages=response.query.pages; for(varpinpages){ console.log(pages[p].title+" has "+pages[p].length+" bytes."); } }) .catch(function(error){console.log(error);});
MediaWiki JS
[edit ]/* get_info.js MediaWiki API Demos Demo of `Info` module: Send a GET request to display information about a page. MIT License */ varparams={ action:'query', format:'json', titles:'Albert Einstein', prop:'info', inprop:'url|talkid' }, api=newmw.Api(); api.get(params).done(function(data){ varpages=data.query.pages, p; for(pinpages){ console.log(pages[p].title+' has '+pages[p].length+' bytes.'); } });
Parameter history
[edit ]- v1.41: Deprecated
preload - v1.32: Deprecated
readable - v1.27: Introduced
visitingwatchers - v1.25: Introduced
intestactions - v1.24: Deprecated
intoken - v1.21: Introduced
watchers - v1.20: Introduced
notificationtimestamp - v1.17: Introduced
displaytitle - v1.16: Introduced
watched,preload - v1.14: Introduced
url,readable - v1.13: Introduced
talkid,subjectid - v1.11: Introduced
inprop,protection,intoken
Additional notes
[edit ]- Pages in the special page namespace, such as Watchlist , are not supported.
- This page covers the
listmodule,info. Please see the Parameters to index page if you are seeking details onaction=info.
See also
[edit ]- Action=info - a separate module used by MediaWiki's own Page information tool; much of the information it returns overlaps this module.
- API:Pageterms displays any Wikidata terms, such as labels or descriptions, associated with a page. See the Wikidata site for more information on this special class of information.
- API:Imageinfo - displays information specific to image files
- API:Stashimageinfo - displays information about stashed image files
- API:Categoryinfo - displays information about categories, such as number of pages
- API:Users - displays information about a list of users, such as their group membership or edit count
- API:Parameter information - an API about other APIs, showing information about API parameters