Wikimedia - API Wikimedia REST API

GET

/data/citation/{format}/{query}

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

Request

Path

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

Header

Name	Data Type	Description
`Accept-Language`	string	For some articles the result depends on the `Accept-Language` header, so provide it if localized content is required.

Responses

200The citation data in the requested format

Body

Name Data Type Description

result

result object

Properties

`url`	string
`title`	string
`itemType`	string

404Citation data was not found.

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/feed/announcements

Gets announcements for display in the official Wikipedia iOS and Android apps.

Stability: experimental

Responses

200Announcements for the given Wiki

Body

Name Data Type Description

announcementsResponse

announcementsResponse object

Properties

announce array [announcement]

announcement object

Properties

`countries`	array [string]	An array of country codes in which to display the announcement. Clients should derive the country from 'GeoIP' portion of the Set-Cookie header
`caption_HTML`	string	HTML to display below the announcement. Usually a privacy statment and link to a policy
`action`	action
`image`	string	The URL of the image for the announcement
`text`	string	The text of the announcement
`platforms`	array [string]	An array of platforms to display the announcement. Possible values are "iOSApp" or "AndroidApp"
`end_time`	string	The date to stop showing the announcement
`start_time`	string	The date to begin showing the announcement
`type`	string	The type of announcement. Possible values are "survey" or "fundraising"
`id`	string	Unique ID of the announcement

GET

/feed/featured/{yyyy}/{mm}/{dd}

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

Request

Path

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

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200JSON containing all of the featured content

Body

Name Data Type Description

feed


                        feed

object

Aggregated feed content for a given date

Properties

onthisday onthisday

onthisday array [object]

image image

image object

Properties

`description`	image_description
`image`	thumbnail
`thumbnail`	thumbnail
`title`	string	Image title

news news

news array [news_item]

mostread mostread

mostread object

Properties

`articles`	array [mostread_article]	Array of most popular articles
`date`	string	The date which the data correspond to

tfa summary

summary object

Properties

`coordinates`
`description`	string	Wikidata description for the page Examples: American poet
`timestamp`	string	The time when the page was last editted in the ISO 8601 format
`dir`	string	The page language direction code Examples: ltr
`lang`	string	The page language code Examples: en
`originalimage`	originalimage
`thumbnail`	thumbnail
`extract_html`	string	First several sentences of an article in simple HTML format
`extract`	string	First several sentences of an article in plain text
`pageid`	integer	The page ID
`displaytitle`	string	The page title how it should be shown to the user
`title`	string	The page title

GET

/feed/onthisday/{type}/{mm}/{dd}

Provides events that historically happened on the provided day and month. Supported types of events are:

All: all of the following
Selected: a list of a few selected anniversaries which occur on the provided day and month; often the entries are curated for the current year
Births: a list of birthdays which happened on the provided day and month
Deaths: a list of deaths which happened on the provided day and month
Holidays: a list of fixed holidays celebrated on the provided day and month
Events: a list of significant events which happened on the provided day and month and which are not covered by the other types yet

Stability: experimental

Request

Path

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

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200JSON containing all of the featured content

Body

Name Data Type Description

onthisdayResponse


                        onthisdayResponse

object

Lists of events which happened on the provided day and month

Properties

selected onthisday

onthisday array [object]

holidays onthisday

onthisday array [object]

events onthisday

onthisday array [object]

deaths onthisday

onthisday array [object]

births onthisday

onthisday array [object]

404No data found for the requested date

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

501Unsupported language

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

POST

/media/math/check/{type}

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.

Request

Path

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

Body

Name	Data Type	Description

Properties

string

The formula to check

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200Information about the checked formula

Body

Name	Data Type	Description
	object

400Invalid type

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/media/math/formula/{hash}

Returns the previously-stored formula via /media/math/check/{type} for the given hash.

Stability: stable.

Request

Path

Name	Data Type	Description
`hash`	string Minimum: 1	The hash string of the previous POST data

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200Information about the checked formula

Body

Name	Data Type	Description
	object

404Data for the given hash cannot be found

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/media/math/render/{format}/{hash}

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.

Request

