MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
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.
- 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
- Gives the text returned by EditFormPreloadText.
- 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.
- Values (separate with | or alternative): displaytitle, notificationtimestamp, preload, protection, subjectid, talkid, url, varianttitles, visitingwatchers, watched, watchers, readable
- 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 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
- intoken
- Deprecated.
Use action=query&meta=tokens instead.
- Values (separate with | or alternative): block, delete, edit, email, import, move, protect, unblock, watch
- incontinue
When more results are available, use this to continue.
- Get information about the page Main Page.
- api.php?action=query&prop=info&titles=Main%20Page [open in sandbox]
- Get general and protection information about the page Main Page.
- api.php?action=query&prop=info&inprop=protection&titles=Main%20Page [open in sandbox]
list=categorymembers (cm)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0-or-later
List all pages in a given category.
- cmtitle
Which category to enumerate (required). Must include the Luokka: prefix. Cannot be used together with cmpageid.
- cmpageid
Page ID of the category to enumerate. Cannot be used together with cmtitle.
- Type: integer
- cmprop
Which 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 | or alternative): ids, sortkey, sortkeyprefix, timestamp, title, type
- Default: ids|title
- cmnamespace
Only include pages in these namespaces. Note that cmtype=subcat or cmtype=file may be used instead of cmnamespace=14 or 6.
- Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303, 3000, 3001
- To specify all values, use *.
- cmtype
Which type of category members to include. Ignored when cmsort=timestamp is set.
- Values (separate with | or alternative): file, page, subcat
- Default: page|subcat|file
- cmcontinue
When more results are available, use this to continue.
- cmlimit
The maximum number of pages to return.
- Type: integer or max
- The value must be between 1 and 500.
- Default: 10
- cmsort
Property to sort by.
- One of the following values: sortkey, timestamp
- Default: sortkey
- cmdir
In which direction to sort.
- One of the following values: asc, ascending, desc, descending, newer, older
- Default: ascending
- cmstart
Timestamp to start listing from. Can only be used with cmsort=timestamp.
- Type: timestamp (allowed formats)
- cmend
Timestamp to end listing at. Can only be used with cmsort=timestamp.
- Type: timestamp (allowed formats)
- cmstarthexsortkey
Sortkey to start listing from, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.
- cmendhexsortkey
Sortkey to end listing at, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.
- cmstartsortkeyprefix
Sortkey prefix to start listing from. Can only be used with cmsort=sortkey. Overrides cmstarthexsortkey.
- cmendsortkeyprefix
Sortkey prefix to end listing before (not at; if this value occurs it will not be included!). Can only be used with cmsort=sortkey. Overrides cmendhexsortkey.
- cmstartsortkey
- Deprecated.
Use cmstarthexsortkey instead.
- cmendsortkey
- Deprecated.
Use cmendhexsortkey instead.
- Get first 10 pages in Category:Physics.
- api.php?action=query&list=categorymembers&cmtitle=Category:Physics [open in sandbox]
- Get page info about first 10 pages in Category:Physics.
- api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info [open in sandbox]