MediaWiki API

https://www.pcgamingwiki.com/w/api.php
Admin
MediaWiki API is a mature and stable web interface that provides programmatic access to query and...
Tokens:253,144
Snippets:1,149
Trust Score:9.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Team Fortress 2 via Steam URL

Source: https://www.pcgamingwiki.com/w/api.php?action=feedrecentchanges

Use this URL to initiate the installation of Team Fortress 2 directly through Steam. This is applicable for the free-to-play version.

```steam
steam://install/440
```

--------------------------------

### Templated Parameters Example

Source: https://www.pcgamingwiki.com/w/api.php

Shows how to use templated parameters to specify a value for each instance of another parameter. This example requests quantities for different fruits.

```api
fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20
```

--------------------------------

### Example JSON API Result

Source: https://www.pcgamingwiki.com/w/api.php?action=query&cmtitle=Category%3APhysics&list=categorymembers

This is an example of the JSON output from the MediaWiki API. Use `format=json` to obtain this format for application use.

```json
{
    "batchcomplete": "",
    "query": {
        "categorymembers": []
    }
}
```

--------------------------------

### MediaWiki API JSON Output Example

Source: https://www.pcgamingwiki.com/w/api.php?action=query&arvlimit=50&arvuser=Example&list=allrevisions

This is an example of the JSON output from the MediaWiki API. Use `format=json` to obtain this representation for application use.

```json
{
    "batchcomplete": "",
    "query": {
        "allrevisions": []
    }
}
```

--------------------------------

### JSON API Response Example

Source: https://www.pcgamingwiki.com/w/api.php?action=query&gatfrom=B&generator=alltransclusions

This is an example of a JSON response from the MediaWiki API. Use `format=json` to obtain this output for application integration.

```json
{
    "batchcomplete": "",
    "continue": {
        "gatcontinue": "CN|147",
        "continue": "gatcontinue||"
    },
    "query": {
        "pages": {
            "38": {
                "pageid": 38,
                "ns": 0,
                "title": "Mass Effect"
            },
            "58": {
                "pageid": 58,
                "ns": 0,
                "title": "Rage"
            },
            "59": {
                "pageid": 59,
                "ns": 0,
                "title": "Battlefield: Bad Company 2"
            },
            "61": {
                "pageid": 61,
                "ns": 0,
                "title": "BioShock"
            },
            "69": {
                "pageid": 69,
                "ns": 0,
                "title": "Dragon Age: Origins"
            },
            "113": {
                "pageid": 113,
                "ns": 0,
                "title": "L.A. Noire"
            },
            "141": {
                "pageid": 141,
                "ns": 0,
                "title": "Killing Floor"
            },
            "143": {
                "pageid": 143,
                "ns": 0,
                "title": "Planescape: Torment"
            },
            "144": {
                "pageid": 144,
                "ns": 0,
                "title": "Left 4 Dead 2"
            },
            "190002": {
                "pageid": 190002,
                "ns": 10,
                "title": "Template:Baronsmoki/Video"
            }
        }
    }
}
```

--------------------------------

### Example JSON API Response

Source: https://www.pcgamingwiki.com/w/api.php?action=parse&prop=&summary=Some+%5B%5Blink%5D%5D

This is an example of a JSON response from the MediaWiki API. Use `format=json` to obtain this output for application use.

```json
{
    "parse": {
        "title": "API",
        "pageid": 0,
        "parsedsummary": {
            "*": "Some <a href=\"/wiki/Link\" title=\"Link\">link</a>"
        }
    }
}
```

--------------------------------

### MediaWiki API JSON Response Example

Source: https://www.pcgamingwiki.com/w/api.php?action=query&generator=fileusage&prop=info&titles=File%3AExample.jpg

This is an example of a JSON response from the MediaWiki API. Specify the `format` parameter to change the output format. Use `format=json` for non-HTML representations.