Path

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

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The rendered formula

Body

Name	Data Type	Description
	string

404Unknown format or hash ID

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/data/css/mobile/{type}

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):

base (Common mobile CSS from ResourceLoader)
pagelib (CSS from wikimedia-page-library)
site (Site-specific, mobile CSS from ResourceLoader, as defined in MediaWiki\:Mobile.css)

The first two are the same regardless of what domain is used. For these we suggest meta.wikimedia.org.

Stability: experimental

Request

Path

Name	Data Type	Description
`type`	string Allowed values: - `base` - `pagelib` - `site`	The desired CSS bundle

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200Success

Header

Name	Data Type	Description
`ETag`	string	Different values indicate that the content has changed

Body

Name	Data Type	Description
	object

GET

/data/javascript/mobile/pagelib

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,

it allows to detect the platform and through that enable platform specific CSS rules,
has code to lazy load images on the page,
code for collapsing and expanding tables.

Stability: experimental

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200Success

Header

Name	Data Type	Description
`ETag`	string	Different values indicate that the content has changed

Body

Name	Data Type	Description
	object

GET

/data/javascript/mobile/pagelib_body_end

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

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200Success

Header

Name	Data Type	Description
`ETag`	string	Different values indicate that the content has changed

Body

Name	Data Type	Description
	object

GET

/data/javascript/mobile/pagelib_body_start

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

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200Success

Header

Name	Data Type	Description
`ETag`	string	Different values indicate that the content has changed

Body

Name	Data Type	Description
	object

GET

/page/mobile-sections-lead/{title}/{revision}

Retrieve the lead section of the latest HTML for a page title optimised for viewing with native mobile applications.

Stability: unstable

Request

Path

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: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Header

Name	Data Type	Description
`Accept-Language`	string	The desired language variant code for wikis where LanguageConverter is enabled. Example: `sr-el` for Latin transcription of the Serbian language.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The HTML for the given page title.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name	Data Type	Description
	object

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/mobile-sections-lead/{title}

Retrieve the lead section of the latest HTML for a page title optimised for viewing with native mobile applications.

Stability: unstable

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Header

Name	Data Type	Description
`Accept-Language`	string	The desired language variant code for wikis where LanguageConverter is enabled. Example: `sr-el` for Latin transcription of the Serbian language.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The HTML for the given page title.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name	Data Type	Description
	object

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/mobile-sections-remaining/{title}/{revision}

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

Request

Path

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: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Header

Name	Data Type	Description
`Accept-Language`	string	The desired language variant code for wikis where LanguageConverter is enabled. Example: `sr-el` for Latin transcription of the Serbian language.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200JSON wrapping HTML sections for the given page title.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name	Data Type	Description
	object

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/mobile-sections-remaining/{title}

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

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Header

Name	Data Type	Description
`Accept-Language`	string	The desired language variant code for wikis where LanguageConverter is enabled. Example: `sr-el` for Latin transcription of the Serbian language.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200JSON wrapping HTML sections for the given page title.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name	Data Type	Description
	object

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/mobile-sections/{title}/{revision}

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

Request

Path

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: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Header

Name	Data Type	Description
`Accept-Language`	string	The desired language variant code for wikis where LanguageConverter is enabled. Example: `sr-el` for Latin transcription of the Serbian language.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200JSON containing HTML sections and metadata for the given page title.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name	Data Type	Description
	object

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/mobile-sections/{title}

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

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Header

Name	Data Type	Description
`Accept-Language`	string	The desired language variant code for wikis where LanguageConverter is enabled. Example: `sr-el` for Latin transcription of the Serbian language.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200JSON containing HTML sections and metadata for the given page title.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name	Data Type	Description
	object

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/

Stability: stable

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200A list of page-related API end points.

Body

Name Data Type Description

listing


                        listing

object

The result format for listings

Properties

`_links`
`items`	array [string]

GET

/page/data-parsoid/{title}/{revision}/{tid}

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

Request

Path

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: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The latest Parsoid data for the given page

Header

Name	Data Type	Description
`ETag`	string	Revision / tid: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name Data Type Description

data-parsoid


                        data-parsoid

