MediaWiki API 帮助

这是自动生成的MediaWiki API文档页面。

文档和例子:https://www.mediawiki.org/wiki/API:Main_page/zh

主模块

main

状态信息:本页所展示的所有特性都应正常工作,但是API仍在开发当中,将会随时变化。请订阅mediawiki-api-announce 邮件列表以便获得更新通知。

错误请求:当API收到错误请求时,HTTP header将会返回一个包含"MediaWiki-API-Error"的值,随后header的值与error code将会送回并设置为相同的值。详细信息请参阅API: 错误与警告

参数:
action

要执行的操作。

一个值:blockchecktokenclearhasmsgcomparecreateaccountdeleteeditemailuserexpandtemplatesfeedcontributionsfeedrecentchangesfeedwatchlistfilereverthelpimagerotateimportloginlogoutmanagetagsmoveopensearchoptionsparaminfoparsepatrolprotectpurgequeryrevisiondeleterollbackrsdsetnotificationtimestampstashedittagtokensunblockundeleteuploaduserrightswatch
默认:help
format

输出的格式。

一个值:dbgdbgfmdumpdumpfmjsonjsonfmnonephpphpfmrawfmtxttxtfmwddxwddxfmxmlxmlfmyamlyamlfm
默认:jsonfm
maxlag

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

smaxage

设置s-maxage页顶至这些秒。错误不会缓存。

默认:0
maxage

设置max-age页顶至这些秒。错误不会缓存。

默认: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=siteinfo通过siprop=languages获取,或指定user以使用当前用户的语言设置,或指定content以使用此wiki的内容语言。

默认:user
例子:
主模块帮助
api.php?action=help
一个页面中的所有帮助
api.php?action=help&recursivesubmodules=1
权限:
writeapi
使用写入API
授予:all、user、bot
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
授予:bot、sysop

action=block

main | block
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

封禁一位用户。

参数:
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”令牌

这个参数是必须的。
例子:
封禁IP地址192.0.2.5三天,原因First strike
api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC
无限期封禁用户Vandal,原因Vandalism,并阻止新账户创建和电子邮件发送。
api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC

action=checktoken

  • 此模块需要读取权限。

action=query&meta=tokens检查令牌有效性。

参数:
type

已开始测试的令牌类型。

这个参数是必须的。
一个值:csrf、patrol、rollback、userrights、watch
token

要测试的令牌。

这个参数是必须的。
maxtokenage

令牌的最大允许年龄,以秒计。

例子:
测试csrf令牌的有效性。
api.php?action=checktoken&type=csrf&token=123ABC

action=clearhasmsg

  • 此模块需要读取权限。
  • 此模块需要写入权限。

清除当前用户的hasmsg标记。

例子:
清除当前用户的hasmsg标记。
api.php?action=clearhasmsg

action=compare

main | compare
  • 此模块需要读取权限。

获得2个页面之间的差别。

用于“from”和“to”的修订版本号、页面标题或页面 ID 必须获得通过。

参数:
fromtitle

要比较的第一个标题。

fromid

要比较的第一个页面 ID。

fromrev

要比较的第一个修订版本。

totitle

要比较的第二个标题。

toid

要比较的第二个页面 ID。

torev

要比较的第二个修订版本。

例子:
在版本1和2中创建差异
api.php?action=compare&fromrev=1&torev=2

action=createaccount

  • 此模块需要写入权限。
  • 此模块只允许POST请求。

创建一个新用户账户。

参数:
name

用户名

这个参数是必须的。
password

密码(如果设置mailpassword则忽略)。

domain

外部身份验证域 (可选)。

token

在第一个请求中获得的帐户创建标记。

email

用户的电子邮件地址(可选)。

realname

用户的真实姓名(可选)。

mailpassword

如果设置为任何值,将向用户发送一个随机密码。

reason

将要放在日志中的,关于创建帐户的可选原因。

language

要为用户设置为默认值的语言代码(可选,默认为内容语言)。

例子:
创建用户testuser和密码test123
api.php?action=createaccount&name=testuser&password=test123
创建用户testmailuser并电邮发送一个随机生成的密码。
api.php?action=createaccount&name=testmailuser&mailpassword=true&reason=MyReason

action=delete

main | delete
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

删除一个页面。

参数:
title

你所希望删除的页面的标题。不能与pageid一起使用。

pageid

要删除的页面的页面 ID。不能与title一起使用。

reason

删除原因。如果未设置,将使用一个自动生成的原因。

watch
不推荐使用。

将该页面加入当前用户的监视列表。

watchlist

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

一个值:watch、unwatch、preferences、nochange
默认:preferences
unwatch
不推荐使用。

将该页面从当前用户的监视列表删除。

oldimage

action=query&prop=imageinfo&iiprop=archivename提供的要删除的旧图片名称。

token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=edit

main | edit
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

创建和编辑页面。

参数:
title

您希望编辑的页面标题。不能与pageid一起使用。

pageid

要编辑的页面的页面 ID。不能与title一起使用。

section

段落数。0用于首段,new用于新的段落。

sectiontitle

新小节的标题。

text

页面内容。

summary

编辑摘要。当section=new且未设置sectiontitle时,还包括小节标题。

tags

Change tags to apply to the revision.

值(以|分隔):
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

用于输入文本的内容串行化格式。

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

新内容的内容模型。

一个值:wikitext、javascript、json、css、text
token

action=query&meta=tokens取回的“csrf”令牌

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

这个参数是必须的。

action=emailuser

main | emailuser
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

电子邮件联系一位用户。

参数:
target

电子邮件的目标用户。

这个参数是必须的。
subject

主题页眉。

text

邮件正文。

这个参数是必须的。
ccme

给我发送一份该邮件的副本。

token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。
例子:
向用户WikiSysop发送邮件,带文字Content
api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC

action=expandtemplates

  • 此模块需要读取权限。

展开维基文本中的所有模板。

参数:
title

页面标题。

默认:API
text

要转换的wiki文本。

这个参数是必须的。
revid

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

prop

要获取的那条信息:

wikitext
展开的wiki文本。
categories
任何在不代表wiki文本输出的输入框出现的分类。
properties
由wiki文本中扩充的魔术字定义的页面属性。
volatile
输出是否不稳定,并且不应在任何页面中再度使用。
ttl
结果的哪个缓存后等待最长时间应无效化。
parsetree
输入的XML解析树。

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

值(以|分隔):wikitext、categories、properties、volatile、ttl、parsetree
includecomments

输出时是否包含HTML摘要。

generatexml
不推荐使用。

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

例子:
展开wiki文本{{Project:Sandbox}}
api.php?action=expandtemplates&text={{Project:Sandbox}}

action=feedcontributions

  • 此模块需要读取权限。

返回用户贡献纲要。

参数:
feedformat

纲要的格式。

一个值:rss、atom
默认:rss
user

获取哪些用户的贡献。

这个参数是必须的。
namespace

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

一个值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
year

起始年份(及更早)。

month

起始月份(及更早)。

tagfilter

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

值(以|分隔):
默认:(空)
deletedonly

仅显示已删除的贡献。

toponly

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

newonly

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

showsizediff

显示修订版本之间的大小差别。

例子:
返回用户Example的贡献。
api.php?action=feedcontributions&user=Example

action=feedrecentchanges

  • 此模块需要读取权限。

返回最新变更纲要。

参数:
feedformat

纲要的格式。

一个值:rss、atom
默认:rss
namespace

用于限制结果的命名空间。

一个值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
invert

除所选定者外的所有命名空间。

associated

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

days

用于限制结果的天数。

值必须不少于1。
默认:7
limit

所要返回结果的最大数目。

值必须介于1和50之间。
默认:50
from

显示自那时以来的更改。

hideminor

隐藏小更改。

hidebots

隐藏机器人所做的更改。

hideanons

隐藏匿名用户做出的更改。

hideliu

隐藏注册用户做出的更改。

hidepatrolled

隐藏已巡查更改。

hidemyself

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

tagfilter

按标签过滤。

target

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

showlinkedto

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

例子:
显示最近更改
api.php?action=feedrecentchanges
显示最近30天的更改
api.php?action=feedrecentchanges&days=30

action=feedwatchlist

  • 此模块需要读取权限。

返回监视列表纲要。

参数:
feedformat

纲要的格式。

一个值:rss、atom
默认:rss
hours

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

值必须介于1和72之间。
默认:24
linktosections

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

allrev

Include multiple revisions of the same page within given timeframe.

wlowner

Used along with token to access a different user's watchlist.

wltoken

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

wlshow

Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set show=minor|!anon.

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

Which types of changes to show:

edit
Regular page edits.
external
External changes.
new
Page creations.
log
Log entries.
值(以|分隔):edit、external、new、log
默认:edit|new|log
wlexcludeuser

不要列出此用户的更改。

例子:
显示监视列表订阅
api.php?action=feedwatchlist
显示过去6小时内受监视页面的所有更改。
api.php?action=feedwatchlist&allrev=&hours=6

action=filerevert

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

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

参数:
filename

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

这个参数是必须的。
comment

上传评论。

默认:(空)
archivename

恢复到修订版存档名称。

这个参数是必须的。
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=help

main | help

显示指定模块的帮助。

参数:
modules

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

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
默认:main
submodules

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

recursivesubmodules

包括递归子模块的帮助。

wrap

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

toc

在HTML输出中包括目录。

例子:
主模块帮助
api.php?action=help
一个页面中的所有帮助
api.php?action=help&recursivesubmodules=1
帮助模块本身的帮助
api.php?action=help&modules=help
两个查询子模块的帮助
api.php?action=help&modules=query+info|query+categorymembers

action=imagerotate

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

旋转一幅或多幅图像。

参数:
rotation

顺时针旋转图像的度数。

这个参数是必须的。
一个值:90、180、270
continue

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

titles

A list of titles to work on.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
pageids

A list of page IDs to work on.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
revids

A list of revision IDs to work on.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
generator

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

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

一个值:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan、iu、kk、ku、shi、sr、tg、uz、zh.

token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=import

main | import
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

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

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

参数:
summary

导入摘要。

xml

上传的XML文件。

Must be posted as a file upload using 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
rootpage

导入作为此页面的子页面。

token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=login (lg)

main | login
  • 此模块只允许POST请求。

登录并获得身份验证Cookie。

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

参数:
lgname

用户名。

lgpassword

密码。

lgdomain

域名(可选)。

lgtoken

在首个请求中获得的登录令牌。

action=logout

main | logout

退出并清除会话数据。

例子:
退出当前用户
api.php?action=logout

action=managetags

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

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

参数:
operation

要执行哪个操作:

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

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

这个参数是必须的。
reason

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

ignorewarnings

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

token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=move

main | move
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

移动一个页面。

参数:
from

要重命名的页面标题。不能与fromid一起使用。

fromid

您希望移动的页面ID。不能与from一起使用。

to

页面重命名的目标标题。

这个参数是必须的。
reason

重命名的原因。

默认:(空)
movetalk

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

movesubpages

重命名子页面,如果可以。

noredirect

不要创建重定向。

watch
不推荐使用。

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

unwatch
不推荐使用。

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

watchlist

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

一个值:watch、unwatch、preferences、nochange
默认:preferences
ignorewarnings

忽略任何警告。

token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=opensearch

  • 此模块需要读取权限。

使用OpenSearch协议搜索本wiki。

参数:
search

搜索字符串。

limit

要返回的结果最大数。

不允许超过100个(对于机器人则是100个)。
默认:10
namespace

搜索的名字空间。

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
默认:0
suggest

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

redirects

如何处理重定向:

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

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