```json
{
    "batchcomplete": "",
    "query": {
        "pages": {
            "202354": {
                "pageid": 202354,
                "ns": 2,
                "title": "User:Sllocsredle/Sandbox",
                "contentmodel": "wikitext",
                "pagelanguage": "en",
                "pagelanguagehtmlcode": "en",
                "pagelanguagedir": "ltr",
                "touched": "2025-03-15T20:30:08Z",
                "lastrevid": 1554297,
                "length": 378
            }
        }
    }
}
```

--------------------------------

### Fetch Revisions for Pages with Prefix

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=query

This example fetches revisions for pages whose titles start with 'API/'. It uses the 'query' action with the 'generator=allpages' and 'gapprefix' parameters to specify the pages, and 'prop=revisions' to get revision data.

```api
api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue=
```

--------------------------------

### Get All Help Information

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=main

Fetch comprehensive help documentation for the main API module and all its submodules. This provides an in-depth overview of API functionalities.

```php
api.php?action=help
```

```php
api.php?action=help&recursivesubmodules=1
```

--------------------------------

### Retrieve module information via paraminfo

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=paraminfo

Examples demonstrating how to query specific API modules and their submodules using the paraminfo action.

```http
api.php?action=paraminfo&modules=parse|phpfm|query%2Ballpages|query%2Bsiteinfo
```

```http
api.php?action=paraminfo&modules=query%2B*
```

--------------------------------

### Get Information About Pages Transcluding a Specific Page (API)

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=query%2Btranscludedin

This example combines the 'transcludedin' generator with the 'info' property to get details about pages transcluding 'Main Page'. Ensure you have read access to the API.

```api
api.php?action=query&generator=transcludedin&titles=Main%20Page&prop=info
```

--------------------------------

### Get pages containing links as a generator

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=query%2Balllinks

Uses the alllinks module as a generator to retrieve pages that contain links starting from 'B'.

```http
api.php?action=query&generator=alllinks&galfrom=B
```

--------------------------------

### Start account linking process

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=linkaccount

Initiates the linking process for a specific provider. Requires a valid CSRF token and a return URL.

```http
api.php?action=linkaccount&provider=Example&linkreturnurl=http://example.org/&linktoken=123ABC
```

--------------------------------

### Get unique linked titles as a generator

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=query%2Balllinks

Uses the alllinks module as a generator to retrieve unique linked titles starting from 'B'.

```http
api.php?action=query&generator=alllinks&galunique=&galfrom=B
```

--------------------------------

### Get All API Help Recursively

Source: https://www.pcgamingwiki.com/w/api.php

Fetch comprehensive API help documentation, including all submodules, by setting 'recursivesubmodules' to 1.

```api
api.php?action=help&recursivesubmodules=1
```

--------------------------------

### GET /api.php?action=query&list=random

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=query%2Brandom

Retrieves a set of random pages from the wiki. Pages are returned in a fixed sequence starting from a random point.

```APIDOC
## GET /api.php?action=query&list=random

### Description
Get a set of random pages from the wiki. The sequence of pages is fixed, but the starting point is randomized.

### Method
GET

### Endpoint
/api.php?action=query&list=random

### Parameters
#### Query Parameters
- **rnnamespace** (string) - Optional - Return pages in these namespaces only. Values separated by '|'. Use '*' for all.
- **rnfilterredir** (string) - Optional - How to filter for redirects. Values: all, nonredirects, redirects. Default: nonredirects.
- **rnredirect** (boolean) - Deprecated - Use rnfilterredir=redirects instead.
- **rnlimit** (integer) - Optional - Limit how many random pages will be returned. Value between 1 and 500. Default: 1.
- **rncontinue** (string) - Optional - When more results are available, use this to continue.

### Request Example
api.php?action=query&list=random&rnnamespace=0&rnlimit=2
```

--------------------------------

### GET /api.php?action=help

Source: https://www.pcgamingwiki.com/w/api.php?action=help

Retrieves help information for the main API module or all modules recursively.

```APIDOC
## GET /api.php?action=help

### Description
Provides help documentation for the API. Can be used to list modules or get detailed information.

### Method
GET

### Endpoint
/api.php?action=help

### Query Parameters
- **recursivesubmodules** (boolean) - Optional - If set to 1, returns all help in one page.
```