object

Result format for Parsoid data queries

Properties

`ids`	object
`counter`	integer

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target, and the body contains the actual data-parsoid for the redirect page. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

400Invalid revision

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

403Access to the specific revision is restricted

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

404Unknown page, revision or tid

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/graph/png/{title}/{revision}/{graph_id}

Retrieve PNG graph images embedded in specific revisions of a page. See the Graphoid documentation for details.

Stability: unstable

Request

Path

Name	Data Type	Description
`graph_id`	string	The graph ID, consisting of a hash and the suffix `.png`.
`revision`	integer	The page revision, or 0 for the latest
`title`	string	The page title

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The PNG render of the requested graph.

Body

Name	Data Type	Description
	string

403access to the specific revision is restricted

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

404Unknown page title or revision

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/html/{title}/{revision}

Stability: stable

Request

Path

Name	Data Type	Description
`revision`	integer	The revision
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Query

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 `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Header

Name	Data Type	Description
`Accept-Language`	string	The desired language variant code for wikis where LanguageConverter is enabled. Example: `sr-el` for Latin transcription of the Serbian language.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The html for the given page, revision and tid. See [the MediaWiki DOM spec](https://www.mediawiki.org/wiki/Parsoid/MediaWiki_DOM_spec) for a description of the MediaWiki-specific semantic markup in this HTML. Note that additional metadata is available in the HTML head. This HTML can be edited using arbitrary HTML tools. The modified HTML can be converted back to wikitext using the [/transform/html/to/wikitext{/title}{/revision}](#!/Transforms/transform_html_to_wikitext__title___revision__post) entry point.

Header

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 `base_etag` POST parameter), and can also be used to retrieve the exact corresponding data-parsoid metadata, by requesting the specific `revision` and `tid` indicated by the `ETag`.

Body

Name	Data Type	Description
	string

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target, and the body contains the actual page revision contents as HTML. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

400Invalid revision or tid

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

403Access to the specific revision is restricted

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

404Unknown page, revision or tid

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/html/{title}

Stability: stable

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Query

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 `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Header

Name	Data Type	Description
`Accept-Language`	string	The desired language variant code for wikis where LanguageConverter is enabled. Example: `sr-el` for Latin transcription of the Serbian language.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The latest HTML for the given page title. See [the MediaWiki DOM spec](https://www.mediawiki.org/wiki/Parsoid/MediaWiki_DOM_spec) for a description of the MediaWiki-specific semantic markup in this HTML. Note that additional metadata is available in the HTML head.

Header

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 `base_etag` POST parameter), and can also be used to retrieve the exact corresponding data-parsoid metadata, by requesting the specific `revision` and `tid` indicated by the `ETag`.

Body

Name	Data Type	Description
	string

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target, and the body contains the actual page contents as HTML. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

POST

/page/html/{title}

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

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Body

Name	Data Type	Description

Properties