一个值:return、resolve
format

输出格式。

一个值:json、jsonfm、xml、xmlfm
默认:json
warningsaserror

If warnings are raised with format=json, return an API error instead of ignoring them.

例子:
查找以Te开头的页面。
api.php?action=opensearch&search=Te

action=options

main | options
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

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

只有注册在核心或者已安装扩展中的选项,或者具有"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

使用选项名指定的选项值中,可以包含管道字符

token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=paraminfo

main | paraminfo

获取关于 API 模块的信息。

参数:
modules

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

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
helpformat

帮助字符串的格式。

一个值:html、wikitext、raw、none
默认:none
querymodules
不推荐使用。

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

值(以|分隔):allcategories、alldeletedrevisions、allfileusages、allimages、alllinks、allmessages、allpages、allredirects、alltransclusions、allusers、backlinks、blocks、categories、categoryinfo、categorymembers、contributors、deletedrevisions、deletedrevs、duplicatefiles、embeddedin、extlinks、exturlusage、filearchive、filerepoinfo、fileusage、imageinfo、images、imageusage、info、iwbacklinks、iwlinks、langbacklinks、langlinks、links、linkshere、logevents、pagepropnames、pageprops、pageswithprop、prefixsearch、protectedtitles、querypage、random、recentchanges、redirects、revisions、search、siteinfo、stashimageinfo、tags、templates、tokens、transcludedin、usercontribs、userinfo、users、watchlist、watchlistraw
值的最高数字是50(对于机器人则是500)。
mainmodule
不推荐使用。

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

pagesetmodule
不推荐使用。

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

formatmodules
不推荐使用。

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

值(以|分隔):dbg、dbgfm、dump、dumpfm、json、jsonfm、none、php、phpfm、rawfm、txt、txtfm、wddx、wddxfm、xml、xmlfm、yaml、yamlfm

action=parse

main | parse
  • 此模块需要读取权限。

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

参见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

Which pieces of information to get:

text
Gives the parsed text of the wikitext.
langlinks
Gives the language links in the parsed wikitext.
categories
Gives the categories in the parsed wikitext.
categorieshtml
Gives the HTML version of the categories.
links
Gives the internal links in the parsed wikitext.
templates
Gives the templates in the parsed wikitext.
images
Gives the images in the parsed wikitext.
externallinks
Gives the external links in the parsed wikitext.
sections
Gives the sections in the parsed wikitext.
revid
Adds the revision ID of the parsed page.
displaytitle
Adds the title of the parsed wikitext.
headitems
Gives items to put in the <head> of the page.
headhtml
Gives parsed <head> of the page.
modules
Gives the ResourceLoader modules used on the page.
indicators
Gives the HTML of page status indicators used on the page.
iwlinks
Gives interwiki links in the parsed wikitext.
wikitext
Gives the original wikitext that was parsed.
properties
Gives various properties defined in the parsed wikitext.
limitreportdata
Gives the limit report in a structured way. Gives no data, when disablepp is set.
limitreporthtml
Gives the HTML version of the limit report. Gives no data, when disablepp is set.
值(以|分隔):text、langlinks、categories、categorieshtml、links、templates、images、externallinks、sections、revid、displaytitle、headitems、headhtml、modules、indicators、iwlinks、wikitext、properties、limitreportdata、limitreporthtml
默认:text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties
pst

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

onlypst

Do a pre-save transform (PST) on the input, but don't parse it. Returns the same wikitext, after a PST has been applied. Only valid when used with text.

effectivelanglinks

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

section

只检索此段数的内容,或只当new生成新的段落时检索。

new段落只当指定text时受尊重。

sectiontitle

sectionnew时新段落标题。

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

disablepp

从解析器输出中禁用PP报告。

disableeditsection

从解析器输出中禁用编辑段落链接。

generatexml

生成XML解析树(需要内容模型wikitext)。

preview

在预览模式下解析。

sectionpreview

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

disabletoc

在输出中禁用目录。

contentformat

Content serialization format used for the input text. Only valid when used with text.

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

Content model of the input text. If omitted, title must be specified, and default will be the model of the specified title. Only valid when used with text.

一个值:wikitext、javascript、json、css、text

action=patrol

main | patrol
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

巡查页面或修订版本。

参数:
rcid

所要巡查的最近变更 ID。

revid

要巡查的修订版本ID。

token

action=query&meta=tokens取回的“patrol”令牌

这个参数是必须的。

action=protect

main | protect
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

更改页面的保护等级。

参数:
title

要(解除)保护的页面标题。不能与pageid一起使用。

pageid

要(解除)保护的页面ID。不能与title一起使用。

protections

保护等级列表,格式:action=level(例如edit=sysop)。

注意:未列出的操作将移除限制。

这个参数是必须的。
通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
expiry

到期时间戳。如果只有一个时间戳被设置,它将被用于所有保护。使用infiniteindefiniteinfinitynever用于永不过期的保护。

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
默认:infinite
reason

(解除)保护的原因。

默认:(空)
cascade

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

watch
不推荐使用。

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

watchlist

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

一个值:watch、unwatch、preferences、nochange
默认:preferences
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=purge

main | purge
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

为指定标题刷新缓存。

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

参数:
forcelinkupdate

更新链接表。

forcerecursivelinkupdate

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

continue

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

titles

A list of titles to work on.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
pageids

A list of page IDs to work on.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
revids

A list of revision IDs to work on.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
generator

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

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

一个值:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan、iu、kk、ku、shi、sr、tg、uz、zh.

例子:
刷新Main PageAPI页面。
api.php?action=purge&titles=Main_Page|API
刷新主名字空间的前10个页面
api.php?action=purge&generator=allpages&gapnamespace=0&gaplimit=10

action=query

main | query
  • 此模块需要读取权限。

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

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

参数:
prop

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

值(以|分隔):categoriescategoryinfocontributorsdeletedrevisionsduplicatefilesextlinksfileusageimageinfoimagesinfoiwlinkslanglinkslinkslinksherepagepropsredirectsrevisionsstashimageinfotemplatestranscludedin
list

要获取的列表。

值(以|分隔):allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsalltransclusionsallusersbacklinksblockscategorymembersdeletedrevsembeddedinexturlusagefilearchiveimageusageiwbacklinkslangbacklinkslogeventspagepropnamespageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangessearchtagsusercontribsuserswatchlistwatchlistraw
meta

要获取的元数据。

值(以|分隔):allmessagesfilerepoinfositeinfotokensuserinfo
indexpageids

Include an additional pageids section listing all returned page IDs.

export

Export the current revisions of all given or generated pages.

exportnowrap

Return the export XML without wrapping it in an XML result (same format as Special:Export). Can only be used with export.

iwurl

Whether to get the full URL if the title is an interwiki link.

continue

When present, formats query-continue as key-value pairs that should simply be merged into the original request. This parameter must be set to an empty string in the initial query.

This parameter is recommended for all new development, and will be made default in the next API version.

rawcontinue

目前被忽略。将来continue将成为默认,且这里将需要得到原始的query-continue数据。

titles

A list of titles to work on.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
pageids

A list of page IDs to work on.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
revids

A list of revision IDs to work on.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
generator

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

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

一个值:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan、iu、kk、ku、shi、sr、tg、uz、zh.

prop=categories (cl)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

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

参数:
clprop

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

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

显示何种分类。

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

返回多少分类。

不允许超过500个(对于机器人则是5,000个)。
默认:10
clcontinue

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

clcategories

Only list these categories. Useful for checking whether a certain page is in a certain category.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
cldir

罗列所采用的方向。

一个值:ascending、descending
默认:ascending
例子:
获取属于Albert Einstein的分类列表。
api.php?action=query&prop=categories&titles=Albert%20Einstein
获得有关用于Albert Einstein的分类的信息。
api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info

prop=categoryinfo (ci)

  • 此模块需要读取权限。

返回有关给定分类的信息。

参数:
cicontinue

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

例子:
获取有关Category:FooCategory:Bar的信息。
api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar

prop=contributors (pc)

  • 此模块需要读取权限。

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

参数:
pcgroup

Only include users in the given groups. Does not include implicit or auto-promoted groups like *, user, or autoconfirmed.

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

Exclude users in the given groups. Does not include implicit or auto-promoted groups like *, user, or autoconfirmed.

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

Only include users having the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.

值(以|分隔):apihighlimits、applychangetags、autoconfirmed、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、proxyunbannable、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
值的最高数字是50(对于机器人则是500)。
pcexcluderights

Exclude users having the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.

值(以|分隔):apihighlimits、applychangetags、autoconfirmed、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、proxyunbannable、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
值的最高数字是50(对于机器人则是500)。
pclimit

返回的贡献数。

不允许超过500个(对于机器人则是5,000个)。
默认:10
pccontinue

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

prop=deletedrevisions (drv)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

获得删除修订版本信息。

可在很多途径中使用:

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

Which properties to get for each revision:

ids
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision.
userid
User ID of the revision creator.
size
Length (bytes) of the revision.
sha1
SHA-1 (base 16) of the revision.
contentmodel
Content model ID of the revision.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Text of the revision.
tags
Tags for the revision.
值(以|分隔):ids、flags、timestamp、user、userid、size、sha1、contentmodel、comment、parsedcomment、content、tags
默认:ids|timestamp|flags|comment|user
drvlimit

限制返回多少修订。

不允许超过500个(对于机器人则是5,000个)。
drvexpandtemplates

Expand templates in revision content (requires drvprop=content).

drvgeneratexml

Generate XML parse tree for revision content (requires drvprop=content).

drvparse

Parse revision content (requires drvprop=content). For performance reasons, if this option is used, drvlimit is enforced to 1.

drvsection

Only retrieve the content of this section number.

drvdiffto

Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

drvdifftotext

Text to diff each revision to. Only diffs a limited number of revisions. Overrides drvdiffto. If drvsection is set, only that section will be diffed against this text

drvcontentformat

Serialization format used for drvdifftotext and expected for output of content.

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

The timestamp to start enumerating from. Ignored when processing a list of revision IDs.

drvend

The timestamp to stop enumerating at. Ignored when processing a list of revision IDs.

drvdir

列举的方向:

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

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

drvuser

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

drvexcludeuser

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

drvcontinue

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

例子:
列出页面Main PageTalk:Main Page的已删除修订,包含内容。
api.php?action=query&prop=deletedrevisions&titles=Main%20Page|Talk:Main%20Page&drvprop=user|comment|content
列出已删除修订123456的信息。
api.php?action=query&prop=deletedrevisions&revids=123456

prop=duplicatefiles (df)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

List all files that are duplicates of the given files based on hash values.

参数:
dflimit

返回多少重复文件。

不允许超过500个(对于机器人则是5,000个)。
默认:10
dfcontinue

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

dfdir

罗列所采用的方向。

一个值:ascending、descending
默认:ascending
dflocalonly

只看本地存储库的文件。

main | query | extlinks
  • 此模块需要读取权限。

Returns all external URLs (not interwikis) from the given pages.

参数:
ellimit

返回多少链接。

不允许超过500个(对于机器人则是5,000个)。
默认:10
eloffset

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

elprotocol

Protocol of the URL. If empty and elquery is set, the protocol is http. Leave both this and elquery empty to list all external links.

一个值:可以为空,或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

Search string without protocol. Useful for checking whether a certain page contains a certain external url.

elexpandurl

Expand protocol-relative URLs with the canonical protocol.

例子:
获取首页的外部链接列表。
api.php?action=query&prop=extlinks&titles=Main%20Page

prop=fileusage (fu)

main | query | fileusage
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Find all pages that use the given files.

