This API provides cacheable and straightforward access to Wikimedia content and data, in machine-readable formats.
User-Agent
or Api-User-Agent
header that
allows us to contact you quickly. Email addresses or URLs
of contact pages work well.By using this API, you agree to Wikimedia's Terms of Use and Privacy Policy. Unless otherwise specified in the endpoint documentation below, content accessed via this API is licensed under the CC-BY-SA 3.0 and GFDL licenses, and you irrevocably agree to release modifications or additions made through this API under these licenses. See https://www.mediawiki.org/wiki/REST_API for background and details.
Please consult each endpoint's documentation for details on:
generation of citation data
Generates citation data given a URL, DOI, PMID, ISBN, or PMCID.
See more at Citoid service documentation
The citation data can be requested in one of the following formats:
mediawiki
: format designed for MediaWiki to be used with templateData
.
Uses Zotero field names.mediawiki-basefields
: mediawiki
format with Zotero basefield
field names.zotero
: format used by Zotero.bibtex
: format used in conjunction with LaTeX documents.
See bibtex.org.wikibase
: format designed for Wikibase.Stability: unstable
Name | Data Type | Description |
---|---|---|
query
|
string |
URL of an article, DOI, ISBN, PMCID or PMID in the URL-encoded format. Note that on the Swagger-UI doc page you don't need to URI-encode the parameter manually, it will be done by the docs engine. |
format
|
string Allowed values: - mediawiki - mediawiki-basefields - zotero - bibtex - wikibase |
The format to use for the resulting citation data |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
For some articles the result depends on the |
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
result | ||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
aggregated daily featured content
Gets announcements for display in the official Wikipedia iOS and Android apps.
Stability: experimental
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
announcementsResponse | |||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Provides the aggregated feed content for the given date. The endpoint returns the featured article of the day, most read articles for the previous day, news content and the featured image and video of the day.
Stability: unstable
Name | Data Type | Description |
---|---|---|
dd
|
string |
Day of the month the aggregated content is requested for, 0-padded |
mm
|
string |
Month the aggregated content is requested for, 0-padded |
yyyy
|
string |
Year the aggregated content is requested for |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
feed | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Provides events that historically happened on the provided day and month. Supported types of events are:
Stability: experimental
Name | Data Type | Description |
---|---|---|
dd
|
string |
Day of the month events are requested for, 0-padded |
mm
|
string |
Month events are requested for, 0-padded |
type
|
string Allowed values: - all - selected - births - deaths - events - holidays |
Type of events |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
onthisdayResponse | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
formula rendering
Checks the supplied TeX formula for correctness and returns the
normalised formula representation as well as information about
identifiers. Available types are tex and inline-tex. The response
contains the x-resource-location
header which can be used to retrieve
the render of the checked formula in one of the supported rendering
formats. Just append the value of the header to /media/math/{format}/
and perform a GET request against that URL.
Stability: stable.
Name | Data Type | Description |
---|---|---|
type
|
string Allowed values: - tex - inline-tex - chem |
The input type of the given formula; can be tex or inline-tex |
Name | Data Type | Description |
---|---|---|
|
q
|
string |
The formula to check |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Returns the previously-stored formula via /media/math/check/{type}
for
the given hash.
Stability: stable.
Name | Data Type | Description |
---|---|---|
hash
|
string Minimum: 1 |
The hash string of the previous POST data |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Given a request hash, renders a TeX formula into its mathematic
representation in the given format. When a request is issued to the
/media/math/check/{format}
POST endpoint, the response contains the
x-resource-location
header denoting the hash ID of the POST data. Once
obtained, this endpoint has to be used to obtain the actual render.
Stability: stable.
Name | Data Type | Description |
---|---|---|
hash
|
string Minimum: 1 |
The hash string of the previous POST data |
format
|
string Allowed values: - svg - mml - png |
The output format; can be svg or mml |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
string |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
mobile-friendly page content
Gets common CSS mobile apps need to properly display pages using Page Content Service. In most cases all of the types are needed (preferably in this order):
The first two are the same regardless of what domain is used. For these we suggest meta.wikimedia.org.
Stability: experimental
Name | Data Type | Description |
---|---|---|
type
|
string Allowed values: - base - pagelib - site |
The desired CSS bundle |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Different values indicate that the content has changed |
Name | Data Type | Description |
---|---|---|
|
object |
Gets the javascript bundle from the wikimedia-page-library so that clients can have convenient access to that for consuming the content-html HTML. Amongst other things,
Stability: experimental
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Different values indicate that the content has changed |
Name | Data Type | Description |
---|---|---|
|
object |
Gets the javascript that is intended to be run at the end of the body tag to apply settings with the wikimedia-page-library. It reads an object from document.pcsSetupSettings and utilizes it as the parameter for pagelib.c1.Page.setup(). It applies settings that can wait until the document finishes loading to be applied. Alternatively, clients can set a pcsClient variable that returns a JSON string with settings from pcsClient.getSetupSettings().
Stability: experimental
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Different values indicate that the content has changed |
Name | Data Type | Description |
---|---|---|
|
object |
Gets the javascript that is intended to be run at the start of the body tag to apply settings with the wikimedia-page-library. It reads an object from document.pcsSetupSettings and utilizes it as the parameter for pagelib.c1.Page.setup(). It applies settings like margins and theming that need to be applied before the page body starts rendering. It also reads a function that takes a single parameter from document.pcsActionHandler and utilizes it to notify the client of page events. Alternatively, clients can set a pcsClient variable that returns a JSON string with settings from pcsClient.getSetupSettings() and receives a JSON string to pcsClient.onReceiveMessage().
Stability: experimental
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Different values indicate that the content has changed |
Name | Data Type | Description |
---|---|---|
|
object |
Retrieve the lead section of the latest HTML for a page title optimised for viewing with native mobile applications.
Stability: unstable
Name | Data Type | Description |
---|---|---|
revision
|
integer |
Optional page revision. Note that older revisions are not stored, so request latency with the revision would be higher. |
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
The desired language variant code for wikis where LanguageConverter is enabled. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description |
---|---|---|
|
object |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Retrieve the lead section of the latest HTML for a page title optimised for viewing with native mobile applications.
Stability: unstable
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
The desired language variant code for wikis where LanguageConverter is enabled. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description |
---|---|---|
|
object |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Retrieve the remainder of the latest HTML (without the lead section) for a page title optimised for viewing with native mobile applications, provided as a JSON object containing the sections.
Stability: unstable
Name | Data Type | Description |
---|---|---|
revision
|
integer |
Optional page revision. Note that older revisions are not stored, so request latency with the revision would be higher. |
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
The desired language variant code for wikis where LanguageConverter is enabled. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description |
---|---|---|
|
object |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Retrieve the remainder of the latest HTML (without the lead section) for a page title optimised for viewing with native mobile applications, provided as a JSON object containing the sections.
Stability: unstable
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
The desired language variant code for wikis where LanguageConverter is enabled. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description |
---|---|---|
|
object |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Retrieve the latest HTML for a page title optimised for viewing with native mobile applications. Note that the output is split by sections.
Stability: unstable
Name | Data Type | Description |
---|---|---|
revision
|
integer |
Optional page revision. Note that older revisions are not stored, so request latency with the revision would be higher. |
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
The desired language variant code for wikis where LanguageConverter is enabled. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description |
---|---|---|
|
object |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Retrieve the latest HTML for a page title optimised for viewing with native mobile applications. Note that the output is split by sections.
Stability: unstable
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
The desired language variant code for wikis where LanguageConverter is enabled. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description |
---|---|---|
|
object |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
page content in different formats
Stability: stable
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
listing | |||||||||||
Properties
|
Data-parsoid is metadata used by Parsoid to support clean round-tripping conversions between HTML and Wikitext. Among other things, it contains the original Wikitext offsets of each HTML element, keyed by element ID. The format is unstable.
The metadata in data-parsoid is specific to a specific HTML render.
For this reason, you need to supply the exact revision
and tid
as
provided in the ETag
header of the HTML response.
Stability: Stable
Name | Data Type | Description |
---|---|---|
tid
|
string |
The revision's time ID |
revision
|
integer |
The revision |
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Revision / tid: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
data-parsoid | |||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Retrieve PNG graph images embedded in specific revisions of a page. See the Graphoid documentation for details.
Stability: unstable
Name | Data Type | Description |
---|---|---|
graph_id
|
string |
The graph ID, consisting of a hash and the suffix |
revision
|
integer |
The page revision, or 0 for the latest |
title
|
string |
The page title |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
string |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Stability: stable
Name | Data Type | Description |
---|---|---|
revision
|
integer |
The revision |
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
stash
|
boolean |
Whether to temporary stash data-parsoid in order to support transforming the modified content later. If this parameter is set, requests are rate-limited on a per-client basis (max 5 requests per second per client) |
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
The desired language variant code for wikis where LanguageConverter is enabled. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
ETag header indicating the revision and render timeuuid
separated by a slash:
"701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"
This ETag can be passed to the HTML save end point (as
|
Name | Data Type | Description |
---|---|---|
|
string |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Stability: stable
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
stash
|
boolean |
Whether to temporary stash data-parsoid in order to support transforming the modified content later. If this parameter is set, requests are rate-limited on a per-client basis (max 5 requests per second per client) |
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
The desired language variant code for wikis where LanguageConverter is enabled. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
ETag header indicating the revision and render timeuuid
separated by a slash:
"701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"
This ETag can be passed to the HTML save end point (as
|
Name | Data Type | Description |
---|---|---|
|
string |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Save a new revision of a page given in Parsoid HTML format.
For new pages, or when editting the latest revision of a page,
the base_etag
parameter should be left empty. For editing old revisions,
it should contain the ETag
header of the revision the edit is derived from.
The latest page revision ETag header could be provided in the If-Match header to detect edit conflicts. If the new page is created, appropriate user cookies must be provided.
Stability: unstable
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
|
is_bot
|
boolean |
Flag indicating a bot edit. |
is_minor
|
boolean |
Flag indicating a minor change. |
comment
|
string |
Comment summarizing the change. |
csrf_token
|
string |
CSRF edit token provided by the MW API. |
html
|
string |
HTML of the page to save. |
base_etag
|
string |
ETag header of the revision the edit is based on. Should be supplied for all existing pages to ensure clean round-tripping. |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
Name | Data Type | Description |
---|---|---|
ETag
|
string |
ETag header indicating the new revision and timeuuid, separated by a slash: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Stability: experimental
Name | Data Type | Description |
---|---|---|
revision
|
integer |
The revision |
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Stability: experimental
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Gets the list of media items (images, audio, and video) in the order in which they appear on a given wiki page.
Stability: experimental
Name | Data Type | Description |
---|---|---|
revision
|
integer |
Optional page revision. Note that older revisions are not stored, so request latency with the revision would be higher. |
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
media_list | |||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Gets the list of media items (images, audio, and video) in the order in which they appear on a given wiki page.
Stability: experimental
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
media_list | |||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Gets detailed information on the media items (images, audio, and video) in the order in which they appear on a given wiki page.
Stability: experimental
Name | Data Type | Description |
---|---|---|
revision
|
integer |
Optional page revision. Note that older revisions are not stored, so request latency with the revision would be higher. |
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
media_list_with_metadata | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Gets detailed information on the media items (images, audio, and video) in the order in which they appear on a given wiki page.
Stability: experimental
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
media_list_with_metadata | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
revision
|
integer |
Optional page revision. Note that older revisions are not stored, so request latency with the revision would be higher. |
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
metadata | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
metadata | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Gets the content HTML optimized for mobile consumption for the given page. This content
is derived from Parsoid HTML (see /page/html/{title}
endpoint).
The difference to Parsoid HTML is roughly:
What's not included? What parts of the PageLibrary does a client still have to do?
Theme support: Themes can be turned on by adding a theme class to the root tag. Possible class names are:
pagelib_theme_default
pagelib_theme_dark
pagelib_theme_black
pagelib_theme_sepia
The pagelib JS has functionality to do that: ThemeTransform.setTheme(document, theme).
Stability: experimental
Name | Data Type | Description |
---|---|---|
revision
|
integer |
Optional page revision. Note that older revisions are not stored, so request latency with the revision would be higher. |
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description |
---|---|---|
|
string |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Gets the content HTML optimized for mobile consumption for the given page. This content
is derived from Parsoid HTML (see /page/html/{title}
endpoint).
The difference to Parsoid HTML is roughly:
What's not included? What parts of the PageLibrary does a client still have to do?
Theme support: Themes can be turned on by adding a theme class to the root tag. Possible class names are:
pagelib_theme_default
pagelib_theme_dark
pagelib_theme_black
pagelib_theme_sepia
The pagelib JS has functionality to do that: ThemeTransform.setTheme(document, theme).
Stability: experimental
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description |
---|---|---|
|
string |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Renders the page content as PDF. Format and type are optional parameters and the default values are "a4" for format and "desktop" for type.
Stability: experimental
Name | Data Type | Description |
---|---|---|
type
|
string Default value: desktop Allowed values: - mobile - desktop |
PDF type - |
format
|
string Allowed values: - a4 - letter - legal |
PDF format |
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description |
---|---|---|
|
string |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Renders the page content as PDF. Format and type are optional parameters and the default values are "a4" for format and "desktop" for type.
Stability: experimental
Name | Data Type | Description |
---|---|---|
format
|
string Allowed values: - a4 - letter - legal |
PDF format |
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description |
---|---|---|
|
string |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Renders the page content as PDF. Format and type are optional parameters and the default values are "a4" for format and "desktop" for type.
Stability: experimental
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description |
---|---|---|
|
string |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
format
|
string Allowed values: - title - html - summary - related - mobile-sections - mobile-sections-lead |
The desired return format |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
Gets references of a page in a way that makes it easy to look up the details of a reference by id and allow some reference lists to be rebuild.
Stability: experimental
Name | Data Type | Description |
---|---|---|
revision
|
integer |
Optional page revision. Note that older revisions are not stored, so request latency with the revision would be higher. |
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
references_response | ||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Gets references of a page in a way that makes it easy to look up the details of a reference by id and allow some reference lists to be rebuild.
Stability: experimental
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
references_response | ||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Returns summaries for 20 pages related to the given page. Summaries include page title, namespace and id along with short text description of the page and a thumbnail.
Stability: experimental
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
related | |||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Use this end point to fetch the segmented content of a page. Clients should use the returned content in conjunction with the language transform API.
Stability: experimental
Name | Data Type | Description |
---|---|---|
revision
|
integer |
The revision id |
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
segmentedContent
|
string |
The segmented HTML body of the contents of the page |
revision
|
integer |
The revision ID of the segmented page |
title
|
string |
The title of the segmented page returned |
sourceLanguage
|
string |
The source language of the page |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Use this end point to fetch the segmented content of a page. Clients should use the returned content in conjunction with the language transform API.
Stability: experimental
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
segmentedContent
|
string |
The segmented HTML body of the contents of the page |
revision
|
integer |
The revision ID of the segmented page |
title
|
string |
The title of the segmented page returned |
sourceLanguage
|
string |
The source language of the page |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
The summary response includes a text extract of the first several sentences, as well as information about a thumbnail that represents the page.
Stability: stable
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
redirect
|
boolean |
Requests for redirect pages return HTTP 302 with a redirect target in |
Name | Data Type | Description |
---|---|---|
Accept-Language
|
string |
The desired language variant code for wikis where LanguageConverter is enabled. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
summary | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Returns the revision metadata for the given title. If a revision ID is provided, metadata for that revision is returned, otherwise the latest revision ID is assumed.
Stability: stable.
Name | Data Type | Description |
---|---|---|
revision
|
integer |
The revision id |
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
revision | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Returns the revision metadata for the given title. If a revision ID is provided, metadata for that revision is returned, otherwise the latest revision ID is assumed.
Stability: stable.
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
revision | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
For new pages, or when editting the latest revision of a page,
the base_etag
parameter should be left empty.
For editing old revisions, it should contain the ETag header
of the revision the edit is derived from.
The latest page revision ETag header should be provided in the If-Match header to detect edit conflicts. If the new page is created, appropriate user cookies must be provided.
Stability: unstable
Name | Data Type | Description |
---|---|---|
title
|
string |
Page title. Use underscores instead of spaces. Example: |
Name | Data Type | Description |
---|---|---|
|
is_bot
|
boolean |
Whether the change is being made by a bot |
is_minor
|
boolean |
Whether this represents a minor change |
comment
|
string |
The summary of the change |
csrf_token
|
string |
The CRSF edit token provided by the MW API |
wikitext
|
string |
The wikitext source of the page to save |
base_etag
|
string |
The ETag header of the revision the edit is based on. |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
ETag header indicating the new revision and timeuuid, separated by a slash: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc" |
Name | Data Type | Description |
---|---|---|
|
object |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Private lists of selected pages
Returns metadata describing the lists of the current user. Might be truncated and include a continuation token.
Request must be authenticated with a MediaWiki session cookie.
Stability: unstable
Name | Data Type | Description |
---|---|---|
sort
|
string Default value: updated Allowed values: - name - updated |
Sort order
|
next
|
string |
Continuation parameter from previous request |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
continue-from
|
dateTime |
Timestamp to sync from, to be used with the |
|||||||||||||||||||
next
|
string |
Continuation token. |
|||||||||||||||||||
lists
|
array [list_read] | ||||||||||||||||||||
Properties
|
Creates a new empty list. On name conflict, does nothing and returns the data of an existing list.
Request must be authenticated with a MediaWiki session cookie.
Stability: unstable
This endpoint is deprecated and might be removed without warning. Use the batch version instead.
Name | Data Type | Description |
---|---|---|
csrf_token
|
string |
The CRSF edit token provided by the MediaWiki API |
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
list_write | |||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
list
|
list_read | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
id
|
integer |
List ID. Deprecated, will be removed. Use the full list object. Examples:7 |
Name | Data Type | Description |
---|---|---|
csrf_token
|
string |
The CRSF edit token provided by the MediaWiki API |
Name | Data Type | Description |
---|---|---|
batch
|
object |
batch
|
array [list_write] | |||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
list_create_batch
|
object |
lists
|
array [list_read] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
batch
|
array [list_id] |
Deprecated, will be removed. Use the full list objects instead. |
|||||||||||||||||||
Properties
|
Returns metadata describing lists and entries which have changed. Might be truncated and include a continuation token.
Request must be authenticated with a MediaWiki session cookie.
For safe synchronization, the date parameter should be taken from the continue-from
field of a previous GET /lists/
or GET /lists/changes/since/{date}
request. This will
ensure that no changes are skipped, at the cost of sometimes receiving the same change
multitple times. Clients should handle changes in an idempotent way.
Stability: unstable
Name | Data Type | Description |
---|---|---|
date
|
dateTime |
Cutoff date (in ISO 8601). To ensure reliable synchronization, the API might return changes which are slightly older than the cutoff date. |
Name | Data Type | Description |
---|---|---|
next
|
string |
Continuation parameter from previous request |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
continue-from
|
dateTime |
Timestamp to sync from, to be used with the |
|||||||||||||||||||
next
|
string |
Continuation token. |
|||||||||||||||||||
lists
|
array [list_read] | ||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
title
|
string | |
project
|
string |
Name | Data Type | Description |
---|---|---|
next
|
string |
Continuation parameter from previous request |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
next
|
string |
Continuation token. |
|||||||||||||||||||
lists
|
array [list_read] | ||||||||||||||||||||
Properties
|
Must precede other list operations.
Request must be authenticated with a MediaWiki session cookie.
Stability: unstable
Name | Data Type | Description |
---|---|---|
csrf_token
|
string |
The CRSF edit token provided by the MediaWiki API |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
|
object |
Deletes all data. User needs to opt in again before being able to do anything.
Request must be authenticated with a MediaWiki session cookie.
Stability: unstable
Name | Data Type | Description |
---|---|---|
csrf_token
|
string |
The CRSF edit token provided by the MediaWiki API |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
problem | |||||||||||||||||
Properties
|
Name |
---|