`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.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The content was not changed, and no new version was created.

Body

Name	Data Type	Description
	object

201A new revision of the page has been created

Header

Name	Data Type	Description
`ETag`	string	ETag header indicating the new revision and timeuuid, separated by a slash: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

400Invalid request - lack of required parameters, bad ETags etc.

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

409Edit conflict

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/lint/{title}/{revision}

Stability: experimental

Request

Path

Name	Data Type	Description
`revision`	integer	The revision
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The lint errors for the given page and optionally revision. See [the Linter extension docs](https://www.mediawiki.org/wiki/Extension:Linter) for more details.

Body

Name	Data Type	Description
	object

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target, and the body contains the actual page revision contents as HTML. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

400Invalid revision or tid

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

403Access to the specific revision is restricted

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

404Unknown page, revision or tid

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/lint/{title}

Stability: experimental

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The lint errors for the given page and optionally revision. See [the Linter extension docs](https://www.mediawiki.org/wiki/Extension:Linter) for more details.

Body

Name	Data Type	Description
	object

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target, and the body contains the actual page revision contents as HTML. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

400Invalid revision or tid

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

403Access to the specific revision is restricted

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

404Unknown page, revision or tid

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/media-list/{title}/{revision}

Gets the list of media items (images, audio, and video) in the order in which they appear on a given wiki page.

Stability: experimental

Request

Path

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: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200JSON containing metadata of media items appearing on the given page.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name Data Type Description

media_list

media_list object

Properties


                        items

array [media_item]

a list of media items

media_item object

Properties

`original`
`caption`
`showInGallery`	boolean	whether the client should show the file in an image gallery presentation
`section_id`	integer	section ID in which the item is found on the page
`type`	string Allowed values: - `image` - `video` - `audio`
`title`	string	The file page title

tid

string

the time uuid of the page rendering used to create the list


                        revision

string

the revision ID used to create the list

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/media-list/{title}

Gets the list of media items (images, audio, and video) in the order in which they appear on a given wiki page.

Stability: experimental

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200JSON containing metadata of media items appearing on the given page.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name Data Type Description

media_list

media_list object

Properties


                        items

array [media_item]

a list of media items

media_item object

Properties

`original`
`caption`
`showInGallery`	boolean	whether the client should show the file in an image gallery presentation
`section_id`	integer	section ID in which the item is found on the page
`type`	string Allowed values: - `image` - `video` - `audio`
`title`	string	The file page title

tid

string

the time uuid of the page rendering used to create the list


                        revision

string

the revision ID used to create the list

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/media/{title}/{revision}

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

Request

Path

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: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200JSON containing metadata of media items appearing on the given page.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name Data Type Description

media_list_with_metadata

media_list_with_metadata object

Properties


                        items

array [media_item_with_metadata]

a list of media items

media_item_with_metadata object

Properties

`description`
`license_url`	string	URL for the pertinent license
`license`
`credit`	object	source of the media item
`artist`
`sources`	array [object]	a list of derivatives of the original file (applies only to videos)
`duration`	double	the playback duration in seconds (for audio and video items)
`end_time`	double	end time (if any) for the media item
`start_time`	double	start time (if any) for the media item
`caption`
`type`	string Allowed values: - `image` - `video` - `audio`
`file_page`	string	Full URL to the file page for the item on Wikimedia Commons
`page_count`	integer	page count, if the item is a paged item (PDF, TIFF, DjVu, etc.)
`original`
`thumbnail`
`titles`	titles_set

tid

string

the time uuid of the page rendering used to create the list


                        revision

string

the revision ID used to create the list

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/media/{title}

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

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200JSON containing metadata of media items appearing on the given page.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name Data Type Description

media_list_with_metadata

media_list_with_metadata object

Properties


                        items

array [media_item_with_metadata]

a list of media items

media_item_with_metadata object

Properties

`description`
`license_url`	string	URL for the pertinent license
`license`
`credit`	object	source of the media item
`artist`
`sources`	array [object]	a list of derivatives of the original file (applies only to videos)
`duration`	double	the playback duration in seconds (for audio and video items)
`end_time`	double	end time (if any) for the media item
`start_time`	double	start time (if any) for the media item
`caption`
`type`	string Allowed values: - `image` - `video` - `audio`
`file_page`	string	Full URL to the file page for the item on Wikimedia Commons
`page_count`	integer	page count, if the item is a paged item (PDF, TIFF, DjVu, etc.)
`original`
`thumbnail`
`titles`	titles_set

tid

string

the time uuid of the page rendering used to create the list


                        revision

string

the revision ID used to create the list

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/metadata/{title}/{revision}

Gets metadata of a page that's not already covered by the summary endpoint.

Stability: experimental

Request

Path

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: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200JSON containing additional metadata of the given page.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name Data Type Description

metadata

metadata object

Properties

variants object


                        description_source

string
Allowed values:
- central
- local

Whether the description is defined locally or comes from Wikidata. May be 'central' or 'local'.


                        protection

object

info on page edit and move rights


                        categories

array [category]

categories the page belongs to

category object

Properties

`ns`	integer	the numeric namespace id for the category page
`hidden`	boolean	whether the category is hidden or not
`summary_url`	string	link to REST API summary
`titles`


                        language_links

array [object]

list of titles and language codes for the article topic on other language Wikipedias

toc


                        issues

array [hatnote_or_page_issue]

the page issues on the page, with html and plaintext representations provided for each

hatnote_or_page_issue object

Properties

`html`	string	the hatnote or page issue HTML
`section`	integer	section ID containing the hatnote or page issue


                        hatnotes

array [hatnote_or_page_issue]

the hatnotes on the page, with html and plaintext representations provided for each

hatnote_or_page_issue object

Properties

`html`	string	the hatnote or page issue HTML
`section`	integer	section ID containing the hatnote or page issue

tid

string

time UUID for the page/revision


                        revision

string

revision ID for the page

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/metadata/{title}

Gets metadata of a page that's not already covered by the summary endpoint.

Stability: experimental

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200JSON containing additional metadata of the given page.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name Data Type Description

metadata

metadata object

Properties

variants object


                        description_source

string
Allowed values:
- central
- local

Whether the description is defined locally or comes from Wikidata. May be 'central' or 'local'.


                        protection

object

info on page edit and move rights


                        categories

array [category]

categories the page belongs to

category object

Properties

`ns`	integer	the numeric namespace id for the category page
`hidden`	boolean	whether the category is hidden or not
`summary_url`	string	link to REST API summary
`titles`


                        language_links

array [object]

list of titles and language codes for the article topic on other language Wikipedias

toc


                        issues

array [hatnote_or_page_issue]

the page issues on the page, with html and plaintext representations provided for each

hatnote_or_page_issue object

Properties

`html`	string	the hatnote or page issue HTML
`section`	integer	section ID containing the hatnote or page issue


                        hatnotes

array [hatnote_or_page_issue]

the hatnotes on the page, with html and plaintext representations provided for each

hatnote_or_page_issue object

Properties

`html`	string	the hatnote or page issue HTML
`section`	integer	section ID containing the hatnote or page issue

tid

string

time UUID for the page/revision


                        revision

string

revision ID for the page

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/mobile-html/{title}/{revision}

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:

Some elements and attributes not needed for the reading case are removed.
LeadIntroductionTransform: The introductory paragraph is moved before an infobox.
RedLinks: Red links are flattened (=turned into span elements).
WidenImage: images that should be displayed in gallery are widened.
Section headings are slightly changed by wrapping the headings inside a div and adding a span element inside the new div for the edit buttons.
Additional classes are added to img elements to fix issues with non-white backgrounds. See Theme support below for instructions on how to enable that.
Pagelib CSS files needed to display the content are referenced.
LazyLoadTransform: server-side portion/prep for lazy loading of images.
CollapseTable: server-side portion/prep for collapsing tables.

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).
Dim images: DimImagesTransform.dim(window, enable)
PlatformTransform.classify(window) to trigger Android and iOS app specific CSS rules
LazyLoadTransformer: client side companion of LazyLoadTransform (note the extra er here)
FooterTransformer: seems to be more UI than content, requires I18N, too

Stability: experimental

Request

Path

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: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200mobile-optimized HTML of the given page.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name	Data Type	Description
	string

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/mobile-html/{title}

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:

Some elements and attributes not needed for the reading case are removed.
LeadIntroductionTransform: The introductory paragraph is moved before an infobox.
RedLinks: Red links are flattened (=turned into span elements).
WidenImage: images that should be displayed in gallery are widened.
Section headings are slightly changed by wrapping the headings inside a div and adding a span element inside the new div for the edit buttons.
Additional classes are added to img elements to fix issues with non-white backgrounds. See Theme support below for instructions on how to enable that.
Pagelib CSS files needed to display the content are referenced.
LazyLoadTransform: server-side portion/prep for lazy loading of images.
CollapseTable: server-side portion/prep for collapsing tables.

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).
Dim images: DimImagesTransform.dim(window, enable)
PlatformTransform.classify(window) to trigger Android and iOS app specific CSS rules
LazyLoadTransformer: client side companion of LazyLoadTransform (note the extra er here)
FooterTransformer: seems to be more UI than content, requires I18N, too

Stability: experimental

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200mobile-optimized HTML of the given page.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name	Data Type	Description
	string

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/pdf/{title}/{format}/{type}

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

Request

Path

Name	Data Type	Description
`type`	string Default value: `desktop` Allowed values: - `mobile` - `desktop`	PDF type - `mobile` (optimized for reading on mobile devices) or `desktop` (regular PDF). `desktop` is the default render mode and it will used if param `type` is not passed
`format`	string Allowed values: - `a4` - `letter` - `legal`	PDF format
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The PDF render of an article

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name	Data Type	Description
	string

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

503A response is unavailable because service queue is busy or full

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/pdf/{title}/{format}

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

Request

Path

Name	Data Type	Description
`format`	string Allowed values: - `a4` - `letter` - `legal`	PDF format
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The PDF render of an article

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name	Data Type	Description
	string

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

503A response is unavailable because service queue is busy or full

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/pdf/{title}

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

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The PDF render of an article

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name	Data Type	Description
	string

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

503A response is unavailable because service queue is busy or full

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/random/{format}

Redirects the client to the URI for the desired format for a random page title.

Stability: unstable

Request

Path

Name	Data Type	Description
`format`	string Allowed values: - `title` - `html` - `summary` - `related` - `mobile-sections` - `mobile-sections-lead`	The desired return format

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

303The redirect to the desired format URI for a random page

Body

Name	Data Type	Description
	object

GET

/page/references/{title}/{revision}

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

Request

Path

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: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200JSON containing a structure of references on the given page.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name Data Type Description

references_response


                        references_response

object

Reference lists and references

Properties

references_by_id references_by_id


                        references_by_id

object

A map of reference ids to reference details

Properties

default reference_detail_item

reference_lists reference_lists


                        reference_lists

array [reference_list]

A list of reference lists

tid

string

time UUID for the page/revision


                        revision

string

revision ID for the page

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/references/{title}

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

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200JSON containing a structure of references on the given page.

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name Data Type Description

references_response


                        references_response

object

Reference lists and references

Properties

references_by_id references_by_id


                        references_by_id

object

A map of reference ids to reference details

Properties

default reference_detail_item

reference_lists reference_lists


                        reference_lists

array [reference_list]

A list of reference lists

tid

string

time UUID for the page/revision


                        revision

string

revision ID for the page

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/related/{title}

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

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The related pages

Body

Name Data Type Description

Properties

pages array [summary]

summary object

Properties

`coordinates`
`description`	string	Wikidata description for the page Examples: American poet
`timestamp`	string	The time when the page was last editted in the ISO 8601 format
`dir`	string	The page language direction code Examples: ltr
`lang`	string	The page language code Examples: en
`originalimage`	originalimage
`thumbnail`	thumbnail
`extract_html`	string	First several sentences of an article in simple HTML format
`extract`	string	First several sentences of an article in plain text
`pageid`	integer	The page ID
`displaytitle`	string	The page title how it should be shown to the user
`title`	string	The page title

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/segments/{title}/{revision}

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

Request

Path

Name	Data Type	Description
`revision`	integer	The revision id
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The segmented page for the given title and revision

Body

Name	Data Type	Description
	object

Properties

`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