--------------------------------

### Start Wiki Login Process

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=clientlogin

Initiates the login process for a wiki user. Requires username, password, a return URL for third-party flows, and a login token.

```php
api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC
```

--------------------------------

### MediaWiki API JSON Error Response

Source: https://www.pcgamingwiki.com/w/api.php?20meet+you=&action=flow&epcontent=Nice+to&epformat=wikitext&eppostId=%3F%3F%3F&epprev_revision=%3F%3F%3F&page=Topic%3AS2tycnas4hcucw8w&submodule=edit-post

Example of a JSON error response indicating a required POST request was sent via GET.

```json
{
    "error": {
        "code": "mustbeposted",
        "info": "The \"edit-post\" module requires a POST request.",
        "*": "See https://www.pcgamingwiki.com/w/api.php for API usage. Subscribe to the mediawiki-api-announce mailing list at <https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce> for notice of API deprecations and breaking changes."
    }
}
```

--------------------------------

### Reset and Change Preferences

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=options

This example demonstrates resetting all preferences and then setting specific ones like 'skin' and 'nickname'. It uses both the 'reset' and 'change' parameters, along with 'optionname' and 'optionvalue' for custom options. A CSRF token is mandatory.

```api
api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC
```

--------------------------------

### Get Category Information for Multiple Categories

Source: https://www.pcgamingwiki.com/w/api.php?action=help&recursivesubmodules=1

Retrieves information about specified categories. This example demonstrates fetching details for 'Category:Foo' and 'Category:Bar'.

```php
api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar [open in sandbox]
```

--------------------------------

### GET /api.php?action=query&list=allimages

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=query%2Ballimages

Enumerate all images sequentially from the wiki.

```APIDOC
## GET /api.php?action=query&list=allimages

### Description
Enumerate all images sequentially. This module requires read rights and can be used as a generator.

### Method
GET

### Endpoint
/api.php?action=query&list=allimages

### Parameters
#### Query Parameters
- **aisort** (string) - Optional - Property to sort by. Values: name, timestamp. Default: name
- **aidir** (string) - Optional - The direction in which to list. Values: ascending, descending, newer, older. Default: ascending
- **aifrom** (string) - Optional - The image title to start enumerating from (requires aisort=name).
- **aito** (string) - Optional - The image title to stop enumerating at (requires aisort=name).
- **aicontinue** (string) - Optional - When more results are available, use this to continue.
- **aistart** (timestamp) - Optional - The timestamp to start enumerating from (requires aisort=timestamp).
- **aiend** (timestamp) - Optional - The timestamp to end enumerating (requires aisort=timestamp).
- **aiprop** (string) - Optional - Which file information to get. Values: timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, mediatype, metadata, commonmetadata, extmetadata, bitdepth, badfile. Default: timestamp|url
- **aiprefix** (string) - Optional - Search for all image titles that begin with this value (requires aisort=name).
- **aiminsize** (integer) - Optional - Limit to images with at least this many bytes.
- **aimaxsize** (integer) - Optional - Limit to images with at most this many bytes.
- **aisha1** (string) - Optional - SHA1 hash of image.
- **aisha1base36** (string) - Optional - SHA1 hash of image in base 36.
- **aiuser** (string) - Optional - Only return files uploaded by this user (requires aisort=timestamp).
- **aifilterbots** (string) - Optional - How to filter files uploaded by bots (requires aisort=timestamp). Values: all, bots, nobots. Default: all
- **aimime** (string) - Optional - Filter by MIME type.
- **ailimit** (integer) - Optional - How many images in total to return. Range: 1-500. Default: 10

### Request Example
api.php?action=query&list=allimages&aifrom=B
```

--------------------------------

### GET /api.php?action=query&generator=recentchanges&grcshow=!patrolled&prop=info

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=query&submodules=1

This example demonstrates using the RecentChanges module as a generator to retrieve information about unpatrolled pages.

