API:REST API/Reference

The REST API lets you interact with MediaWiki by sending HTTP requests to unique URLs. You can use the API to build apps and scripts that search wiki pages and explore page history.

Search result object
The search result object represents a wiki page matching the requested search.

Search pages
Searches wiki page titles and contents for the provided search terms, and returns matching pages.

Autocomplete page title
Searches wiki page titles, and returns matches between the beginning of a title and the provided search terms. You can use this endpoint for a typeahead search that automatically suggests relevant pages by title.

Page object
The page object represents the latest revision of a wiki page.

Page language object
The page language object represents a wiki page and its language.

Create page
Creates a wiki page. The response includes a header containing the API endpoint to fetch the new page.

This endpoint is designed to be used with the OAuth extension authorization process. Callers using cookie-based authentication instead must add a CSRF to the request body. To get a CSRF token, see the Action API.

Update page
Updates or creates a wiki page. This endpoint is designed to be used with the OAuth extension authorization process. Callers using cookie-based authentication instead must add a CSRF to the request body. To get a CSRF token, see the Action API.

To update a page, you need the page's latest revision ID and the page source. First call the get page source endpoint, and then use the and  to update the page. If doesn't match the page's latest revision, the API resolves conflicts automatically when possible. In the event of an edit conflict, the API returns a 409 error.

To create a page, omit from the request.

Get page
Returns the standard page object for a wiki page, including the API route to fetch the latest content in HTML, the license, and information about the latest revision.

Get page offline
Returns information about a wiki page, including the license, latest revision, and latest content in HTML.

Get page source
Returns the content of a wiki page in the format specified by the property, the license, and information about the latest revision.

Get HTML
Returns the latest content of a wiki page in HTML.

Get languages
Searches connected wikis for pages with the same topic in different languages. Returns an array of page language objects that include the name of the language, the language code, and the translated page title.

Get files on page
Returns information about media files used on a wiki page.

Transform
The transform endpoint provides on-the-fly round-trip conversion between wikitext and HTML.

Convert Wikitext to HTML
Converts wikitext to HTML.

Convert HTML to Wikitext
Converts wikitext to HTML.

Transform request body
Payload structure for transform requests.

Example
For converting wikitext to HTML:

For converting HTML to Wikitext:

File object
The file object represents a file uploaded to a wiki.

Get file
Returns information about a file, including links to download the file in thumbnail, preview, and original formats.

Revision object
The revision object represents a change to a wiki page.

Get page history
Returns information about the latest revisions to a wiki page, in segments of 20 revisions, starting with the latest revision. The response includes API routes for the next oldest, next newest, and latest revision segments, letting you scroll through page history.

Get page history counts
Returns data about a page's history.

Get revision
Returns details for an individual revision.

Compare revisions
Returns data that lets you display a line-by-line comparison of two revisions. (See [ https://en.wikipedia.beta.wmflabs.org/w/index.php?diff=388864&oldid=388863&title=Main_Page&type=revision an example].) Only text-based wiki pages can be compared.