400Invalid revision

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

403Access to the specific revision is restricted

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

404Unknown page or revision

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/segments/{title}

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

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The segmented page for the given title and revision

Body

Name	Data Type	Description
	object

Properties

`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

400Invalid revision

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

403Access to the specific revision is restricted

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

404Unknown page or revision

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/summary/{title}

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

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Query

Name	Data Type	Description
`redirect`	boolean	Requests for redirect pages return HTTP 302 with a redirect target in `Location` header and content in the body. To get a 200 response instead, supply `false` to the `redirect` parameter.

Header

Name	Data Type	Description
`Accept-Language`	string	The desired language variant code for wikis where LanguageConverter is enabled. Example: `sr-el` for Latin transcription of the Serbian language.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The summary for the given page

Header

Name	Data Type	Description
`ETag`	string	Syntax: "{revision}/{tid}". Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name Data Type Description

summary

summary object

Properties

coordinates


                        description

string

Wikidata description for the page

Examples:

American poet


                        timestamp

string

The time when the page was last editted in the ISO 8601 format

dir

string

The page language direction code

Examples:

ltr


                        lang

string

The page language code

Examples:

en

originalimage originalimage

originalimage object

Properties

`height`	integer	Original image height
`width`	integer	Original image width
`source`	string	Original image URI

thumbnail thumbnail

thumbnail object

Properties

`height`	integer	Thumnail height
`width`	integer	Thumbnail width
`source`	string	Thumbnail image URI


                        extract_html

string

First several sentences of an article in simple HTML format


                        extract

string

First several sentences of an article in plain text


                        pageid

integer

The page ID


                        displaytitle

string

The page title how it should be shown to the user


                        title

string

The page title

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid this kind of redirect, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client-side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/title/{title}/{revision}

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.

Request

Path

Name	Data Type	Description
`revision`	integer	The revision id
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The latest revision metadata for the provided title.

Body

Name Data Type Description

revision


                        revision

object

Result format for revision items

Properties

items revisionInfo


                        revisionInfo

object

Complete information about the revision

Properties

`page_language`	string
`redirect`	boolean
`timestamp`	dateTime
`user_text`	string
`user_id`	integer
`tags`	array [string]
`restrictions`	array [string]
`comment`	string
`tid`	string
`rev`	integer
`page_id`	integer
`title`	string

count integer

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid these redirects, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title or no revisions found.

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/page/title/{title}

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.

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The latest revision metadata for the provided title.

Body

Name Data Type Description

revision


                        revision

object

Result format for revision items

Properties

items revisionInfo


                        revisionInfo

object

Complete information about the revision

Properties

`page_language`	string
`redirect`	boolean
`timestamp`	dateTime
`user_text`	string
`user_id`	integer
`tags`	array [string]
`restrictions`	array [string]
`comment`	string
`tid`	string
`rev`	integer
`page_id`	integer
`title`	string

count integer

301A permanent redirect is returned if the supplied article title was not in the normalized form. To avoid these redirects, you can use the [mediawiki-title](https://github.com/wikimedia/mediawiki-title) library to perform title normalization client side. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

302The page is a [redirect page](https://www.mediawiki.org/wiki/Help:Redirects). The `location` header points to the redirect target. If you would like to avoid automatically following redirect pages, set the `redirect=false` query parameter. Beware that redirected pre-flighted cross-origin requests (such as those sending custom request headers like `Api-User-Agent`) will fail in most current browsers [due to a spec bug](https://github.com/whatwg/fetch/issues/204).

404Unknown page title or no revisions found.

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

POST

/page/wikitext/{title}

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

Request

Path

Name	Data Type	Description
`title`	string	Page title. Use underscores instead of spaces. Example: `Main_Page`.

Body

Name	Data Type	Description

Properties

`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.

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The existing revision of the page matches the sent text