```APIDOC
## GET /api.php?action=query&generator=recentchanges&grcshow=!patrolled&prop=info

### Description
Retrieve information about pages that have recent unpatrolled changes. This uses the `recentchanges` module as a generator.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be set to `query`.
- **generator** (string) - Required - Must be set to `recentchanges`.
- **grcshow** (string) - Optional - Filters the recent changes. `!patrolled` shows only unpatrolled changes.
- **prop** (string) - Required - Specifies the properties to retrieve for each page. `info` retrieves page information.

### Request Example
```json
{
  "example": "api.php?action=query&generator=recentchanges&grcshow=!patrolled&prop=info"
}
```

### Response
#### Success Response (200)
- **query.pages** (object) - An object containing page information keyed by page ID.
  - Each page object may contain fields like `pageid`, `ns`, `title`, `contentmodel`, `imagerepository`, `imageinfo`, `touched`, `lastrevid`, `length`.

#### Response Example
```json
{
  "example": "{\n  \"batchcomplete\": \"\",\n  \"query\": {\n    \"pages\": {\n      \"12345\": {\n        \"pageid\": 12345,\n        \"ns\": 0,\n        \"title\": \"Unpatrolled Page\",\n        \"touched\": \"2023-01-01T12:00:00Z\",\n        \"lastrevid\": 67890,\n        \"length\": 150\n      }\n    }\n  }\n}"
}
```
```

--------------------------------

### Get API Help

Source: https://www.pcgamingwiki.com/w/api.php

Retrieve help documentation for the main API module. This can be used to understand available actions and parameters.

```api
api.php?action=help
```

--------------------------------

### Get Page Info Using Categorymembers Generator

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=query&submodules=1

This example demonstrates using the `categorymembers` module as a generator to retrieve additional properties for each page within a category.

```APIDOC
## GET /api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info

### Description
Retrieves information (like `info`) for pages generated by the `categorymembers` module.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be set to `query`.
- **generator** (string) - Required - Must be set to `categorymembers`.
- **gcmtitle** (string) - Required - The category to enumerate. Must include the `Category:` prefix.
- **prop** (string) - Required - Which properties to get for the generated pages. Example: `info`.
- **cmlimit** (integer) - Optional - The maximum number of pages to return. Value must be between 1 and 500. Default: 10.

### Request Example
```
api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info
```

### Response
#### Success Response (200)
- **batchcomplete** (boolean) - Indicates if the query is complete.
- **continue** (object) - Contains information for continuing the query if more results are available.
- **query** (object)
  - **pages** (object) - An object where keys are page IDs and values are page objects containing requested properties (e.g., `info`).
    - **pageid** (integer) - The page ID.
    - **ns** (integer) - The namespace ID.
    - **title** (string) - The title of the page.
    - **revisions** (array) - Revision history (if `prop=revisions` is used).
    - **info** (object) - General information about the page (if `prop=info` is used).
      - **size** (integer) - Size of the page in bytes.
      - **ns** (integer) - Namespace.
      - **title** (string) - Title.
      - **lastrevid** (integer) - Last revision ID.
      - **type** (string) - Type of page (e.g., `normal`, `file`).
      - **etag** (string) - ETag for caching.

#### Response Example
```json
{
  "batchcomplete": true,
  "query": {
    "pages": {
      "123": {
        "pageid": 123,
        "ns": 0,
        "title": "Example Page",
        "index": "",
        "imagerepo": "",
        "imagedesiredsize": 0,
        "imagethumbnail": "",
        "url": "",
        "descriptionurl": "",
        "descriptionsnippet": "",
        "touched": "2023-10-27T10:00:00Z",
        "lastrevid": 456,
        "length": 789,
        "new": "",
        "talkid": 0,
        "fullurl": "http://example.com/wiki/Example_Page",
        "editurl": "http://example.com/wiki/Example_Page?action=edit",
        "canonicalurl": "http://example.com/wiki/Example_Page"
      }
    }
  }
}
```
```

--------------------------------

### Get info about pages transcluding a template

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=query%2Bembeddedin

