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=revisions (rv)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- Licence: GPL-2.0-or-later
Get revision information.
May be used in several ways:
- Get data about a set of pages (last revision), by setting titles or pageids.
- Get revisions for one given page, by using titles or pageids with start, end, or limit.
- Get data about a set of revisions by setting their IDs with revids.
- rvprop
Which properties to get for each revision:
- ids
- The ID of the revision.
- flags
- Revision flags (minor).
- timestamp
- The timestamp of the revision.
- user
- User that made the revision. If the user has been revision deleted, a userhidden property will be returned.
- userid
- User ID of the revision creator. If the user has been revision deleted, a userhidden property will be returned.
- size
- Length (bytes) of the revision.
- slotsize
- Length (bytes) of each revision slot.
- sha1
- SHA-1 (base 16) of the revision. If the content has been revision deleted, a sha1hidden property will be returned.
- slotsha1
- SHA-1 (base 16) of each revision slot. If the content has been revision deleted, a sha1hidden property will be returned.
- contentmodel
- Content model ID of each revision slot.
- comment
- Comment by the user for the revision. If the comment has been revision deleted, a commenthidden property will be returned.
- parsedcomment
- Parsed comment by the user for the revision. If the comment has been revision deleted, a commenthidden property will be returned.
- content
- Content of each revision slot. If the content has been revision deleted, a texthidden property will be returned.
- tags
- Tags for the revision.
- roles
- List content slot roles that exist in the revision.
- parsetree
- Deprecated. Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model
wikitext).
- Values (separate with | or alternative): comment, content, contentmodel, flags, ids, parsedcomment, roles, sha1, size, slotsha1, slotsize, tags, timestamp, user, userid, parsetree
- Default: ids|timestamp|flags|comment|user
- rvslots
Which revision slots to return data for, when slot-related properties are included in rvprops. If omitted, data from the main slot will be returned in a backwards-compatible format.
- Values (separate with | or alternative): main
- To specify all values, use *.
- rvcontentformat-{slot}
Content serialization format used for output of content.
- This is a templated parameter. When making the request, {slot} in the parameter's name should be replaced with values of rvslots.
- One of the following values: application/json, application/octet-stream, application/unknown, application/x-binary, less, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
- rvlimit
Limit how many revisions will be returned.
- May only be used with a single page (mode #2).
- Type: integer or max
- The value must be between 1 and 500.
- rvexpandtemplates
- Deprecated.
Use action=expandtemplates instead. Expand templates in revision content (requires rvprop=content).
- Type: boolean (details)
- rvgeneratexml
- Deprecated.
Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires rvprop=content).
- Type: boolean (details)
- rvparse
- Deprecated.
Use action=parse instead. Parse revision content (requires rvprop=content). For performance reasons, if this option is used, rvlimit is enforced to 1.
- Type: boolean (details)
- rvsection
Only retrieve the content of the section with this identifier.
- rvdiffto
- Deprecated.
Use action=compare instead. Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.
- rvdifftotext
- Deprecated.
Use action=compare instead. Text to diff each revision to. Only diffs a limited number of revisions. Overrides rvdiffto. If rvsection is set, only that section will be diffed against this text.
- rvdifftotextpst
- Deprecated.
Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with rvdifftotext.
- Type: boolean (details)
- rvcontentformat
- Deprecated.
Serialisation format used for rvdifftotext and expected for output of content.
- One of the following values: application/json, application/octet-stream, application/unknown, application/x-binary, less, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
- rvstartid
Start enumeration from this revision's timestamp. The revision must exist, but need not belong to this page.
- May only be used with a single page (mode #2).
- Type: integer
- rvendid
Stop enumeration at this revision's timestamp. The revision must exist, but need not belong to this page.
- May only be used with a single page (mode #2).
- Type: integer
- rvstart
From which revision timestamp to start enumeration.
- May only be used with a single page (mode #2).
- Type: timestamp (allowed formats)
- rvend
Enumerate up to this timestamp.
- May only be used with a single page (mode #2).
- Type: timestamp (allowed formats)
- rvdir
In which direction to enumerate:
- newer
- List oldest first. Note: rvstart has to be before rvend.
- older
- List newest first (default). Note: rvstart has to be later than rvend.
- May only be used with a single page (mode #2).
- One of the following values: newer, older
- Default: older
- rvuser
Only include revisions made by user.
- May only be used with a single page (mode #2).
- Type: user, by any of username, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
- rvexcludeuser
Exclude revisions made by user.
- May only be used with a single page (mode #2).
- Type: user, by any of username, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
- rvtag
Only list revisions tagged with this tag.
- rvcontinue
When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.
- Get data with content for the last revision of titles API and Main Page.
- api.php?action=query&prop=revisions&titles=API|Main%20Page&rvslots=*&rvprop=timestamp|user|comment|content [open in sandbox]
- Get last 5 revisions of the Main Page.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment [open in sandbox]
- 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 [open in sandbox]
- 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=2006-05-01T00:00:00Z [open in sandbox]
- Get first 5 revisions of the Main Page that were not 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 [open in sandbox]
- 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 [open in sandbox]