201A new revision of the page has been created

Header

Name	Data Type	Description
`ETag`	string	ETag header indicating the new revision and timeuuid, separated by a slash: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"

Body

Name	Data Type	Description
	object

400Invalid request - lack of required parameters, bad ETags etc.

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

409Edit conflict

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

GET

/data/lists/

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

Request

Query

Name	Data Type	Description
`sort`	string Default value: `updated` Allowed values: - `name` - `updated`	Sort order `name`: by name, ascending; `updated`: by last modification date, descending.
`next`	string	Continuation parameter from previous request

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200An array of list metadata.

Body

Name	Data Type	Description
	object

Properties


                        continue-from

dateTime

Timestamp to sync from, to be used with the GET /lists/changes/since/{date} endpoint.


                        next

string

Continuation token.

lists array [list_read]

list object

Properties

`updated`	dateTime	Last modification date (in ISO 8601)
`created`	dateTime	Creation date (in ISO 8601)
`description`	string	Examples: Planets of the Solar System
`name`	string	Examples: Planets
`id`	integer	Examples: 42

POST

/data/lists/

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.

Request

Query

Name	Data Type	Description
`csrf_token`	string	The CRSF edit token provided by the MediaWiki API

Body

Name Data Type Description

list_write

list object

Properties

`description`	string	Examples: Planets of the Solar System
`name`	string	Examples: Planets

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The data for the new list.