This example retrieves information about pages that transclude a given template by using 'embeddedin' as a generator. It requires the 'prop=info' parameter to fetch page details.

```api
api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info
```

--------------------------------

### Help Module

Source: https://www.pcgamingwiki.com/w/api.php

Provides help documentation for the MediaWiki API. You can get help for the main module or recursively for all submodules.

```APIDOC
## GET /api.php?action=help

### Description
Retrieves help information for the main API module.

### Method
GET

### Endpoint
/api.php?action=help

### Request Example
```
api.php?action=help
```

### Response
(Help documentation content)
```

```APIDOC
## GET /api.php?action=help&recursivesubmodules=1

### Description
Retrieves comprehensive help information for all API submodules.

### Method
GET

### Endpoint
/api.php?action=help&recursivesubmodules=1

### Request Example
```
api.php?action=help&recursivesubmodules=1
```

### Response
(Recursive help documentation content)
```

--------------------------------

### Get Pages Transcluding a Specific Page (API)

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=query%2Btranscludedin

Use this query to retrieve a list of pages that transclude the 'Main Page'. No special setup is required beyond basic API access.

```api
api.php?action=query&prop=transcludedin&titles=Main%20Page
```

--------------------------------

### Get info about pages linking to Main Page

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=query%2Bbacklinks

This example demonstrates using the backlinks module as a generator to fetch information about pages linking to a specific title. It combines backlinks with the 'info' property.

```api
api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info
```

--------------------------------

### POST /api.php action=createaccount

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=createaccount

This module is used to create a new user account on a MediaWiki instance. It requires write permissions and only accepts POST requests. The process involves fetching authentication details, presenting them to the user, and submitting the information via this API.

```APIDOC
## POST /api.php action=createaccount

### Description
Creates a new user account on a MediaWiki instance. This module requires write permissions and only accepts POST requests. The general procedure involves fetching available fields, presenting them to the user, and then posting to this module with the necessary information.

### Method
POST

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be set to `createaccount`.
- **createtoken** (string) - Required - A "createaccount" token retrieved from `action=query&meta=tokens`.

#### Request Body
- **username** (string) - Required - The desired username for the new account.
- **password** (string) - Required - The password for the new account.
- **retype** (string) - Required - The password re-entered for confirmation.
- **createrequests** (string) - Optional - Specifies authentication requests by ID. Separate values with `|`. Maximum 50 values.
- **createmessageformat** (string) - Optional - Format for returning messages. One of: `html`, `none`, `raw`, `wikitext`. Default: `wikitext`.
- **createmergerequestfields** (boolean) - Optional - Merges field information for all authentication requests into one array.
- **createpreservestate** (boolean) - Optional - Preserves state from a previous failed login attempt.
- **createreturnurl** (string) - Optional - Return URL for third-party authentication flows. Must be absolute. Either this or `createcontinue` is required.
- **createcontinue** (boolean) - Optional - Indicates this request is a continuation after a previous UI or REDIRECT response. Either this or `createreturnurl` is required.

*Note: This module accepts additional parameters depending on the available authentication requests. Use `action=query&meta=authmanagerinfo` with `amirequestsfor=create` to determine available requests and their fields.*

### Request Example
```
POST /api.php
Content-Type: application/x-www-form-urlencoded

action=createaccount&
username=Example&
password=ExamplePassword&
retype=ExamplePassword&
createreturnurl=http://example.org/&
createtoken=123ABC
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the account creation (e.g., PASS, FAIL, UI, REDIRECT, RESTART).
- **message** (string) - A message related to the status.
- **fields** (object) - Fields to be presented to the user if the status is 'UI'.
- **redirecttarget** (string) - URL to redirect to if the status is 'REDIRECT'.
- **createreturnurl** (string) - The return URL provided in the request.

#### Response Example (PASS)
```json
{
  "batchcomplete": "",
  "query": {
    "createaccount": {
      "status": "PASS",
      "message": "Account created successfully."
    }
  }
}
```

