MediaWiki API 說明

此頁為自動產生的 MediaWiki API 說明文件頁面。

說明文件與範例:https://www.mediawiki.org/wiki/API

主要模組

(main)
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

狀態資訊:本頁所展示的所有功能都應正常工作,但是 API 仍在開發當中,將會隨時變化。請訂閱mediawiki-api-announce 郵件清單以便得到更新通知。

錯誤請求:當 API 收到錯誤請求時, HTTP header 將會返回一個包含「MediaWiki-API-Error」的值,隨後 header 的值與錯誤碼將會送回並設定為相同的值。詳細資訊請參閱API: 錯誤與警告

參數:
action

要執行的動作。

單值:abusefiltercheckmatchabusefilterchecksyntaxabusefilterevalexpressionabusefilterunblockautopromoteblockchangeauthenticationdatachecktokenclearhasmsgclientlogincomparecreateaccountdeleteechomarkreadechomarkseeneditemailuserembedvideoexpandtemplatesfeedcontributionsfeedrecentchangesfeedwatchlistfilerevertgeocodehelpimagerotateimportlinkaccountloginlogoutmanagetagsmergehistorymoveopensearchoptionsparaminfoparsepatrolprotectpurgequeryremoveauthenticationdataresetpasswordrevisiondeleterollbackrsdsetnotificationtimestampspamblackliststashedittagthanktitleblacklisttokensunblockundeleteunlinkaccountuploaduserrightswatch
預設值:help
format

輸出的格式。

單值:jsonjsonfmnonephpphpfmrawfmxmlxmlfm
預設值:jsonfm
maxlag

最大延迟可被用于MediaWiki安装于数据库复制集中。要保存导致更多网站复制延迟的操作,此参数可使客户端等待直到复制延迟少于指定值时。万一发生过多延迟,错误代码maxlag会返回消息,例如等待$host中:延迟$lag秒
参见Manual: Maxlag parameter以获取更多信息。

类型:整数
smaxage

设置s-maxage HTTP缓存控制头至这些秒。错误不会缓存。

类型:整数
預設值:0
maxage

设置max-age HTTP缓存控制头至这些秒。错误不会缓存。

类型:整数
預設值:0
assert

如果设置为user就验证用户是否登录,或如果设置为bot就验证是否有机器人用户权限。

單值:user、bot
requestid

任何在此提供的值将包含在响应中。可能可以用以区别请求。

servedby

包含保存结果请求的主机名。