Body

Name	Data Type	Description
	object

Properties

list list_read

list object

Properties

`updated`	dateTime	Last modification date (in ISO 8601)
`created`	dateTime	Creation date (in ISO 8601)
`description`	string	Examples: Planets of the Solar System
`name`	string	Examples: Planets
`id`	integer	Examples: 42

id

integer

List ID.

Deprecated, will be removed. Use the full list object.

Examples:

POST

/data/lists/batch

See POST /lists/.

Stability: unstable

Request

Query

Name	Data Type	Description
`csrf_token`	string	The CRSF edit token provided by the MediaWiki API

Body

Name	Data Type	Description
`batch`	object

Properties

batch array [list_write]

list object

Properties

`description`	string	Examples: Planets of the Solar System
`name`	string	Examples: Planets

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200The data for the new lists (in the same order as the inputs).

Body

Name	Data Type	Description
`list_create_batch`	object

Properties

lists array [list_read]

list object

Properties

`updated`	dateTime	Last modification date (in ISO 8601)
`created`	dateTime	Creation date (in ISO 8601)
`description`	string	Examples: Planets of the Solar System
`name`	string	Examples: Planets
`id`	integer	Examples: 42


                        batch

array [list_id]

Deprecated, will be removed. Use the full list objects instead.

list_id object