#### Response Example (UI)
```json
{
  "batchcomplete": "",
  "query": {
    "createaccount": {
      "status": "UI",
      "message": "Please provide additional information.",
      "fields": {
        "username": {
          "label": "Username",
          "type": "text",
          "required": true
        },
        "email": {
          "label": "Email",
          "type": "email",
          "required": true
        }
      },
      "createreturnurl": "http://example.org/"
    }
  }
}
```
```

--------------------------------

### Get information about pages linking to a specific interwiki link

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=query%2Biwbacklinks

This example demonstrates using the `iwbacklinks` module as a generator to fetch information about pages that link to a specified interwiki link. It requires the `prop=info` parameter to retrieve page properties.

```api
api.php?action=query&generator=iwbacklinks&giwbltitle=Test&giwblprefix=wikibooks&prop=info
```

--------------------------------

### Displaying Game Availability Information

Source: https://www.pcgamingwiki.com/w/api.php?action=feedrecentchanges&days=30

This snippet shows how to display game availability, including retail and Steam versions, and notes on DRM-free access. It also includes details about command-line arguments for launching the game.

```WikiText
{{Availability| Retail | | Steam | | | Windows }}
```

```WikiText
{{Availability/row| Retail | | Steam | Initially only available as part of The Orange Box. Received a standalone retail release later. | | Windows }}
```

```WikiText
{{Availability/row| Steam | 400 | DRM-free | DRM-free when launched directly from the executable with <code>-game portal</code><ref>{{Refcheck|user=Jwillikers|date=2025-09-25|comment=Confirmed on Linux that {{file|hl2.sh}} run with the <code>-game portal</code> flag can be launched directly from the game folder without the Steam client running or launching.}}</ref> [[Glossary:Command line arguments|command line argument]]. (<code>-game portal_rtx</code> for the RTX edition){{cn|OS X testing needed|date=October 2018}}<br/>[https://store.steampowered.com/bundle/234/Portal_Bundle Portal
```

--------------------------------

### GET query+alldeletedrevisions

Source: https://www.pcgamingwiki.com/w/api.php?action=paraminfo&format=json&modules=query%2B%2A

Get all deleted revisions for a user or namespace.

```APIDOC
## GET query+alldeletedrevisions

### Description
Get all deleted revisions for a user or namespace.

### Method
GET

### Endpoint
query+alldeletedrevisions

### Parameters
#### Query Parameters
- **prop** (string) - Optional - Which properties to get (comment, content, contentmodel, flags, ids, parsedcomment, roles, sha1, size, slotsha1, slotsize, tags, timestamp, user, userid).
- **limit** (limit) - Optional - How many revisions to return. Max: 5000.
- **user** (user) - Optional - Limit to revisions by this user.
- **namespace** (namespace) - Optional - Limit to revisions in this namespace.
- **start** (timestamp) - Optional - The timestamp to start enumerating from.
- **end** (timestamp) - Optional - The timestamp to stop enumerating at.
```

--------------------------------

### GET /api.php?action=query&list=deletedrevisions

Source: https://www.pcgamingwiki.com/w/api.php?action=help&recursivesubmodules=1

Retrieves deleted revision information. This module can be used to get deleted revisions for a set of pages by titles or pageids, or to get data about specific deleted revisions by their IDs.

```APIDOC
## GET /api.php?action=query&list=deletedrevisions

### Description
Get deleted revision information. May be used to retrieve deleted revisions for a set of pages by titles or pageids, or to get data about a set of deleted revisions by their IDs.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be set to `query`.
- **list** (string) - Required - Must be set to `deletedrevisions`.
- **format** (string) - Required - Response format (e.g., `json`, `xml`).
- **titles** (string) - Optional - Titles of pages to get deleted revisions for, separated by `|`.
- **pageids** (integer) - Optional - Page IDs to get deleted revisions for, separated by `|`.
- **revids** (integer) - Optional - Revision IDs to get data for, separated by `|`.
- **drvprop** (string) - Optional - Which properties to get for each revision. Values: `ids`, `flags`, `timestamp`, `user`, `userid`, `size`, `slotsize`, `sha1`, `slotsha1`, `contentmodel`, `comment`, `parsedcomment`, `content`, `tags`, `roles`, `parsetree`. Separate multiple values with `|`.
- **drvslots** (string) - Optional - Which revision slots to return data for. Values: `main`, `*` (all). Separate multiple values with `|`.
- **drvlimit** (integer) - Optional - Limit how many revisions will be returned. Maximum value is 500.
- **drvsection** (integer) - Optional - Only retrieve the content of this section number.
- **drvcontentformat** (string) - Optional - Serialization format used for `drvdifftotext` and expected for output of `content`. Values: `application/json`, `text/css`, `text/javascript`, `text/plain`, `text/x-wiki`.
- **drvstart** (timestamp) - Optional - The timestamp to start enumerating from. Ignored when processing a list of revision IDs.
- **drvend** (timestamp) - Optional - The timestamp to stop enumerating at. Ignored when processing a list of revision IDs.
- **drvdir** (string) - Optional - In which direction to enumerate. Values: `newer` (oldest first), `older` (newest first, default).
- **drvtag** (string) - Optional - Only list revisions tagged with this tag.
- **drvuser** (string) - Optional - Only list revisions by this user (user name, IP, or user ID).

### Deprecated Parameters
- **drvexpandtemplates** (boolean) - Use `action=expandtemplates` instead.
- **drvgeneratexml** (boolean) - Use `action=expandtemplates` or `action=parse` instead.
- **drvparse** (boolean) - Use `action=parse` instead.
- **drvdiffto** (string) - Use `action=compare` instead.
- **drvdifftotext** (string) - Use `action=compare` instead.
- **drvdifftotextpst** (boolean) - Use `action=compare` instead.

### Request Example
```json
{
  "action": "query",
  "list": "deletedrevisions",
  "format": "json",
  "titles": "ExamplePage",
  "drvprop": "ids|timestamp|user|comment"
}
```

### Response
#### Success Response (200)
- **query.deletedrevisions** (array) - An array of deleted revision objects.
  - Each object contains properties specified by `drvprop`.

#### Response Example
```json
{
  "batchcomplete": "",
  "continue": {
    "grvcontinue": "20230101000000|ExamplePage|12345"
  },
  "query": {
    "deletedrevisions": [
      {
        "revid": 12345,
        "parentid": 12344,
        "minor": "",
        "timestamp": "2023-01-01T00:00:00Z",
        "user": "ExampleUser",
        "userid": 67890,
        "size": 1024,
        "comment": "Initial revision"
      }
    ]
  }
}
```
```

--------------------------------

### API Parameter Formatting Examples

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=main

Demonstrates how to format parameters for API requests. Multiple values are pipe-separated, and values containing pipes use a Unit Separator.

```php
param=value1|value2
```

```php
param=value1%7Cvalue2
```

```php
param=%1Fvalue1%1Fvalue2
```

--------------------------------

### GET /api.php?action=query&prop=pageprops

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=query&submodules=1

Get various page properties defined in the page content.

```APIDOC
## GET /api.php?action=query&prop=pageprops

### Description
Get various page properties defined in the page content.

### Method
GET

### Endpoint
api.php?action=query&prop=pageprops

### Parameters
#### Query Parameters
- **ppcontinue** (string) - Optional - When more results are available, use this to continue.
- **ppprop** (string) - Optional - Only list these page properties.
```

--------------------------------

### Perform API Login

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=login

Example request for logging into the MediaWiki API using credentials and a login token.

```http
api.php?action=login&lgname=user&lgpassword=password&lgtoken=123ABC
```

--------------------------------

### Enumerate pages starting with a specific letter

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=query%2Ballpages

Retrieves a list of pages starting from the letter B.

```text
api.php?action=query&list=allpages&apfrom=B
```

--------------------------------

### GET /api.php?action=query&list=allpages

Source: https://www.pcgamingwiki.com/w/api.php?action=paraminfo&format=json&modules=parse%7Cphpfm%7Cquery%2Ballpages%7Cquery%2Bsiteinfo

Enumerates all pages in the wiki.

```APIDOC
## GET /api.php?action=query&list=allpages

### Description
Lists all pages sequentially in the wiki.

### Method
GET

### Endpoint
/api.php?action=query&list=allpages

### Parameters
#### Query Parameters
- **from** (string) - Optional - The page title to start enumerating from.
- **to** (string) - Optional - The page title to stop enumerating at.
- **prefix** (string) - Optional - Search for all page titles that begin with this value.
- **namespace** (namespace) - Optional - The namespace to enumerate (default: 0).
- **limit** (limit) - Optional - How many total pages to return (default: 10, max: 5000).
```

--------------------------------

### GET /api.php?action=expandtemplates

Source: https://www.pcgamingwiki.com/w/api.php?action=help&recursivesubmodules=1

Expands all templates within the provided wikitext.

```APIDOC
## GET /api.php?action=expandtemplates

### Description
Expands all templates within wikitext.

### Method
GET

### Endpoint
/api.php?action=expandtemplates

### Parameters
#### Query Parameters
- **title** (string) - Optional - Title of the page.
- **text** (string) - Required - Wikitext to convert.
- **revid** (integer) - Optional - Revision ID.
- **prop** (string) - Optional - Which pieces of information to get (categories, encodedjsconfigvars, jsconfigvars, modules, parsetree, properties, ttl, volatile, wikitext).
- **includecomments** (boolean) - Optional - Whether to include HTML comments in the output.
- **generatexml** (boolean) - Optional - Deprecated. Generate XML parse tree.

### Request Example
api.php?action=expandtemplates&text={{Project:Sandbox}}
```

--------------------------------

### Example JSON API Response

Source: https://www.pcgamingwiki.com/w/api.php?action=query&list=usercontribs&ucuser=Example

This is an example of the JSON output from the MediaWiki API. It is suitable for application use.

```json
{
    "batchcomplete": "",
    "query": {
        "usercontribs": []
    }
}
```

--------------------------------

### MediaWiki API JSON Response Example

Source: https://www.pcgamingwiki.com/w/api.php?action=checktoken&token=123ABC&type=csrf

Example of a JSON response from the MediaWiki API when checking a token.

```json
{
    "checktoken": {
        "result": "invalid"
    }
}
```

--------------------------------

### GET /api.php?action=query&list=alllinks

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=query%2Balllinks

Enumerate all links that point to a given namespace.

```APIDOC
## GET /api.php?action=query&list=alllinks

### Description
Enumerate all links that point to a given namespace. This module requires read rights and can be used as a generator.

### Method
GET

### Endpoint
/api.php?action=query&list=alllinks

### Parameters
#### Query Parameters
- **alcontinue** (string) - Optional - When more results are available, use this to continue.
- **alfrom** (string) - Optional - The title of the link to start enumerating from.
- **alto** (string) - Optional - The title of the link to stop enumerating at.
- **alprefix** (string) - Optional - Search for all linked titles that begin with this value.
- **alunique** (boolean) - Optional - Only show distinct linked titles. Cannot be used with alprop=ids.
- **alprop** (string) - Optional - Which pieces of information to include: ids, title. Default: title.
- **alnamespace** (integer) - Optional - The namespace to enumerate. Default: 0.
- **allimit** (integer) - Optional - How many total items to return. Value between 1 and 500. Default: 10.
- **aldir** (string) - Optional - The direction in which to list: ascending, descending. Default: ascending.

### Request Example
api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title

### Response
#### Success Response (200)
- **query** (object) - The result set containing the list of links.
```

--------------------------------

### Activate a change tag

Source: https://www.pcgamingwiki.com/w/api.php?action=help&modules=managetags

Use this example to activate a change tag, making it available for manual application by users. The tag must exist and not be in use by an extension.

```api
api.php?action=managetags&operation=activate&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC
```

--------------------------------

### Query allimages for files starting with T

Source: https://www.pcgamingwiki.com/w/api.php?action=help&recursivesubmodules=1

Retrieves information for 4 files starting with the letter T using the allimages generator.

```text
api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo
```
Tokens:
Raw