参数:
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
fushow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
值(以|分隔):redirect、!redirect
fulimit

返回多少。

不允许超过500个(对于机器人则是5,000个)。
默认:10
fucontinue

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

prop=imageinfo (ii)

main | query | imageinfo
  • 此模块需要读取权限。

返回文件信息和上传历史。

参数:
iiprop

要获取的文件信息:

timestamp
添加时间戳至上传的版本。
user
Adds the user who uploaded each file version.
userid
Add the user ID that uploaded each file version.
comment
此版本的摘要。
parsedcomment
Parse the comment on the version.
canonicaltitle
Adds the canonical title of the file.
url
Gives URL to the file and the description page.
size
Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions
大小别名。
sha1
为文件加入SHA-1哈希值。
mime
添加文件的MIME类型。
thumbmime
Adds MIME type of the image thumbnail (requires url and param iiurlwidth).
mediatype
添加文件媒体类型。
metadata
Lists Exif metadata for the version of the file.
commonmetadata
Lists file format generic metadata for the version of the file.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted.
archivename
Adds the filename of the archive version for non-latest versions.
bitdepth
Adds the bit depth of the version.
uploadwarning
Used by the Special:Upload page to get information about an existing file. Not intended for use outside MediaWiki core.
值(以|分隔):timestamp、user、userid、comment、parsedcomment、canonicaltitle、url、size、dimensions、sha1、mime、thumbmime、mediatype、metadata、commonmetadata、extmetadata、archivename、bitdepth、uploadwarning
默认:timestamp|user
iilimit

How many file revisions to return per file.

不允许超过500个(对于机器人则是5,000个)。
默认:1
iistart

开始列举的时间戳。

iiend

列举的结束时间戳。

iiurlwidth

If iiprop=url is set, a URL to an image scaled to this width will be returned. For performance reasons if this option is used, no more than 50 scaled images will be returned.

默认:-1
iiurlheight

与iiurlwidth类似。

默认:-1
iimetadataversion

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

默认:1
iiextmetadatalanguage

What language to fetch extmetadata in. This affects both which translation to fetch, if multiple are available, as well as how things like numbers and various values are formatted.

默认:zh-cn
iiextmetadatamultilang

If translations for extmetadata property are available, fetch all of them.

iiextmetadatafilter

If specified and non-empty, only these keys will be returned for iiprop=extmetadata.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
iiurlparam

A handler specific parameter string. For example, PDFs might use page15-100px. iiurlwidth must be used and be consistent with iiurlparam.

默认:(空)
iicontinue

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

iilocalonly

只看本地存储库的文件。

prop=images (im)

main | query | images
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Returns all files contained on the given pages.

参数:
imlimit

返回多少文件。

不允许超过500个(对于机器人则是5,000个)。
默认:10
imcontinue

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

imimages

Only list these files. Useful for checking whether a certain page has a certain file.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
imdir

罗列所采用的方向。

一个值:ascending、descending
默认:ascending

prop=info (in)

main | query | info
  • 此模块需要读取权限。

获取基本页面信息。

参数:
inprop

要获取的额外属性:

protection
列出每个页面的保护等级。
talkid
The page ID of the talk page for each non-talk page.
watched
列出每个页面的被监视状态。
watchers
监视人员数,如果允许。
notificationtimestamp
The watchlist notification timestamp of each page.
subjectid
The page ID of the parent page for each talk page.
url
Gives a full URL, an edit URL, and the canonical URL for each page.
readable
用户是否可以阅读此页面。
preload
Gives the text returned by EditFormPreloadText.
displaytitle
Gives the way the page title is actually displayed.
值(以|分隔):protection、talkid、watched、watchers、notificationtimestamp、subjectid、url、readable、preload、displaytitle
intestactions

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

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
intoken
不推荐使用。

请改用action=query&meta=tokens

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

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

例子:
获得有关页面Main Page的信息。
api.php?action=query&prop=info&titles=Main%20Page
获取首页相关的常规和保护信息。
api.php?action=query&prop=info&inprop=protection&titles=Main%20Page
main | query | iwlinks
  • 此模块需要读取权限。

从指定页面返回所有跨wiki链接。

参数:
iwprop

Which additional properties to get for each interlanguage link:

url
Adds the full URL.
值(以|分隔):url
iwprefix

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

iwtitle

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

iwdir

罗列所采用的方向。

一个值:ascending、descending
默认:ascending
iwlimit

返回多少跨wiki链接。

不允许超过500个(对于机器人则是5,000个)。
默认:10
iwcontinue

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

iwurl
不推荐使用。

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

例子:
从页面Main Page获得跨wiki链接。
api.php?action=query&prop=iwlinks&titles=Main%20Page
main | query | langlinks
  • 此模块需要读取权限。

从指定页面返回所有跨语言链接。

参数:
llprop

Which additional properties to get for each interlanguage link:

url
Adds the full URL.
langname
Adds the localised language name (best effort). Use llinlanguagecode to control the language.
autonym
Adds the native language name.
值(以|分隔):url、langname、autonym
lllang

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

lltitle

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

lldir

罗列所采用的方向。

一个值:ascending、descending
默认:ascending
llinlanguagecode

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

默认:zh-cn
lllimit

返回多少语言链接。

不允许超过500个(对于机器人则是5,000个)。
默认:10
llcontinue

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

llurl
不推荐使用。

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

例子:
从页面Main Page获得跨语言链接。
api.php?action=query&prop=langlinks&titles=Main%20Page&redirects=
main | query | links
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

从指定页面返回所有链接。

参数:
plnamespace

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

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
pllimit

返回多少链接。

不允许超过500个(对于机器人则是5,000个)。
默认:10
plcontinue

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

pltitles

Only list links to these titles. Useful for checking whether a certain page links to a certain title.

通过“|”隔开各值。 值的最高数字是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 (lh)

main | query | linkshere
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

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

参数:
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
lhshow

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

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

返回多少。

不允许超过500个(对于机器人则是5,000个)。
默认:10
lhcontinue

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

prop=pageprops (pp)

main | query | pageprops
  • 此模块需要读取权限。

Get various properties defined in the page content.

参数:
ppcontinue

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

ppprop

Only list these props. Useful for checking whether a certain page uses a certain page prop.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
例子:
获得用于Category:Foo的属性。
api.php?action=query&prop=pageprops&titles=Category:Foo

prop=redirects (rd)

main | query | redirects
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

返回至指定页面的所有重定向。

参数:
rdprop

Which properties to get:

pageid
Page ID of each redirect.
title
Title of each redirect.
fragment
Fragment of each redirect, if any.
值(以|分隔):pageid、title、fragment
默认:pageid|title
rdnamespace

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

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
rdshow

Show only items that meet these criteria:

fragment
Only show redirects with a fragment.
!fragment
Only show redirects without a fragment.
值(以|分隔):fragment、!fragment
rdlimit

返回多少重定向。

不允许超过500个(对于机器人则是5,000个)。
默认:10
rdcontinue

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

prop=revisions (rv)

main | query | revisions
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Get revision information.

May be used in several ways:

  1. Get data about a set of pages (last revision), by setting titles or pageids.
  2. Get revisions for one given page, by using titles or pageids with start, end, or limit.
  3. Get data about a set of revisions by setting their IDs with revids.
参数:
rvprop

Which properties to get for each revision:

ids
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision.
userid
User ID of the revision creator.
size
Length (bytes) of the revision.
sha1
SHA-1 (base 16) of the revision.
contentmodel
Content model ID of the revision.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Text of the revision.
tags
Tags for the revision.
值(以|分隔):ids、flags、timestamp、user、userid、size、sha1、contentmodel、comment、parsedcomment、content、tags
默认:ids|timestamp|flags|comment|user
rvlimit

限制返回多少修订。

