API:Query - Properties

From MediaWiki.org

Properties are used to get various data about a list of pages specified with either the titles=, pageids=, or revids= parameters, or by using generators.

Contents 1 info / in 1.1 Parameters 1.2 Example 1.3 Possible warnings 1.4 Possible errors 2 revisions / rv 2.1 Parameters 2.2 Example 2.3 Possible warnings 2.4 Possible errors 3 categories / cl 3.1 Parameters 3.2 Example 3.3 Possible errors 4 imageinfo / ii 4.1 Parameters 4.2 Example 5 langlinks / ll 5.1 Parameters 5.2 Example 5.3 Possible errors 6 links / pl 6.1 Parameters 6.2 Example 6.3 Possible errors 7 templates / tl 7.1 Parameters 7.2 Example 7.3 Possible errors 8 images / im 8.1 Parameters 8.2 Example 8.3 Possible errors 9 extlinks / el 9.1 Parameters 9.2 Example 9.3 Possible errors 10 categoryinfo / ci 10.1 Parameters 10.2 Example 10.3 Possible errors 11 duplicatefiles / df 11.1 Parameters 11.2 Example 11.3 Possible errors

[edit] info / in

MediaWiki version:

1.9

Gets basic page information

[edit] Parameters

• inprop: Which properties to get
  • protection: The protection level
  • talkid: The page ID of the talk page for each non-talk page
  • subjectid: The page ID of the parent page for each talk page
  • By default, the following properties will be listed:
    • page ID (pageid)
    • namespace (ns)
    • title (title)
    • last touched timestamp (touched)
    • last revision ID (lastrevid)
    • number of views (counter)
    • page size (length)
    • whether the page is a redirect (redirect)
    • whether the page has only one revision (new)
• intoken: Get a token to allow page modification

[edit] Example

[edit] Possible warnings

• Action 'action' is not allowed for the current user
  • Thrown when a token is requested that the current user isn't allowed to use

[edit] Possible errors

None

[edit] revisions / rv

MediaWiki version:

1.8

Returns revisions for a given page, or the latest revision for each of several pages. When using parameters marked as (enum), titles= must have only one title listed.

[edit] Parameters

• rvprop: Which properties to get for each revision
  • ids: Revision ID (default)
  • flags: Whether the revision was a minor edit (default)
  • timestamp: The date and time the revision was made (default)
  • user: The user who made the revision (default)
  • comment: The edit comment (default)
  • size: The size of the revision text in bytes
  • content: The revision content. If set, the maximum limit will be 10 times as low
• rvlimit: The maximum number of revisions to return (enum)
• rvstartid: Revision ID to start listing from. (enum)
• rvendid: Revision ID to stop listing at. (enum)
• rvstart: Timestamp to start listing from. (enum)
• rvend: Timestamp to end listing at. (enum)
• rvdir: Direction to list in. (enum)
  • older: List newest revisions first (default). NOTE: rvstart/rvstartid has to be higher than rvend/rvendid
  • newer: List oldest revisions first. NOTE: rvstart/rvstartid has to be lower than rvend/rvendid
• rvuser: Only list revisions made by this user
• rvexcludeuser: Do not list revisions made by this user
• rvexpandtemplates: Expand templates in rvprop=content output
• rvsection: If rvprop=content is set, only retrieve the contents of this section. NOTE: Only implemented in MediaWiki versions 1.13 and above.
• rvtoken: Tokens to get for each revision
  • rollback: Rollback token

[edit] Example

[edit] Possible warnings

• Action 'action' is not allowed for the current user
  • Thrown when a token is requested that the current user isn't allowed to use

[edit] Possible errors

• code: rvrevids
  • info: The revids= parameter may not be used with the list options (limit, startid, endid, dirNewer, start, end).
• code: rvmultpages
  • info: titles, pageids or a generator was used to supply multiple pages, but the limit, startid, endid, dirNewer, user, excludeuser, start and end parameters may only be used on a single page.
• code: rvaccessdenied
  • info: The current user is not allowed to read title
• code: rvbadparams
  • info: start and startid cannot be used together
• code: rvbadparams
  • info: end and endid cannot be used together
• code: rvbadparams
  • info: user and excludeuser cannot be used together
• code: rvnosuchsection
  • info: There is no section section in rrevid

[edit] categories / cl

MediaWiki version:

1.11

Gets a list of all categories used on the provided pages. This module can be used as a generator.

[edit] Parameters

• clprop: Which properties to get (cannot be used with a generator)
  • sortkey: The sort key
  • timestamp: The date and time the page was added to the category, or the date and time its sortkey was changed last
• clshow: Which kinds of categories to list. Conflicting options (such as hidden and !hidden) cannot be used together.
  • hidden: Only list hidden categories
  • !hidden: Don't list hidden categories
• cllimit: Maximum number of results to return
• clcontinue: When more results are available, use this to continue

[edit] Example

[edit] Possible errors

• code: clshow
  • info: Incorrect parameter - mutually exclusive values may not be supplied

[edit] imageinfo / ii

MediaWiki version:

1.11

Gets image information for any titles in the image namespace

[edit] Parameters

• iiprop: Which properties to get
  • timestamp: The time and date of the revision (default)
  • user: The user who made the revision (default)
  • comment: The edit comment
  • url: URL of the image
  • size: The image's size in bytes, plus width and height
  • sha1: The image's SHA-1 hash
  • mime: The image's MIME type
  • metadata: Image metadata, if available
  • archivename: Archive name (old images only)
• iilimit: How many image revisions to return (1 by default)
• 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 as well. Old versions of images can't be scaled
• iiurlheight: Similar to iiurlwidth

[edit] Example

[edit] langlinks / ll

MediaWiki version:

1.9

Gets a list of all language links from the provided pages to other languages.

Only returns language links for 50 titles

[edit] Parameters

None

[edit] Example

[edit] Possible errors

None

[edit] links / pl

MediaWiki version:

1.9

Gets a list of all links on the provided pages. This module can be used as a generator.

[edit] Parameters

• plnamespace: Only list links to pages in these namespaces

[edit] Example

[edit] Possible errors

None

[edit] templates / tl

MediaWiki version:

1.9

Gets a list of all pages included in the provided pages. This module can be used as a generator.

[edit] Parameters

• tlnamespace: Only list pages in these namespaces

[edit] Example

[edit] Possible errors

None.

[edit] images / im

MediaWiki version:

1.9

In Query API interface, this command found pages that embedded the given image. That function has been renamed to imageusage.

Gets a list of all images used on the provided pages. This module can be used as a generator.

[edit] Parameters

None.

[edit] Example

[edit] Possible errors

None.

[edit] extlinks / el

MediaWiki version:

1.11

Gets a list of all external links on the provided pages

[edit] Parameters

None.

[edit] Example

[edit] Possible errors

None.

[edit] categoryinfo / ci

MediaWiki version:

1.13

Gets information about categories

[edit] Parameters

None

[edit] Example

[edit] Possible errors

None

[edit] duplicatefiles / df

MediaWiki version:

1.14

List duplicates of the given files.

[edit] Parameters

• dflimit: How many duplicates to list
• dfcontinue: When more results are available, use this to continue

[edit] Example

[edit] Possible errors

None.