Properties

id

integer

List ID

Examples:

GET

/data/lists/changes/since/{date}

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

Request

Path

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.

Query

Name	Data Type	Description
`next`	string	Continuation parameter from previous request

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200An array of list and entry metadata.

Body

Name	Data Type	Description
	object

Properties


                        continue-from

dateTime

Timestamp to sync from, to be used with the GET /lists/changes/since/{date} endpoint.


                        next

string

Continuation token.

lists array [list_read]

list object

Properties

`updated`	dateTime	Last modification date (in ISO 8601)
`created`	dateTime	Creation date (in ISO 8601)
`description`	string	Examples: Planets of the Solar System
`name`	string	Examples: Planets
`id`	integer	Examples: 42

GET

/data/lists/pages/{project}/{title}

Request must be authenticated with a MediaWiki session cookie.

Stability: unstable

Request

Path

Name	Data Type	Description
`title`	string
`project`	string

Query

Name	Data Type	Description
`next`	string	Continuation parameter from previous request

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200An array of list metadata.

Body

Name	Data Type	Description
	object

Properties


                        next

string

Continuation token.

lists array [list_read]

list object

Properties

`updated`	dateTime	Last modification date (in ISO 8601)
`created`	dateTime	Creation date (in ISO 8601)
`description`	string	Examples: Planets of the Solar System
`name`	string	Examples: Planets
`id`	integer	Examples: 42

POST

/data/lists/setup

Must precede other list operations.

Request must be authenticated with a MediaWiki session cookie.

Stability: unstable

Request

Query

Name	Data Type	Description
`csrf_token`	string	The CRSF edit token provided by the MediaWiki API

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200Success.

Body

Name	Data Type	Description
	object

POST

/data/lists/teardown

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

Request

Query

Name	Data Type	Description
`csrf_token`	string	The CRSF edit token provided by the MediaWiki API

Responses

200Error

Body

Name Data Type Description

problem

problem object

Properties

`instance`	string
`detail`	string
`title`	string
`type`	string

200Success.

Body

Name

Wikimedia REST API

Global Rules

Endpoint documentation

Resources

Citation

Request

Path

Header

Responses

Body

Properties

Body

Properties

Feed

Responses

Body

Properties

Properties

Request

Path

Responses

Body

Properties

Body

Properties

Properties

Properties

Properties

Request

Path

Responses

Body

Properties

Body

Properties

Body

Properties

Body

Properties

Math

Request

Path

Body

Properties

Responses

Body

Properties

Body

Body

Properties

Request

Path

Responses

Body

Properties

Body

Body

Properties

Request

Path

Responses

Body

Properties

Body

Body

Properties

Mobile

Request

Path

Responses

Body

Properties

Header

Body

Responses

Body

Properties

Header

Body

Responses