May only be used with a single page (mode #2).
不允许超过500个(对于机器人则是5,000个)。
rvexpandtemplates

Expand templates in revision content (requires rvprop=content).

rvgeneratexml

Generate XML parse tree for revision content (requires rvprop=content).

rvparse

Parse revision content (requires rvprop=content). For performance reasons, if this option is used, rvlimit is enforced to 1.

rvsection

Only retrieve the content of this section number.

rvdiffto

Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

rvdifftotext

Text to diff each revision to. Only diffs a limited number of revisions. Overrides rvdiffto. If rvsection is set, only that section will be diffed against this text

rvcontentformat

Serialization format used for rvdifftotext and expected for output of content.

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

From which revision ID to start enumeration.

May only be used with a single page (mode #2).
rvendid

Stop revision enumeration on this revision ID.

May only be used with a single page (mode #2).
rvstart

From which revision timestamp to start enumeration.

May only be used with a single page (mode #2).
rvend

Enumerate up to this timestamp.

May only be used with a single page (mode #2).
rvdir

列举的方向:

newer
最早的优先。注意:rvstart应早于rvend。
older
最新的优先(默认)。注意:rvstart应晚于rvend。
May only be used with a single page (mode #2).
一个值:newer、older
默认:older
rvuser

Only include revisions made by user.

May only be used with a single page (mode #2).
rvexcludeuser

Exclude revisions made by user.

May only be used with a single page (mode #2).
rvtag

Only list revisions tagged with this tag.

rvtoken
不推荐使用。

Which tokens to obtain for each revision.

值(以|分隔):rollback
rvcontinue

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

prop=stashimageinfo (sii)

  • 此模块需要读取权限。

Returns file information for stashed files.

参数:
siifilekey

Key that identifies a previous upload that was stashed temporarily.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
siisessionkey
不推荐使用。

Alias for siifilekey, for backward compatibility.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
siiprop

要获取的文件信息:

timestamp
添加时间戳至上传的版本。
canonicaltitle
Adds the canonical title of the file.
url
Gives URL to the file and the description page.
size
Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions
大小别名。
sha1
为文件加入SHA-1哈希值。
mime
添加文件的MIME类型。
thumbmime
Adds MIME type of the image thumbnail (requires url and param siiurlwidth).
metadata
Lists Exif metadata for the version of the file.
commonmetadata
Lists file format generic metadata for the version of the file.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted.
bitdepth
Adds the bit depth of the version.
值(以|分隔):timestamp、canonicaltitle、url、size、dimensions、sha1、mime、thumbmime、metadata、commonmetadata、extmetadata、bitdepth
默认:timestamp|url
siiurlwidth

If siiprop=url is set, a URL to an image scaled to this width will be returned. For performance reasons if this option is used, no more than 50 scaled images will be returned.

默认:-1
siiurlheight

与siiurlwidth类似。

默认:-1
siiurlparam

A handler specific parameter string. For example, PDFs might use page15-100px. siiurlwidth must be used and be consistent with siiurlparam.

默认:(空)

prop=templates (tl)

main | query | templates
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Returns all pages transcluded on the given pages.

参数:
tlnamespace

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

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
tllimit

返回多少模板。

不允许超过500个(对于机器人则是5,000个)。
默认: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 (ti)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Find all pages that transclude the given pages.

参数:
tiprop

Which properties to get:

pageid
Page ID of each page.
title
Title of each page.
redirect
Flag if the page is a redirect.
值(以|分隔):pageid、title、redirect
默认:pageid|title|redirect
tinamespace

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

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
tishow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
值(以|分隔):redirect、!redirect
tilimit

返回多少。

不允许超过500个(对于机器人则是5,000个)。
默认:10
ticontinue

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

例子:
获得嵌入Main Page的页面列表。
api.php?action=query&prop=transcludedin&titles=Main%20Page
获得有关嵌入Main Page的页面的信息。
api.php?action=query&generator=transcludedin&titles=Main%20Page&prop=info

list=allcategories (ac)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

枚举所有类别。

参数:
acfrom

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

accontinue

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

acto

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

acprefix

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

acdir

排序方向。

一个值:ascending、descending
默认:ascending
acmin

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

acmax

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

aclimit

要返回多少个类别。

不允许超过500个(对于机器人则是5,000个)。
默认:10
acprop

要获取的属性:

size
在分类中添加页面数。
hidden
标记由__HIDDENCAT__隐藏的分类。
值(以|分隔):size、hidden
默认:(空)
例子:
列出分类及其含有多少页面的信息。
api.php?action=query&list=allcategories&acprop=size
Retrieve info about the category page itself for categories beginning List.
api.php?action=query&generator=allcategories&gacprefix=List&prop=info

list=alldeletedrevisions (adr)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

List all deleted revisions by a user or in a namespace.

参数:
adrprop

Which properties to get for each revision:

ids
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision.
userid
User ID of the revision creator.
size
Length (bytes) of the revision.
sha1
SHA-1 (base 16) of the revision.
contentmodel
Content model ID of the revision.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Text of the revision.
tags
Tags for the revision.
值(以|分隔):ids、flags、timestamp、user、userid、size、sha1、contentmodel、comment、parsedcomment、content、tags
默认:ids|timestamp|flags|comment|user
adrlimit

限制返回多少修订。

不允许超过500个(对于机器人则是5,000个)。
adrexpandtemplates

Expand templates in revision content (requires adrprop=content).

adrgeneratexml

Generate XML parse tree for revision content (requires adrprop=content).

adrparse

Parse revision content (requires adrprop=content). For performance reasons, if this option is used, adrlimit is enforced to 1.

adrsection

Only retrieve the content of this section number.

adrdiffto

Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

adrdifftotext

Text to diff each revision to. Only diffs a limited number of revisions. Overrides adrdiffto. If adrsection is set, only that section will be diffed against this text

adrcontentformat

Serialization format used for adrdifftotext and expected for output of content.

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

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

adrnamespace

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

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
adrstart

枚举的起始时间戳。

只可以与adruser一起使用。
adrend

枚举的结束时间戳。

只可以与adruser一起使用。
adrdir

列举的方向:

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

从此标题开始列出。

不能与adruser一起使用。
adrto

列出至此标题为止。

不能与adruser一起使用。
adrprefix

Search for all page titles that begin with this value.

不能与adruser一起使用。
adrexcludeuser

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

不能与adruser一起使用。
adrtag

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

adrcontinue

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

adrgeneratetitles

When being used as a generator, generate titles rather than revision IDs.

例子:
列出由Example作出的最近50次已删除贡献。
api.php?action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50
列出前50次已删除的主名字空间修订。
api.php?action=query&list=alldeletedrevisions&adrdir=newer&adrlimit=50

list=allfileusages (af)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

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

参数:
afcontinue

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

affrom

文件的标题开始枚举于.

afto

The title of the file to stop enumerating at.

afprefix

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

afunique

Only show distinct file titles. Cannot be used with afprop=ids. When used as a generator, yields target pages instead of source pages.

afprop

要包含的信息束:

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

要返回的总计项目。

不允许超过500个(对于机器人则是5,000个)。
默认:10
afdir

罗列所采用的方向。

一个值:ascending、descending
默认:ascending
例子:
List file titles, including missing ones, with page IDs they are from, starting at B.
api.php?action=query&list=allfileusages&affrom=B&afprop=ids|title
列出唯一性的文件标题
api.php?action=query&list=allfileusages&afunique=&affrom=B
获取所有文件标题,并标记出缺失者
api.php?action=query&generator=allfileusages&gafunique=&gaffrom=B
获取包含这些文件的页面
api.php?action=query&generator=allfileusages&gaffrom=B

list=allimages (ai)

main | query | allimages
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

按顺序枚举所有图像。

参数:
aisort

要作为排序方式的属性。

一个值:name、timestamp
默认:name
aidir

罗列所采用的方向。

一个值:ascending、descending、newer、older
默认:ascending
aifrom

The image title to start enumerating from. Can only be used with aisort=name.

aito

The image title to stop enumerating at. Can only be used with aisort=name.

aicontinue

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

aistart

The timestamp to start enumerating from. Can only be used with aisort=timestamp.

aiend

The timestamp to end enumerating. Can only be used with aisort=timestamp.

aiprop

要获取的文件信息:

timestamp
添加时间戳至上传的版本。
user
Adds the user who uploaded each file version.
userid
Add the user ID that uploaded each file version.
comment
此版本的摘要。
parsedcomment
Parse the comment on the version.
canonicaltitle
Adds the canonical title of the file.
url
Gives URL to the file and the description page.
size
Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions
大小别名。
sha1
为文件加入SHA-1哈希值。
mime
添加文件的MIME类型。
mediatype
添加文件媒体类型。
metadata
Lists Exif metadata for the version of the file.
commonmetadata
Lists file format generic metadata for the version of the file.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted.
bitdepth
Adds the bit depth of the version.
值(以|分隔):timestamp、user、userid、comment、parsedcomment、canonicaltitle、url、size、dimensions、sha1、mime、mediatype、metadata、commonmetadata、extmetadata、bitdepth
默认:timestamp|url
aiprefix

Search for all image titles that begin with this value. Can only be used with aisort=name.

aiminsize

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

aimaxsize

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

aisha1

图像的 SHA1 哈希。覆盖aisha1base36。

aisha1base36

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

aiuser

Only return files uploaded by this user. Can only be used with aisort=timestamp. Cannot be used together with aifilterbots.

aifilterbots

How to filter files uploaded by bots. Can only be used with aisort=timestamp. Cannot be used together with aiuser.

一个值:all、bots、nobots
默认:all
aimime

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

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
ailimit

共计要返回多少图像。

不允许超过500个(对于机器人则是5,000个)。
默认:10
例子:
显示以字母B开始的文件列表。
api.php?action=query&list=allimages&aifrom=B
显示一个最近上传文件的列表,类似Special:NewFiles
api.php?action=query&list=allimages&aiprop=user|timestamp|url&aisort=timestamp&aidir=older
显示带MIME类型image/pngimage/gif的文件列表
api.php?action=query&list=allimages&aimime=image/png|image/gif
显示有关4个以T开头的文件的信息。
api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo
main | query | alllinks
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Enumerate all links that point to a given namespace.

参数:
alcontinue

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

alfrom

The title of the link to start enumerating from.

alto

The title of the link to stop enumerating at.

alprefix

Search for all linked titles that begin with this value.

alunique

Only show distinct linked titles. Cannot be used with alprop=ids. When used as a generator, yields target pages instead of source pages.

alprop

Which pieces of information to include:

ids
Adds the page ID of the linking page (cannot be used with alunique).
title
Adds the title of the link.
值(以|分隔):ids、title
默认:title
alnamespace

要列举的名字空间。

一个值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
默认:0
allimit

总共要返回多少个项目。

不允许超过500个(对于机器人则是5,000个)。
默认:10
aldir

列出方向。

一个值:ascending、descending
默认:ascending
例子:
List linked titles, including missing ones, with page IDs they are from, starting at 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 (ap)

main | query | allpages
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Enumerate all pages sequentially in a given namespace.

参数:
apfrom

The page title to start enumerating from.

apcontinue

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

apto

The page title to stop enumerating at.

apprefix

Search for all page titles that begin with this value.

apnamespace

要列举的名字空间。

一个值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
默认:0
apfilterredir

要列出哪些页面。

一个值:all、redirects、nonredirects
默认:all
apminsize

限于至少这么多字节的页面。

apmaxsize

限于至多这么多字节的页面。

apprtype

仅限于受保护页面。

值(以|分隔):edit、move、upload
apprlevel

Filter protections based on protection level (must be used with apprtype= parameter).

值(以|分隔):可以为空,或autoconfirmed、sysop
apprfiltercascade

Filter protections based on cascadingness (ignored when apprtype isn't set).

一个值:cascading、noncascading、all
默认:all
aplimit

返回的总计页面数。

不允许超过500个(对于机器人则是5,000个)。
默认:10
apdir

The direction in which to list.

一个值:ascending、descending
默认:ascending
apfilterlanglinks

Filter based on whether a page has langlinks. Note that this may not consider langlinks added by extensions.

一个值:withlanglinks、withoutlanglinks、all
默认:all
apprexpiry

Which protection expiry to filter the page on:

indefinite
Get only pages with indefinite protection expiry.
definite
Get only pages with a definite (specific) protection expiry.
all
Get pages with any protections expiry.
一个值:indefinite、definite、all
默认:all
例子:
显示以字母B开头的页面的列表。
api.php?action=query&list=allpages&apfrom=B
显示有关4个以字母T开头的页面的信息。
api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info
显示前2个以Re开头的非重定向页面的内容。
api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content

list=allredirects (ar)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

列出至一个名字空间的重定向。

参数:
arcontinue

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

arfrom

The title of the redirect to start enumerating from.

arto

The title of the redirect to stop enumerating at.

arprefix

Search for all target pages that begin with this value.

arunique

Only show distinct target pages. Cannot be used with arprop=ids|fragment|interwiki. When used as a generator, yields target pages instead of source pages.

arprop

Which pieces of information to include:

ids
Adds the page ID of the redirecting page (cannot be used with arunique).
title
Adds the title of the redirect.
fragment
Adds the fragment from the redirect, if any (cannot be used with arunique).
interwiki
Adds the interwiki prefix from the redirect, if any (cannot be used with arunique).
值(以|分隔):ids、title、fragment、interwiki
默认:title
arnamespace

要列举的名字空间。

一个值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
默认:0
arlimit

返回的总计项目数。

不允许超过500个(对于机器人则是5,000个)。
默认:10
ardir

罗列所采用的方向。

一个值:ascending、descending
默认:ascending
例子:
List target pages, including missing ones, with page IDs they are from, starting at B.
api.php?action=query&list=allredirects&arfrom=B&arprop=ids|title
列出孤立目标页面
api.php?action=query&list=allredirects&arunique=&arfrom=B
获得所有目标页面,标记丢失的
api.php?action=query&generator=allredirects&garunique=&garfrom=B
获得包含重定向的页面
api.php?action=query&generator=allredirects&garfrom=B

list=alltransclusions (at)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。

参数:
atcontinue

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

atfrom

The title of the transclusion to start enumerating from.

atto

The title of the transclusion to stop enumerating at.

atprefix

Search for all transcluded titles that begin with this value.

atunique

Only show distinct transcluded titles. Cannot be used with atprop=ids. When used as a generator, yields target pages instead of source pages.

atprop

Which pieces of information to include:

ids
Adds the page ID of the transcluding page (cannot be used with atunique).
title
Adds the title of the transclusion.
值(以|分隔):ids、title
默认:title
atnamespace

要列举的名字空间。

一个值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
默认:10
atlimit

要返回的总计项目。

不允许超过500个(对于机器人则是5,000个)。
默认:10
atdir

罗列所采用的方向。

一个值:ascending、descending
默认:ascending
例子:
List transcluded titles, including missing ones, with page IDs they are from, starting at B.
api.php?action=query&list=alltransclusions&atfrom=B&atprop=ids|title
列出孤立嵌入标题
api.php?action=query&list=alltransclusions&atunique=&atfrom=B
Gets all transcluded titles, marking the missing ones.
api.php?action=query&generator=alltransclusions&gatunique=&gatfrom=B
获得包含嵌入内容的页面。
api.php?action=query&generator=alltransclusions&gatfrom=B

list=allusers (au)

main | query | allusers
  • 此模块需要读取权限。

列举所有注册用户。

参数:
aufrom

枚举的起始用户名。

auto

枚举的结束用户名。

auprefix

搜索以此值开始的所有用户。

audir

排序方向。

一个值:ascending、descending
默认:ascending
augroup

只包含指定组中的用户。

值(以|分隔):bot、sysop、bureaucrat
auexcludegroup

排除指定组中的用户。

值(以|分隔):bot、sysop、bureaucrat
aurights

仅列出有所选权限的用户。不包括隐性的或自动加入的用户组别(如*、用户或自动确认用户)所授予的权限。

值(以|分隔):apihighlimits、applychangetags、autoconfirmed、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、proxyunbannable、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
值的最高数字是50(对于机器人则是500)。
auprop

Which pieces of information to include:

blockinfo
Adds the information about a current block on the user.
groups
Lists groups that the user is in. This uses more server resources and may return fewer results than the limit.
implicitgroups
Lists all the groups the user is automatically in.
rights
Lists rights that the user has.
editcount
Adds the edit count of the user.
registration
Adds the timestamp of when the user registered if available (may be blank).
值(以|分隔):blockinfo、groups、implicitgroups、rights、editcount、registration
aulimit

返回的总计用户数。

不允许超过500个(对于机器人则是5,000个)。
默认:10
auwitheditsonly

只列出有编辑的用户。

auactiveusers

只列出最近30天内活跃的用户。

例子:
列出以Y开头的用户。
api.php?action=query&list=allusers&aufrom=Y
main | query | backlinks
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

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

参数:
bltitle

要搜索的标题。不能与blpageid一起使用。

blpageid

要搜索的页面ID。不能与bltitle一起使用。

blcontinue

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

blnamespace

要列举的名字空间。

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
bldir

罗列所采用的方向。

一个值:ascending、descending
默认:ascending
blfilterredir

How to filter for redirects. If set to nonredirects when blredirect is enabled, this is only applied to the second level.

一个值:all、redirects、nonredirects
默认:all
bllimit

返回总计页面数。如果blredirect被启用,则限定分别适用于每一等级(这意味着将返回多达2 * bllimit个结果)。

不允许超过500个(对于机器人则是5,000个)。
默认:10
blredirect

If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.

例子:
显示至Main page的链接。
api.php?action=query&list=backlinks&bltitle=Main%20Page
获得关于链接至Main page的页面的信息。
api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info

list=blocks (bk)

main | query | blocks
  • 此模块需要读取权限。

列出所有被封禁的用户和IP地址。

参数:
bkstart

The timestamp to start enumerating from.

bkend

The timestamp to stop enumerating at.

bkdir

列举的方向:

newer
最早的优先。注意:bkstart应早于bkend。
older
最新的优先(默认)。注意:bkstart应晚于bkend。
一个值:newer、older
默认:older
bkids

要列出的封禁ID列表(可选)。

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
bkusers

要搜索的用户列表(可选)。

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
bkip

Get all blocks applying to this IP or CIDR range, including range blocks. Cannot be used together with bkusers. CIDR ranges broader than IPv4/16 or IPv6/19 are not accepted.

bklimit

The maximum number of blocks to list.

不允许超过500个(对于机器人则是5,000个)。
默认: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

Show only items that meet these criteria. For example, to see only indefinite blocks on IP addresses, set bkshow=ip|!temp.

值(以|分隔):account、!account、temp、!temp、ip、!ip、range、!range
bkcontinue

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

例子:
封禁列表
api.php?action=query&list=blocks
列出用户AliceBob的封禁。
api.php?action=query&list=blocks&bkusers=Alice|Bob

list=categorymembers (cm)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

在指定的分类中列出所有页面。

参数:
cmtitle

要列举的分类(必需)。必须包括分类:前缀。不能与cmpageid一起使用。

cmpageid

要枚举的分类的页面 ID。不能与cmtitle一起使用。

cmprop

Which pieces of information to include:

ids
Adds the page ID.
title
Adds the title and namespace ID of the page.
sortkey
Adds the sortkey used for sorting in the category (hexadecimal string).
sortkeyprefix
Adds the sortkey prefix used for sorting in the category (human-readable part of the sortkey).
type
Adds the type that the page has been categorised as (page, subcat or file).
timestamp
Adds the timestamp of when the page was included.
值(以|分隔):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
cmtype

包含的分类成员类型。当cmsort=timestamp被设置时会忽略。

值(以|分隔):page、subcat、file
默认:page|subcat|file
cmcontinue

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

cmlimit

返回页面的最大数量。

不允许超过500个(对于机器人则是5,000个)。
默认: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

Sortkey prefix to start listing from. Can only be used with cmsort=sortkey. Overrides cmstarthexsortkey.

cmendsortkeyprefix

Sortkey prefix to end listing BEFORE (not at, if this value occurs it will not be included!). Can only be used with cmsort=sortkey. Overrides cmendhexsortkey.

cmstartsortkey
不推荐使用。

请改用cmstarthexsortkey。

cmendsortkey
不推荐使用。

请改用cmendhexsortkey。

例子:
获得Category:Physics中的前10个页面。
api.php?action=query&list=categorymembers&cmtitle=Category:Physics
获得有关Category:Physics中的前10个页面的页面信息。
api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info

list=deletedrevs (dr)

  • 此模块已弃用。
  • 此模块需要读取权限。

List deleted revisions.

Operates in three modes:

  1. List deleted revisions for the given titles, sorted by timestamp.
  2. List deleted contributions for the given user, sorted by timestamp (no titles specified).
  3. List all deleted revisions in the given namespace, sorted by title and timestamp (no titles specified, druser not set).

Certain parameters only apply to some modes and are ignored in others.

参数:
drstart

The timestamp to start enumerating from.

模式:1、2
drend

The timestamp to stop enumerating at.

模式:1、2
drdir

列举的方向:

newer
最早的优先。注意:drstart应早于drend。
older
最新的优先(默认)。注意:drstart应晚于drend。
模式:1、3
一个值:newer、older
默认:older
drfrom

从此标题开始列出。

模式:3
drto

列出至此标题为止。

模式:3
drprefix

Search for all page titles that begin with this value.

模式:3
drunique

List only one revision for each page.

模式:3
drnamespace

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

模式:3
一个值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
默认:0
drtag

Only list revisions tagged with this tag.

druser

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

drexcludeuser

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

drprop

Which properties to get:

revid
Adds the revision ID of the deleted revision.
parentid
Adds the revision ID of the previous revision to the page.
user
Adds the user who made the revision.
userid
Adds the user ID whom made the revision.
comment
Adds the comment of the revision.
parsedcomment
Adds the parsed comment of the revision.
minor
Tags if the revision is minor.
len
Adds the length (bytes) of the revision.
sha1
Adds the SHA-1 (base 16) of the revision.
content
Adds the content of the revision.
token
Deprecated. Gives the edit token.
tags
Tags for the revision.
值(以|分隔):revid、parentid、user、userid、comment、parsedcomment、minor、len、sha1、content、token、tags
默认:user|comment
drlimit

The maximum amount of revisions to list.

不允许超过500个(对于机器人则是5,000个)。
默认: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 (ei)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Find all pages that embed (transclude) the given title.

参数:
eititle

要搜索的标题。不能与eipageid一起使用。

eipageid

要搜索的页面ID。不能与eititle一起使用。

eicontinue

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

einamespace

列举的名字空间。

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
eidir

罗列所采用的方向。

一个值:ascending、descending
默认:ascending
eifilterredir

如何过滤重定向。

一个值:all、redirects、nonredirects
默认:all
eilimit

返回的总计页面数。

不允许超过500个(对于机器人则是5,000个)。
默认:10
例子:
显示嵌入Template:Stub的页面。
api.php?action=query&list=embeddedin&eititle=Template:Stub
获得有关显示嵌入Template:Stub的页面的信息。
api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info

list=exturlusage (eu)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Enumerate pages that contain a given URL.

参数:
euprop

Which pieces of information to include:

ids
Adds the ID of page.
title
Adds the title and namespace ID of the page.
url
Adds the URL used in the page.
值(以|分隔):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
eulimit

返回多少页面。

不允许超过500个(对于机器人则是5,000个)。
默认:10
euexpandurl

Expand protocol-relative URLs with the canonical protocol.

list=filearchive (fa)

  • 此模块需要读取权限。

Enumerate all deleted files sequentially.

参数:
fafrom

枚举的起始图片标题。

fato

枚举的结束图片标题。

faprefix

搜索所有以此值开头的图像标题。

fadir

罗列所采用的方向。

一个值:ascending、descending
默认:ascending
fasha1

图片的SHA1哈希值。覆盖fasha1base36。

fasha1base36

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

faprop

Which image information to get:

sha1
Adds SHA-1 hash for the image.
timestamp
Adds timestamp for the uploaded version.
user
Adds user who uploaded the image version.
size
Adds the size of the image in bytes and the height, width and page count (if applicable).
dimensions
Alias for size.
description
Adds description the image version.
parseddescription
Parse the description on the version.
mime
Adds MIME of the image.
mediatype
Adds the media type of the image.
metadata
Lists Exif metadata for the version of the image.
bitdepth
Adds the bit depth of the version.
archivename
Adds the filename of the archive version for non-latest versions.
值(以|分隔):sha1、timestamp、user、size、dimensions、description、parseddescription、mime、mediatype、metadata、bitdepth、archivename
默认:timestamp
falimit

返回图像的总数。

不允许超过500个(对于机器人则是5,000个)。
默认:10
facontinue

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

例子:
显示已删除文件列表
api.php?action=query&list=filearchive

list=imageusage (iu)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

查找所有使用指定图片标题的页面。

参数:
iutitle

要搜索的标题。不能与iupageid一起使用。

iupageid

要搜索的页面ID。不能与iutitle一起使用。

iucontinue

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

iunamespace

要列举的名字空间。

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
iudir

罗列所采用的方向。

一个值:ascending、descending
默认:ascending
iufilterredir

How to filter for redirects. If set to nonredirects when iuredirect is enabled, this is only applied to the second level.

一个值:all、redirects、nonredirects
默认:all
iulimit

How many total pages to return. If iuredirect is enabled, the limit applies to each level separately (which means up to 2 * iulimit results may be returned).

不允许超过500个(对于机器人则是5,000个)。
默认:10
iuredirect

If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Find all pages that link to the given interwiki link.

Can be used to find all links with a prefix, or all links to a title (with a given prefix). Using neither parameter is effectively "all interwiki links".

参数:
iwblprefix

跨维基前缀。

iwbltitle

要搜索的跨wiki链接。必须与iwblblprefix一起使用。

iwblcontinue

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

iwbllimit

返回的总计页面数。

不允许超过500个(对于机器人则是5,000个)。
默认:10
iwblprop

要获取的属性:

iwprefix
加入跨wiki前缀。
iwtitle
加入跨wiki标题。
值(以|分隔):iwprefix、iwtitle
默认:(空)
iwbldir

罗列所采用的方向。

一个值:ascending、descending
默认:ascending
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Find all pages that link to the given language link.

Can be used to find all links with a language code, or all links to a title (with a given language). Using neither parameter is effectively "all language links".

Note that this may not consider language links added by extensions.

参数:
lbllang

用于语言链接的语言。

lbltitle

要搜索的语言链接。必须与lbllang一起使用。

lblcontinue

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

lbllimit

返回的总计页面数。

不允许超过500个(对于机器人则是5,000个)。
默认:10
lblprop

要获得的属性:

lllang
添加语言链接的语言代码。
lltitle
添加语言链接的标题。
值(以|分隔):lllang、lltitle
默认:(空)
lbldir

罗列所采用的方向。

一个值:ascending、descending
默认:ascending

list=logevents (le)

main | query | logevents
  • 此模块需要读取权限。

从日志获取事件。

参数:
leprop

Which properties to get:

ids
Adds the ID of the log event.
title
Adds the title of the page for the log event.
type
Adds the type of log event.
user
Adds the user responsible for the log event.
userid
Adds the user ID who was responsible for the log event.
timestamp
Adds the timestamp for the event.
comment
Adds the comment of the event.
parsedcomment
Adds the parsed comment of the event.
details
Lists additional details about the event.
tags
Lists tags for the event.
值(以|分隔):ids、title、type、user、userid、timestamp、comment、parsedcomment、details、tags
默认:ids|title|type|user|timestamp|comment|details
letype

Filter log entries to only this type.

一个值:可以为空,或block、protect、rights、delete、upload、move、import、patrol、merge、suppress、tag、managetags、newusers
leaction

Filter log actions to only this action. Overrides letype. Wildcard actions like action/* allows to specify any string for the asterisk.

一个值:protect/protect、protect/modify、protect/unprotect、protect/move_prot、move/move、move/move_redir、delete/delete、delete/restore、delete/revision、delete/event、suppress/revision、suppress/event、suppress/delete、patrol/patrol、rights/rights、rights/autopromote、upload/upload、upload/overwrite、upload/revert、merge/merge、tag/update、managetags/create、managetags/delete、managetags/activate、managetags/deactivate、block/block、block/unblock、block/reblock、suppress/block、suppress/reblock、import/upload、import/interwiki、newusers/newusers、newusers/create、newusers/create2、newusers/byemail、newusers/autocreate
lestart

枚举的起始时间戳。

leend

枚举的结束时间戳。

ledir

列举的方向:

newer
最早的优先。注意:lestart应早于leend。
older
最新的优先(默认)。注意:lestart应晚于leend。
一个值:newer、older
默认:older
leuser

Filter entries to those made by the given user.

letitle

Filter entries to those related to a page.

lenamespace

Filter entries to those in the given namespace.

一个值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
leprefix

Filter entries that start with this prefix.

letag

Only list event entries tagged with this tag.

lelimit

How many total event entries to return.

不允许超过500个(对于机器人则是5,000个)。
默认:10
lecontinue

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

例子:
列出最近日志活动
api.php?action=query&list=logevents

list=pagepropnames (ppn)

  • 此模块需要读取权限。

列出wiki中所有使用中的页面属性名称。

参数:
ppncontinue

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

ppnlimit

返回名称的最大数量。

不允许超过500个(对于机器人则是5,000个)。
默认:10
例子:
获取前10个属性名称。
api.php?action=query&list=pagepropnames

list=pageswithprop (pwp)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

列出所有使用指定页面属性的页面。

参数:
pwppropname

Page prop for which to enumerate pages.

这个参数是必须的。
pwpprop

Which pieces of information to include:

ids
Adds the page ID.
title
Adds the title and namespace ID of the page.
value
Adds the value of the page prop.
值(以|分隔):ids、title、value
默认:ids|title
pwpcontinue

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

pwplimit

返回页面的最大数量。

不允许超过500个(对于机器人则是5,000个)。
默认:10
pwpdir

排序的方向。

一个值:ascending、descending
默认:ascending
例子:
列出前10个使用{{DISPLAYTITLE:}}的页面。
api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value
获取有关前10个使用__NOTOC__的页面的信息。
api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info

list=prefixsearch (ps)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Perform a prefix search for page titles.

参数:
pssearch

搜索字符串。

这个参数是必须的。
psnamespace

搜索的名字空间。

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
默认:0
pslimit

要返回的结果最大数。

不允许超过100个(对于机器人则是200个)。
默认:10
psoffset

跳过的结果数。

默认:0
例子:
搜索以meaning开头的页面标题。
api.php?action=query&list=prefixsearch&pssearch=meaning

list=protectedtitles (pt)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

List all titles protected from creation.

参数:
ptnamespace

只列出这些名字空间的标题。

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
ptlevel

Only list titles with these protection levels.

值(以|分隔):autoconfirmed、sysop
ptlimit

返回的总计页面数。

不允许超过500个(对于机器人则是5,000个)。
默认:10
ptdir

列举的方向:

newer
最早的优先。注意:ptstart应早于ptend。
older
最新的优先(默认)。注意:ptstart应晚于ptend。
一个值:newer、older
默认:older
ptstart

Start listing at this protection timestamp.

ptend

Stop listing at this protection timestamp.

ptprop

Which properties to get:

timestamp
Adds the timestamp of when protection was added.
user
Adds the user that added the protection.
userid
Adds the user ID that added the protection.
comment
Adds the comment for the protection.
parsedcomment
Adds the parsed comment for the protection.
expiry
Adds the timestamp of when the protection will be lifted.
level
Adds the protection level.
值(以|分隔):timestamp、user、userid、comment、parsedcomment、expiry、level
默认:timestamp|level
ptcontinue

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

例子:
受保护标题列表
api.php?action=query&list=protectedtitles
找到主命名空间中已保护的标题的链接。
api.php?action=query&generator=protectedtitles&gptnamespace=0&prop=linkshere

list=querypage (qp)

main | query | querypage
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Get a list provided by a QueryPage-based special page.

参数:
qppage

The name of the special page. Note, this is case sensitive.

这个参数是必须的。
一个值: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
qpoffset

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

默认:0
qplimit

返回的结果数。

不允许超过500个(对于机器人则是5,000个)。
默认:10

list=random (rn)

main | query | random
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Get a set of random pages.

Pages are listed in a fixed sequence, only the starting point is random. This means that if, for example, Main Page is the first random page in the list, List of fictional monkeys will always be second, List of people on stamps of Vanuatu third, etc.

If the number of pages in the namespace is lower than rnlimit, fewer pages will be returned. The same page will not be returned twice.

参数:
rnnamespace

只返回这些名字空间的页面。

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
rnlimit

限制返回多少随机页面。

不允许超过10个(对于机器人则是20个)。
默认:1
rnredirect

加载一个随机重定向而不是一个随机页面。

例子:
从主名字空间返回两个随机页面。
api.php?action=query&list=random&rnnamespace=0&rnlimit=2
Return page info about two random pages from the main namespace.
api.php?action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info

list=recentchanges (rc)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

枚举最近更改。

参数:
rcstart

枚举的起始时间戳。

rcend

枚举的结束时间戳。

rcdir

列举的方向:

newer
最早的优先。注意:rcstart应早于rcend。
older
最新的优先(默认)。注意:rcstart应晚于rcend。
一个值:newer、older
默认:older
rcnamespace

Filter changes to only these namespaces.

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
rcuser

只列出此用户的更改。

rcexcludeuser

不要列出此用户的更改。

rctag

只列出带此标签的更改。

rcprop

Include additional pieces of information:

user
Adds the user responsible for the edit and tags if they are an IP.
userid
Adds the user ID responsible for the edit.
comment
Adds the comment for the edit.
parsedcomment
Adds the parsed comment for the edit.
flags
Adds flags for the edit.
timestamp
Adds timestamp of the edit.
title
Adds the page title of the edit.
ids
Adds the page ID, recent changes ID and the new and old revision ID.
sizes
Adds the new and old page length in bytes.
redirect
Tags edit if page is a redirect.
patrolled
Tags patrollable edits as being patrolled or unpatrolled.
loginfo
Adds log information (log ID, log type, etc) to log entries.
tags
Lists tags for the entry.
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

Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set rcshow=minor|!anon.

值(以|分隔):minor、!minor、bot、!bot、anon、!anon、redirect、!redirect、patrolled、!patrolled、unpatrolled
rclimit

返回总计更新数。

不允许超过500个(对于机器人则是5,000个)。
默认:10
rctype

显示的更改类型。

值(以|分隔):edit、external、new、log
默认:edit|new|log
rctoponly

Only list changes which are the latest revision.

rccontinue

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

list=search (sr)

main | query | search
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Perform a full text search.

参数:
srsearch

搜索所有拥有此值的页面标题(或内容)。

这个参数是必须的。
srnamespace

只在这些名字空间搜索。

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
默认:0
srwhat

Which type of search to perform.

一个值:title、text、nearmatch
srinfo

要返回的元数据。

值(以|分隔):totalhits、suggestion
默认:totalhits|suggestion
srprop

Which properties to return:

size
Adds the size of the page in bytes.
wordcount
Adds the word count of the page.
timestamp
Adds the timestamp of when the page was last edited.
snippet
Adds a parsed snippet of the page.
titlesnippet
Adds a parsed snippet of the page title.
redirectsnippet
Adds a parsed snippet of the redirect title.
redirecttitle
Adds the title of the matching redirect.
sectionsnippet
Adds a parsed snippet of the matching section title.
sectiontitle
Adds the title of the matching section.
score
Deprecated and ignored.
hasrelated
Deprecated and ignored.
值(以|分隔):size、wordcount、timestamp、score、snippet、titlesnippet、redirecttitle、redirectsnippet、sectiontitle、sectionsnippet、hasrelated
默认:size|wordcount|timestamp|snippet
sroffset

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

默认:0
srlimit

返回的总计页面数。

不允许超过50个(对于机器人则是500个)。
默认:10
srinterwiki

搜索结果中包含跨wiki结果,如果可用。

list=tags (tg)

main | query | tags
  • 此模块需要读取权限。

列出更改标签。

参数:
tgcontinue

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

tglimit

列出标签的最大数量。

不允许超过500个(对于机器人则是5,000个)。
默认:10
tgprop

要获取哪个属性:

name
添加标签名称。
displayname
为标签添加系统消息。
description
为标签添加描述。
hitcount
已添加此标签的修订版本与日志数量。
defined
标识标签是否已定义。
source
获得标签来源,它可能包括用于扩展定义的标签的extension,以及用于可被用户手动应用的标签的manual
active
标签是否仍可被应用。
值(以|分隔):name、displayname、description、hitcount、defined、source、active
默认:name

list=usercontribs (uc)

  • 此模块需要读取权限。

获取一位用户的所有编辑。

参数:
uclimit

返回贡献的最大数量。

不允许超过500个(对于机器人则是5,000个)。
默认:10
ucstart

返回的起始时间戳。

ucend

返回的最终时间戳。

uccontinue

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

ucuser

The users to retrieve contributions for.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
ucuserprefix

Retrieve contributions for all users whose names begin with this value. Overrides 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
ucprop

Include additional pieces of information:

ids
Adds the page ID and revision ID.
title
Adds the title and namespace ID of the page.
timestamp
Adds the timestamp of the edit.
comment
Adds the comment of the edit.
parsedcomment
Adds the parsed comment of the edit.
size
Adds the new size of the edit.
sizediff
Adds the size delta of the edit against its parent.
flags
Adds flags of the edit.
patrolled
Tags patrolled edits.
tags
Lists tags for the edit.
值(以|分隔):ids、title、timestamp、comment、parsedcomment、size、sizediff、flags、patrolled、tags
默认:ids|title|timestamp|comment|size|flags
ucshow

Show only items that meet these criteria, e.g. non minor edits only: ucshow=!minor.

If ucshow=patrolled or ucshow=!patrolled is set, revisions older than $wgRCMaxAge (7776000 seconds) won't be shown.

值(以|分隔):minor、!minor、patrolled、!patrolled、top、!top、new、!new
uctag

Only list revisions tagged with this tag.

uctoponly
不推荐使用。

Only list changes which are the latest revision.

例子:
显示用户Example的贡献。
api.php?action=query&list=usercontribs&ucuser=Example
显示来自192.0.2.前缀所有 IP 地址的贡献。
api.php?action=query&list=usercontribs&ucuserprefix=192.0.2.

list=users (us)

main | query | users
  • 此模块需要读取权限。

获取有关列出用户的信息。

参数:
usprop

Which pieces of information to include:

blockinfo
Tags if the user is blocked, by whom, and for what reason.
groups
Lists all the groups each user belongs to.
implicitgroups
Lists all the groups a user is automatically a member of.
rights
Lists all the rights each user has.
editcount
Adds the user's edit count.
registration
Adds the user's registration timestamp.
emailable
Tags if the user can and wants to receive email through Special:Emailuser.
gender
Tags the gender of the user. Returns "male", "female", or "unknown".
值(以|分隔):blockinfo、groups、implicitgroups、rights、editcount、registration、emailable、gender
ususers

A list of users to obtain information for.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
ustoken
不推荐使用。

请改用action=query&meta=tokens

值(以|分隔):userrights

list=watchlist (wl)

main | query | watchlist
  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

Get recent changes to pages in the current user's watchlist.

参数:
wlallrev

Include multiple revisions of the same page within given timeframe.

wlstart

枚举的起始时间戳。

wlend

枚举的结束时间戳。

wlnamespace

Filter changes to only the given namespaces.

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
wluser

只列出此用户的更改。

wlexcludeuser

不要列出此用户的更改。

wldir

列举的方向:

newer
最早的优先。注意:wlstart应早于wlend。
older
最新的优先(默认)。注意:wlstart应晚于wlend。
一个值:newer、older
默认:older
wllimit

根据结果返回的结果总数。

不允许超过500个(对于机器人则是5,000个)。
默认:10
wlprop

Which additional items to get:

ids
Adds revision IDs and page IDs.
title
Adds title of the page.
flags
Adds flags for the edit.
user
Adds the user who made the edit.
userid
Adds user ID of whom made the edit.
comment
Adds comment of the edit.
parsedcomment
Adds parsed comment of the edit.
timestamp
Adds timestamp of the edit.
patrol
Tags edits that are patrolled.
sizes
Adds the old and new lengths of the page.
notificationtimestamp
Adds timestamp of when the user was last notified about the edit.
loginfo
Adds log information where appropriate.
值(以|分隔):ids、title、flags、user、userid、comment、parsedcomment、timestamp、patrol、sizes、notificationtimestamp、loginfo
默认:ids|title|flags
wlshow

Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set wlshow=minor|!anon.

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

Which types of changes to show:

edit
Regular page edits.
external
External changes.
new
Page creations.
log
Log entries.
值(以|分隔):edit、external、new、log
默认:edit|new|log
wlowner

Used along with wltoken to access a different user's watchlist.

wltoken

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

wlcontinue

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

例子:
List the top revision for recently changed pages on the current user's watchlist.
api.php?action=query&list=watchlist
Fetch additional information about the top revision for recently changed pages on the current user's watchlist.
api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment
Fetch information about all recent changes to pages on the current user's watchlist.
api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment
在当前用户的监视列表中检索用于最近更改页面的页面信息。
api.php?action=query&generator=watchlist&prop=info
Fetch revision info for recent changes to pages on the current user's watchlist.
api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user
List the top revision for recently changed pages on the watchlist of user Example.
api.php?action=query&list=watchlist&wlowner=Example&wltoken=123ABC

list=watchlistraw (wr)

  • 此模块需要读取权限。
  • 此模块可作为发生器使用。

获得当前用户的监视列表上的所有页面。

参数:
wrcontinue

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

wrnamespace

只列出指定名字空间的页面。

值(以|分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
wrlimit

根据结果返回的结果总数。

不允许超过500个(对于机器人则是5,000个)。
默认:10
wrprop

Which additional properties to get:

changed
Adds timestamp of when the user was last notified about the edit.
值(以|分隔):changed
wrshow

Only list items that meet these criteria.

值(以|分隔):changed、!changed
wrowner

Used along with wrtoken to access a different user's watchlist.

wrtoken

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

wrdir

列举的方向:

newer
最早的优先。注意:wrstart应早于wrend。
older
最新的优先(默认)。注意:wrstart应晚于wrend。
一个值:ascending、descending
默认:ascending
例子:
列出当前用户的监视列表中的页面。
api.php?action=query&list=watchlistraw
Fetch page info for pages on the current user's watchlist.
api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=info

meta=allmessages (am)

  • 此模块需要读取权限。

返回来自该网站的消息。

参数:
ammessages

要输出的消息。*(默认)表示所有消息。

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
默认:*
amprop

要获取的属性。

值(以|分隔):default
amenableparser

Set to enable parser, will preprocess the wikitext of message (substitute magic words, handle templates, etc.).

amnocontent

If set, do not include the content of the messages in the output.

amincludelocal

Also include local messages, i.e. messages that don't exist in the software but do exist as a MediaWiki: page. This lists all MediaWiki: pages, so it will also list those that aren't really messages such as Common.js.

amargs

Arguments to be substituted into message.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
amfilter

Return only messages with names that contain this string.

amcustomised

只返回在此定制情形下的消息。

一个值:all、modified、unmodified
默认:all
amlang

返回这种语言的信息。

amfrom

从此消息开始返回消息。

amto

返回消息至此消息为止。

amtitle

Page name to use as context when parsing message (for amenableparser option).

amprefix

返回带有该前缀的消息。

例子:
显示以ipb-开始的消息。
api.php?action=query&meta=allmessages&amprefix=ipb-
显示德语版的augustmainpage消息。
api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de

meta=filerepoinfo (fri)

  • 此模块需要读取权限。

Return meta information about image repositories configured on the wiki.

参数:
friprop

Which repository properties to get (there may be more available on some wikis):

apiurl
URL to the repository API - helpful for getting image info from the host.
name
The key of the repository - used in e.g. $wgForeignFileRepos and imageinfo return values.
displayname
The human-readable name of the repository wiki.
rooturl
Root URL for image paths.
local
Whether that repository is the local one or not.
值(以|分隔):name、displayname、rootUrl、local、url、thumbUrl、initialCapital、scriptDirUrl、fetchDescription、descriptionCacheExpiry、apiurl、scriptExtension、favicon
默认:name|displayname|rootUrl|local|url|thumbUrl|initialCapital|scriptDirUrl|fetchDescription|descriptionCacheExpiry|apiurl|scriptExtension|favicon
例子:
获得有关文件存储库的信息。
api.php?action=query&meta=filerepoinfo&friprop=apiurl|name|displayname

meta=siteinfo (si)

main | query | siteinfo
  • 此模块需要读取权限。

Return general information about the site.

参数:
siprop

Which information to get:

general
Overall system information.
namespaces
List of registered namespaces and their canonical names.
namespacealiases
List of registered namespace aliases.
specialpagealiases
List of special page aliases.
magicwords
List of magic words and their aliases.
statistics
Returns site statistics.
interwikimap
Returns interwiki map (optionally filtered, optionally localised by using siinlanguagecode).
dbrepllag
Returns database server with the highest replication lag.
usergroups
Returns user groups and the associated permissions.
libraries
Returns libraries installed on the wiki.
extensions
Returns extensions installed on the wiki.
fileextensions
Returns list of file extensions allowed to be uploaded.
rightsinfo
Returns wiki rights (license) information if available.
restrictions
Returns information on available restriction (protection) types.
languages
Returns a list of languages MediaWiki supports (optionally localised by using siinlanguagecode).
skins
Returns a list of all enabled skins (optionally localised by using siinlanguagecode, otherwise in the content language).
extensiontags
Returns a list of parser extension tags.
functionhooks
Returns a list of parser function hooks.
showhooks
Returns a list of all subscribed hooks (contents of $wgHooks).
variables
Returns a list of variable IDs.
protocols
Returns a list of protocols that are allowed in external links.
defaultoptions
Returns the default values for user preferences.
值(以|分隔):general、namespaces、namespacealiases、specialpagealiases、magicwords、interwikimap、dbrepllag、statistics、usergroups、libraries、extensions、fileextensions、rightsinfo、restrictions、languages、skins、extensiontags、functionhooks、showhooks、variables、protocols、defaultoptions
默认:general
sifilteriw

Return only local or only nonlocal entries of the interwiki map.

一个值:local、!local
sishowalldb

List all database servers, not just the one lagging the most.

sinumberingroup

列出用户组中的用户数。

siinlanguagecode

Language code for localised language names (best effort) and skin names.

meta=tokens

main | query | tokens
  • 此模块需要读取权限。

Gets tokens for data-modifying actions.

参数:
type

要请求的令牌类型。

值(以|分隔):csrf、patrol、rollback、userrights、watch
默认:csrf
例子:
Retrieve a csrf token (the default).
api.php?action=query&meta=tokens
Retrieve a watch token and a patrol token.
api.php?action=query&meta=tokens&type=watch|patrol

meta=userinfo (ui)

main | query | userinfo
  • 此模块需要读取权限。

获取有关当前用户的信息。

参数:
uiprop

Which pieces of information to include:

blockinfo
Tags if the current user is blocked, by whom, and for what reason.
hasmsg
Adds a tag message if the current user has pending messages.
groups
Lists all the groups the current user belongs to.
implicitgroups
Lists all the groups the current user is automatically a member of.
rights
Lists all the rights the current user has.
changeablegroups
Lists the groups the current user can add to and remove from.
options
Lists all preferences the current user has set.
preferencestoken
Deprecated. Get a token to change current user's preferences.
editcount
Adds the current user's edit count.
ratelimits
Lists all rate limits applying to the current user.
realname
Adds the user's real name.
email
Adds the user's email address and email authentication date.
acceptlang
Echoes the Accept-Language header sent by the client in a structured format.
registrationdate
Adds the user's registration date.
unreadcount
Adds the count of unread pages on the user's watchlist (maximum 999; returns 1000+ if more).
值(以|分隔):blockinfo、hasmsg、groups、implicitgroups、rights、changeablegroups、options、preferencestoken、editcount、ratelimits、email、realname、acceptlang、registrationdate、unreadcount
例子:
获取有关当前用户的信息
api.php?action=query&meta=userinfo
获取有关当前用户的额外信息
api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg

action=revisiondelete

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

删除和恢复修订版本。

参数:
type

Type of revision deletion being performed.

这个参数是必须的。
一个值:revision、archive、oldimage、filearchive、logging
target

Page title for the revision deletion, if required for the type.

ids

Identifiers for the revisions to be deleted.

这个参数是必须的。
通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
hide

每次修订要隐藏的东西。

值(以|分隔):content、comment、user
show

每次修订要恢复显示的东西。

值(以|分隔):content、comment、user
suppress

Whether to suppress data from administrators as well as others.

一个值:yes、no、nochange
默认:nochange
reason

删除或恢复的原因。

token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=rollback

main | rollback
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

Undo the last edit to the page.

If the last user who edited the page made multiple edits in a row, they will all be rolled back.

参数:
title

要回退的页面标题。不能与pageid一起使用。

pageid

要回退的页面的页面 ID。不能与title一起使用。

user

Name of the user whose edits are to be rolled back.

这个参数是必须的。
summary

Custom edit summary. If empty, default summary will be used.

默认:(空)
markbot

Mark the reverted edits and the revert as bot edits.

watchlist

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

一个值:watch、unwatch、preferences、nochange
默认:preferences
token

action=query&meta=tokens取回的“rollback”令牌

For compatibility, the token used in the web UI is also accepted.

这个参数是必须的。
例子:
回退由用户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

导出一个RSD(Really Simple Discovery)架构

例子:
导出RSD架构
api.php?action=rsd

action=setnotificationtimestamp

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

Update the notification timestamp for watched pages.

This affects the highlighting of changed pages in the watchlist and history, and the sending of email when the "Email me when a page on my watchlist is changed" preference is enabled.

参数:
entirewatchlist

工作于所有已监视页面。

timestamp

Timestamp to which to set the notification timestamp.

torevid

Revision to set the notification timestamp to (one page only).

newerthanrevid

Revision to set the notification timestamp newer than (one page only).

continue

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

titles

A list of titles to work on.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
pageids

A list of page IDs to work on.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
revids

A list of revision IDs to work on.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
generator

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

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

一个值:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan、iu、kk、ku、shi、sr、tg、uz、zh.

token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。
例子:
重置整个监视列表的通知状态。
api.php?action=setnotificationtimestamp&entirewatchlist=&token=123ABC
Reset the notification status for Main page.
api.php?action=setnotificationtimestamp&titles=Main_page&token=123ABC
设置Main page的通知时间戳,这样所有从2012年1月1日起的编辑都会是未复核的。
api.php?action=setnotificationtimestamp&titles=Main_page&timestamp=2012-01-01T00:00:00Z&token=123ABC
重置在用户名字空间中的页面的通知状态。
api.php?action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC

action=stashedit

main | stashedit
  • 此模块是内部或不稳定的。它的操作可以更改而不另行通知。
  • 此模块需要读取权限。
  • 此模块只允许POST请求。
参数:
title
(没有说明)
这个参数是必须的。
section
(没有说明)
sectiontitle
(没有说明)
text
(没有说明)
这个参数是必须的。
contentmodel
(没有说明)
这个参数是必须的。
一个值:wikitext、javascript、json、css、text
contentformat
(没有说明)
这个参数是必须的。
一个值:text/x-wiki、text/javascript、application/json、text/css、text/plain
baserevid
(没有说明)
这个参数是必须的。
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=tag

main | tag
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

Add or remove change tags from individual revisions or log entries.

参数:
rcid

One or more recent changes IDs from which to add or remove the tag.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
revid

One or more revision IDs from which to add or remove the tag.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
logid

One or more log entry IDs from which to add or remove the tag.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
add

Tags to add. Only manually defined tags can be added.

值(以|分隔):
remove

Tags to remove. Only tags that are either manually defined or completely undefined can be removed.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
reason

Reason for the change.

默认:(空)
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。
例子:
Add the vandalism tag from revision ID 123 without specifying a reason
api.php?action=tag&revid=123&add=vandalism&token=123ABC
Remove the spam tag from log entry ID 123 with the reason Wrongly applied
api.php?action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC

action=tokens

main | tokens
  • 此模块已弃用。
  • 此模块需要读取权限。

Get tokens for data-modifying actions.

This module is deprecated in favor of action=query&meta=tokens.

参数:
type

要请求的令牌类型。

值(以|分隔):block、delete、edit、email、import、move、options、patrol、protect、unblock、watch
默认:edit
例子:
Retrieve an edit token (the default).
api.php?action=tokens
Retrieve an email token and a move token.
api.php?action=tokens&type=email|move

action=unblock

main | unblock
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

解封一位用户。

参数:
id

解封时需要的封禁ID(通过list=blocks获得)。不能与user一起使用。

user

要解封的用户名、IP地址或IP段。不能与id一起使用。

reason

解封的原因。

默认:(空)
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。
例子:
解封封禁ID #105
api.php?action=unblock&id=105
解封用户Bob,原因Sorry Bob
api.php?action=unblock&user=Bob&reason=Sorry%20Bob

action=undelete

main | undelete
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

Restore revisions of a deleted page.

A list of deleted revisions (including timestamps) can be retrieved through list=deletedrevs, and a list of deleted file IDs can be retrieved through list=filearchive.

参数:
title

要恢复的页面标题。

这个参数是必须的。
reason

恢复的原因。

默认:(空)
timestamps

Timestamps of the revisions to restore. If both timestamps and fileids are empty, all will be restored.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
fileids

要恢复的文件修订ID。如果timestampsfileids都为空,所有将被恢复。

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
watchlist

Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.

一个值:watch、unwatch、preferences、nochange
默认:preferences
token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=upload

main | upload
  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

Upload a file, or get the status of pending uploads.

Several methods are available:

  • Upload file contents directly, using the file parameter.
  • Upload the file in pieces, using the filesize, chunk, and offset parameters.* Have the MediaWiki server fetch a file from a URL, using the url parameter.
  • Complete an earlier upload that failed due to warnings, using the filekey parameter.

Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when sending the file.

参数:
filename

目标文件名。

comment

上传注释。如果没有指定text,那么它也被用于新文件的初始页面文本。

默认:(空)
text

Initial page text for new files.

watch
不推荐使用。

监视页面。

watchlist

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

一个值:watch、preferences、nochange
默认:preferences
ignorewarnings

忽略任何警告。

file

文件内容。

Must be posted as a file upload using multipart/form-data.
url

URL to fetch the file from.

filekey

Key that identifies a previous upload that was stashed temporarily.

sessionkey
不推荐使用。

Same as filekey, maintained for backward compatibility.

stash

如果设置,服务器将临时藏匿文件而不是加入存储库。

filesize

Filesize of entire upload.

offset

块的偏移量(字节)。

chunk

大块内容。

Must be posted as a file upload using multipart/form-data.
async

Make potentially large file operations asynchronous when possible.

asyncdownload

Make fetching a URL asynchronous.

leavemessage

If asyncdownload is used, leave a message on the user talk page if finished.

statuskey

Fetch the upload status for this file key (upload by URL).

checkstatus

Only fetch the upload status for the given file key.

token

action=query&meta=tokens取回的“csrf”令牌

这个参数是必须的。

action=userrights

  • 此模块需要读取权限。
  • 此模块需要写入权限。
  • 此模块只允许POST请求。

更改一位用户的组成员。

参数:
user

用户名。

userid

用户ID。

add

将用户加入至这些组中。

值(以|分隔):bot、sysop、bureaucrat
remove

将用户从这些组中移除。

值(以|分隔):bot、sysop、bureaucrat
reason

更改原因。

默认:(空)
token

action=query&meta=tokens取回的“userrights”令牌

For compatibility, the token used in the web UI is also accepted.

这个参数是必须的。
例子:
将用户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请求。

Add or remove pages from the current user's watchlist.

参数:
title
不推荐使用。

要(取消)监视的页面。也可使用titles

unwatch

If set the page will be unwatched rather than watched.

continue

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

titles

A list of titles to work on.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
pageids

A list of page IDs to work on.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
revids

A list of revision IDs to work on.

通过“|”隔开各值。 值的最高数字是50(对于机器人则是500)。
generator

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

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

一个值:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan、iu、kk、ku、shi、sr、tg、uz、zh.

token

action=query&meta=tokens取回的“watch”令牌

这个参数是必须的。

format=dbg

main | dbg
  • 此模块已弃用。
  • 此模块需要读取权限。

输出数据为PHP的var_export()格式。

例子:
格式化查询结果为DBG格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbg

format=dbgfm

main | dbgfm
  • 此模块已弃用。
  • 此模块需要读取权限。

输出数据为PHP的var_export()格式(HTML优质打印效果)。

例子:
格式化查询结果为DBG格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbgfm

format=dump

main | dump
  • 此模块已弃用。
  • 此模块需要读取权限。

输出数据为PHP的var_dump()格式。

例子:
格式化查询结果为DUMP格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=dump

format=dumpfm

main | dumpfm
  • 此模块已弃用。
  • 此模块需要读取权限。

输出数据为PHP的var_dump()格式(HTML优质打印效果)。

例子:
格式化查询结果为DUMP格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=dumpfm

format=json

main | json
  • 此模块需要读取权限。

输出数据为JSON格式。

参数:
callback

If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

utf8

If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.

ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
一个值:1、2、latest
默认:1
例子:
格式化查询结果为JSON格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=json

format=jsonfm

main | jsonfm
  • 此模块需要读取权限。

输出数据为JSON格式(HTML优质打印效果)。

参数:
callback

If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

utf8

If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.

ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
一个值:1、2、latest
默认:1
例子:
格式化查询结果为JSON格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=jsonfm

format=none

main | none
  • 此模块需要读取权限。

不输出任何东西。

例子:
格式化查询结果为NONE格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=none

format=php

main | php
  • 此模块需要读取权限。

输出数据为序列化PHP格式。

参数:
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
一个值:1、2、latest
默认:1
例子:
格式化查询结果为PHP格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=php

format=phpfm

main | phpfm
  • 此模块需要读取权限。

输出数据为序列化PHP格式(HTML优质打印效果)。

参数:
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
一个值:1、2、latest
默认:1
例子:
格式化查询结果为PHP格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=phpfm

format=rawfm

main | rawfm
  • 此模块需要读取权限。

输出数据为JSON格式,带调试元素(HTML优质打印效果)。

例子:
格式化查询结果为RAW格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=rawfm

format=txt

main | txt
  • 此模块已弃用。
  • 此模块需要读取权限。

输出数据为PHP的print_r()格式。

例子:
格式化查询结果为TXT格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=txt

format=txtfm

main | txtfm
  • 此模块已弃用。
  • 此模块需要读取权限。

输出数据为PHP的print_r()格式(HTML优质打印效果)。

例子:
格式化查询结果为TXT格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=txtfm

format=wddx

main | wddx
  • 此模块已弃用。
  • 此模块需要读取权限。

输出数据为WDDX格式。

例子:
格式化查询结果为WDDX格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=wddx

format=wddxfm

main | wddxfm
  • 此模块已弃用。
  • 此模块需要读取权限。

输出数据为WDDX格式(HTML优质打印效果)。

例子:
格式化查询结果为WDDX格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=wddxfm

format=xml

main | xml
  • 此模块需要读取权限。

输出数据为XML格式。

参数:
xslt

如果指定,加入已命名的页面作为一个XSL样式表。值必须是在MediaWiki名字空间以.xsl为结尾的标题。

includexmlnamespace

If specified, adds an XML namespace.

例子:
格式化查询结果为XML格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=xml

format=xmlfm

main | xmlfm
  • 此模块需要读取权限。

输出数据为XML格式(HTML优质打印效果)。

参数:
xslt

如果指定,加入已命名的页面作为一个XSL样式表。值必须是在MediaWiki名字空间以.xsl为结尾的标题。

includexmlnamespace

If specified, adds an XML namespace.

例子:
格式化查询结果为XML格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=xmlfm

format=yaml

main | yaml
  • 此模块已弃用。
  • 此模块需要读取权限。

输出数据为YAML格式。

参数:
callback

If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

utf8

If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.

ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
一个值:1、2、latest
默认:1
例子:
格式化查询结果为YAML格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=yaml

format=yamlfm

main | yamlfm
  • 此模块已弃用。
  • 此模块需要读取权限。

输出数据为YAML格式(HTML优质打印效果)。

参数:
callback

If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

utf8

If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.

ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
一个值:1、2、latest
默认:1
例子:
格式化查询结果为YAML格式。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=yamlfm

制作人员

API 开发人员:

  • Roan Kattouw(2007年9月~2009年的开发组领导)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan(创建者,2006年9月~2007年9月的开发组领导)
  • Brad Jorsch(2013年至今的开发组领导)

请将您的评论、建议和问题发送至mediawiki-api@lists.wikimedia.org,或提交错误请求在https://phabricator.wikimedia.org/。