类型:布尔值(详细信息
curtimestamp

在结果中包括当前时间戳。

类型:布尔值(详细信息
origin

当通过跨域名AJAX请求(CORS)访问API时,设置此作为起始域名。这必须包括在任何pre-flight请求中,并因此必须是请求的URI的一部分(而不是POST正文)。这必须匹配Origin中的一个起点:从头到底,因此它已经设置为像https://zh.wikipedia.orghttps://meta.wikimedia.org的东西。如果此参数不匹配Origin页顶,就返回403错误响应。如果此参数匹配Origin页顶并且起点被白名单,将设置一个Access-Control-Allow-Origin开头。

uselang

用于消息翻译的语言。action=query&meta=siteinfosiprop=languages可返回语言代码列表,或指定user以使用当前用户的语言设置,或指定content以使用此wiki的内容语言。

預設值:user
權限:
writeapi
使用寫入 API
已授權給: all、user、bot
apihighlimits
在API查询中使用更高的上限(慢查询:500;快查询:5000)。慢查询的限制也适用于多值参数。
已授權給: bot、sysop

action=abusefiltercheckmatch

  • 此模組需要讀取權限。
  • 来源:Abuse Filter
  • 许可协议:GPL-2.0+

检查以查看一组变量是否匹配防滥用过滤器,编辑者会被记录相关事件。

vars、rcid或logid是必须的,然而只有一个会被使用。

參數:
filter

要检查是否匹配的完整过滤器文本。

此參數為必填。
vars

要测试是否触发的JSON编码数组变量。

rcid

要检查是否触发的最近更改ID。

类型:整数
logid

用以检查的滥用过滤器日志ID。

类型:整数

action=abusefilterchecksyntax

  • 此模組需要讀取權限。
  • 来源:Abuse Filter
  • 许可协议:GPL-2.0+

检查一个防滥用过滤器的语法。

參數:
filter

要检查语法的完整过滤器文本。

此參數為必填。

action=abusefilterevalexpression

  • 此模組需要讀取權限。
  • 来源:Abuse Filter
  • 许可协议:GPL-2.0+

评估防滥用过滤器的表达式。

參數:
expression

要评估的表达式。

此參數為必填。

action=abusefilterunblockautopromote

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:Abuse Filter
  • 许可协议:GPL-2.0+

从由于防滥用过滤器的结果而接受的autopromotions解封用户。

參數:
user

您希望解封的用户的用户名。

此參數為必填。
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=block

(main | block)
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

封鎖使用者。

參數:
user

您要封鎖的使用者名稱、IP 位址或 IP 範圍。

此參數為必填。
类型:用户名
expiry

到期时间。可以是相对时间(例如5 months2 weeks)或绝对时间(例如2014-09-18T12:34:56Z)。如果设置为infiniteindefinitenever,封禁将无限期。

預設值:never
reason

封鎖原因。

預設值:(空)
anononly

僅封鎖匿名使用者 (禁止這個 IP 位址的匿名使用者編輯)。

类型:布尔值(详细信息
nocreate

禁止建立帳號。

类型:布尔值(详细信息
autoblock

自動封鎖最後使用的 IP 位址,以及在這之後嘗試登入的 IP 位址。

类型:布尔值(详细信息
noemail

禁止使用者透過 Wiki 寄送電子郵件。 (需要 blockemail 權限)。

类型:布尔值(详细信息
hidename

隱藏封鎖日誌的使用者名稱。 (需要 hideuser 權限)。

类型:布尔值(详细信息
allowusertalk

允許使用者編輯自己的對話頁面 (依據 $wgBlockAllowsUTEdit 的設定)。

类型:布尔值(详细信息
reblock

若使用者已被封鎖,覆寫既有的封鎖設定值。

类型:布尔值(详细信息
watchuser

監視使用者或 IP 位址的使用者頁面與對話頁面。

类型:布尔值(详细信息
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=changeauthenticationdata <pre>(changeauth) </pre>

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

Change authentication data for the current user.

參數:
changeauthrequest

Use this authentication request, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=change.

此參數為必填。
changeauthtoken

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。
*
This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=change (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.

action=checktoken

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

檢查來自 action=query&meta=tokens 的密鑰有效性。

參數:
type

要測試的密鑰類型。

此參數為必填。
單值:createaccount、csrf、login、patrol、rollback、userrights、watch
token

要測試的密鑰。

此參數為必填。
maxtokenage

密鑰的有效期間,以秒為單位。

类型:整数

action=clearhasmsg

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

清除目前使用者的 hasmsg 標記。

範例:
清除目前使用者的 hasmsg 標記。
api.php?action=clearhasmsg [在沙盒中打开]

action=clientlogin <pre>(login) </pre>

  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

Log in to the wiki using the interactive flow.

The general procedure to use this module is:

  1. Fetch the fields available from action=query&meta=authmanagerinfo with amirequestsfor=login, and a login token from action=query&meta=tokens.
  2. Present the fields to the user, and obtain their submission.
  3. Post to this module, supplying loginreturnurl and any relevant fields.
  4. Check the status in the response.
    • If you received PASS or FAIL, you're done. The operation either succeeded or it didn't.
    • If you received UI, present the new fields to the user and obtain their submission. Then post to this module with logincontinue and the relevant fields set, and repeat step 4.
    • If you received REDIRECT, direct the user to the redirecttarget and wait for the return to loginreturnurl. Then post to this module with logincontinue and any fields passed to the return URL, and repeat step 4.
    • If you received RESTART, that means the authentication worked but we don't have an linked user account. You might treat this as UI or as FAIL.
參數:
loginrequests

Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=login or from a previous response from this module.

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
loginmessageformat

Format to use for returning messages.

單值:html、wikitext、raw、none
預設值:wikitext
loginmergerequestfields

Merge field information for all authentication requests into one array.

类型:布尔值(详细信息
loginpreservestate

Preserve state from a previous failed login attempt, if possible.

类型:布尔值(详细信息
loginreturnurl

Return URL for third-party authentication flows, must be absolute. Either this or logincontinue is required.

Upon receiving a REDIRECT response, you will typically open a browser or web view to the specified redirecttarget URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a logincontinue request to this API module.

logincontinue

This request is a continuation after an earlier UI or REDIRECT response. Either this or loginreturnurl is required.

类型:布尔值(详细信息
logintoken

action=query&meta=tokens 接收的 "login" 密鑰。

此參數為必填。
*
This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=login (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.
範例:
Start the process of logging in to the wiki as user Example with password ExamplePassword.
api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [在沙盒中打开]
Continue logging in after a UI response for two-factor auth, supplying an OATHToken of 987654.
api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [在沙盒中打开]

action=compare

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

比較 2 個頁面間的差異。

"from" 以及 "to" 的修訂編號,頁面標題或頁面 ID 為必填。

參數:
fromtitle

要比對的第一個標題。

fromid

要比對的第一個頁面 ID。

类型:整数
fromrev

要比對的第一個修訂。

类型:整数
totitle

要比對的第二個標題。

toid

要比對的第二個頁面 ID。

类型:整数
torev

要比對的第二個修訂。

类型:整数
範例:
建立修訂 1 與 1 的差異檔
api.php?action=compare&fromrev=1&torev=2 [在沙盒中打开]

action=createaccount <pre>(create) </pre>

  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

建立新使用者帳號。

The general procedure to use this module is:

  1. Fetch the fields available from action=query&meta=authmanagerinfo with amirequestsfor=create, and a createaccount token from action=query&meta=tokens.
  2. Present the fields to the user, and obtain their submission.
  3. Post to this module, supplying createreturnurl and any relevant fields.
  4. Check the status in the response.
    • If you received PASS or FAIL, you're done. The operation either succeeded or it didn't.
    • If you received UI, present the new fields to the user and obtain their submission. Then post to this module with createcontinue and the relevant fields set, and repeat step 4.
    • If you received REDIRECT, direct the user to the redirecttarget and wait for the return to createreturnurl. Then post to this module with createcontinue and any fields passed to the return URL, and repeat step 4.
    • If you received RESTART, that means the authentication worked but we don't have an linked user account. You might treat this as UI or as FAIL.
參數:
createrequests

Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=create or from a previous response from this module.

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
createmessageformat

Format to use for returning messages.

單值:html、wikitext、raw、none
預設值:wikitext
createmergerequestfields

Merge field information for all authentication requests into one array.

类型:布尔值(详细信息
createpreservestate

Preserve state from a previous failed login attempt, if possible.

If action=query&meta=authmanagerinfo returned true for hasprimarypreservedstate, requests marked as primary-required should be omitted. If it returned a non-empty value for preservedusername, that username must be used for the username parameter.

类型:布尔值(详细信息
createreturnurl

Return URL for third-party authentication flows, must be absolute. Either this or createcontinue is required.

Upon receiving a REDIRECT response, you will typically open a browser or web view to the specified redirecttarget URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a createcontinue request to this API module.

createcontinue

This request is a continuation after an earlier UI or REDIRECT response. Either this or createreturnurl is required.

类型:布尔值(详细信息
createtoken

action=query&meta=tokens 接收的 "createaccount" 密鑰。

此參數為必填。
*
This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=create (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.

action=delete

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

刪除頁面。

參數:
title

您欲刪除的頁面標題。 無法與 pageid 同時使用。

pageid

您欲刪除頁面的頁面 ID。 無法與 title 同時使用。

类型:整数
reason

刪除的原因。 若未設定,將會使用自動產生的原因。

tags

要在删除日志中应用到实体的更改标签。

多值 (以 | 分隔):
watch
已停用。

加入目前頁面至您的監視清單。

类型:布尔值(详细信息
watchlist

無條件使用設置將頁面加入或移除目前使用者的監視清單或者是不更改監視清單。

單值:watch、unwatch、preferences、nochange
預設值:preferences
unwatch
已停用。

從您的監視清單中移除目前頁面。

类型:布尔值(详细信息
oldimage

action=query&prop=imageinfo&iiprop=archivename 所提供要刪除的舊圖片名稱。

token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=echomarkread

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:Echo
  • 许可协议:MIT

標記目前使用者的通知為已讀。

參數:
list

要標記為已讀的通知 ID 清單。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
unreadlist

要标记未读的通知ID列表。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
all

若設定,標記所有某個使用者的通知為已讀。

类型:布尔值(详细信息
sections

要標記為已讀的章節清單。

多值 (以 | 分隔):alert、message
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=echomarkseen

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:Echo
  • 许可协议:MIT

標記目前使用者的通知為已讀

參數:
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。
type

標記為已讀的通知類型:'alert'、'message' 或 'all'。

此參數為必填。
單值:alert、message、all
範例:
標記所有類型的通知為已讀
api.php?action=echomarkseen&type=all [在沙盒中打开]

action=edit

(main | edit)
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

建立與編輯頁面。

參數:
title

您欲編輯的頁面標題。 無法與 pageid 同時使用。

pageid

您欲編輯頁面的頁面 ID。 無法與 title 同時使用。

类型:整数
section

章節編號。 0 代表最上層章節,new 代表新章節。

sectiontitle

新章節的標題。

text

頁面內容。

summary

編輯摘要。 當未設定 section=new 與 sectiontitle 時也會當做章節標題。

tags

更改标签以应用修订。

多值 (以 | 分隔):
minor

小編輯。

类型:布尔值(详细信息
notminor

非小編輯。

类型:布尔值(详细信息
bot

標記此編輯為機器人編輯。

类型:布尔值(详细信息
basetimestamp

基於修訂的時間戳記,用來檢測編輯衝突。也许可以取得action=query&prop=revisions&rvprop=timestamp認可。

类型:时间戳(允许格式
starttimestamp

编辑过程开始的时间戳,用于检测编辑冲突。当开始编辑过程时(例如当加载要编辑的页面时)使用curtimestamp可能取得一个适当的值。

类型:时间戳(允许格式
recreate

覆盖有关该页面在此期间已被删除的任何错误。

类型:布尔值(详细信息
createonly

若頁面已存在,則不編輯頁面。

类型:布尔值(详细信息
nocreate

若頁面不存在,則產生錯誤。

类型:布尔值(详细信息
watch
已停用。

加入目前頁面至您的監視清單。

类型:布尔值(详细信息
unwatch
已停用。

從您的監視清單中移除目前頁面。

类型:布尔值(详细信息
watchlist

无条件地将页面加入至当前用户的监视列表或将其移除,使用设置或不更改监视。

單值:watch、unwatch、preferences、nochange
預設值:preferences
md5

text参数或prependtext和appendtext级联参数的MD5哈希值。如果设置,除非哈希值正确否则编辑无法完成。

prependtext

将该文本添加到该页面的开始。覆盖text。

appendtext

将该文本添加到该页面的结尾。覆盖text。

采用section=new来添加一个新的章节,而不是这个参数。

undo

撤销此次修订。覆盖text、prependtext和appendtext。

类型:整数
undoafter

撤销从undo至此的所有修订。如果不设置就撤销一次修订。

类型:整数
redirect

自动解决重定向。

类型:布尔值(详细信息
contentformat

用于输入文本的内容序列化格式。

單值:application/json、text/x-wiki、text/javascript、text/css、text/plain
contentmodel

新内容的内容模型。

單值:GadgetDefinition、wikitext、javascript、json、css、text
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

令牌应总是发送为最后参数,或至少在text参数之后。

此參數為必填。
captchaword

回答验证码

captchaid

之前请求的验证码ID

action=emailuser

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

寄送電子郵件給使用者。

參數:
target

電子郵件的收件使用者。

此參數為必填。
subject

郵件主旨。

text

郵件內容。

此參數為必填。
ccme

寄送一份此郵件的複本給我。

类型:布尔值(详细信息
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。
範例:
寄送電子郵件給使用者 WikiSysop 使用內容 Content
api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC [在沙盒中打开]

action=embedvideo

  • 此模組需要讀取權限。
  • 来源:EmbedVideo
  • 许可协议:MIT

Get generated embed code for given parameters

參數:
service

Name of the service (youtube, twitch, ect)

此參數為必填。
id

The ID of the video for that service

此參數為必填。
dimensions

Either a numeric width (100) or width by height (100x100)

alignment

Alignment of video

description

Description of video

container

Accepts frame, or leave empty

urlargs

Additional arguments to pass in the video url (for some services)

autoresize

Auto resize video? (true or false)

action=expandtemplates

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

展開所有於 wikitext 中模板。

參數:
title

頁面標題。

預設值:API
text

要轉換的 Wikitext。

此參數為必填。
revid

修订版本ID,用于{{REVISIONID}}和类似变体。

类型:整数
prop

要获取的那条信息。

注意如果没有选定值,结果将包含wiki文本,但将以弃用的格式显示。

wikitext
扩充的wiki文本。
categories
任何在输出中提供的,未在wiki文本输出中表现的分类。
properties
由wiki文本中扩充的魔术字定义的页面属性。
volatile
无论输出是否常常变动,均不应被在页面中其他任何位置重用。
ttl
结果缓存应无效化后的最长时间。
modules
任何解析器函数请求添加至输出的ResourceLoader模块。无论jsconfigvars还是encodedjsconfigvars都必须与modules共同被请求。
jsconfigvars
针对页面提供JavaScript配置变量。
encodedjsconfigvars
针对页面提供JavaScript配置变量为一个JSON字符串。
parsetree
输入的XML分析树。
多值 (以 | 分隔):wikitext、categories、properties、volatile、ttl、modules、jsconfigvars、encodedjsconfigvars、parsetree
includecomments

输出时是否包含HTML摘要。

类型:布尔值(详细信息
generatexml
已停用。

生成XML解析树(取代自prop=parsetree)。

类型:布尔值(详细信息

action=feedcontributions

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

回傳使用者貢獻 Feed。

參數:
feedformat

Feed 的格式。

單值:rss、atom
預設值:rss
user

获取哪些用户的贡献。

此參數為必填。
类型:用户名
namespace

过滤哪些命名空间的贡献。

單值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
year

起始年份(及更早)。

类型:整数
month

起始月份(及更早)。

类型:整数
tagfilter

过滤有这些标签的贡献者。

多值 (以 | 分隔):疑似機器人,若誤判請聯絡管理員。
預設值:(空)
deletedonly

仅显示已删除的贡献。

类型:布尔值(详细信息
toponly

仅仅显示那些作为最新修订的编辑。

类型:布尔值(详细信息
newonly

仅仅显示那些作为页面创建的编辑。

类型:布尔值(详细信息
showsizediff

顯示修訂版本之間的差異大小。

类型:布尔值(详细信息
範例:
返回使用者Example的貢獻。
api.php?action=feedcontributions&user=Example [在沙盒中打开]

action=feedrecentchanges

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

返回最近變更摘要。

參數:
feedformat

摘要格式。

單值:rss、atom
預設值:rss
namespace

用於限制結果的命名空間。

單值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
invert

除所選定者外的所有命名空間。

类型:布尔值(详细信息
associated

包括相关的命名空间(讨论页或主要)。

类型:布尔值(详细信息
days

用于限制结果的天数。

數值不可小於 1。
类型:整数
預設值:7
limit

回傳的結果數量上限。

數值必須在 1 與 50 之間。
类型:整数
預設值:50
from

显示自那时以来的更改。

类型:时间戳(允许格式
hideminor

隱藏小編輯。

类型:布尔值(详细信息
hidebots

隱藏由機器人做的變更。

类型:布尔值(详细信息
hideanons

隱藏匿名使用者做的變更。

类型:布尔值(详细信息
hideliu

隱藏已註冊使用者做的變更。

类型:布尔值(详细信息
hidepatrolled

隱藏已巡查的變更。

类型:布尔值(详细信息
hidemyself

隐藏当前用户做出的更改。

类型:布尔值(详细信息
hidecategorization

隐藏分类成员更改。

类型:布尔值(详细信息
tagfilter

按标签过滤。

target

仅仅显示从该页面链出的那些页面的变更。

showlinkedto

仅仅显示链入到该页面的那些页面的变更。

类型:布尔值(详细信息

action=feedwatchlist

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

返回監視清單 feed。

參數:
feedformat

Feed 的格式。

單值:rss、atom
預設值:rss
hours

列出从现在起数小时内修改的页面。

數值必須在 1 與 72 之間。
类型:整数
預設值:24
linktosections

如果可能的话,直接链接到已变更的小节。

类型:布尔值(详细信息
allrev

将同一页面的多个修订包含于指定的时间表内。

类型:布尔值(详细信息
wlowner

与token一起使用以访问不同用户的监视列表。

类型:用户名
wltoken

允许访问其他用户监视列表的安全密钥(可通过用户的参数设置找到)。

wlshow

只显示满足这些标准的项目。例如,要只查看由登录用户做出的小编辑,设置show=minor|!anon。

多值 (以 | 分隔):minor、!minor、bot、!bot、anon、!anon、patrolled、!patrolled、unread、!unread
wltype

要显示的更改类型:

edit
普通页面编辑。
new
页面创建。
log
日志记录。
external
外部更改。
categorize
分类成员组更改。
多值 (以 | 分隔):edit、new、log、external、categorize
預設值:edit|new|log|categorize
wlexcludeuser

不要列出此用户的更改。

类型:用户名
範例:
显示监视列表订阅。
api.php?action=feedwatchlist [在沙盒中打开]
显示过去6小时内受监视页面的所有更改。
api.php?action=feedwatchlist&allrev=&hours=6 [在沙盒中打开]

action=filerevert

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

回退一个文件至某一旧版本。

參數:
filename

目标文件名,不包含前缀“File:”。

此參數為必填。
comment

上載意見。

預設值:(空)
archivename

恢复到修订版存档名称。

此參數為必填。
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=geocode

  • 此模組需要讀取權限。
  • 来源:Maps
  • 许可协议:GPL-2.0+

API module for geocoding.

參數:
locations

The locations to geocode

此參數為必填。
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
service

The geocoding service to use

單值:google、geocoderus、nominatim
props
(無描述)
多值 (以 | 分隔):lat、lon、alt
預設值:lat|lon

action=help

(main | help)
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

显示指定模块的帮助。

參數:
modules

用于显示帮助的模块(actionformat参数值,或main)。可通过+指定子模块。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
預設值:main
submodules

包括给定名称模块的子模块的帮助。

类型:布尔值(详细信息
recursivesubmodules

包括递归子模块的帮助。

类型:布尔值(详细信息
wrap

在一个标准API响应结构中包裹输出。

类型:布尔值(详细信息
toc

在HTML输出中包括目录。

类型:布尔值(详细信息

action=imagerotate

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

旋轉一張或多張圖片。

參數:
rotation

顺时针旋转图像的度数。

此參數為必填。
單值:90、180、270
continue

当更多结果可用时,使用这个继续。

titles

要使用的標題清單。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
pageids

要使用的頁面 ID 清單。

类型:整数列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
revids

要使用的修訂 ID 清單。

类型:整数列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
generator

通过执行指定查询模块获得页面列表以工作。

注意:发生器参数名称必须以“g”开头,参见例子。

單值:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

自动解决在titlespageidsrevids,以及在由generator返回的页面中的重定向。

类型:布尔值(详细信息
converttitles

如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括gan、iu、kk、ku、shi、sr、tg、uz、zh。

类型:布尔值(详细信息
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=import

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

从另一个wiki或从一个XML文件导入页面。

注意当发送一个用于xml参数的文件时,HTTP POST必须作为一次文件上传完成(也就是使用multipart/form-data)。

參數:
summary

匯入摘要。

xml

上載的 XML 檔。

必須使用 multipart/form-data 以檔案上傳的方式傳送。
interwikisource

用於跨 wiki 匯入:匯入的來源 wiki。

單值:
interwikipage

用於跨 wiki 匯入:匯入的頁面。

fullhistory

用於跨 wiki 匯入:完整匯入歷史,而不只是最新版本。

类型:布尔值(详细信息
templates

用於跨 wiki 匯入:匯入一切包含的模板。

类型:布尔值(详细信息
namespace

用於跨 wiki 匯入:匯入至此命名空間。

單值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
rootpage

匯入作為此頁面的子頁面。

token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=linkaccount <pre>(link) </pre>

  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

Link an account from a third-party provider to the current user.

The general procedure to use this module is:

  1. Fetch the fields available from action=query&meta=authmanagerinfo with amirequestsfor=link, and a csrf token from action=query&meta=tokens.
  2. Present the fields to the user, and obtain their submission.
  3. Post to this module, supplying linkreturnurl and any relevant fields.
  4. Check the status in the response.
    • If you received PASS or FAIL, you're done. The operation either succeeded or it didn't.
    • If you received UI, present the new fields to the user and obtain their submission. Then post to this module with linkcontinue and the relevant fields set, and repeat step 4.
    • If you received REDIRECT, direct the user to the redirecttarget and wait for the return to linkreturnurl. Then post to this module with linkcontinue and any fields passed to the return URL, and repeat step 4.
    • If you received RESTART, that means the authentication worked but we don't have an linked user account. You might treat this as UI or as FAIL.
參數:
linkrequests

Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=link or from a previous response from this module.

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
linkmessageformat

Format to use for returning messages.

單值:html、wikitext、raw、none
預設值:wikitext
linkmergerequestfields

Merge field information for all authentication requests into one array.

类型:布尔值(详细信息
linkreturnurl

Return URL for third-party authentication flows, must be absolute. Either this or linkcontinue is required.

Upon receiving a REDIRECT response, you will typically open a browser or web view to the specified redirecttarget URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a linkcontinue request to this API module.

linkcontinue

This request is a continuation after an earlier UI or REDIRECT response. Either this or linkreturnurl is required.

类型:布尔值(详细信息
linktoken

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。
*
This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=link (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.

action=login <pre>(lg) </pre>

(main | login)
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

登录并获得身份验证Cookie。

在成功登录的情况下,所需的Cookie将包含在HTTP响应头中。在登录失败的情况下,进一步的尝试可能会被自动密码猜解攻击的限制所遏制。

參數:
lgname

使用者名稱。

lgpassword

密碼。

lgdomain

網域名稱(可選)。

lgtoken

action=query&meta=tokens 接收的 "login" 密鑰。

action=logout

  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

登出並清除 session 資料。

範例:
登出當前使用者
api.php?action=logout [在沙盒中打开]

action=managetags

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

执行有关更改标签的管理任务。

參數:
operation

要执行哪个操作:

create
创建一个新的更改标签供手动使用。
delete
从数据库中移除一个更改标签,包括移除已使用在所有修订版本、最近更改记录和日志记录上的该标签。
activate
激活一个更改标签,允许用户手动应用它。
deactivate
停用一个更改标签,阻止用户手动应用它。
此參數為必填。
單值:create、delete、activate、deactivate
tag

要创建、删除、激活或取消激活的标签。要创建标签,标签必须不存在。要删除标签,标签必须存在。要激活标签,标签必须存在,且不被任何扩展使用。要取消激活标签,标签必须当前处于激活状态,且被手动定义。

此參數為必填。
reason

一个创建、删除、激活或停用标签时的原因,可选。

ignorewarnings

是否忽略操作期间发生的任何警告。

类型:布尔值(详细信息
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=mergehistory

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

合并页面历史。

參數:
from

将被合并历史的页面的标题。不能与fromid一起使用。

fromid

将被合并历史的页面的页面ID。不能与from一起使用。

类型:整数
to

将要合并历史的页面的标题。不能与toid一起使用。

toid

将要合并历史的页面的页面ID。不能与to一起使用。

类型:整数
timestamp

Timestamp up to which revisions will be moved from the source page's history to the destination page's history. If omitted, the entire page history of the source page will be merged into the destination page.

类型:时间戳(允许格式
reason

历史合并的原因。

預設值:(空)
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=move

(main | move)
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

移動頁面。

參數:
from

重新命名本頁面的標題。不能與 fromid 一起出現。

fromid

重新命名本頁面的 ID 。不能與 fromid 一起出現。

类型:整数
to

將本頁面的標題重新命名為

此參數為必填。
reason

重新命名的原因。

預設值:(空)
movetalk

重命名讨论页,如果存在。

类型:布尔值(详细信息
movesubpages

如果適用,則重新命名子頁面。

类型:布尔值(详细信息
noredirect

不要建立重新導向。

类型:布尔值(详细信息
watch
已停用。

将页面和重定向加入至当前用户的监视列表中。

类型:布尔值(详细信息
unwatch
已停用。

从当前用户的监视列表中移除页面及重定向。

类型:布尔值(详细信息
watchlist

无条件地将页面加入至当前用户的监视列表或将其移除,使用设置或不更改监视。

單值:watch、unwatch、preferences、nochange
預設值:preferences
ignorewarnings

忽略所有警告。

类型:布尔值(详细信息
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=opensearch

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

使用 OpenSearch 協定搜尋本 wiki。

參數:
search

搜尋字串。

limit

回傳的結果數量上限。

不允許超過 100 (機器人為 100)。
类型:整数或max
預設值:10
namespace

搜尋的命名空間。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
預設值:0
suggest

如果$wgEnableOpenSearchSuggest设置为false则不做任何事情。

类型:布尔值(详细信息
redirects

如何处理重定向:

return
返回重定向本身。
resolve
返回目标页面。可能返回少于limit个结果。

由于历史原因,format=json默认为"return",其他格式默认为"resolve"。

單值:return、resolve
format

輸出的格式。

單值:json、jsonfm、xml、xmlfm
預設值:json
warningsaserror

如果警告通过format=json提升,返回一个API错误而不是忽略它们。

类型:布尔值(详细信息
範例:
查找以Te开头的页面。
api.php?action=opensearch&search=Te [在沙盒中打开]

action=options

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

更改当前用户的偏好设置。

只有注册在核心或者已安装扩展中的选项,或者具有userjs-键值前缀(旨在被用户脚本使用)的选项可被设置。

參數:
reset

重設偏好設定為網站預設值。

类型:布尔值(详细信息
resetkinds

reset选项被设置时,要重置的选项类型列表。

多值 (以 | 分隔):registered、registered-multiselect、registered-checkmatrix、userjs、special、unused、all
預設值:all
change

更改列表,以name=value格式化(例如skin=vector)。值不能包含管道字符。如果没提供值(甚至没有等号),例如optionname|otheroption|...,选项将重置为默认值。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
optionname

应设置为由optionvalue提供值的选项名称。

optionvalue

用于由optionname指定的选项的值,可以包含管道字符。

token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=paraminfo

  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

获得关于API模块的信息。

參數:
modules

模块名称(actionformat参数值,或main)的列表。可通过+指定子模块。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
helpformat

帮助字符串的格式。

單值:html、wikitext、raw、none
預設值:none
querymodules
已停用。

查询模块名称(propmetalist参数值)的列表。使用modules=query+foo而不是querymodules=foo

多值 (以 | 分隔):abusefilters、abuselog、allcategories、alldeletedrevisions、allfileusages、allimages、alllinks、allmessages、allpages、allredirects、allrevisions、alltransclusions、allusers、authmanagerinfo、backlinks、betafeatures、blocks、categories、categoryinfo、categorymembers、contributors、deletedrevisions、deletedrevs、duplicatefiles、embeddedin、extlinks、exturlusage、filearchive、filerepoinfo、fileusage、gadgetcategories、gadgets、imageinfo、images、imageusage、info、iwbacklinks、iwlinks、langbacklinks、langlinks、links、linkshere、logevents、mystashedfiles、notifications、pagepropnames、pageprops、pageswithprop、prefixsearch、protectedtitles、querypage、random、recentchanges、redirects、references、revisions、search、siteinfo、stashimageinfo、tags、templates、tokens、transcludedin、usercontribs、userinfo、users、watchlist、watchlistraw
上限值為 50 (機器人為 500)。
mainmodule
已停用。

获取有关主要(最高级)模块的信息。也可使用modules=main

pagesetmodule
已停用。

获取有关页面设置模块(提供titles=和朋友)的信息。

formatmodules
已停用。

格式模块名称(format参数的值)的列表。也可使用modules

多值 (以 | 分隔):json、jsonfm、none、php、phpfm、rawfm、xml、xmlfm

action=parse

(main | parse)
  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

解析内容并返回解析器输出。

参见action=query的各种prop-module以从页面的当前版本获得信息。

这里有几种方法可以指定解析的文本:

  1. 指定一个页面或修订,使用pagepageidoldid
  2. 明确指定内容,使用texttitlecontentmodel
  3. 只指定一段摘要解析。prop应提供一个空值。
參數:
title

文本属于的页面标题。如果省略,contentmodel就必须被指定,且API将作为标题使用。

text

要解析的文本。使用titlecontentmodel以控制内容模型。

summary

所要解析的摘要。

page

解析此页的内容。不能与texttitle一起使用。

pageid

解析此页的内容。覆盖page

类型:整数
redirects

如果pagepageid被设置为一个重定向,则解析它。

类型:布尔值(详细信息
oldid

解析该修订版本的内容。覆盖pagepageid

类型:整数
prop

要获取的信息束:

text
提供wiki文本中的被解析文本。
langlinks
在被解析的wiki文本中提供语言链接。
categories
在被解析的wiki文本中提供分类。
categorieshtml
提供HTML版本分类。
links
在被解析的wiki文本中提供内部链接。
templates
在被解析的wiki文本中提供模板。
images
在被解析的wiki文本中提供图片。
externallinks
在被解析的wiki文本中提供外部链接。
sections
在被解析的wiki文本中提供段落。
revid
添加被解析页面的修订ID。
displaytitle
为被解析的wiki文本添加标题。
headitems
提供项目以插入至页面的<head>
headhtml
提供页面的被解析<head>
modules
提供在页面中使用的ResourceLoader模块。无论jsconfigvars还是encodedjsconfigvars都必须与modules共同被请求。
jsconfigvars
针对页面提供JavaScript配置变量。
encodedjsconfigvars
针对页面提供JavaScript配置变量为一个JSON字符串。
indicators
提供页面上使用的页面状态指示器的HTML。
iwlinks
在被解析的wiki文本中提供跨wiki链接。
wikitext
提供被解析的原始wiki文本。
properties
提供多种定义在被解析的wiki文本中的属性。
limitreportdata
以结构化的方式提供限制报告。如果disablelimitreport被设定则不提供数据。
limitreporthtml
提供限制报告的HTML版本。当disablelimitreport被设置时不会提供数据。
parsetree
修订内容的XML解析树(需要内容模型wikitext
多值 (以 | 分隔):text、langlinks、categories、categorieshtml、links、templates、images、externallinks、sections、revid、displaytitle、headitems、headhtml、modules、jsconfigvars、encodedjsconfigvars、indicators、iwlinks、wikitext、properties、limitreportdata、limitreporthtml、parsetree
預設值:text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties
pst

在解析输入前,对输入做一次保存前变换处理。仅当使用文本时有效。

类型:布尔值(详细信息
onlypst

在输入内容中执行预保存转换(PST),但不解析它。在PST被应用后返回相同的wiki文本。只当与text一起使用时有效。

类型:布尔值(详细信息
effectivelanglinks

包含由扩展提供的语言链接(用于与prop=langlinks一起使用)。

类型:布尔值(详细信息
section

只解析此段数的内容。

new时,将textsectiontitle解析为添加新段落至页面。

new段落只当指定text时允许。

sectiontitle

sectionnew时新段落标题。

不像页面编辑,当省略或为空时将不会备选为summary

disablepp
已停用。

请改用disablelimitreport

类型:布尔值(详细信息
disablelimitreport

从解析器输出中省略限制报告(“NewPP limit report”)。

类型:布尔值(详细信息
disableeditsection

从解析器输出中省略编辑段落链接。

类型:布尔值(详细信息
disabletidy

不要在解析器输出中运行HTML清理(例如tidy)。

类型:布尔值(详细信息
generatexml
已停用。

生成XML解析树(需要内容模型wikitext;被prop=parsetree所取代)。

类型:布尔值(详细信息
preview

在预览模式下解析。

类型:布尔值(详细信息
sectionpreview

在段落预览模式下解析(同时要启用预览模式)。

类型:布尔值(详细信息
disabletoc

在输出中省略目录。

类型:布尔值(详细信息
contentformat

用于输入文本的内容序列化格式。只当与text一起使用时有效。

單值:application/json、text/x-wiki、text/javascript、text/css、text/plain
contentmodel

输入文本的内容模型。如果省略,title必须指定,并且默认将为指定标题的模型。只当与text一起使用时有效。

單值:GadgetDefinition、wikitext、javascript、json、css、text

action=patrol

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

巡查一個頁面或修訂。

參數:
rcid

要巡查的最近變更 ID。

类型:整数
revid

要巡查的修訂 ID。

类型:整数
tags

要在巡查日志中应用到实体的更改标签。

多值 (以 | 分隔):
token

action=query&meta=tokens 接收的 "patrol" 密鑰。

此參數為必填。

action=protect

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

變更頁面的保護層級。

參數:
title

要(解除)保護頁面的標題。 不能與 pageid 一起使用。

pageid

要(解除)保護頁面的 ID。 不能與 title 一起使用。

类型:整数
protections

保護層級清單,格式為 action=level (例如 edit=sysop)。

注意: 任何未列入清單項目的限制將會被移除。

此參數為必填。
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
expiry

期限時間戳記,若只設定一個時間戳記,該時間戳記將會套用至所有的保護層級。 使用 infiniteindefiniteinfinitynever 來設定保護層級期限為永遠。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
預設值:infinite
reason

(解除)保護的原因。

預設值:(空)
tags

要在保护日志中应用到实体的更改标签。

多值 (以 | 分隔):
cascade

启用连锁保护(也就是保护包含于此页面的页面)。如果所有提供的保护等级不支持连锁,就将其忽略。

类型:布尔值(详细信息
watch
已停用。

如果设置,就加入已开始(解除)保护的页面至当前用户的监视列表。

类型:布尔值(详细信息
watchlist

无条件地将页面加入至当前用户的监视列表或将其移除,使用设置或不更改监视。

單值:watch、unwatch、preferences、nochange
預設值:preferences
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=purge

(main | purge)
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

为指定标题刷新缓存。

如果用户尚未登录的话,就需要POST请求。

參數:
forcelinkupdate

更新链接表。

类型:布尔值(详细信息
forcerecursivelinkupdate

更新链接表中,并更新任何使用此页作为模板的页面的链接表。

类型:布尔值(详细信息
continue

当更多结果可用时,使用这个继续。

titles

要使用的標題清單。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
pageids

要使用的頁面 ID 清單。

类型:整数列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
revids

要使用的修訂 ID 清單。

类型:整数列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
generator

通过执行指定查询模块获得页面列表以工作。

注意:发生器参数名称必须以“g”开头,参见例子。

單值:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

自动解决在titlespageidsrevids,以及在由generator返回的页面中的重定向。

类型:布尔值(详细信息
converttitles

如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括gan、iu、kk、ku、shi、sr、tg、uz、zh。

类型:布尔值(详细信息

action=query

(main | query)
  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

获取来自和有关MediaWiki的数据。

所有数据修改将首先要使用查询以获得令牌以阻止来自恶意网站的滥用破坏。

參數:
prop

要为已查询页面获取的属性。

多值 (以 | 分隔):categoriescategoryinfocontributorsdeletedrevisionsduplicatefilesextlinksfileusageimageinfoimagesinfoiwlinkslanglinkslinkslinksherepagepropsredirectsreferencesrevisionsstashimageinfotemplatestranscludedin
list

要获取的列表。

多值 (以 | 分隔):abusefiltersabuselogallcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsallusersbacklinksbetafeaturesblockscategorymembersdeletedrevsembeddedinexturlusagefilearchivegadgetcategoriesgadgetsimageusageiwbacklinkslangbacklinkslogeventsmystashedfilespagepropnamespageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangessearchtagsusercontribsuserswatchlistwatchlistraw
meta

要获取的元数据。

多值 (以 | 分隔):allmessagesauthmanagerinfofilerepoinfonotificationssiteinfotokensuserinfo
indexpageids

包含一个额外的pageid段落,列举所有返回的页面ID。

类型:布尔值(详细信息
export

导出所有指定或生成页面的当前修订。

类型:布尔值(详细信息
exportnowrap

返回导出XML,不需要将其包裹在一个XML结果中(与Special:Export格式相同)。只能与export一起使用。

类型:布尔值(详细信息
iwurl

如果标题是一个跨wiki链接的话,是否获取完整URL。

类型:布尔值(详细信息
continue

当更多结果可用时,使用这个继续。

rawcontinue

为继续返回原始query-continue数据。

类型:布尔值(详细信息
titles

要使用的標題清單。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
pageids

要使用的頁面 ID 清單。

类型:整数列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
revids

要使用的修訂 ID 清單。

类型:整数列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
generator

通过执行指定查询模块获得页面列表以工作。

注意:发生器参数名称必须以“g”开头,参见例子。

單值:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

自动解决在titlespageidsrevids,以及在由generator返回的页面中的重定向。

类型:布尔值(详细信息
converttitles

如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括gan、iu、kk、ku、shi、sr、tg、uz、zh。

类型:布尔值(详细信息

prop=categories <pre>(cl) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

页面属于的所有分类列表。

參數:
clprop

要为每个分类获取的额外属性:

sortkey
为每个分类添加关键词(十六进制字符串)和关键词前缀(人类可读部分)。
timestamp
添加分类添加时的时间戳。
hidden
标记由__HIDDENCAT__隐藏的分类。
多值 (以 | 分隔):sortkey、timestamp、hidden
clshow

显示何种分类。

多值 (以 | 分隔):hidden、!hidden
cllimit

要回傳的分類數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
clcontinue

当更多结果可用时,使用这个继续。

clcategories

只列出这些分类。对于检查某一页面使用某一分类很有用。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
cldir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending

prop=categoryinfo <pre>(ci) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

回傳有關指定分類的資訊。

參數:
cicontinue

当更多结果可用时,使用这个继续。

範例:
获取有关Category:FooCategory:Bar的信息。
api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar [在沙盒中打开]

prop=contributors <pre>(pc) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

获取对一个页面的登录贡献者列表和匿名贡献数。

參數:
pcgroup

只包括指定用户组中的用户。不包括隐性的或自动提升的用户组,例如*、用户或自动确认用户。

多值 (以 | 分隔):bot、sysop、bureaucrat、widgeteditor
pcexcludegroup

排除指定用户组中的用户。不包括隐性的或自动提升的用户组,例如*、用户或自动确认用户。

多值 (以 | 分隔):bot、sysop、bureaucrat、widgeteditor
pcrights

只包括拥有指定权限的用户。不包括隐性的或自动提升的用户组,例如*、用户或自动确认用户。

多值 (以 | 分隔):apihighlimits、applychangetags、autoconfirmed、autocreateaccount、autopatrol、bigdelete、block、blockemail、bot、browsearchive、changetags、createaccount、createpage、createtalk、delete、deletedhistory、deletedtext、deletelogentry、deleterevision、edit、editcontentmodel、editinterface、editprotected、editmyoptions、editmyprivateinfo、editmyusercss、editmyuserjs、editmywatchlist、editsemiprotected、editusercssjs、editusercss、edituserjs、hideuser、import、importupload、ipblock-exempt、managechangetags、markbotedits、mergehistory、minoredit、move、movefile、move-categorypages、move-rootuserpages、move-subpages、nominornewtalk、noratelimit、override-export-depth、pagelang、passwordreset、patrol、patrolmarks、protect、purge、read、reupload、reupload-own、reupload-shared、rollback、sendemail、siteadmin、suppressionlog、suppressredirect、suppressrevision、unblockself、undelete、unwatchedpages、upload、upload_by_url、userrights、userrights-interwiki、viewmyprivateinfo、viewmywatchlist、viewsuppressed、writeapi、skipcaptcha、gadgets-edit、gadgets-definition-edit、nuke、renameuser、spamblacklistlog、tboverride、tboverride-account、titleblacklistlog、abusefilter-modify、abusefilter-log-detail、abusefilter-view、abusefilter-log、abusefilter-private、abusefilter-modify-restricted、abusefilter-revert、abusefilter-view-private、abusefilter-log-private、abusefilter-hidden-log、abusefilter-hide-log、abusefilter-modify-global、editwidgets、interwiki、geocode
上限值為 50 (機器人為 500)。
pcexcluderights

排除拥有指定权限的用户。不包括隐性的或自动提升的用户组,例如*、用户或自动确认用户。

多值 (以 | 分隔):apihighlimits、applychangetags、autoconfirmed、autocreateaccount、autopatrol、bigdelete、block、blockemail、bot、browsearchive、changetags、createaccount、createpage、createtalk、delete、deletedhistory、deletedtext、deletelogentry、deleterevision、edit、editcontentmodel、editinterface、editprotected、editmyoptions、editmyprivateinfo、editmyusercss、editmyuserjs、editmywatchlist、editsemiprotected、editusercssjs、editusercss、edituserjs、hideuser、import、importupload、ipblock-exempt、managechangetags、markbotedits、mergehistory、minoredit、move、movefile、move-categorypages、move-rootuserpages、move-subpages、nominornewtalk、noratelimit、override-export-depth、pagelang、passwordreset、patrol、patrolmarks、protect、purge、read、reupload、reupload-own、reupload-shared、rollback、sendemail、siteadmin、suppressionlog、suppressredirect、suppressrevision、unblockself、undelete、unwatchedpages、upload、upload_by_url、userrights、userrights-interwiki、viewmyprivateinfo、viewmywatchlist、viewsuppressed、writeapi、skipcaptcha、gadgets-edit、gadgets-definition-edit、nuke、renameuser、spamblacklistlog、tboverride、tboverride-account、titleblacklistlog、abusefilter-modify、abusefilter-log-detail、abusefilter-view、abusefilter-log、abusefilter-private、abusefilter-modify-restricted、abusefilter-revert、abusefilter-view-private、abusefilter-log-private、abusefilter-hidden-log、abusefilter-hide-log、abusefilter-modify-global、editwidgets、interwiki、geocode
上限值為 50 (機器人為 500)。
pclimit

要回傳的貢獻人員數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
pccontinue

当更多结果可用时,使用这个继续。

prop=deletedrevisions <pre>(drv) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

获得删除修订版本信息。

可在很多途径中使用:

  1. 获得一组页面的已删除修订,通过设置标题或页面ID。以标题和时间戳排序。
  2. 通过设置它们的ID与修订ID获得关于一组已删除修订。以修订ID排序。
參數:
drvprop

要为每个修订获取的属性:

ids
修订ID。
flags
修订标记(小编辑)。
timestamp
修订的时间戳。
user
做出修订的用户。
userid
修订创建者的用户ID。
size
修订的长度(字节)。
sha1
修订的SHA-1(base 16)。
contentmodel
修订的内容模型ID。
comment
由用户对修订做出的摘要。
parsedcomment
由用户对修订做出的被解析的摘要。
content
修订文本。
tags
修订标签。
parsetree
修订内容的XML解析树(需要内容模型wikitext)。
多值 (以 | 分隔):ids、flags、timestamp、user、userid、size、sha1、contentmodel、comment、parsedcomment、content、tags、parsetree
預設值:ids|timestamp|flags|comment|user
drvlimit

限制返回多少修订。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
drvexpandtemplates

展开修订内容中的模板(需要drvprop=content)。

类型:布尔值(详细信息
drvgeneratexml
已停用。

生成用于修订内容的XML解析树(需要drvprop=content;被drvprop=parsetree所取代)。

类型:布尔值(详细信息
drvparse

解析修订内容(需要drvprop=content)。由于性能原因,如果此选项被使用,drvlimit会被强制为1。

类型:布尔值(详细信息
drvsection

只检索此段落数的内容。

drvdiffto

要比较修订差异的修订ID。使用prevnextcur分别用于上个、下个和当前修订。

drvdifftotext

要比较修订差异的文本。只有修订的有限数字内的差异。覆盖drvdiffto。如果drvsection被设置,只有那个段落将与此文本之间比较差异

drvdifftotextpst

在编辑文本前对其执行预保存转换。只当与drvdifftotext一起使用时有效。

类型:布尔值(详细信息
drvcontentformat

序列化用于drvdifftotext的格式并预估内容输出。

單值:application/json、text/x-wiki、text/javascript、text/css、text/plain
drvstart

要开始枚举的时间戳。当处理修订ID列表时会被忽略。

类型:时间戳(允许格式
drvend

要停止枚举的时间戳。当处理修订ID列表时会被忽略。

类型:时间戳(允许格式
drvdir

列举的方向:

newer
最早的优先。注意:drvstart应早于drvend。
older
最新的优先(默认)。注意:drvstart应晚于drvend。
單值:newer、older
預設值:older
drvtag

只列出被此标签标记的修订。

drvuser

只列出此用户做出的修订。

类型:用户名
drvexcludeuser

不要列出此用户做出的修订。

类型:用户名
drvcontinue

当更多结果可用时,使用这个继续。

prop=duplicatefiles <pre>(df) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

根据哈希值列出此给定文件的所有副本。

參數:
dflimit

要回傳的重複檔案數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
dfcontinue

当更多结果可用时,使用这个继续。

dfdir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending
dflocalonly

只看本地存储库的文件。

类型:布尔值(详细信息
  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

回傳所有指定頁面的外部 URL (非 interwiki)。

參數:
ellimit

要回傳的連結數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
eloffset

当更多结果可用时,使用这个继续。

类型:整数
elprotocol

URL协议。如果为空并且elquery被设置,协议为http。将此和elquery都留空以列举所有外部链接。

單值:可以空白,或 bitcoin、ftp、ftps、geo、git、gopher、http、https、irc、ircs、magnet、mailto、mms、news、nntp、redis、sftp、sip、sips、sms、ssh、svn、tel、telnet、urn、worldwind、xmpp
預設值:(空)
elquery

不使用协议搜索字符串。对于检查某一页面是否包含某一外部URL很有用。

elexpandurl

扩展协议相对URL与规范协议。

类型:布尔值(详细信息
範例:
获取Main Page的外部链接列表。
api.php?action=query&prop=extlinks&titles=Main%20Page [在沙盒中打开]

prop=fileusage <pre>(fu) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

查找所有使用指定文件的页面。

參數:
fuprop

要获取的属性:

pageid
每个页面的页面ID。
title
每个页面的标题。
redirect
标记作为重定向的页面。
多值 (以 | 分隔):pageid、title、redirect
預設值:pageid|title|redirect
funamespace

只包括这些名字空间的页面。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
fushow

只显示符合以下标准的项:

redirect
只显示重定向。
!redirect
只显示非重定向。
多值 (以 | 分隔):redirect、!redirect
fulimit

要回傳的數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
fucontinue

当更多结果可用时,使用这个继续。

prop=imageinfo <pre>(ii) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

回傳檔案資訊與上傳日誌。

參數:
iiprop

要获取的文件信息:

timestamp
添加时间戳至上传的版本。
user
添加上传了每个文件版本的用户。
userid
添加上传了每个文件版本的用户ID。
comment
此版本的摘要。
parsedcomment
解析版本上的注释。
canonicaltitle
添加文件的规范标题。
url
为文件及其描述页面提供URL。
size
添加文件大小(字节)及其高度、宽度和页面数(如果可以)。
dimensions
用于大小的别名。
sha1
为文件加入SHA-1哈希值。
mime
添加文件的MIME类型。
thumbmime
添加图片缩略图的MIME类型(需要url和参数iiurlwidth)。
mediatype
添加文件媒体类型。
metadata
列出这个版本的文件的EXIF元数据。
commonmetadata
为文件的修订版本列出文件格式相关元数据。
extmetadata
列出结合自多个来源的格式化的元数据。结果均依HTML格式化。
archivename
添加用于非最新修订的存档修订的文件名。
bitdepth
添加修订的字节深度。
uploadwarning
由Special:Upload所使用,以获取关于现有文件的信息。不适用于MediaWiki核心以外代码。
多值 (以 | 分隔):timestamp、user、userid、comment、parsedcomment、canonicaltitle、url、size、dimensions、sha1、mime、thumbmime、mediatype、metadata、commonmetadata、extmetadata、archivename、bitdepth、uploadwarning
預設值:timestamp|user
iilimit

每個檔案要回傳的檔案修訂數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:1
iistart

开始列举的时间戳。

类型:时间戳(允许格式
iiend

列举的结束时间戳。

类型:时间戳(允许格式
iiurlwidth

如果iiprop=url被设定,将返回至缩放到此宽度的一张图片的URL。 由于性能原因,如果此消息被使用,将不会返回超过50张被缩放的图片。

类型:整数
預設值:-1
iiurlheight

与iiurlwidth类似。

类型:整数
預設值:-1
iimetadataversion

要使用的元数据版本。如果latest被指定,则使用最新版本。默认为1以便向下兼容。

預設值:1
iiextmetadatalanguage

要取得extmetadata的语言。这会影响到抓取翻译的选择,如果有多个可用的话,还会影响到数字等数值的格式。

預設值:zh-tw
iiextmetadatamultilang

如果用于extmetadata属性的翻译可用,则全部取得。

类型:布尔值(详细信息
iiextmetadatafilter

如果指定且非空,则只为iiprop=extmetadata返回这些键。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
iiurlparam

处理器特定的参数字符串。例如PDF可能使用page15-100pxiiurlwidth必须被使用,并与iiurlparam一致。

預設值:(空)
iicontinue

当更多结果可用时,使用这个继续。

iilocalonly

只看本地存储库的文件。

类型:布尔值(详细信息

prop=images <pre>(im) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

回傳指定頁面中包含的所有檔案。

參數:
imlimit

要回傳的檔案數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
imcontinue

当更多结果可用时,使用这个继续。

imimages

只列出这些文件。对于检查某一页面是否使用某一文件很有用。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
imdir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending

prop=info <pre>(in) </pre>

(main | query | info)
  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

获取基本页面信息。

參數:
inprop

要获取的额外属性:

protection
列出每个页面的保护等级。
talkid
每个非讨论页面的讨论页的页面ID。
watched
列出每个页面的被监视状态。
watchers
监视人员数,如果允许。
visitingwatchers
访问了每个页面的最近编辑的监视者数量,如果允许。
notificationtimestamp
每个页面的监视列表通知时间戳。
subjectid
每个讨论页的母页面的页面ID。
url
为每个页面提供一个完整URL、一个编辑URL和规范URL。
readable
用户是否可以阅读此页面。
preload
提供由EditFormPreloadText返回的文本。
displaytitle
在页面标题实际显示的地方提供方式。
多值 (以 | 分隔):protection、talkid、watched、watchers、visitingwatchers、notificationtimestamp、subjectid、url、readable、preload、displaytitle
intestactions

测试当前用户是否可以在页面上执行某种操作。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
intoken
已停用。

请改用action=query&meta=tokens

多值 (以 | 分隔):edit、delete、protect、move、block、unblock、email、import、watch
incontinue

当更多结果可用时,使用这个继续。

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

回傳指定頁面的所有 interwiki 連結。

參數:
iwprop

要为每个跨语言链接获取的额外属性:

url
添加完整URL。
多值 (以 | 分隔):url
iwprefix

只返回此前缀的跨wiki链接。

iwtitle

用于搜索的跨wiki链接。必须与iwprefix一起使用。

iwdir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending
iwlimit

要回傳的跨 Wiki 連結數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
iwcontinue

当更多结果可用时,使用这个继续。

iwurl
已停用。

是否获取完整URL(不能与iwprop一起使用)。

类型:布尔值(详细信息
範例:
从页面Main Page获得跨wiki链接。
api.php?action=query&prop=iwlinks&titles=Main%20Page [在沙盒中打开]
  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

回傳指定頁面的所有跨語言連結。

參數:
llprop

要为每个跨语言链接获取的额外属性:

url
添加完整URL。
langname
添加本地化语言名(尽可能)。使用llinlanguagecode以控制语言。
autonym
添加本地语言名。
多值 (以 | 分隔):url、langname、autonym
lllang

只返回带此语言代码的语言链接。

lltitle

要搜索的链接。必须与lllang一起使用。

lldir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending
llinlanguagecode

本地化语言名称的语言代码。

預設值:zh-tw
lllimit

要回傳的 langlinks 數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
llcontinue

当更多结果可用时,使用这个继续。

llurl
已停用。

是否获取完整URL(不能与llprop一起使用)。

类型:布尔值(详细信息
  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

回傳指定頁面的所有連結。

參數:
plnamespace

只显示这些名字空间的链接。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
pllimit

要回傳的連結數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
plcontinue

当更多结果可用时,使用这个继续。

pltitles

只列出这些标题。对于检查某一页面是否使用某一标题很有用。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
pldir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending
範例:
从页面Main Page获取链接。
api.php?action=query&prop=links&titles=Main%20Page [在沙盒中打开]
获取有关在页面Main Page中连接的页面的信息。
api.php?action=query&generator=links&titles=Main%20Page&prop=info [在沙盒中打开]
获取在使用者和模板名字空间中来自页面Main Page的链接。
api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10 [在沙盒中打开]

prop=linkshere <pre>(lh) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

查找所有链接至指定页面的页面。

參數:
lhprop

要获取的属性:

pageid
每个页面的页面ID。
title
每个页面的标题。
redirect
如果页面是一个重定向就标记。
多值 (以 | 分隔):pageid、title、redirect
預設值:pageid|title|redirect
lhnamespace

只包括这些名字空间的页面。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
lhshow

只显示符合以下标准的项:

redirect
只显示重定向。
!redirect
只显示非重定向。
多值 (以 | 分隔):redirect、!redirect
lhlimit

要回傳的數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
lhcontinue

当更多结果可用时,使用这个继续。

prop=pageprops <pre>(pp) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

获取页面内容中定义的各种页面属性。

參數:
ppcontinue

当更多结果可用时,使用这个继续。

ppprop

只列出这些页面属性(action=query&list=pagepropnames返回使用中的页面属性名称)。在检查页面是否使用某一页面属性时有用。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
範例:
获取用于页面Main PageMediaWiki的属性。
api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki [在沙盒中打开]

prop=redirects <pre>(rd) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

回傳連結至指定頁面的所有重新導向。

參數:
rdprop

要获取的属性:

pageid
每个重定向的页面ID。
title
每个重定向的标题。
fragment
每个重定向的碎片,如果有。
多值 (以 | 分隔):pageid、title、fragment
預設值:pageid|title
rdnamespace

只包含这些名字空间的页面。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
rdshow

只显示符合这些标准的项目:

fragment
只显示带碎片的重定向。
!fragment
只显示不带碎片的重定向。
多值 (以 | 分隔):fragment、!fragment
rdlimit

要回傳的重新導向數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
rdcontinue

当更多结果可用时,使用这个继续。

prop=references <pre>(rf) </pre>

  • 此模組需要讀取權限。
  • 来源:Cite
  • 许可协议:GPL-2.0+

返回与指定页面相关联的参考文献的数据表示法。

參數:
rfcontinue

当更多结果可用时,使用这个继续。

範例:
Albert Einstein相关联的参考文献。
api.php?action=query&prop=references&titles=Albert%20Einstein [在沙盒中打开]

prop=revisions <pre>(rv) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

获取修订版本信息。

可用于以下几个方面:

  1. 通过设置标题或页面ID获取一批页面(最新修订)的数据。
  2. 通过使用带start、end或limit的标题或页面ID获取给定页面的多个修订。
  3. 通过revid设置一批修订的ID获取它们的数据。
參數:
rvprop

要为每个修订获取的属性:

ids
修订ID。
flags
修订标记(小编辑)。
timestamp
修订的时间戳。
user
做出修订的用户。
userid
修订创建者的用户ID。
size
修订的长度(字节)。
sha1
修订的SHA-1(base 16)。
contentmodel
修订的内容模型ID。
comment
由用户对修订做出的摘要。
parsedcomment
由用户对修订做出的被解析的摘要。
content
修订文本。
tags
修订标签。
parsetree
修订内容的XML解析树(需要内容模型wikitext)。
多值 (以 | 分隔):ids、flags、timestamp、user、userid、size、sha1、contentmodel、comment、parsedcomment、content、tags、parsetree
預設值:ids|timestamp|flags|comment|user
rvlimit

限制返回多少修订。

可能只能与单一页面使用(模式#2)。
不允許超過 500 (機器人為 5,000)。
类型:整数或max
rvexpandtemplates

展开修订内容中的模板(需要rvprop=content)。

类型:布尔值(详细信息
rvgeneratexml
已停用。

生成用于修订内容的XML解析树(需要rvprop=content;被rvprop=parsetree所取代)。

类型:布尔值(详细信息
rvparse

解析修订内容(需要rvprop=content)。由于性能原因,如果此选项被使用,rvlimit会被强制为1。

类型:布尔值(详细信息
rvsection

只检索此段落数的内容。

rvdiffto

要比较修订差异的修订ID。使用prevnextcur分别用于上个、下个和当前修订。

rvdifftotext

要比较修订差异的文本。只有修订的有限数字内的差异。覆盖rvdiffto。如果rvsection被设置,只有那个段落将与此文本之间比较差异

rvdifftotextpst

在编辑文本前对其执行预保存转换。只当与rvdifftotext一起使用时有效。

类型:布尔值(详细信息
rvcontentformat

序列化用于rvdifftotext的格式并预估内容输出。

單值:application/json、text/x-wiki、text/javascript、text/css、text/plain
rvstartid

从哪个修订版本ID开始列举。

可能只能与单一页面使用(模式#2)。
类型:整数
rvendid

在此修订版本ID停止修订列举。

可能只能与单一页面使用(模式#2)。
类型:整数
rvstart

从哪个修订版本时间戳开始列举。

可能只能与单一页面使用(模式#2)。
类型:时间戳(允许格式
rvend

列举直至此时间戳。

可能只能与单一页面使用(模式#2)。
类型:时间戳(允许格式
rvdir

列举的方向:

newer
最早的优先。注意:rvstart应早于rvend。
older
最新的优先(默认)。注意:rvstart应晚于rvend。
可能只能与单一页面使用(模式#2)。
單值:newer、older
預設值:older
rvuser

只包含由用户做出的修订。

可能只能与单一页面使用(模式#2)。
类型:用户名
rvexcludeuser

不包括由用户做出的修订。

可能只能与单一页面使用(模式#2)。
类型:用户名
rvtag

只列出被此标签标记的修订。

rvtoken
已停用。

要为每个修订版本获得的令牌。

多值 (以 | 分隔):rollback
rvcontinue

当更多结果可用时,使用这个继续。

prop=stashimageinfo <pre>(sii) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

回傳多筆儲藏檔案的檔案資訊。

參數:
siifilekey

用于识别一次临时藏匿的早前上传的关键字。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
siisessionkey
已停用。

siifilekey的别名,用于向后兼容。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
siiprop

要获取的文件信息:

timestamp
添加时间戳至上传的版本。
canonicaltitle
添加文件的规范标题。
url
为文件及其描述页面提供URL。
size
添加文件大小(字节)及其高度、宽度和页面数(如果可以)。
dimensions
用于大小的别名。
sha1
为文件加入SHA-1哈希值。
mime
添加文件的MIME类型。
thumbmime
添加图片缩略图的MIME类型(需要url和参数siiurlwidth)。
metadata
列出这个版本的文件的EXIF元数据。
commonmetadata
为文件的修订版本列出文件格式相关元数据。
extmetadata
列出结合自多个来源的格式化的元数据。结果均依HTML格式化。
bitdepth
添加修订的字节深度。
多值 (以 | 分隔):timestamp、canonicaltitle、url、size、dimensions、sha1、mime、thumbmime、metadata、commonmetadata、extmetadata、bitdepth
預設值:timestamp|url
siiurlwidth

如果siiprop=url被设定,将返回至缩放到此宽度的一张图片的URL。 由于性能原因,如果此消息被使用,将不会返回超过50张被缩放的图片。

类型:整数
預設值:-1
siiurlheight

与siiurlwidth类似。

类型:整数
預設值:-1
siiurlparam

处理器特定的参数字符串。例如PDF可能使用page15-100pxsiiurlwidth必须被使用,并与siiurlparam一致。

預設值:(空)

prop=templates <pre>(tl) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

回傳指定頁面中所有引用的頁面。

參數:
tlnamespace

只显示此名字空间的模板。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
tllimit

要回傳的模板數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
tlcontinue

当更多结果可用时,使用这个继续。

tltemplates

只列出这些模板。对于检查某一页面使用某一模板很有用。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
tldir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending
範例:
获取在页面Main Page使用的模板。
api.php?action=query&prop=templates&titles=Main%20Page [在沙盒中打开]
获取有关Main Page中使用的模板页面的信息。
api.php?action=query&generator=templates&titles=Main%20Page&prop=info [在沙盒中打开]
获取在使用者和模板名字空间中,嵌入在Main Page页面的页面。
api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10 [在沙盒中打开]

prop=transcludedin <pre>(ti) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

查找所有嵌入指定页面的页面。

參數:
tiprop

要获取的属性:

pageid
每个页面的页面ID。
title
每个页面的标题。
redirect
标记作为重定向的页面。
多值 (以 | 分隔):pageid、title、redirect
預設值:pageid|title|redirect
tinamespace

至包含这些名字空间的页面。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
tishow

只显示符合以下标准的项:

redirect
只显示重定向。
!redirect
只显示非重定向。
多值 (以 | 分隔):redirect、!redirect
tilimit

回傳的數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
ticontinue

当更多结果可用时,使用这个继续。

list=abusefilters <pre>(abf) </pre>

  • 此模組需要讀取權限。
  • 来源:Abuse Filter
  • 许可协议:GPL-2.0+

显示防滥用过滤器的详细说明。

參數:
abfstartid

枚举的起始过滤器ID。

类型:整数
abfendid

枚举的结束过滤器ID。

类型:整数
abfdir

列举的方向:

newer
最早的优先。注意:abfstart应早于abfend。
older
最新的优先(默认)。注意:abfstart应晚于abfend。
單值:older、newer
預設值:newer
abfshow

只显示符合这些标准的过滤器。

多值 (以 | 分隔):enabled、!enabled、deleted、!deleted、private、!private
abflimit

过滤器列表的最大数量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
abfprop

要获取的属性。

多值 (以 | 分隔):id、description、pattern、actions、hits、comments、lasteditor、lastedittime、status、private
預設值:id|description|actions|status

list=abuselog <pre>(afl) </pre>

  • 此模組需要讀取權限。
  • 来源:Abuse Filter
  • 许可协议:GPL-2.0+

显示一个滥用过滤器的捕获事件。

參數:
aflstart

枚举的起始时间戳。

类型:时间戳(允许格式
aflend

枚举的结束时间戳。

类型:时间戳(允许格式
afldir

列举的方向:

newer
最早的优先。注意:aflstart应早于aflend。
older
最新的优先(默认)。注意:aflstart应晚于aflend。
單值:newer、older
預設值:older
afluser

只显示由指定的用户或IP地址完成的记录。

afltitle

只显示在指定页面上发生过的条项。

aflfilter

只显示被指定过滤器ID捕获过的记录。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
afllimit

列出日志记录的最大数量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
aflprop

要获得的属性。

多值 (以 | 分隔):ids、filter、user、ip、title、action、details、result、timestamp、hidden、revid
預設值:ids|user|title|action|result|timestamp|hidden|revid

list=allcategories <pre>(ac) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列举所有分类。

參數:
acfrom

要作为枚举起始点的类别。

accontinue

当更多结果可用时,使用这个继续。

acto

要作为枚举终止点的类别。

acprefix

搜索所有以此值开头的分类标题。

acdir

排序方向。

單值:ascending、descending
預設值:ascending
acmin

只返回至少带这么多成员的分类。

类型:整数
acmax

只返回最多带这么多成员的分类。

类型:整数
aclimit

要回傳的分類數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
acprop

要获取的属性:

size
在分类中添加页面数。
hidden
标记由__HIDDENCAT__隐藏的分类。
多值 (以 | 分隔):size、hidden
預設值:(空)
範例:
列出分类及其含有多少页面的信息。
api.php?action=query&list=allcategories&acprop=size [在沙盒中打开]
为以List的分类检索有关分类页面本身的信息。
api.php?action=query&generator=allcategories&gacprefix=List&prop=info [在沙盒中打开]

list=alldeletedrevisions <pre>(adr) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列举由一位用户或在一个名字空间中所有已删除的修订。

參數:
adrprop

要为每个修订获取的属性:

ids
修订ID。
flags
修订标记(小编辑)。
timestamp
修订的时间戳。
user
做出修订的用户。
userid
修订创建者的用户ID。
size
修订的长度(字节)。
sha1
修订的SHA-1(base 16)。
contentmodel
修订的内容模型ID。
comment
由用户对修订做出的摘要。
parsedcomment
由用户对修订做出的被解析的摘要。
content
修订文本。
tags
修订标签。
parsetree
修订内容的XML解析树(需要内容模型wikitext)。
多值 (以 | 分隔):ids、flags、timestamp、user、userid、size、sha1、contentmodel、comment、parsedcomment、content、tags、parsetree
預設值:ids|timestamp|flags|comment|user
adrlimit

限制返回多少修订。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
adrexpandtemplates

展开修订内容中的模板(需要adrprop=content)。

类型:布尔值(详细信息
adrgeneratexml
已停用。

生成用于修订内容的XML解析树(需要adrprop=content;被adrprop=parsetree所取代)。

类型:布尔值(详细信息
adrparse

解析修订内容(需要adrprop=content)。由于性能原因,如果此选项被使用,adrlimit会被强制为1。

类型:布尔值(详细信息
adrsection

只检索此段落数的内容。

adrdiffto

要比较修订差异的修订ID。使用prevnextcur分别用于上个、下个和当前修订。

adrdifftotext

要比较修订差异的文本。只有修订的有限数字内的差异。覆盖adrdiffto。如果adrsection被设置,只有那个段落将与此文本之间比较差异

adrdifftotextpst

在编辑文本前对其执行预保存转换。只当与adrdifftotext一起使用时有效。

类型:布尔值(详细信息
adrcontentformat

序列化用于adrdifftotext的格式并预估内容输出。

單值:application/json、text/x-wiki、text/javascript、text/css、text/plain
adruser

只列出此用户做出的修订。

类型:用户名
adrnamespace

只列出此名字空间的页面。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
adrstart

枚举的起始时间戳。

只可以与adruser一起使用。
类型:时间戳(允许格式
adrend

枚举的结束时间戳。

只可以与adruser一起使用。
类型:时间戳(允许格式
adrdir

列举的方向:

newer
最早的优先。注意:adrstart应早于adrend。
older
最新的优先(默认)。注意:adrstart应晚于adrend。
單值:newer、older
預設值:older
adrfrom

从此标题开始列出。

不能与adruser一起使用。
adrto

列出至此标题为止。

不能与adruser一起使用。
adrprefix

搜索所有以此值开头的页面标题。

不能与adruser一起使用。
adrexcludeuser

不要列出此用户做出的修订。

不能与adruser一起使用。
类型:用户名
adrtag

只列出被此标签标记的修订。

adrcontinue

当更多结果可用时,使用这个继续。

adrgeneratetitles

当作为生成器使用时,生成标题而不是修订ID。

类型:布尔值(详细信息

list=allfileusages <pre>(af) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列出所有文件用途,包括不存在的。

參數:
afcontinue

当更多结果可用时,使用这个继续。

affrom

要列举的起始文件标题。

afto

要列举的最终文件标题。

afprefix

搜索所有以此值开头的文件标题。

afunique

只显示明显的文件标题。不能与afprop=ids一起使用。 当作为生成器使用时,产生目标页面而不是来源页面。

类型:布尔值(详细信息
afprop

要包含的信息束:

ids
添加使用中的页面的页面ID(不能与afunique一起使用)。
title
添加文件的标题。
多值 (以 | 分隔):ids、title
預設值:title
aflimit

要回傳的項目總數。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
afdir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending

list=allimages <pre>(ai) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

按顺序枚举所有图像。

參數:
aisort

要作为排序方式的属性。

單值:name、timestamp
預設值:name
aidir

罗列所采用的方向。

單值:ascending、descending、newer、older
預設值:ascending
aifrom

要列举的起始图片标题。只能与aisort=name一起使用。

aito

要列举的最终图片标题。只能与aisort=name一起使用。

aicontinue

当更多结果可用时,使用这个继续。

aistart

要列举的起始时间戳。只能与aisort=timestamp一起使用。

类型:时间戳(允许格式
aiend

要列举的最终时间戳。只能与aisort=timestamp一起使用。

类型:时间戳(允许格式
aiprop

要获取的文件信息:

timestamp
添加时间戳至上传的版本。
user
添加上传了每个文件版本的用户。
userid
添加上传了每个文件版本的用户ID。
comment
此版本的摘要。
parsedcomment
解析版本上的注释。
canonicaltitle
添加文件的规范标题。
url
为文件及其描述页面提供URL。
size
添加文件大小(字节)及其高度、宽度和页面数(如果可以)。
dimensions
用于大小的别名。
sha1
为文件加入SHA-1哈希值。
mime
添加文件的MIME类型。
mediatype
添加文件媒体类型。
metadata
列出这个版本的文件的EXIF元数据。
commonmetadata
为文件的修订版本列出文件格式相关元数据。
extmetadata
列出结合自多个来源的格式化的元数据。结果均依HTML格式化。
bitdepth
添加修订的字节深度。
多值 (以 | 分隔):timestamp、user、userid、comment、parsedcomment、canonicaltitle、url、size、dimensions、sha1、mime、mediatype、metadata、commonmetadata、extmetadata、bitdepth
預設值:timestamp|url
aiprefix

搜索所有以此值开头的图像标题。只能与aisort=name一起使用。

aiminsize

限于至少这么多字节的图像。

类型:整数
aimaxsize

限于顶多这么多字节的图像。

类型:整数
aisha1

图像的 SHA1 哈希。覆盖aisha1base36。

aisha1base36

基于base 36的图片的SHA1哈希值(用于MediaWiki)。

aiuser

只返回此用户上传的文件。只能与aisort=timestamp一起使用。不能与aifilterbots一起使用。

类型:用户名
aifilterbots

如何过滤由机器人上传的文件。只能与aisort=timestamp一起使用。不能与aiuser一起使用。

單值:all、bots、nobots
預設值:all
aimime

要搜索的MIME类型,例如image/jpeg

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
ailimit

要回傳的圖片總數。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列举所有指向至指定名字空间的链接。

參數:
alcontinue

当更多结果可用时,使用这个继续。

alfrom

要列举的起始标题链接。

alto

要列举的最终标题链接。

alprefix

搜索所有以此值开头的已链接标题。

alunique

只显示明显的链接标题。不能与alprop=ids一起使用。 当作为生成器使用时,产生目标页面而不是来源页面。

类型:布尔值(详细信息
alprop

要包含的信息束:

ids
添加链接中的页面的页面ID(不能与alunique一起使用)。
title
添加链接的标题。
多值 (以 | 分隔):ids、title
預設值:title
alnamespace

要列举的名字空间。

單值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
預設值:0
allimit

要回傳的項目總數。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
aldir

列出方向。

單值:ascending、descending
預設值:ascending
範例:
列出链接的标题,包括丢失的,带它们来自的页面ID,以B开头。
api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title [在沙盒中打开]
列出唯一的链接标题。
api.php?action=query&list=alllinks&alunique=&alfrom=B [在沙盒中打开]
获取所有已链接的标题,标记缺少的。
api.php?action=query&generator=alllinks&galunique=&galfrom=B [在沙盒中打开]
获取包含这些链接的页面。
api.php?action=query&generator=alllinks&galfrom=B [在沙盒中打开]

list=allpages <pre>(ap) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

循序列举在指定名字空间中的所有页面。

參數:
apfrom

枚举的起始页面标题。

apcontinue

当更多结果可用时,使用这个继续。

apto

枚举的结束页面标题。

apprefix

搜索所有以此值开头的页面标题。

apnamespace

要列举的名字空间。

單值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
預設值:0
apfilterredir

要列出哪些页面。

單值:all、redirects、nonredirects
預設值:all
apminsize

限于至少这么多字节的页面。

类型:整数
apmaxsize

限于至多这么多字节的页面。

类型:整数
apprtype

仅限于受保护页面。

多值 (以 | 分隔):edit、move、upload
apprlevel

过滤基于保护等级的保护(必须与apprtype=参数一起使用)。

多值 (以 | 分隔):可以空白,或 autoconfirmed、sysop
apprfiltercascade

过滤基于cascadingness的保护(当apprtype未设置时忽略)。

單值:cascading、noncascading、all
預設值:all
aplimit

要回傳的頁面總數。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
apdir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending
apfilterlanglinks

过滤基于页面是否有语言链接。注意这可能不考虑由扩展添加的语言链接。

單值:withlanglinks、withoutlanglinks、all
預設值:all
apprexpiry

要在页面上过滤的保护期限:

indefinite
只获取带无限期保护的页面。
definite
只获取带指定保护期限的页面。
all
获取任意保护期限的页面。
單值:indefinite、definite、all
預設值:all

list=allredirects <pre>(ar) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列出至一个名字空间的重定向。

參數:
arcontinue

当更多结果可用时,使用这个继续。

arfrom

要列举的起始重定向标题。

arto

要列举的最终重定向标题。

arprefix

搜索所有以此值开头的目标页面。

arunique

只显示明显的目标页面。不能与arprop=ids|fragment|interwiki一起使用。 当作为生成器使用时,产生目标页面而不是来源页面。

类型:布尔值(详细信息
arprop

要包含的信息束:

ids
添加重定向页面的页面ID(不能与arunique一起使用)。
title
添加重定向的标题。
fragment
添加来自重定向的碎片,如果有(不能与arunique一起使用)。
interwiki
添加来自重定向的跨wiki前缀,如果有(不能与arunique一起使用)。
多值 (以 | 分隔):ids、title、fragment、interwiki
預設值:title
arnamespace

要列举的名字空间。

單值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
預設值:0
arlimit

要回傳的項目總數。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
ardir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending

list=allrevisions <pre>(arv) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列举所有修订。

參數:
arvprop

要为每个修订获取的属性:

ids
修订ID。
flags
修订标记(小编辑)。
timestamp
修订的时间戳。
user
做出修订的用户。
userid
修订创建者的用户ID。
size
修订的长度(字节)。
sha1
修订的SHA-1(base 16)。
contentmodel
修订的内容模型ID。
comment
由用户对修订做出的摘要。
parsedcomment
由用户对修订做出的被解析的摘要。
content
修订文本。
tags
修订标签。
parsetree
修订内容的XML解析树(需要内容模型wikitext)。
多值 (以 | 分隔):ids、flags、timestamp、user、userid、size、sha1、contentmodel、comment、parsedcomment、content、tags、parsetree
預設值:ids|timestamp|flags|comment|user
arvlimit

限制返回多少修订。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
arvexpandtemplates

展开修订内容中的模板(需要arvprop=content)。

类型:布尔值(详细信息
arvgeneratexml
已停用。

生成用于修订内容的XML解析树(需要arvprop=content;被arvprop=parsetree所取代)。

类型:布尔值(详细信息
arvparse

解析修订内容(需要arvprop=content)。由于性能原因,如果此选项被使用,arvlimit会被强制为1。

类型:布尔值(详细信息
arvsection

只检索此段落数的内容。

arvdiffto

要比较修订差异的修订ID。使用prevnextcur分别用于上个、下个和当前修订。

arvdifftotext

要比较修订差异的文本。只有修订的有限数字内的差异。覆盖arvdiffto。如果arvsection被设置,只有那个段落将与此文本之间比较差异

arvdifftotextpst

在编辑文本前对其执行预保存转换。只当与arvdifftotext一起使用时有效。

类型:布尔值(详细信息
arvcontentformat

序列化用于arvdifftotext的格式并预估内容输出。

單值:application/json、text/x-wiki、text/javascript、text/css、text/plain
arvuser

只列出此用户做出的修订。

类型:用户名
arvnamespace

只列出此名字空间的页面。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
arvstart

枚举的起始时间戳。

类型:时间戳(允许格式
arvend

枚举的结束时间戳。

类型:时间戳(允许格式
arvdir

列举的方向:

newer
最早的优先。注意:arvstart应早于arvend。
older
最新的优先(默认)。注意:arvstart应晚于arvend。
單值:newer、older
預設值:older
arvexcludeuser

不要列出此用户做出的修订。

类型:用户名
arvcontinue

当更多结果可用时,使用这个继续。

arvgeneratetitles

当作为生成器使用时,生成标题而不是修订ID。

类型:布尔值(详细信息

list=alltransclusions <pre>(at) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。

參數:
atcontinue

当更多结果可用时,使用这个继续。

atfrom

要列举的起始嵌入标题。

atto

要列举的最终嵌入标题。

atprefix

搜索所有以此值开头的嵌入的标题。

atunique

只显示明显的被嵌入标题。不能与atprop=ids一起使用。 当作为生成器使用时,产生目标页面而不是来源页面。

类型:布尔值(详细信息
atprop

要包含的信息束:

ids
添加嵌入中的页面的页面ID(不能与atunique一起使用)。
title
添加嵌入的标题。
多值 (以 | 分隔):ids、title
預設值:title
atnamespace

要列举的名字空间。

單值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
預設值:10
atlimit

要回傳的項目總數。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
atdir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending

list=allusers <pre>(au) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列举所有注册用户。

參數:
aufrom

枚举的起始用户名。

auto

枚举的结束用户名。

auprefix

搜索所有以此值开头的用户。

audir

排序方向。

單值:ascending、descending
預設值:ascending
augroup

只包含指定组中的用户。

多值 (以 | 分隔):bot、sysop、bureaucrat、widgeteditor
auexcludegroup

排除指定组中的用户。

多值 (以 | 分隔):bot、sysop、bureaucrat、widgeteditor
aurights

仅列出有所选权限的用户。不包括隐性的或自动加入的用户组别(如*、用户或自动确认用户)所授予的权限。

多值 (以 | 分隔):apihighlimits、applychangetags、autoconfirmed、autocreateaccount、autopatrol、bigdelete、block、blockemail、bot、browsearchive、changetags、createaccount、createpage、createtalk、delete、deletedhistory、deletedtext、deletelogentry、deleterevision、edit、editcontentmodel、editinterface、editprotected、editmyoptions、editmyprivateinfo、editmyusercss、editmyuserjs、editmywatchlist、editsemiprotected、editusercssjs、editusercss、edituserjs、hideuser、import、importupload、ipblock-exempt、managechangetags、markbotedits、mergehistory、minoredit、move、movefile、move-categorypages、move-rootuserpages、move-subpages、nominornewtalk、noratelimit、override-export-depth、pagelang、passwordreset、patrol、patrolmarks、protect、purge、read、reupload、reupload-own、reupload-shared、rollback、sendemail、siteadmin、suppressionlog、suppressredirect、suppressrevision、unblockself、undelete、unwatchedpages、upload、upload_by_url、userrights、userrights-interwiki、viewmyprivateinfo、viewmywatchlist、viewsuppressed、writeapi、skipcaptcha、gadgets-edit、gadgets-definition-edit、nuke、renameuser、spamblacklistlog、tboverride、tboverride-account、titleblacklistlog、abusefilter-modify、abusefilter-log-detail、abusefilter-view、abusefilter-log、abusefilter-private、abusefilter-modify-restricted、abusefilter-revert、abusefilter-view-private、abusefilter-log-private、abusefilter-hidden-log、abusefilter-hide-log、abusefilter-modify-global、editwidgets、interwiki、geocode
上限值為 50 (機器人為 500)。
auprop

要包含的信息束:

blockinfo
添加有关用户当前封禁的信息。
groups
列举用户所在的组。这使用更多服务器资源,并可能返回少于限制的结果。
implicitgroups
列出用户自动属于的所有组。
rights
用户拥有的权限列表。
editcount
添加用户的编辑计数。
registration
如果可能,添加用户注册时的时间戳(可能为空白)。
centralids
添加中心ID并为用户附加状态。
多值 (以 | 分隔):blockinfo、groups、implicitgroups、rights、editcount、registration、centralids
aulimit

返回的总计用户数。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
auwitheditsonly

只列出有编辑的用户。

类型:布尔值(详细信息
auactiveusers

只列出最近30天内活跃的用户。

类型:布尔值(详细信息
auattachedwiki

auprop=centralids一起使用,也表明用户是否附加于此ID定义的wiki。

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

查找所有链接至指定页面的页面。

參數:
bltitle

要搜索的标题。不能与blpageid一起使用。

blpageid

要搜索的页面ID。不能与bltitle一起使用。

类型:整数
blcontinue

当更多结果可用时,使用这个继续。

blnamespace

要列举的名字空间。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
bldir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending
blfilterredir

如何过滤重定向。当blredirect被启用时如果设置为nonredirects,这只会应用到第二级。

單值:all、redirects、nonredirects
預設值:all
bllimit

返回总计页面数。如果blredirect被启用,则限定分别适用于每一等级(这意味着将返回多达2 * bllimit个结果)。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
blredirect

如果链入页面是一个重定向,则寻找所有链接至此重定向的页面。最大限制减半。

类型:布尔值(详细信息

list=betafeatures <pre>(bf) </pre>

  • 此模組需要讀取權限。
  • 来源:BetaFeatures
  • 许可协议:GPL-2.0+

列出所有測試功能

參數:
bfcounts

是否取得有多少使用者已開啟某個偏好設定的資訊。

範例:
取得所有可用的測試功能並顯示目前有多少數使用者已開啟該功能
api.php?action=query&list=betafeatures&bfcounts= [在沙盒中打开]

list=blocks <pre>(bk) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列出所有被封禁的用户和IP地址。

參數:
bkstart

枚举的起始时间戳。

类型:时间戳(允许格式
bkend

枚举的结束时间戳。

类型:时间戳(允许格式
bkdir

列举的方向:

newer
最早的优先。注意:bkstart应早于bkend。
older
最新的优先(默认)。注意:bkstart应晚于bkend。
單值:newer、older
預設值:older
bkids

要列出的封禁ID列表(可选)。

类型:整数列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
bkusers

要搜索的用户列表(可选)。

类型:用户名列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
bkip

获取应用到此IP地址或者CIDR范围的所有封禁,包括范围封禁。不能与bkusers一起使用。CIDR范围不允许比IPv4/16或IPv6/19更宽。

bklimit

封禁列表的最大数量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
bkprop

要获取的属性:

id
添加封禁ID。
user
添加被封禁用户的用户名。
userid
添加被封禁用户的用户ID。
by
添加执行封禁的用户的用户名。
byid
添加执行封禁的用户的用户ID。
timestamp
添加封禁生效时的时间戳。
expiry
添加封禁截止时的时间戳。
reason
添加封禁原因。
range
添加受封禁影响的IP地址段。
flags
标记编辑禁止(自动封禁、仅限匿名用户等)。
多值 (以 | 分隔):id、user、userid、by、byid、timestamp、expiry、reason、range、flags
預設值:id|user|by|timestamp|expiry|reason|flags
bkshow

只显示符合这些标准的项目。 例如,要只查看IP地址的无限期封禁,设置bkshow=ip|!temp

多值 (以 | 分隔):account、!account、temp、!temp、ip、!ip、range、!range
bkcontinue

当更多结果可用时,使用这个继续。

list=categorymembers <pre>(cm) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

在指定的分类中列出所有页面。

參數:
cmtitle

要列举的分类(必需)。必须包括分類:前缀。不能与cmpageid一起使用。

cmpageid

要枚举的分类的页面 ID。不能与cmtitle一起使用。

类型:整数
cmprop

要包含的信息束:

ids
添加页面ID。
title
添加页面标题和名字空间ID。
sortkey
添加用于分类中排序的关键字(十六进制字符串)。
sortkeyprefix
添加用于分类中排序的关键字前缀(关键字的人类可读部分)。
type
添加页面被分类的类型(pagesubcatfile)。
timestamp
添加页面被包括时的时间戳。
多值 (以 | 分隔):ids、title、sortkey、sortkeyprefix、type、timestamp
預設值:ids|title
cmnamespace

仅包含这些名字空间的页面。注意cmtype=subcatcmtype=file可能被使用,而不是cmnamespace=146

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
cmtype

包含的分类成员类型。当cmsort=timestamp被设置时会忽略。

多值 (以 | 分隔):page、subcat、file
預設值:page|subcat|file
cmcontinue

当更多结果可用时,使用这个继续。

cmlimit

回傳的頁面數量上限。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
cmsort

要作为排序方式的属性。

單值:sortkey、timestamp
預設值:sortkey
cmdir

排序的方向。

單值:asc、desc、ascending、descending、newer、older
預設值:ascending
cmstart

开始列举的时间戳。只能与cmsort=timestamp一起使用。

类型:时间戳(允许格式
cmend

列举的结尾时间戳。只能与cmsort=timestamp一起使用。

类型:时间戳(允许格式
cmstarthexsortkey

开始列举的关键词,由cmprop=sortkey返回。不能与cmsort=sortkey一起使用。

cmendhexsortkey

结束列举的关键字,由cmprop=sortkey返回。只能与cmsort=sortkey一起使用。

cmstartsortkeyprefix

要开始列举的排序关键词前缀。只能与cmsort=sortkey一起使用。覆盖cmstarthexsortkey

cmendsortkeyprefix

要结束列举before的关键字前缀(而不是at;如果此值出现,它将不被包括!)只能与cmsort=sortkey一起使用。覆盖cmendhexsortkey。

cmstartsortkey
已停用。

请改用cmstarthexsortkey。

cmendsortkey
已停用。

请改用cmendhexsortkey。

list=deletedrevs <pre>(dr) </pre>

  • 此模組已停用。
  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列出被删除修订。

操作于三种模式中:

  1. 为指定标题列举已删除修订,按时间戳排列。
  2. 为指定用户列举已删除贡献,按时间戳排列(未指定标题)。
  3. 在指定名字空间中列举所有已删除修订,按标题和时间戳排列(无指定标题,未设置druser)。

任一参数只应用于一些模式,并忽略其他参数。

參數:
drstart

枚举的起始时间戳。

模式:1、2
类型:时间戳(允许格式
drend

枚举的结束时间戳。

模式:1、2
类型:时间戳(允许格式
drdir

列举的方向:

newer
最早的优先。注意:drstart应早于drend。
older
最新的优先(默认)。注意:drstart应晚于drend。
模式:1、3
單值:newer、older
預設值:older
drfrom

从此标题开始列出。

模式:3
drto

列出至此标题为止。

模式:3
drprefix

搜索所有以此值开头的页面标题。

模式:3
drunique

每个页面只列出一个修订。

模式:3
类型:布尔值(详细信息
drnamespace

只列出此名字空间的页面。

模式:3
單值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
預設值:0
drtag

只列出被此标签标记的修订。

druser

只列出此用户做出的修订。

类型:用户名
drexcludeuser

不要列出此用户做出的修订。

类型:用户名
drprop

要获取的属性:

revid
添加被删除修订的修订ID。
parentid
添加上一修订的修订ID至页面。
user
添加做出修订的用户。
userid
添加做出修订的用户ID。
comment
添加修订摘要。
parsedcomment
添加解析过的修订摘要。
minor
如果修订是小编辑则加标签。
len
添加修订长度(字节)。
sha1
添加修订的SHA-1(base 16)。
content
添加修订内容。
token
已弃用。提供编辑令牌。
tags
修订标签。
多值 (以 | 分隔):revid、parentid、user、userid、comment、parsedcomment、minor、len、sha1、content、token、tags
預設值:user|comment
drlimit

要列出的最大修订数量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
drcontinue

当更多结果可用时,使用这个继续。

範例:
列出最近已删除的对页面Main PageTalk:Main Page的贡献,带内容(模式1)。
api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content [在沙盒中打开]
列出由Bob作出的最近50次已删除贡献(模式2)。
api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50 [在沙盒中打开]
列出前50次主名字空间已删除贡献(模式3)。
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50 [在沙盒中打开]
列出前50次討論名字空间已删除页面(模式3)。
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique= [在沙盒中打开]

list=embeddedin <pre>(ei) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

查找所有嵌入指定标题的页面。

參數:
eititle

要搜索的标题。不能与eipageid一起使用。

eipageid

要搜索的页面ID。不能与eititle一起使用。

类型:整数
eicontinue

当更多结果可用时,使用这个继续。

einamespace

列举的名字空间。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
eidir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending
eifilterredir

如何過濾重新導向。

單值:all、redirects、nonredirects
預設值:all
eilimit

要回傳的頁面總數。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10

list=exturlusage <pre>(eu) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列举包含一个指定URL的页面。

參數:
euprop

要包含的信息束:

ids
添加页面ID。
title
添加页面的标题和名字空间ID。
url
添加页面中使用的URL。
多值 (以 | 分隔):ids、title、url
預設值:ids|title|url
euoffset

当更多结果可用时,使用这个继续。

类型:整数
euprotocol

URL协议。如果为空并且euquery被设置,协议为http。将此和euquery都留空以列举所有外部链接。

單值:可以空白,或 bitcoin、ftp、ftps、geo、git、gopher、http、https、irc、ircs、magnet、mailto、mms、news、nntp、redis、sftp、sip、sips、sms、ssh、svn、tel、telnet、urn、worldwind、xmpp
預設值:(空)
euquery

不包括协议的搜索字符串。参见Special:LinkSearch。留空以列出所有外部链接。

eunamespace

要列举的页面名字空间。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
eulimit

要回傳的頁面數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
euexpandurl

用标准协议展开协议相关URL。

类型:布尔值(详细信息

list=filearchive <pre>(fa) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

循序列举所有被删除的文件。

參數:
fafrom

枚举的起始图片标题。

fato

枚举的结束图片标题。

faprefix

搜索所有以此值开头的图像标题。

fadir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending
fasha1

图片的SHA1哈希值。覆盖fasha1base36。

fasha1base36

基于base 36的图片的SHA1哈希值(用于MediaWiki)。

faprop

要获取的图片信息:

sha1
为文件加入SHA-1哈希值。
timestamp
为已上传版本添加时间戳。
user
添加上传了图片版本的用户。
size
添加图片大小(字节)及其高度、宽度和页面计数(如果可以)。
dimensions
用于大小的别名。
description
添加图片版本的说明。
parseddescription
解析版本的描述。
mime
添加图片的MIME。
mediatype
添加图片的媒体类型。
metadata
为图片版本列出Exif元数据。
bitdepth
添加版本的字节深度。
archivename
添加用于非最新版本的存档版本的文件名。
多值 (以 | 分隔):sha1、timestamp、user、size、dimensions、description、parseddescription、mime、mediatype、metadata、bitdepth、archivename
預設值:timestamp
falimit

要回傳的圖片總數。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
facontinue

当更多结果可用时,使用这个继续。

範例:
显示已删除文件列表。
api.php?action=query&list=filearchive [在沙盒中打开]

list=gadgetcategories <pre>(gc) </pre>

  • 此模組需要讀取權限。
  • 来源:Gadgets
  • 许可协议:GPL-2.0+

回傳小工具分類清單。

參數:
gcprop

要取得什麼小工具分類資訊:

name
內部份類名稱。
title
分類標題。
members
分類中的小工具數量。
多值 (以 | 分隔):name、title、members
預設值:name
gcnames

要取得分類名稱。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。

list=gadgets <pre>(ga) </pre>

  • 此模組需要讀取權限。
  • 来源:Gadgets
  • 许可协议:GPL-2.0+

回傳在此 wiki 使用過的小工具清單。

參數:
gaprop

要取得什麼小工具資訊:

id
內部小工具 ID。
metadata
小工具 metadata。
desc
小工具描述轉換至 HTML 格式 (可能較慢,只在需要時使用)。
多值 (以 | 分隔):id、metadata、desc
預設值:id|metadata
gacategories

自那個分類取得小工具。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
gaids

要取得小工具的 ID。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
gaallowedonly

只列出目前使用者可使用的小工具。

类型:布尔值(详细信息
gaenabledonly

只列出由目前使用者開啟的小工具。

类型:布尔值(详细信息

list=imageusage <pre>(iu) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

查找所有使用指定图片标题的页面。

參數:
iutitle

要搜索的标题。不能与iupageid一起使用。

iupageid

要搜索的页面ID。不能与iutitle一起使用。

类型:整数
iucontinue

当更多结果可用时,使用这个继续。

iunamespace

要列举的名字空间。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
iudir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending
iufilterredir

如何过滤重定向。当iuredirect被启用时如果设置为nonredirects,这只会应用到第二级。

單值:all、redirects、nonredirects
預設值:all
iulimit

返回总计页面数。如果iuredirect被启用,则限定分别适用于每一等级(这意味着将返回多达2 * iulimit个结果)。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
iuredirect

如果链接页面是重定向,则查找所有链接至该重定向的页面。最大限制减半。

类型:布尔值(详细信息
  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

查找所有链接至指定跨wiki链接的页面。

可被用于查找带某一前缀的所有链接,或所有至某一标题的链接(带指定前缀)。两参数都不使用就意味着“所有跨wiki链接”。

參數:
iwblprefix

跨维基前缀。

iwbltitle

要搜索的跨wiki链接。必须与iwblblprefix一起使用。

iwblcontinue

当更多结果可用时,使用这个继续。

iwbllimit

返回的总计页面数。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
iwblprop

要获取的属性:

iwprefix
加入跨wiki前缀。
iwtitle
加入跨wiki标题。
多值 (以 | 分隔):iwprefix、iwtitle
預設值:(空)
iwbldir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending
  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

发现所有链接至指定语言链接的页面。

可被用于查找所有带某一语言代码的链接,或所有至某一标题的链接(带指定语言)。不使用任何参数就意味着“所有语言链接”。

注意这可能不考虑由扩展添加的语言链接。

參數:
lbllang

用于语言链接的语言。

lbltitle

要搜索的语言链接。必须与lbllang一起使用。

lblcontinue

当更多结果可用时,使用这个继续。

lbllimit

要回傳的頁面總數。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
lblprop

要获得的属性:

lllang
添加语言链接的语言代码。
lltitle
添加语言链接的标题。
多值 (以 | 分隔):lllang、lltitle
預設值:(空)
lbldir

罗列所采用的方向。

單值:ascending、descending
預設值:ascending

list=logevents <pre>(le) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

从日志获取事件。

參數:
leprop

要获取的属性:

ids
添加日志活动的ID。
title
为日志事件添加页面标题。
type
添加日志活动的类型。
user
为日志事件添加用户责任。
userid
为日志事件添加对此负责的用户ID。
timestamp
为日志活动添加时间戳。
comment
添加日志活动的摘要。
parsedcomment
添加被解析的日志活动的摘要。
details
列举有关日志事件的额外详细信息。
tags
列举用于日志活动的标签。
多值 (以 | 分隔):ids、title、type、user、userid、timestamp、comment、parsedcomment、details、tags
預設值:ids|title|type|user|timestamp|comment|details
letype

过滤日志记录至仅限此类型。

單值:可以空白,或 renameuser、spamblacklist、titleblacklist、abusefilter、thanks、block、protect、rights、delete、upload、move、import、patrol、merge、suppress、tag、managetags、contentmodel、newusers、interwiki、smw
leaction

过滤日志操作为仅限此操作。覆盖letype。在可用值列表中,带星号通配符的值例如action/*可在斜线(/)后拥有不同字符串。

單值:suppress/hide-afl、suppress/unhide-afl、renameuser/renameuser、spamblacklist/*、titleblacklist/*、abusefilter/modify、abusefilter/hit、thanks/*、block/block、block/reblock、block/unblock、contentmodel/change、contentmodel/new、delete/delete、delete/event、delete/restore、delete/revision、import/interwiki、import/upload、managetags/activate、managetags/create、managetags/deactivate、managetags/delete、merge/merge、move/move、move/move_redir、patrol/patrol、patrol/autopatrol、protect/modify、protect/move_prot、protect/protect、protect/unprotect、rights/autopromote、rights/rights、suppress/block、suppress/delete、suppress/event、suppress/reblock、suppress/revision、tag/update、upload/overwrite、upload/revert、upload/upload、newusers/newusers、newusers/create、newusers/create2、newusers/byemail、newusers/autocreate、interwiki/*
lestart

枚举的起始时间戳。

类型:时间戳(允许格式
leend

枚举的结束时间戳。

类型:时间戳(允许格式
ledir

列举的方向:

newer
最早的优先。注意:lestart应早于leend。
older
最新的优先(默认)。注意:lestart应晚于leend。
單值:newer、older
預設值:older
leuser

过滤记录为这些由指定用户做出的。

类型:用户名
letitle

过滤记录至这些与页面相关的。

lenamespace

过滤事件为在这些指定的名字空间中。

單值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
leprefix

过滤以此前缀开头的记录。

letag

只列举带此标签的事件日志记录。

lelimit

要回傳的事件項目總數。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
lecontinue

当更多结果可用时,使用这个继续。

範例:
列出最近日志事件。
api.php?action=query&list=logevents [在沙盒中打开]

list=mystashedfiles <pre>(msf) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

获取当前用户上传暂存库中的文件列表。

參數:
msfprop

要检索文件的属性。

size
检索文件大小和图片尺寸。
type
检索文件的MIME类型和媒体类型。
多值 (以 | 分隔):size、type
預設值:(空)
msflimit

要获取文件的数量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
msfcontinue

当更多结果可用时,使用这个继续。

範例:
获取当前用户上传暂存库中的文件的filekey、大小和像素尺寸。
api.php?action=query&list=mystashedfiles&msfprop=size [在沙盒中打开]

list=pagepropnames <pre>(ppn) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列出wiki中所有使用中的页面属性名称。

參數:
ppncontinue

当更多结果可用时,使用这个继续。

ppnlimit

回傳的名稱數量上限。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10

list=pageswithprop <pre>(pwp) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列出所有使用指定页面属性的页面。

參數:
pwppropname

要用于列举页面的页面属性(action=query&list=pagepropnames返回正在使用中的页面属性名称)。

此參數為必填。
pwpprop

要包含的信息束:

ids
添加页面ID。
title
添加页面的标题和名字空间ID。
value
添加页面属性值。
多值 (以 | 分隔):ids、title、value
預設值:ids|title
pwpcontinue

当更多结果可用时,使用这个继续。

pwplimit

回傳的頁面數量上限。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
pwpdir

排序的方向。

單值:ascending、descending
預設值:ascending

list=prefixsearch <pre>(ps) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

为页面标题执行前缀搜索。

Despite the similarity in names, this module is not intended to be equivalent to Special:PrefixIndex; for that, see action=query&list=allpages with the apprefix parameter. The purpose of this module is similar to action=opensearch: to take user input and provide the best-matching titles. Depending on the search engine backend, this might include typo correction, redirect avoidance, or other heuristics.

參數:
pssearch

搜索字符串。

此參數為必填。
psnamespace

搜索的名字空间。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
預設值:0
pslimit

回傳的結果數量上限。

不允許超過 100 (機器人為 200)。
类型:整数或max
預設值:10
psoffset

跳过的结果数。

类型:整数
預設值:0
範例:
搜索以meaning开头的页面标题。
api.php?action=query&list=prefixsearch&pssearch=meaning [在沙盒中打开]

list=protectedtitles <pre>(pt) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列出所有被限制创建的标题。

參數:
ptnamespace

只列出这些名字空间的标题。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
ptlevel

只列出带这些保护级别的标题。

多值 (以 | 分隔):autoconfirmed、sysop
ptlimit

要回傳的頁面總數。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
ptdir

列举的方向:

newer
最早的优先。注意:ptstart应早于ptend。
older
最新的优先(默认)。注意:ptstart应晚于ptend。
單值:newer、older
預設值:older
ptstart

从此保护时间戳开始列举。

类型:时间戳(允许格式
ptend

列举至此保护时间戳为止。

类型:时间戳(允许格式
ptprop

要获取的属性:

timestamp
添加保护被添加时的时间戳。
user
添加对页面添加保护的用户。
userid
添加对页面添加保护的用户ID。
comment
为保护添加摘要。
parsedcomment
为保护添加解析的摘要。
expiry
添加保护将被提升时的时间戳。
level
添加保护级别。
多值 (以 | 分隔):timestamp、user、userid、comment、parsedcomment、expiry、level
預設值:timestamp|level
ptcontinue

当更多结果可用时,使用这个继续。

list=querypage <pre>(qp) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

获取由基于QueryPage的特殊页面提供的列表。

參數:
qppage

特殊页面的名称。注意其区分大小写。

此參數為必填。
單值:Ancientpages、BrokenRedirects、Deadendpages、DoubleRedirects、ListDuplicatedFiles、Listredirects、Lonelypages、Longpages、MediaStatistics、Mostcategories、Mostimages、Mostinterwikis、Mostlinkedcategories、Mostlinkedtemplates、Mostlinked、Mostrevisions、Fewestrevisions、Shortpages、Uncategorizedcategories、Uncategorizedpages、Uncategorizedimages、Uncategorizedtemplates、Unusedcategories、Unusedimages、Wantedcategories、Wantedfiles、Wantedpages、Wantedtemplates、Unwatchedpages、Unusedtemplates、Withoutinterwiki、GadgetUsage
qpoffset

当更多结果可用时,使用这个继续。

类型:整数
預設值:0
qplimit

回傳的結果數量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10

list=random <pre>(rn) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

获取一组随机页面。

页面列举在一个固定序列中,只有起始点是随机的。这意味着如果Main Page是列表中第一个随机页面的话,List of fictional monkeys总是第二个,List of people on stamps of Vanuatu是第三个等。

參數:
rnnamespace

只返回这些名字空间的页面。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
rnfilterredir

如何过滤重定向。

單值:all、redirects、nonredirects
預設值:nonredirects
rnredirect
已停用。

请改用rnfilterredir=redirects

类型:布尔值(详细信息
rnlimit

限制返回多少随机页面。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:1
rncontinue

当更多结果可用时,使用这个继续。

範例:
从主名字空间返回两个随机页面。
api.php?action=query&list=random&rnnamespace=0&rnlimit=2 [在沙盒中打开]
返回有关来自主名字空间的两个随机页面的页面信息。
api.php?action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info [在沙盒中打开]

list=recentchanges <pre>(rc) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列舉出最近變更。

參數:
rcstart

枚举的起始时间戳。

类型:时间戳(允许格式
rcend

枚举的结束时间戳。

类型:时间戳(允许格式
rcdir

列举的方向:

newer
最早的优先。注意:rcstart应早于rcend。
older
最新的优先(默认)。注意:rcstart应晚于rcend。
單值:newer、older
預設值:older
rcnamespace

过滤更改为仅限这些名字空间。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
rcuser

只列出此用户的更改。

类型:用户名
rcexcludeuser

不要列出此用户的更改。

类型:用户名
rctag

只列出带此标签的更改。

rcprop

包含的额外信息束:

user
为编辑和标签添加用户责任,如果它们是IP的话。
userid
为编辑添加用户ID责任。
comment
为编辑添加摘要。
parsedcomment
为编辑添加解析的摘要。
flags
为编辑添加标记。
timestamp
添加编辑的时间戳。
title
添加编辑的页面标题。
ids
添加页面ID、最近更改ID和新旧修订的ID。
sizes
添加新旧页面长度(字节)。
redirect
如果页面是重定向的话,标记编辑。
patrolled
Tags patrollable edits as being patrolled or unpatrolled.
loginfo
Adds log information (log ID, log type, etc) to log entries.
tags
列举条目的标签。
sha1
Adds the content checksum for entries associated with a revision.
多值 (以 | 分隔):user、userid、comment、parsedcomment、flags、timestamp、title、ids、sizes、redirect、patrolled、loginfo、tags、sha1
預設值:title|timestamp|ids
rctoken
已停用。

请改用action=query&meta=tokens

多值 (以 | 分隔):patrol
rcshow

只显示满足这些标准的项目。例如,要只查看由登录用户做出的小编辑,设置rcshow=minor|!anon。

多值 (以 | 分隔):minor、!minor、bot、!bot、anon、!anon、redirect、!redirect、patrolled、!patrolled、unpatrolled
rclimit

要回傳變更總數。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
rctype

显示的更改类型。

多值 (以 | 分隔):edit、new、log、external、categorize
預設值:edit|new|log|categorize
rctoponly

只列举作为最新修订的更改。

类型:布尔值(详细信息
rccontinue

当更多结果可用时,使用这个继续。

rcgeneraterevisions

当作为生成器使用时,生成修订ID而不是标题。不带关联修订ID的最近更改记录(例如大多数日志记录)将不会生成任何东西。

类型:布尔值(详细信息

list=search <pre>(sr) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

执行一次全文本搜索。

參數:
srsearch

搜索所有匹配此值的页面标题或内容。根据wiki的搜索后端工具,您可以使用搜索字符串以调用特殊搜索功能。

此參數為必填。
srnamespace

只在这些名字空间搜索。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
預設值:0
srwhat

要执行的搜索类型。

單值:title、text、nearmatch
srinfo

要返回的元数据。

多值 (以 | 分隔):totalhits、suggestion、rewrittenquery
預設值:totalhits|suggestion|rewrittenquery
srprop

要返回的属性:

size
添加页面大小,单位为字节。
wordcount
添加页面的字数。
timestamp
添加页面上次编辑时的时间戳。
snippet
Adds a parsed snippet of the page.
titlesnippet
Adds a parsed snippet of the page title.
redirecttitle
Adds the title of the matching redirect.
redirectsnippet
Adds a parsed snippet of the redirect title.
sectiontitle
Adds the title of the matching section.
sectionsnippet
Adds a parsed snippet of the matching section title.
isfilematch
Adds a boolean indicating if the search matched file content.
categorysnippet
Adds a parsed snippet of the matching category.
score
已弃用并已忽略。
hasrelated
Deprecated and ignored.
多值 (以 | 分隔):size、wordcount、timestamp、snippet、titlesnippet、redirecttitle、redirectsnippet、sectiontitle、sectionsnippet、isfilematch、categorysnippet、score、hasrelated
預設值:size|wordcount|timestamp|snippet
sroffset

当更多结果可用时,使用这个继续。

类型:整数
預設值:0
srlimit

要回傳的頁面總數。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
srinterwiki

搜索结果中包含跨wiki结果,如果可用。

类型:布尔值(详细信息
srenablerewrites

启用内部查询重写。一些搜索后端可以重写查询到它认为会给出更好结果的地方,例如纠正拼写错误。

类型:布尔值(详细信息

list=tags <pre>(tg) </pre>

(main | query | tags)
  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

列出更改标签。

參數:
tgcontinue

当更多结果可用时,使用这个继续。

tglimit

列出标签的最大数量。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
tgprop

要获取哪个属性:

name
添加标签名称。
displayname
为标签添加系统消息。
description
为标签添加描述。
hitcount
已添加此标签的修订版本与日志数量。
defined
标识标签是否已定义。
source
获得标签来源,它可能包括用于扩展定义的标签的extension,以及用于可被用户手动应用的标签的manual
active
标签是否仍可被应用。
多值 (以 | 分隔):name、displayname、description、hitcount、defined、source、active
預設值:name

list=usercontribs <pre>(uc) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

获取一位用户的所有编辑。

參數:
uclimit

回傳的貢獻數量上限。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
ucstart

返回的起始时间戳。

类型:时间戳(允许格式
ucend

返回的最终时间戳。

类型:时间戳(允许格式
uccontinue

当更多结果可用时,使用这个继续。

ucuser

要检索贡献的用户。

类型:用户名列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
ucuserprefix

取得所有用户名以这个值开头的用户的贡献。覆盖ucuser。

ucdir

列举的方向:

newer
最早的优先。注意:ucstart应早于ucend。
older
最新的优先(默认)。注意:ucstart应晚于ucend。
單值:newer、older
預設值:older
ucnamespace

只列出这些名字空间的贡献。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
ucprop

包含额外的信息束:

ids
添加页面ID和修订ID。
title
添加页面标题及其名字空间ID。
timestamp
添加编辑的时间戳。
comment
添加编辑摘要。
parsedcomment
添加被解析的编辑摘要。
size
添加编辑的新大小。
sizediff
添加与父编辑相比该编辑的大小变化。
flags
添加编辑标记。
patrolled
标记已巡查编辑。
tags
列举用于编辑的标签。
多值 (以 | 分隔):ids、title、timestamp、comment、parsedcomment、size、sizediff、flags、patrolled、tags
預設值:ids|title|timestamp|comment|size|flags
ucshow

只显示符合这些标准的项目,例如只显示不是小编辑的编辑:ucshow=!minor

如果ucshow=patrolleducshow=!patrolled被设定,早于$wgRCMaxAge(7776000秒)的修订不会被显示。

多值 (以 | 分隔):minor、!minor、patrolled、!patrolled、top、!top、new、!new
uctag

只列出被此标签标记的修订。

uctoponly
已停用。

只列举作为最新修订的更改。

类型:布尔值(详细信息

list=users <pre>(us) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

获取有关列出用户的信息。

參數:
usprop

要包含的信息束:

blockinfo
如果用户被封禁就标记,并注明是谁封禁,以何种原因封禁的。
groups
列举每位用户属于的所有组。
implicitgroups
Lists all the groups a user is automatically a member of.
rights
列举每位用户拥有的所有权限。
editcount
添加用户的编辑计数。
registration
添加用户的注册时间戳。
emailable
Tags if the user can and wants to receive email through Special:Emailuser.
gender
标记用户性别。返回“male”、“female”或“unknown”。
centralids
添加中心ID并为用户附加状态。
cancreate
Indicates whether an account for valid but unregistered usernames can be created.
多值 (以 | 分隔):blockinfo、groups、implicitgroups、rights、editcount、registration、emailable、gender、centralids、cancreate
usattachedwiki

usprop=centralids一起使用,表明用户是否附加于此ID定义的wiki。

ususers

要获取信息的用户列表。

类型:用户名列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
ustoken
已停用。

请改用action=query&meta=tokens

多值 (以 | 分隔):userrights

list=watchlist <pre>(wl) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

在当前用户的监视列表中获取对页面的最近更改。

參數:
wlallrev

将同一页面的多个修订包含于指定的时间表内。

类型:布尔值(详细信息
wlstart

枚举的起始时间戳。

类型:时间戳(允许格式
wlend

枚举的结束时间戳。

类型:时间戳(允许格式
wlnamespace

过滤更改为仅限指定的名字空间。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
wluser

只列出此用户的更改。

类型:用户名
wlexcludeuser

不要列出此用户的更改。

类型:用户名
wldir

列举的方向:

newer
最早的优先。注意:wlstart应早于wlend。
older
最新的优先(默认)。注意:wlstart应晚于wlend。
單值:newer、older
預設值:older
wllimit

每個請求要回傳的結果總數。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
wlprop

要获取的额外属性:

ids
添加修订ID和页面ID。
title
添加页面标题。
flags
为编辑添加标记。
user
添加做出编辑的用户。
userid
添加做出编辑的用户的ID。
comment
添加编辑摘要。
parsedcomment
添加解析过的编辑摘要。
timestamp
添加编辑时间戳。
patrol
将编辑标记为已巡查。
sizes
添加页面的旧有长度和新长度。
notificationtimestamp
添加最近被通知有关编辑的用户的时间戳。
loginfo
在适当位置添加日志信息。
多值 (以 | 分隔):ids、title、flags、user、userid、comment、parsedcomment、timestamp、patrol、sizes、notificationtimestamp、loginfo
預設值:ids|title|flags
wlshow

只显示满足这些标准的项目。例如,要只查看由登录用户做出的小编辑,设置wlshow=minor|!anon。

多值 (以 | 分隔):minor、!minor、bot、!bot、anon、!anon、patrolled、!patrolled、unread、!unread
wltype

要显示的更改类型:

edit
普通页面编辑。
new
页面创建。
log
日志记录。
external
外部更改。
categorize
分类成员组更改。
多值 (以 | 分隔):edit、new、log、external、categorize
預設值:edit|new|log|categorize
wlowner

与wltoken一起使用以访问不同用户的监视列表。

类型:用户名
wltoken

允许访问其他用户监视列表的安全密钥(可通过用户的参数设置找到)。

wlcontinue

当更多结果可用时,使用这个继续。

範例:
在当前用户的监视列表中列出用于最近更改页面的最新修订。
api.php?action=query&list=watchlist [在沙盒中打开]
在当前用户的监视列表中检索有关用于最近更改页面的最新修订的额外信息。
api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment [在沙盒中打开]
在当前用户的监视列表中检索有关所有最近对页面的更改的信息。
api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment [在沙盒中打开]
在当前用户的监视列表中检索用于最近更改页面的页面信息。
api.php?action=query&generator=watchlist&prop=info [在沙盒中打开]
在当前用户的监视列表中检索用于对页面最近更改的修订信息。
api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user [在沙盒中打开]
在用户Example的监视列表中列出用于最近更改页面的最新修订。
api.php?action=query&list=watchlist&wlowner=Example&wltoken=123ABC [在沙盒中打开]

list=watchlistraw <pre>(wr) </pre>

  • 此模組需要讀取權限。
  • 此模块可作为发生器使用。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

获得当前用户的监视列表上的所有页面。

參數:
wrcontinue

当更多结果可用时,使用这个继续。

wrnamespace

只列出指定名字空间的页面。

多值 (以 | 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、274、275、2300、2301、2302、2303
wrlimit

每個請求要回傳的結果總數。

不允許超過 500 (機器人為 5,000)。
类型:整数或max
預設值:10
wrprop

要获取的额外属性:

changed
添加最近被通知有关编辑的用户的时间戳。
多值 (以 | 分隔):changed
wrshow

只列出符合这些标准的项目。

多值 (以 | 分隔):changed、!changed
wrowner

与wrtoken一起使用以访问不同用户的监视列表。

类型:用户名
wrtoken

允许访问其他用户监视列表的安全密钥(可通过用户的参数设置找到)。

wrdir

列举的方向:

newer
最早的优先。注意:wrstart应早于wrend。
older
最新的优先(默认)。注意:wrstart应晚于wrend。
單值:ascending、descending
預設值:ascending
wrfromtitle

要列举的起始标题(带名字空间前缀)。

wrtotitle

要列举的最终标题(带名字空间前缀)。

範例:
列出当前用户的监视列表中的页面。
api.php?action=query&list=watchlistraw [在沙盒中打开]
检索当前用户监视列表上的页面的页面信息。
api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=info [在沙盒中打开]

meta=allmessages <pre>(am) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

返回来自该网站的消息。

參數:
ammessages

要输出的消息。*(默认)表示所有消息。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
預設值:*
amprop

要获取的属性。

多值 (以 | 分隔):default
amenableparser

设置以启用解析器,将处理消息的wiki文本(替代魔术字、处理模板等)。

类型:布尔值(详细信息
amnocontent

如果设置,不要在输出中包含消息内容。

类型:布尔值(详细信息
amincludelocal

也包括本地消息,也就是不存在于软件但作为MediaWiki:页面存在的消息。 这会列举所有MediaWiki:页面,因此它也将列举那些不是真消息的消息,例如Common.js

类型:布尔值(详细信息
amargs

要替代进消息的参数。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
amfilter

只返回名称包含此字符串的消息。

amcustomised

只返回在此定制情形下的消息。

單值:all、modified、unmodified
預設值:all
amlang

返回这种语言的信息。

amfrom

从此消息开始返回消息。

amto

返回消息至此消息为止。

amtitle

当解析消息时,要用作环境的页面(用于amenableparser选项)。

amprefix

返回带有该前缀的消息。

meta=authmanagerinfo <pre>(ami) </pre>

  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

Retrieve information about the current authentication status.

參數:
amisecuritysensitiveoperation

Test whether the user's current authentication status is sufficient for the specified security-sensitive operation.

amirequestsfor

Fetch information about the authentication requests needed for the specified authentication action.

單值:login、login-continue、create、create-continue、link、link-continue、change、remove、unlink
amimergerequestfields

Merge field information for all authentication requests into one array.

类型:布尔值(详细信息
amimessageformat

Format to use for returning messages.

單值:html、wikitext、raw、none
預設值:wikitext
範例:
Fetch the requests that may be used when beginning a login.
api.php?action=query&meta=authmanagerinfo&amirequestsfor=login [在沙盒中打开]
Fetch the requests that may be used when beginning a login, with form fields merged.
api.php?action=query&meta=authmanagerinfo&amirequestsfor=login&amimergerequestfields=1 [在沙盒中打开]
Test whether authentication is sufficient for action foo.
api.php?action=query&meta=authmanagerinfo&amisecuritysensitiveoperation=foo [在沙盒中打开]

meta=filerepoinfo <pre>(fri) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

返回有关wiki配置的图片存储库的元信息。

參數:
friprop

要获取的存储库属性(这在一些wiki上可能有更多可用选项):

apiurl
链接至API的URL - 对从主机获取图片信息有用。
name
存储库关键词 - 用于例如$wgForeignFileRepos,并且imageinfo会返回值。
displayname
人类可读的存储库wiki名称。
rooturl
图片路径的根URL。
local
存储库是否在本地。
多值 (以 | 分隔):name、displayname、rootUrl、local、url、thumbUrl、initialCapital、scriptDirUrl、scriptExtension、favicon、canUpload
預設值:name|displayname|rootUrl|local|url|thumbUrl|initialCapital|scriptDirUrl|scriptExtension|favicon|canUpload

meta=notifications <pre>(not) </pre>

  • 此模組需要讀取權限。
  • 来源:Echo
  • 许可协议:MIT

取得目前使用者等待的通知。

參數:
notfilter

过滤返回的通知。

多值 (以 | 分隔):read、!read
預設值:read|!read
notprop

請求的詳細資料。

多值 (以 | 分隔):list、count
預設值:list
notsections

要查詢的通知章節 (例如部份 'alert' 與 'message' 的組合)。

多值 (以 | 分隔):alert、message
預設值:alert|message
notgroupbysection

是否要依據章節來分類查詢結果。 若開啟此功能會各別取得每個章節。

类型:布尔值(详细信息
notformat

若有指定,通知將會以此指定的格式回傳結果。

text
純文字格式
model
原始通知資料
special
格式化用于Special:Notifications页面(并仅限于此!)不要依赖HTML,这可能在任何指定的时间更改。
flyout
已弃用。使用notformat=model用于原始数据
html
已弃用。使用notformat=model用于原始数据
單值:text、model、special、flyout、html
notlimit

要回傳的通知數量上限。

不允許超過 50 (機器人為 500)。
类型:整数或max
預設值:20
notcontinue

当更多结果可用时,使用这个继续。

notunreadfirst

是否首先显示未读通知(只当groupbysection未设置时使用)。

类型:布尔值(详细信息
notalertcontinue

當有多個警告的結果時,使用此參數來繼續。

notalertunreadfirst

是否要先顯示未讀的訊息通知。

类型:布尔值(详细信息
notmessagecontinue

當有更多訊息結果時,使用此參數來繼續。

notmessageunreadfirst

是否先顯示未讀的警告通知。

类型:布尔值(详细信息

meta=siteinfo <pre>(si) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

返回有关网站的一般信息。

參數:
siprop

要获取的信息:

general
全部系统信息。
namespaces
注册的名字空间及其规范名称列表。
namespacealiases
注册的名字空间别名列表。
specialpagealiases
特殊页面别名列表。
magicwords
魔术字及其别名列表。
interwikimap
返回跨wiki映射(可选过滤,可选择使用siinlanguagecode本地化)。
dbrepllag
返回数据库服务器与最高反应延迟。
statistics
返回网站统计。
usergroups
返回用户组及其相关权限。
libraries
返回wiki上安装的库。
extensions
返回wiki上安装的扩展。
fileextensions
返回允许上传的文件扩展名(文件类型)列表。
rightsinfo
如果可用,返回wiki的版权信息。
restrictions
返回可用的编辑限制(保护)类型信息。
languages
返回MediaWiki支持的语言列表(可选择使用siinlanguagecode本地化)。
skins
返回所有启用的皮肤列表(可选择使用siinlanguagecode本地化,否则是内容语言)。
extensiontags
返回解析器扩展标签列表。
functionhooks
返回解析器函数钩列表。
showhooks
返回所有订阅的钩列表($wgHooks的内容)。
variables
返回变量ID列表。
protocols
返回外部链接中允许的协议列表。
defaultoptions
返回用户设置的默认值。
uploaddialog
Returns the upload dialog configuration.
多值 (以 | 分隔):general、namespaces、namespacealiases、specialpagealiases、magicwords、interwikimap、dbrepllag、statistics、usergroups、libraries、extensions、fileextensions、rightsinfo、restrictions、languages、skins、extensiontags、functionhooks、showhooks、variables、protocols、defaultoptions、uploaddialog
預設值:general
sifilteriw

只返回跨wiki地图中的本地或非本地记录。

單值:local、!local
sishowalldb

列出所有数据库服务器,不只是最落后的那个。

类型:布尔值(详细信息
sinumberingroup

列出用户组中的用户数。

类型:布尔值(详细信息
siinlanguagecode

用于本地化语言名称(尽可能)和皮肤名称的语言代码。

meta=tokens

  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

获取可修改数据的操作的令牌。

參數:
type

要求的權杖類型。

多值 (以 | 分隔):createaccount、csrf、login、patrol、rollback、userrights、watch
預設值:csrf

meta=userinfo <pre>(ui) </pre>

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

获取有关当前用户的信息。

參數:
uiprop

要包含的信息束:

blockinfo
如果当前用户被封禁就标记,并注明是谁封禁,以何种原因封禁的。
hasmsg
如果当前用户有等待中的消息的话,添加标签messages
groups
列举当前用户隶属的所有群组。
implicitgroups
列举当前用户的所有自动成为成员的用户组。
rights
列举当前用户拥有的所有权限。
changeablegroups
Lists the groups the current user can add to and remove from.
options
Lists all preferences the current user has set.
preferencestoken
已弃用。获取令牌以更改当前用户的参数设置。
editcount
添加当前用户的编辑计数。
ratelimits
Lists all rate limits applying to the current user.
email
Adds the user's email address and email authentication date.
realname
添加用户的真实姓名。
acceptlang
Echoes the Accept-Language header sent by the client in a structured format.
registrationdate
添加用户的注册时间。
unreadcount
Adds the count of unread pages on the user's watchlist (maximum 999; returns 1000+ if more).
centralids
添加中心ID并为用户附加状态。
多值 (以 | 分隔):blockinfo、hasmsg、groups、implicitgroups、rights、changeablegroups、options、preferencestoken、editcount、ratelimits、email、realname、acceptlang、registrationdate、unreadcount、centralids
uiattachedwiki

uiprop=centralids一起使用,表明用户是否附加于此ID定义的wiki。

action=removeauthenticationdata

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

Remove authentication data for the current user.

參數:
request

Use this authentication request, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=remove.

此參數為必填。
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。
範例:
Attempt to remove the current user's data for FooAuthenticationRequest.
api.php?action=removeauthenticationdata&request=FooAuthenticationRequest&token=123ABC [在沙盒中打开]

action=resetpassword

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

Send a password reset email to a user.

參數:
user

User being reset.

类型:用户名
email

Email address of the user being reset.

capture

Return the temporary passwords that were sent. Requires the passwordreset user right.

类型:布尔值(详细信息
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。
範例:
Send a password reset email to user Example.
api.php?action=resetpassword&user=Example&token=123ABC [在沙盒中打开]
Send a password reset email for all users with email address user@example.com.
api.php?action=resetpassword&user=user@example.com&token=123ABC [在沙盒中打开]

action=revisiondelete

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

删除和恢复修订版本。

參數:
type

正在执行的修订版本删除类型。

此參數為必填。
單值:revision、archive、oldimage、filearchive、logging
target

要进行修订版本删除的页面标题,如果对某一类型需要。

ids

用于将被删除的修订的标识符。

此參數為必填。
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
hide

每次修订要隐藏的东西。

多值 (以 | 分隔):content、comment、user
show

每次修订要恢复显示的东西。

多值 (以 | 分隔):content、comment、user
suppress

是否对管理员及其他人禁止数据。

單值:yes、no、nochange
預設值:nochange
reason

删除或恢复的原因。

token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=rollback

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

撤销对页面的最近编辑。

如果最近编辑页面的用户在一行中进行多次编辑,所有编辑将被回退。

參數:
title

要回退的页面标题。不能与pageid一起使用。

pageid

要回退的页面的页面 ID。不能与title一起使用。

类型:整数
tags

要应用在回退上的标签。

多值 (以 | 分隔):
user

做出要回退的编辑的用户名称。

此參數為必填。
类型:用户名
summary

自定义编辑摘要。如果为空,将使用默认摘要。

預設值:(空)
markbot

将被回退的编辑和回退操作标记为机器人编辑。

类型:布尔值(详细信息
watchlist

无条件地将页面加入至当前用户的监视列表或将其移除,使用设置或不更改监视。

單值:watch、unwatch、preferences、nochange
預設值:preferences
token

action=query&meta=tokens 接收的 "rollback" 密鑰。

出于兼容性考虑,web UI中使用的令牌也被接受。

此參數為必填。
範例:
回退由用户ExampleMain Page做出的最近编辑。
api.php?action=rollback&title=Main%20Page&user=Example&token=123ABC [在沙盒中打开]
回退由IP用户192.0.2.5对页面Main Page做出的最近编辑,带编辑摘要Reverting vandalism,并将这些编辑和回退标记为机器人编辑。
api.php?action=rollback&title=Main%20Page&user=192.0.2.5&token=123ABC&summary=Reverting%20vandalism&markbot=1 [在沙盒中打开]

action=rsd

(main | rsd)
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

导出一个RSD(Really Simple Discovery)架构。

範例:
导出RSD架构。
api.php?action=rsd [在沙盒中打开]

action=setnotificationtimestamp

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

更新用于监视页面的通知时间戳。

这会影响监视列表和历史中已更改页面的高亮度,并且如果“當我的監視清單中的頁面或檔案有變更時,傳送電子郵件通知我”设置被启用的话,也会影响电子邮件的发送。

參數:
entirewatchlist

工作于所有已监视页面。

类型:布尔值(详细信息
timestamp

要设置通知时间戳的时间戳。

类型:时间戳(允许格式
torevid

要设置通知时间戳的修订(只限一个页面)。

类型:整数
newerthanrevid

要设置通知时间戳的较新修订(只限一个页面)。

类型:整数
continue

当更多结果可用时,使用这个继续。

titles

要使用的標題清單。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
pageids

要使用的頁面 ID 清單。

类型:整数列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
revids

要使用的修訂 ID 清單。

类型:整数列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
generator

通过执行指定查询模块获得页面列表以工作。

注意:发生器参数名称必须以“g”开头,参见例子。

單值:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

自动解决在titlespageidsrevids,以及在由generator返回的页面中的重定向。

类型:布尔值(详细信息
converttitles

如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括gan、iu、kk、ku、shi、sr、tg、uz、zh。

类型:布尔值(详细信息
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=spamblacklist

  • 此模組需要讀取權限。
  • 来源:SpamBlacklist
  • 许可协议:GPL-2.0+

验证一个或多个URL是否触发SpamBlacklist。

參數:
url

要验证是否触发黑名单的URL。

此參數為必填。
使用 | 分隔數值。 上限值為 50 (機器人為 500)。

action=stashedit

  • 此模块是内部或不稳定的。它的操作可以更改而不另行通知。
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

在分享的缓存中准备一次编辑。

这是为了从编辑表单中通过AJAX使用,以改进页面保存的性能。

參數:
title

正在編輯此頁面的標題。

此參數為必填。
section

段落数。0用于首段,new用于新的段落。

sectiontitle

新段落的标题。

text

頁面內容。

此參數為必填。
contentmodel

新内容的内容模型。

此參數為必填。
單值:GadgetDefinition、wikitext、javascript、json、css、text
contentformat

用于输入文本的内容序列化格式。

此參數為必填。
單值:application/json、text/x-wiki、text/javascript、text/css、text/plain
baserevid

基础修订的修订ID。

此參數為必填。
类型:整数
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=tag

(main | tag)
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

从个别修订或日志记录中添加或移除更改标签。

參數:
rcid

要添加或移除标签的一个或更多的最近更改ID。

类型:整数列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
revid

要添加或移除标签的一个或更多的修订ID。

类型:整数列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
logid

要添加或移除标签的一个或更多的日志记录ID。

类型:整数列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
add

要添加的标签。只有手动定义的标签可以添加。

多值 (以 | 分隔):
remove

要移除的标签。只有手动定义或完全不明确的标签可以被移除。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
reason

更改原因。

預設值:(空)
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。
範例:
vandalism标签添加至修订ID 123,而不指定原因
api.php?action=tag&revid=123&add=vandalism&token=123ABC [在沙盒中打开]
从日志记录ID 123移除spam标签,原因为Wrongly applied
api.php?action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC [在沙盒中打开]

action=thank

(main | thank)
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:Thanks
  • 许可协议:MIT

向一名编辑者发送感谢通知。

參數:
rev

要感谢某人的版本ID。

此參數為必填。
數值不可小於 1。
类型:整数
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。
source

一个描述请求来源的短字符串,例如diffhistory

範例:
为修订ID 456发送感谢,将差异页面作为来源
api.php?action=thank&revid=456&source=diff&token=123ABC [在沙盒中打开]

action=titleblacklist <pre>(tb) </pre>

  • 此模組需要讀取權限。
  • 来源:TitleBlacklist
  • 许可协议:GPL-2.0+

使用 TitleBlacklist 檢驗文章標題、檔案名稱或使用者名稱。

參數:
tbtitle

要用來檢驗封鎖清單的字串。

此參數為必填。
tbaction

要檢查的操作。

單值:create、edit、upload、createtalk、createpage、move、new-account
預設值:edit
tbnooverride

不要嘗試覆蓋標題封鎖清單。

範例:
檢查 Foo 是否已被列入封鎖名單
api.php?action=titleblacklist&tbtitle=Foo [在沙盒中打开]
檢查 Bar 是否已被列入編輯的封鎖名單
api.php?action=titleblacklist&tbtitle=Bar&tbaction=edit [在沙盒中打开]

action=tokens

  • 此模組已停用。
  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

取得資料修改動作的密鑰。

此模組已因支援 action=query&meta=tokens 而停用。

參數:
type

要请求的令牌类型。

多值 (以 | 分隔):block、createaccount、csrf、delete、edit、email、import、login、move、options、patrol、protect、rollback、unblock、userrights、watch
預設值:edit
範例:
检索一个编辑令牌(默认)。
api.php?action=tokens [在沙盒中打开]
检索一个电子邮件令牌和一个移动令牌。
api.php?action=tokens&type=email|move [在沙盒中打开]

action=unblock

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

解封一位用户。

參數:
id

解封时需要的封禁ID(通过list=blocks获得)。不能与user一起使用。

类型:整数
user

要解封的用户名、IP地址或IP段。不能与id一起使用。

reason

解除封鎖的原因。

預設值:(空)
tags

要在封禁日志中应用到实体的更改标签。

多值 (以 | 分隔):
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=undelete

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

恢复一个被删除页面的修订。

被删除修订的列表(包括时间戳)可通过list=deletedrevs检索到,并且被删除的文件ID列表可通过list=filearchive检索到。

參數:
title

要恢复的页面标题。

此參數為必填。
reason

還原的原因。

預設值:(空)
tags

要在删除日志中应用到实体的更改标签。

多值 (以 | 分隔):
timestamps

要回复的修订的时间戳。如果timestampsfileids都为空,所有将被恢复。

类型:时间戳列表(允许格式
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
fileids

要恢复的文件修订ID。如果timestampsfileids都为空,所有将被恢复。

类型:整数列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
watchlist

无条件地将页面加入至当前用户的监视列表或将其移除,使用设置或不更改监视。

單值:watch、unwatch、preferences、nochange
預設值:preferences
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=unlinkaccount

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

Remove a linked third-party account from the current user.

參數:
request

Use this authentication request, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=unlink.

此參數為必填。
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。
範例:
Attempt to remove the current user's link for the provider associated with FooAuthenticationRequest.
api.php?action=unlinkaccount&request=FooAuthenticationRequest&token=123ABC [在沙盒中打开]

action=upload

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

上传一个文件,或获取正在等待中的上传的状态。

可以使用的几种方法:

  • 直接上传文件内容,使用file参数。
  • 成批上传文件,使用filesizechunkoffset参数。
  • 有MediaWiki服务器从URL检索一个文件,使用url参数。
  • 完成一次由于警告而失败的早前上传,使用filekey参数。

需要注意,当发送file时,HTTP POST必须做为一次文件上传(也就是使用multipart/form-data)完成。

參數:
filename

目标文件名。

comment

上传注释。如果没有指定text,那么它也被用于新文件的初始页面文本。

預設值:(空)
tags

更改标签以应用于上传日志记录和文件页面修订中。

多值 (以 | 分隔):
text

用于新文件的初始页面文本。

watch
已停用。

监视页面。

类型:布尔值(详细信息
watchlist

无条件地将页面加入至当前用户的监视列表或将其移除,使用设置或不更改监视。

單值:watch、preferences、nochange
預設值:preferences
ignorewarnings

忽略任何警告。

类型:布尔值(详细信息
file

文件内容。

必須使用 multipart/form-data 以檔案上傳的方式傳送。
url

要检索文件来源的URL。

filekey

用于识别一次临时藏匿的早前上传的关键字。

sessionkey
已停用。

与filekey相同,基于向后兼容而维护。

stash

如果设置,服务器将临时藏匿文件而不是加入存储库。

类型:布尔值(详细信息
filesize

全部上传的文件大小。

數值必須在 0 與 104,857,600 之間。
类型:整数
offset

块的偏移量(字节)。

數值不可小於 0。
类型:整数
chunk

大块内容。

必須使用 multipart/form-data 以檔案上傳的方式傳送。
async

在可能的情况下,使潜在的大文件操作异步进行。

类型:布尔值(详细信息
checkstatus

只检索指定文件密钥的上传状态。

类型:布尔值(详细信息
token

action=query&meta=tokens 接收的 "csrf" 密鑰。

此參數為必填。

action=userrights

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

更改一位使用者的群組成員。

參數:
user

使用者名稱。

类型:用户名
userid

使用者 ID。

类型:整数
add

加入使用者至這些群組。

多值 (以 | 分隔):bot、sysop、bureaucrat、widgeteditor
remove

從這些群組移除使用者。

多值 (以 | 分隔):bot、sysop、bureaucrat、widgeteditor
reason

變更的原因。

預設值:(空)
token

action=query&meta=tokens 接收的 "userrights" 密鑰。

出于兼容性考虑,web UI中使用的令牌也被接受。

此參數為必填。
範例:
将用户FooBot添加至bot用户组,并从sysopbureaucrat组移除。
api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC [在沙盒中打开]
将ID为123的用户加入至机器人组,并将其从管理员行政员组移除。
api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC [在沙盒中打开]

action=watch

(main | watch)
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

从当前用户的监视列表中添加或移除页面。

參數:
title
已停用。

要(取消)监视的页面。也可使用titles

unwatch

如果设置页面将被取消监视而不是被监视。

类型:布尔值(详细信息
continue

当更多结果可用时,使用这个继续。

titles

要使用的標題清單。

使用 | 分隔數值。 上限值為 50 (機器人為 500)。
pageids

要使用的頁面 ID 清單。

类型:整数列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
revids

要使用的修訂 ID 清單。

类型:整数列表
使用 | 分隔數值。 上限值為 50 (機器人為 500)。
generator

通过执行指定查询模块获得页面列表以工作。

注意:发生器参数名称必须以“g”开头,参见例子。

單值:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

自动解决在titlespageidsrevids,以及在由generator返回的页面中的重定向。

类型:布尔值(详细信息
converttitles

如有需要,将标题转换为其他变体。只有当wiki的内容语言支持变体转换时才能工作。支持变体转换的语言包括gan、iu、kk、ku、shi、sr、tg、uz、zh。

类型:布尔值(详细信息
token

action=query&meta=tokens 接收的 "watch" 密鑰。

此參數為必填。

format=json

(main | json)
  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

使用 JSON 格式輸出資料。

參數:
callback

如果指定,将输出内容包裹在一个指定的函数调用中。出于安全考虑,所有用户相关的数据将被限制。

utf8

如果指定,使用十六进制转义序列将大多数(但不是全部)非ASCII的字符编码为UTF-8,而不是替换它们。默认当formatversion不是1时。

类型:布尔值(详细信息
ascii

如果指定,使用十六进制转义序列将所有非ASCII编码。默认当formatversion1时。

类型:布尔值(详细信息
formatversion

输出格式:

1
向后兼容格式(XML样式布尔值、用于内容节点的*键等)。
2
实验现代格式。细节可以更改!
latest
使用最新格式(当前为2),可以在没有警告的情况下更改。
單值:1、2、latest
預設值:1

format=jsonfm

  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

使用 JSON 格式輸出資料 (使用 HTML 格式顯示)。

參數:
wrappedhtml

作为一个JSON对象返回渲染好的HTML和关联的ResouceLoader模块。

类型:布尔值(详细信息
callback

如果指定,将输出内容包裹在一个指定的函数调用中。出于安全考虑,所有用户相关的数据将被限制。

utf8

如果指定,使用十六进制转义序列将大多数(但不是全部)非ASCII的字符编码为UTF-8,而不是替换它们。默认当formatversion不是1时。

类型:布尔值(详细信息
ascii

如果指定,使用十六进制转义序列将所有非ASCII编码。默认当formatversion1时。

类型:布尔值(详细信息
formatversion

输出格式:

1
向后兼容格式(XML样式布尔值、用于内容节点的*键等)。
2
实验现代格式。细节可以更改!
latest
使用最新格式(当前为2),可以在没有警告的情况下更改。
單值:1、2、latest
預設值:1

format=none

(main | none)
  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

不輸出。

format=php

(main | php)
  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

使用序列化 PHP 格式輸出資料。

參數:
formatversion

输出格式:

1
向后兼容格式(XML样式布尔值、用于内容节点的*键等)。
2
实验现代格式。细节可以更改!
latest
使用最新格式(当前为2),可以在没有警告的情况下更改。
單值:1、2、latest
預設值:1

format=phpfm

(main | phpfm)
  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

使用序列化 PHP 格式輸出資料 (使用 HTML 格式顯示)。

參數:
wrappedhtml

作为一个JSON对象返回渲染好的HTML和关联的ResouceLoader模块。

类型:布尔值(详细信息
formatversion

输出格式:

1
向后兼容格式(XML样式布尔值、用于内容节点的*键等)。
2
实验现代格式。细节可以更改!
latest
使用最新格式(当前为2),可以在没有警告的情况下更改。
單值:1、2、latest
預設值:1

format=rawfm

(main | rawfm)
  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

使用 JSON 格式的除錯元素輸出資料 (使用 HTML 格式顯示)。

參數:
wrappedhtml

作为一个JSON对象返回渲染好的HTML和关联的ResouceLoader模块。

类型:布尔值(详细信息

format=xml

(main | xml)
  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

使用 XML 格式輸出資料。

參數:
xslt

如果指定,加入已命名的页面作为一个XSL样式表。值必须是在MediaWiki名字空间以.xsl为结尾的标题。

includexmlnamespace

如果指定,添加一个XML名字空间。

类型:布尔值(详细信息

format=xmlfm

(main | xmlfm)
  • 此模組需要讀取權限。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0+

使用 XML 格式輸出資料 (使用 HTML 格式顯示)。

參數:
wrappedhtml

作为一个JSON对象返回渲染好的HTML和关联的ResouceLoader模块。

类型:布尔值(详细信息
xslt

如果指定,加入已命名的页面作为一个XSL样式表。值必须是在MediaWiki名字空间以.xsl为结尾的标题。

includexmlnamespace

如果指定,添加一个XML名字空间。

类型:布尔值(详细信息

数据类型

一些在API请求中的参数类型需要更进一步解释:

boolean
布尔参数就像HTML复选框一样工作:如果指定参数,无论何值都被认为是真。如果要假值,则可完全忽略参数。
timestamp
时间戳可被指定为很多格式。推荐使用ISO 8601日期和时间标准。所有时间为UTC时间,包含的任何时区会被忽略。
  • ISO 8601日期和时间,2001-01-15T14:56:00Z(标点和Z是可选项)
  • 带小数秒(会被忽略)的ISO 8601日期和时间,2001-01-15T14:56:00.00001Z(破折号、括号和Z是可选的)
  • MediaWiki格式,20010115145600
  • 一般数字格式,2001-01-15 14:56:00GMT+##-##的可选时区会被忽略)
  • EXIF格式,2001:01:15 14:56:00
  • RFC 2822格式(时区可能会被省略),Mon, 15 Jan 2001 14:56:00
  • RFC 850格式(时区可能会被省略),Monday, 15-Jan-2001 14:56:00
  • C ctime格式,Mon Jan 15 14:56:00 2001
  • 秒数是从1970-01-01T00:00:00Z开始,作为1到13位数的整数(除了0
  • 字符串now

製作群

API 開發人員:

  • Roan Kattouw (首席開發者 Sep 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (創立者,首席開發者 Sep 2006–Sep 2007)
  • Brad Jorsch (首席開發者 2013–present)

請傳送您的評論、建議以及問題至 mediawiki-api@lists.wikimedia.org 或者回報問題至 https://phabricator.wikimedia.org/。