MediaWiki API 說明

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

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

主要模組

main

狀態資訊:MediaWiki API 已是成熟、穩定,並積極支援以改善的介面。儘管我們儘可能避免,但仍偶有需要重大變更的情況,請訂閱mediawiki-api-announce 郵寄清單以便獲得更新通知。

錯誤的請求:當 API 收到錯誤的請求,會發出以「MediaWiki-API-Error」為鍵的 HTTP 標頭欄位,隨後標頭欄位的值,以及傳回的錯誤碼會設為相同值。詳細資訊請參閱 API: 錯誤與警告

參數:
action

要執行的動作。

block
封鎖使用者。
changeauthenticationdata
為目前使用者變更身分核對資料。
checktoken
檢查來自 action=query&meta=tokens 的密鑰有效性。
clearhasmsg
清除目前使用者的 hasmsg 標記。
clientlogin
使用交互式流登录wiki。
compare
比較 2 個頁面間的差異。
createaccount
建立新使用者帳號。
cspreport
由浏览器使用以报告违反内容安全方针的内容。此模块应永不使用,除了在被CSP兼容的浏览器自动使用时。
delete
刪除頁面。
edit
建立與編輯頁面。
emailuser
寄送電子郵件給使用者。
expandtemplates
展開所有於 wikitext 中模板。
feedcontributions
回傳使用者貢獻 Feed。
feedrecentchanges
返回最近變更摘要。
feedwatchlist
返回監視清單 feed。
filerevert
回退檔案至舊的版本。
help
顯示指定模組的說明。
imagerotate
旋轉一張或多張圖片。
import
從其它 wiki 或 XML 檔案來匯入頁面。
linkaccount
将来自第三方提供商的账户链接至当前用户。
login
登入並取得身分核對 cookies
logout
登出並清除 session 資料。
managetags
執行相關到更改標籤的管理任務。
mergehistory
合併頁面歷史
move
移動頁面。
opensearch
使用 OpenSearch 協定搜尋本 wiki。
options
更改目前使用者的偏好設定。
paraminfo
獲得有關 API 模組的資訊。
parse
解析內容併回傳解析器輸出。
patrol
巡查頁面或修訂。
protect
變更頁面的保護層級。
purge
為指定標題清除快取。
query
擷取來自及有關MediaWiki的數據。
removeauthenticationdata
為目前使用者移除身分核對資料。
resetpassword
寄送重新設定密碼的電子郵件給使用者。
revisiondelete
刪除和取消刪除修訂。
rollback
復原頁面的最後一次編輯。
rsd
匯出一個簡易探索(Really Simple Discovery、RSD)架構。
setnotificationtimestamp
更新監視頁面的通知時間戳記。
setpagelanguage
更改頁面的語言。
stashedit
在分享快取裡預備編輯。
tag
从个别修订或日志记录中添加或移除更改标签。
unblock
解除封鎖一位使用者。
undelete
恢復已刪除頁面的修訂。
unlinkaccount
移除目前使用者所連結到的第三方帳號。
upload
上傳檔案,或取得等待上傳的狀態。
userrights
變更一位使用者的群組成員。
validatepassword
驗證密碼是否符合 wiki 的密碼方針。
watch
從目前使用者的監視清單添加或移除頁面。
tokens
已停用。 取得資料修改動作的密鑰。
單值:blockchangeauthenticationdatachecktokenclearhasmsgclientlogincomparecreateaccountcspreportdeleteeditemailuserexpandtemplatesfeedcontributionsfeedrecentchangesfeedwatchlistfilereverthelpimagerotateimportlinkaccountloginlogoutmanagetagsmergehistorymoveopensearchoptionsparaminfoparsepatrolprotectpurgequeryremoveauthenticationdataresetpasswordrevisiondeleterollbackrsdsetnotificationtimestampsetpagelanguagestashedittagunblockundeleteunlinkaccountuploaduserrightsvalidatepasswordwatchtokens
預設值:help
format

輸出的格式。

json
使用 JSON 格式輸出資料。
jsonfm
使用 JSON 格式輸出資料 (使用 HTML 格式顯示)。
none
不輸出。
php
使用序列化 PHP 格式輸出資料。
phpfm
使用序列化 PHP 格式輸出資料 (使用 HTML 格式顯示)。
rawfm
使用 JSON 格式的除錯元素輸出資料 (使用 HTML 格式顯示)。
xml
使用 XML 格式輸出資料。
xmlfm
使用 XML 格式輸出資料 (使用 HTML 格式顯示)。
單值:jsonjsonfmnonephpphpfmrawfmxmlxmlfm
預設值:jsonfm
maxlag

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

類型:整數
smaxage

將HTTP緩存控制頭欄位設為s-maxage秒。錯誤不會做緩存。

類型:整數
預設值:0
maxage

將HTTP緩存控制頭欄位設為max-age秒。錯誤不會做緩存。

類型:整數
預設值:0
assert

若設為user,會確認使用者是否已登入;若設為bot,會確認是否擁有機械人權限。

單值:userbot
assertuser

確認目前使用者就是指定的使用者。

類型:使用者名稱
requestid

在此處提供的任何值都將包括在響應之中。可用於區分請求。

servedby

在結果中包括提出請求的主機名。

類型:布林值(詳細資訊
curtimestamp

在結果中包括目前的時間戳。

類型:布林值(詳細資訊
responselanginfo

在結果中包括uselangerrorlang所用的語言。

類型:布林值(詳細資訊
origin

当通过跨域名AJAX请求(CORS)访问API时,设置此作为起始域名。这必须包括在任何pre-flight请求中,并因此必须是请求的URI的一部分(而不是POST正文)。

对于已验证的请求,这必须正确匹配Origin标头中的原点之一,因此它已经设置为像https://en.wikipedia.orghttps://meta.wikimedia.org的东西。如果此参数不匹配Origin页顶,就返回403错误响应。如果此参数匹配Origin页顶并且起点被白名单,将设置Access-Control-Allow-OriginAccess-Control-Allow-Credentials开头。

对于未验证的请求,会指定值*。这将导致Access-Control-Allow-Origin标头被设置,但Access-Control-Allow-Credentials将为false,且所有用户特定数据将受限制。

uselang

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

預設值:user
errorformat

用于警告和错误文本输出的格式。

plaintext
已移除HTML标签,并被替换实体的Wiki文本。
wikitext
未解析的wiki文本。
html
HTML。
raw
消息关键词和参数。
none
无文本输出,仅包含错误代码。
bc
在MediaWiki 1.29以前版本使用的格式。errorlangerrorsuselocal会被忽略。
單值:plaintextwikitexthtmlrawnonebc
預設值:bc
errorlang

用于警告和错误的语言。action=query&meta=siteinfosiprop=languages返回语言代码的列表,或指定content以使用此wiki的内容语言,或指定uselang以使用与uselang参数相同的值。

預設值:uselang
errorsuselocal

如果指定,错误文本将使用来自MediaWiki名字空间的本地自定义消息。

類型:布林值(詳細資訊
權限:
writeapi
使用寫入 API
已授權給: all、user與bot
apihighlimits
在API查询中使用更高的上限(慢查询:500;快查询:5000)。慢查询的限制也适用于多值参数。
已授權給: bot與sysop

action=block

main | block
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

封鎖使用者。

參數:
user

要封鎖的使用者名稱、IP 位址或 IP 範圍。不能與 userid 一起使用

類型:使用者名稱
userid

要封鎖的使用者 ID。不可與 user 一同使用。

類型:整數
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 位址的使用者頁面與對話頁面。

類型:布林值(詳細資訊
tags

在封鎖日誌裡更改套用到項目的標籤。

多值 (以 |alternative 分隔):
token

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

此參數為必填。

action=changeauthenticationdata (changeauth)

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

為目前使用者變更身分核對資料。

參數:
changeauthrequest

使用此身份驗證請求,透過自action=query&meta=authmanagerinfo回傳的idamirequestsfor=change

此參數為必填。
changeauthtoken

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

此參數為必填。
*
此模組允許額外參數,取決於可用的身份驗證請求。使用action=query&meta=authmanagerinfoamirequestsfor=change(或之前來自此模組的回應,如果合適)以決定可用請求及其使用的欄位。

action=checktoken

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

參數:
type

要測試的密鑰類型。

此參數為必填。
單值:createaccountcsrfloginpatrolrollbackuserrightswatch
token

要測試的密鑰。

此參數為必填。
maxtokenage

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

類型:整數

action=clearhasmsg

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

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

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

action=clientlogin (login)

使用交互式流登录wiki。

使用此模組的一般程式是:

  1. 通過amirequestsfor=login取得來自action=query&meta=authmanagerinfo的可用欄位,和來自action=query&meta=tokenslogin令牌。
  2. 向用戶顯示欄位,並獲得其提交的內容。
  3. 提交(POST)至此模組,提供loginreturnurl及任何相關欄位。
  4. 在回应中檢查status
    • 如果您收到了PASS(成功)或FAIL(失敗),則認為操作結束。成功與否如上句所示。
    • 如果您收到了UI,向用戶顯示新欄位,並再次獲取其提交的內容。然後再次使用logincontinue,向本模組提交相關欄位,並重復第四步。
    • 如果您收到了REDIRECT,將使用者指向redirecttarget中的目標,等待其返回loginreturnurl。然後再次使用logincontinue,向本模組提交返回URL中提供的一切欄位,並重復第四步。
    • 如果您收到了RESTART,這意味著身份驗證正常運作,但我們沒有連結的使用者賬戶。您可以將此看做UIFAIL
參數:
loginrequests

只使用這些身份驗證請求,透過自action=query&meta=authmanagerinfo回傳的idamirequestsfor=login,或來自此模組之前的回應。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
loginmessageformat

用於回傳訊息的格式。

單值:htmlwikitextrawnone
預設值:wikitext
loginmergerequestfields

將用於所有身份驗證請求的欄位資訊合併至一個陣列中。

類型:布林值(詳細資訊
loginpreservestate

從之前失敗的登入嘗試中保持狀態,如果可能。

類型:布林值(詳細資訊
loginreturnurl

為第三方身份驗證流程傳回URL,必須為絕對值。需要此值或logincontinue兩者之一。

在接收REDIRECT回應時,一般狀況下您將打開瀏覽器或網站瀏覽功能到特定的redirecttarget URL以進行第三方身份驗證流程。當它完成時,第三方會將瀏覽器或網站瀏覽功能送至此URL。您應當提取任何來自URL的查詢或POST參數,並將之作為logincontinue請求傳遞至此API模組。

logincontinue

此請求是在先前的UIREDIRECT回應之後的後續動作。必須為此值或loginreturnurl

類型:布林值(詳細資訊
logintoken

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

此參數為必填。
*
此模組允許額外參數,取決於可用的身份驗證請求。使用action=query&meta=authmanagerinfoamirequestsfor=login(或之前來自此模組的回應,如果合適)以決定可用請求及其使用的欄位。

action=compare

main | compare

比較 2 個頁面間的差異。

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

參數:
fromtitle

要比對的第一個標題。

fromid

要比對的第一個頁面 ID。

類型:整數
fromrev

要比對的第一個修訂。

類型:整數
fromslots

Override content of the revision specified by fromtitle, fromid or fromrev.

This parameter specifies the slots that are to be modified. Use fromtext-{slot}, fromcontentmodel-{slot}, and fromcontentformat-{slot} to specify content for each slot.

多值 (以 |alternative 分隔):main
fromtext-{slot}

Text of the specified slot. If omitted, the slot is removed from the revision.

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为fromslots的值。
fromsection-{slot}

When fromtext-{slot} is the content of a single section, this is the section number. It will be merged into the revision specified by fromtitle, fromid or fromrev as if for a section edit.

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为fromslots的值。
fromcontentformat-{slot}

fromtext-{slot} 的內容序列化格式。

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为fromslots的值。
單值:text/x-wikitext/javascriptapplication/jsontext/csstext/plain
fromcontentmodel-{slot}

Content model of fromtext-{slot}. If not supplied, it will be guessed based on the other parameters.

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为fromslots的值。
單值:wikitextjavascriptjsoncsstext
frompst

fromtext执行预保存转变。

類型:布林值(詳細資訊
fromtext
已停用。

指定 fromslots=main 並改用 fromtext-main

fromcontentformat
已停用。

指定 fromslots=main 並改使用 fromcontentformat-main

單值:text/x-wikitext/javascriptapplication/jsontext/csstext/plain
fromcontentmodel
已停用。

指定 fromslots=main 並改使用 fromcontentmodel-main

單值:wikitextjavascriptjsoncsstext
fromsection
已停用。

只使用指定“from”内容的指定章节。

totitle

要比對的第二個標題。

toid

要比對的第二個頁面 ID。

類型:整數
torev

要比對的第二個修訂。

類型:整數
torelative

使用与定义自fromtitlefromidfromrev的修订版本相关的修订版本。所有其他“to”的选项将被忽略。

單值:prevnextcur
toslots

Override content of the revision specified by totitle, toid or torev.

This parameter specifies the slots that are to be modified. Use totext-{slot}, tocontentmodel-{slot}, and tocontentformat-{slot} to specify content for each slot.

多值 (以 |alternative 分隔):main
totext-{slot}

Text of the specified slot. If omitted, the slot is removed from the revision.

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为toslots的值。
tosection-{slot}

When totext-{slot} is the content of a single section, this is the section number. It will be merged into the revision specified by totitle, toid or torev as if for a section edit.

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为toslots的值。
tocontentformat-{slot}

totext-{slot} 的內容序列化格式。

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为toslots的值。
單值:text/x-wikitext/javascriptapplication/jsontext/csstext/plain
tocontentmodel-{slot}

Content model of totext-{slot}. If not supplied, it will be guessed based on the other parameters.

这是一个模板参数。当做出请求时,参数名中的{slot}应替换为toslots的值。
單值:wikitextjavascriptjsoncsstext
topst

totext 執行預先保存轉換。

類型:布林值(詳細資訊
totext
已停用。

指定 toslots=main 並改用 totext-main

tocontentformat
已停用。

指定 toslots=main 並改使用 tocontentformat-main

單值:text/x-wikitext/javascriptapplication/jsontext/csstext/plain
tocontentmodel
已停用。

指定 toslots=main 並改使用 tocontentmodel-main

單值:wikitextjavascriptjsoncsstext
tosection
已停用。

只使用指定“to”内容的指定章节。

prop

要取得的資訊部份。

diff
HTML 差異。
diffsize
以位元組為單位的 HTML 差異大小。
rel
“from”之前及“to”之后修订版本的修订ID,如果有。
ids
「from」與「to」修訂的頁面與修訂 ID。
title
「from」與「to」修訂的頁面標題。
user
「from」與「to」修訂的使用者名稱與 ID。
comment
「from」與「to」修訂的註釋。
parsedcomment
「from」與「to」修訂的解析註釋。
size
「from」與「to」修訂的大小。
多值 (以 |alternative 分隔):diffdiffsizerelidstitleusercommentparsedcommentsize
預設值:diff|ids|title
slots

Return individual diffs for these slots, rather than one combined diff for all slots.

多值 (以 |alternative 分隔):main
要指定所有值,請使用*
範例:
建立修訂 1 與 1 的差異檔
api.php?action=compare&fromrev=1&torev=2 [在沙盒中開啟]

action=createaccount (create)

  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

建立新使用者帳號。

使用此模組的一般程式是:

  1. 通過amirequestsfor=create取得來自action=query&meta=authmanagerinfo的可用欄位,和來自action=query&meta=tokenscreateaccount令牌。
  2. 向用戶顯示欄位,並獲得其提交的內容。
  3. 提交(POST)至此模組,提供createreturnurl及任何相關欄位。
  4. 在回应中檢查status
    • 如果您收到了PASS(成功)或FAIL(失敗),則認為操作結束。成功與否如上句所示。
    • 如果您收到了UI,向用戶顯示新欄位,並再次獲取其提交的內容。然後再次使用createcontinue,向本模組提交相關欄位,並重復第四步。
    • 如果您收到了REDIRECT,將使用者指向redirecttarget中的目標,等待其返回createreturnurl。然後再次使用createcontinue,向本模組提交返回URL中提供的一切欄位,並重復第四步。
    • 如果您收到了RESTART,這意味著身份驗證正常運作,但我們沒有連結的使用者賬戶。您可以將此看做UIFAIL
參數:
createrequests

只使用這些身份驗證請求,透過自action=query&meta=authmanagerinfo回傳的idamirequestsfor=create,或來自此模組之前的回應。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
createmessageformat

用於回傳訊息的格式。

單值:htmlwikitextrawnone
預設值:wikitext
createmergerequestfields

將用於所有身份驗證請求的欄位資訊合併至一個陣列中。

類型:布林值(詳細資訊
createpreservestate

從之前失敗的登入嘗試中保持狀態,如果可能。

如果action=query&meta=authmanagerinfo返回用于hasprimarypreservedstate的真值,标记为primary-required的请求应被忽略。如果它返回用于preservedusername的非空值,用户名必须用于username参数。

類型:布林值(詳細資訊
createreturnurl

為第三方身份驗證流程傳回URL,必須為絕對值。需要此值或createcontinue兩者之一。

在接收REDIRECT回應時,一般狀況下您將打開瀏覽器或網站瀏覽功能到特定的redirecttarget URL以進行第三方身份驗證流程。當它完成時,第三方會將瀏覽器或網站瀏覽功能送至此URL。您應當提取任何來自URL的查詢或POST參數,並將之作為createcontinue請求傳遞至此API模組。

createcontinue

此請求是在先前的UIREDIRECT回應之後的後續動作。必須為此值或createreturnurl

類型:布林值(詳細資訊
createtoken

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

此參數為必填。
*
此模組允許額外參數,取決於可用的身份驗證請求。使用action=query&meta=authmanagerinfoamirequestsfor=create(或之前來自此模組的回應,如果合適)以決定可用請求及其使用的欄位。

action=cspreport

main | cspreport
  • 此模組是內部的或不穩定的。它的操作可能更改而不另行通知。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

由浏览器使用以报告违反内容安全方针的内容。此模块应永不使用,除了在被CSP兼容的浏览器自动使用时。

參數:
reportonly

标记作为来自监视方针的报告,而不是执行方针的报告

類型:布林值(詳細資訊
source

生成引发此报告的CSP标头的事物

預設值:internal

action=delete

main | delete
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

刪除頁面。

參數:
title

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

pageid

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

類型:整數
reason

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

tags

在刪除日誌裡更改套用到項目的標籤。

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

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

類型:布林值(詳細資訊
watchlist

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

單值:watchunwatchpreferencesnochange
預設值:preferences
unwatch
已停用。

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

類型:布林值(詳細資訊
oldimage

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

token

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

此參數為必填。

action=edit

main | edit
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

建立與編輯頁面。

參數:
title

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

pageid

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

類型:整數
section

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

sectiontitle

新章節的標題。

text

頁面內容。

summary

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

tags

更改套用到修訂的標籤。

多值 (以 |alternative 分隔):
minor

小編輯。

類型:布林值(詳細資訊
notminor

非小編輯。

類型:布林值(詳細資訊
bot

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

類型:布林值(詳細資訊
basetimestamp

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

類型:時間戳記(允許格式
starttimestamp

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

類型:時間戳記(允許格式
recreate

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

類型:布林值(詳細資訊
createonly

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

類型:布林值(詳細資訊
nocreate

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

類型:布林值(詳細資訊
watch
已停用。

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

類型:布林值(詳細資訊
unwatch
已停用。

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

類型:布林值(詳細資訊
watchlist

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

單值:watchunwatchpreferencesnochange
預設值:preferences
md5

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

prependtext

添加此文字至頁面開頭。覆蓋text。

appendtext

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

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

undo

復原此修訂。覆寫 text、prependtext 與 appendtext。

數值不可小於 0。
類型:整數
undoafter

撤銷從 undo 至此為止的所有修訂。若不設定則僅會撤銷一次修訂。

數值不可小於 0。
類型:整數
redirect

自動化解決重新導向。

類型:布林值(詳細資訊
contentformat

用於輸入文字的內容序列化格式。

單值:text/x-wikitext/javascriptapplication/jsontext/csstext/plain
contentmodel

新內容的內容模組。

單值:wikitextjavascriptjsoncsstext
token

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

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

此參數為必填。
g-recaptcha-response

自 ReCaptcha 小工具的欄位。

action=emailuser

main | emailuser
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

寄送電子郵件給使用者。

參數:
target

電子郵件的收件使用者。

此參數為必填。
subject

郵件主旨。

text

郵件內容。

此參數為必填。
ccme

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

類型:布林值(詳細資訊
token

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

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

action=expandtemplates

展開所有於 wikitext 中模板。

參數:
title

頁面標題。

text

要轉換的 Wikitext。

此參數為必填。
revid

修訂 ID,用於 {{REVISIONID}} 和相似變數。

類型:整數
prop

要获取的那条信息。

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

wikitext
展開的 wiki 文字。
categories
任何在输出中提供的,未在wiki文本输出中表现的分类。
properties
透過在 wiki 文字裡擴充魔術字所定義的頁面屬性。
volatile
输出是否常常变动,是否不应被在页面中其他任何位置重用。
ttl
结果缓存应无效化后的最长时间。
modules
任何解析器函数请求添加至输出的ResourceLoader模块。jsconfigvarsencodedjsconfigvars之一必须与modules共同被请求。
jsconfigvars
指定頁面的 JavaScript 設置變量。
encodedjsconfigvars
指定頁面的 JavaScript 設置變量為 JSON 字串。
parsetree
输入的XML分析树。
多值 (以 |alternative 分隔):wikitextcategoriespropertiesvolatilettlmodulesjsconfigvarsencodedjsconfigvarsparsetree
includecomments

輸出裡是否包含 HTML 註解。

類型:布林值(詳細資訊
generatexml
已停用。

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

類型:布林值(詳細資訊
範例:
展開 wiki 文字{{Project:Sandbox}}
api.php?action=expandtemplates&text={{Project:Sandbox}} [在沙盒中開啟]

action=feedcontributions

回傳使用者貢獻 Feed。

參數:
feedformat

Feed 的格式。

單值:rssatom
預設值:rss
user

要取得哪些使用者的貢獻。

此參數為必填。
類型:使用者名稱
namespace

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

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

起始年份(更早之前)。

類型:整數
month

起始月份(更早之前)。

類型:整數
tagfilter

篩選有這些標籤的貢獻。

多值 (以 |alternative 分隔):mw-contentmodelchangemw-new-redirectmw-removed-redirectmw-changed-redirect-targetmw-blankmw-replacemw-rollbackmw-undo
預設值:(空)
deletedonly

僅顯示已刪除的貢獻。

類型:布林值(詳細資訊
toponly

只顯示最新修訂的編輯。

類型:布林值(詳細資訊
newonly

只顯示建立頁面的編輯。

類型:布林值(詳細資訊
hideminor

隱藏小編輯。

類型:布林值(詳細資訊
showsizediff

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

類型:布林值(詳細資訊
範例:
返回使用者Example的貢獻。
api.php?action=feedcontributions&user=Example [在沙盒中開啟]

action=feedrecentchanges

返回最近變更摘要。

參數:
feedformat

摘要格式。

單值:rssatom
預設值: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

隱藏由目前使用者做出的更改。

類型:布林值(詳細資訊
hidecategorization

隱藏分類成員更改。

類型:布林值(詳細資訊
tagfilter

按標籤篩選。

target

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

showlinkedto

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

類型:布林值(詳細資訊

action=feedwatchlist

返回監視清單 feed。

參數:
feedformat

Feed 的格式。

單值:rssatom
預設值:rss
hours

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

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

若可以的話,直接連結至更改過的段落。

類型:布林值(詳細資訊
allrev

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

類型:布林值(詳細資訊
wlowner

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

類型:使用者名稱
wltoken

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

wlshow

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

多值 (以 |alternative 分隔):minor!minorbot!botanon!anonpatrolled!patrolledautopatrolled!autopatrolledunread!unread
wltype

要顯示的更改類型:

edit
一般頁面編輯。
new
頁面建立。
log
日誌項目。
external
外部更改。
categorize
分類成員更改。
多值 (以 |alternative 分隔):editnewlogexternalcategorize
預設值:edit|new|log|categorize
wlexcludeuser

不要列出由該使用者作出的更改。

類型:使用者名稱
範例:
显示监视列表订阅。
api.php?action=feedwatchlist [在沙盒中開啟]
顯示過去 6 小時在監視頁面的所有更改。
api.php?action=feedwatchlist&allrev=&hours=6 [在沙盒中開啟]

action=filerevert

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

回退檔案至舊的版本。

參數:
filename

目標檔案名稱,不需包含「File:」這樣的前綴字元。

此參數為必填。
comment

上載意見。

預設值:(空)
archivename

恢复到修订版存档名称。

此參數為必填。
token

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

此參數為必填。

action=help

main | help

顯示指定模組的說明。

參數:
modules

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

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
預設值:main
submodules

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

類型:布林值(詳細資訊
recursivesubmodules

包括递归子模块的帮助。

類型:布林值(詳細資訊
wrap

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

類型:布林值(詳細資訊
toc

在 HTML 輸出裡包含目錄。

類型:布林值(詳細資訊

action=imagerotate

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

旋轉一張或多張圖片。

參數:
rotation

順時針旋轉圖片的度數。

此參數為必填。
單值:90180270
continue

當有更多結果可用時,使用這個繼續。

tags

在更新日誌裡套用到項目的標籤。

多值 (以 |alternative 分隔):
titles

要使用的標題清單。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
pageids

要使用的頁面 ID 清單。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
revids

要使用的修訂 ID 清單。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
generator

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

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

allcategories
列舉所有分類。
alldeletedrevisions
依使用者或所在命名空間來列出所有已刪除的修訂。
allfileusages
列出所有檔案用途,包含不存在的。
allimages
按順序列舉所有圖片。
alllinks
列舉所有指向所指定命名空間的連結。
allpages
依序列舉在指定命名空間的所有頁面。
allredirects
列出至命名空間的所有重新導向。
allrevisions
列出所有修訂版本。
alltransclusions
列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。
backlinks
找出連結至指定頁面的所有頁面。
categories
列出頁面隸屬的所有分類。
categorymembers
在指定的分類中列出所有頁面。
deletedrevisions
取得已刪除修訂的資訊。
duplicatefiles
根据哈希值列出此给定文件的所有副本。
embeddedin
查找所有嵌入指定标题的页面。
exturlusage
列舉包含指定 URL 的頁面。
fileusage
尋找使用到指定檔案的所有頁面。
images
回傳指定頁面中包含的所有檔案。
imageusage
尋找使用到指定圖片標題的所有頁面。
iwbacklinks
找出連結至指定跨 wiki 連結的所有頁面。
langbacklinks
找出連結至指定語言連結的所有頁面。
links
回傳指定頁面的所有連結。
linkshere
找出連結至指定頁面的所有頁面。
pageswithprop
列出使用到指定頁面屬性的所有頁面。
prefixsearch
執行頁面標題的前綴搜尋。
protectedtitles
列出所有被限制创建的标题。
querypage
取得透過特殊頁面 QueryPage-based 所提供的清單。
random
取得隨機頁面集合
recentchanges
列舉出最近變更。
redirects
回傳連結至指定頁面的所有重新導向。
revisions
取得修訂的資訊。
search
執行全文搜尋。
templates
回傳指定頁面中所有引用的頁面。
transcludedin
找出嵌入至指定頁面的所有頁面。
watchlist
在当前用户的监视列表中获取对页面的最近更改。
watchlistraw
列出在目前使用者的監視清單裡頭所有頁面。
單值:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

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

類型:布林值(詳細資訊
converttitles

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

類型:布林值(詳細資訊
token

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

此參數為必填。

action=import

main | import
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

從其它 wiki 或 XML 檔案來匯入頁面。

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

參數:
summary

匯入摘要。

xml

上載的 XML 檔。

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

对于上传导入:要应用到位置用户名的跨wiki前缀(如果设置了assignknownusers的话,则也包含已知用户)。

interwikisource

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

單值:
interwikipage

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

fullhistory

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

類型:布林值(詳細資訊
templates

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

類型:布林值(詳細資訊
namespace

匯入至此命名空間。無法與 rootpage 一起使用。

單值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
assignknownusers

分配編輯至所命名使用者已存在本地的本地使用者。

類型:布林值(詳細資訊
rootpage

匯入作為此頁面的子頁面。無法與 namespace 一起使用。

tags

要在导入日志,以及在导入页面的空修订版本中应用到实体的更改标签。

多值 (以 |alternative 分隔):
token

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

此參數為必填。

action=linkaccount (link)

  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

将来自第三方提供商的账户链接至当前用户。

使用此模組的一般程式是:

  1. 通過amirequestsfor=link取得來自action=query&meta=authmanagerinfo的可用欄位,和來自action=query&meta=tokenscsrf令牌。
  2. 向用戶顯示欄位,並獲得其提交的內容。
  3. 提交(POST)至此模組,提供linkreturnurl及任何相關欄位。
  4. 在回应中檢查status
    • 如果您收到了PASS(成功)或FAIL(失敗),則認為操作結束。成功與否如上句所示。
    • 如果您收到了UI,向用戶顯示新欄位,並再次獲取其提交的內容。然後再次使用linkcontinue,向本模組提交相關欄位,並重復第四步。
    • 如果您收到了REDIRECT,將使用者指向redirecttarget中的目標,等待其返回linkreturnurl。然後再次使用linkcontinue,向本模組提交返回URL中提供的一切欄位,並重復第四步。
    • 如果您收到了RESTART,這意味著身份驗證正常運作,但我們沒有連結的使用者賬戶。您可以將此看做UIFAIL
參數:
linkrequests

只使用這些身份驗證請求,透過自action=query&meta=authmanagerinfo回傳的idamirequestsfor=link,或來自此模組之前的回應。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
linkmessageformat

用於回傳訊息的格式。

單值:htmlwikitextrawnone
預設值:wikitext
linkmergerequestfields

將用於所有身份驗證請求的欄位資訊合併至一個陣列中。

類型:布林值(詳細資訊
linkreturnurl

為第三方身份驗證流程傳回URL,必須為絕對值。需要此值或linkcontinue兩者之一。

在接收REDIRECT回應時,一般狀況下您將打開瀏覽器或網站瀏覽功能到特定的redirecttarget URL以進行第三方身份驗證流程。當它完成時,第三方會將瀏覽器或網站瀏覽功能送至此URL。您應當提取任何來自URL的查詢或POST參數,並將之作為linkcontinue請求傳遞至此API模組。

linkcontinue

此請求是在先前的UIREDIRECT回應之後的後續動作。必須為此值或linkreturnurl

類型:布林值(詳細資訊
linktoken

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

此參數為必填。
*
此模組允許額外參數,取決於可用的身份驗證請求。使用action=query&meta=authmanagerinfoamirequestsfor=link(或之前來自此模組的回應,如果合適)以決定可用請求及其使用的欄位。

action=login (lg)

main | login

登入並取得身分核對 cookies

此操作只应与Special:BotPasswords一起使用;用于主账户登录的方式已弃用,并可能在没有警告的情况下失败。要安全登录主账户,请使用action=clientlogin

參數:
lgname

使用者名稱。

lgpassword

密碼。

lgdomain

網域名稱(可有可無)。

lgtoken

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

action=logout

main | logout

登出並清除 session 資料。

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

action=managetags

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

執行相關到更改標籤的管理任務。

參數:
operation

要执行哪个操作:

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

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

此參數為必填。
reason

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

ignorewarnings

是否在處理期間發生問題時忽略任何警告。

類型:布林值(詳細資訊
tags

在標籤管理日誌裡更改套用到項目的標籤。

多值 (以 |alternative 分隔):
token

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

此參數為必填。

action=mergehistory

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

合併頁面歷史

參數:
from

要合併歷史的頁面標題。不能與 fromid 一起使用。

fromid

要合併歷史的頁面之頁面 ID。不能與 from 一起使用。

類型:整數
to

要合併歷史的頁面標題。不能與 toid 一起使用。

toid

要合併歷史的頁面之頁面 ID。不能與 to 一起使用。

類型:整數
timestamp

指定时间戳,决定源页面的哪些修订历史被移动到目标页面的历史中。如果省略,源页面的所有历史记录都将被合并到目标页面。

類型:時間戳記(允許格式
reason

合併歷史的原因。

預設值:(空)
token

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

此參數為必填。

action=move

main | move
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

移動頁面。

參數:
from

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

fromid

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

類型:整數
to

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

此參數為必填。
reason

重新命名的原因。

預設值:(空)
movetalk

如果討論頁存在,變更討論頁名稱。

類型:布林值(詳細資訊
movesubpages

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

類型:布林值(詳細資訊
noredirect

不要建立重新導向。

類型:布林值(詳細資訊
watchlist

在目前使用者的監視清單中無條件地加入或移除頁面,或使用設定,或不變更監視清單。

單值:watchunwatchpreferencesnochange
預設值:preferences
ignorewarnings

忽略所有警告。

類型:布林值(詳細資訊
tags

要在移动日志,以及在目标页面的空修订版本中应用到实体的更改标签。

多值 (以 |alternative 分隔):
token

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

此參數為必填。

action=opensearch

使用 OpenSearch 協定搜尋本 wiki。

參數:
search

搜尋字串。

此參數為必填。
namespace

搜尋的命名空間。若 search 以有效的命名空間前綴為開頭則會被忽略。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
預設值:0
limit

回傳的結果數量上限。

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

$wgEnableOpenSearchSuggest設定為false,則不做任何事。

類型:布林值(詳細資訊
redirects

如何處理重定向:

return
傳回重定向本身。
resolve
傳回目標頁面,傳回的結果數目可能少於limit。

由於歷史原因,format=json的預設值為「return」,其他格式則為「resolve」。

單值:returnresolve
format

輸出的格式。

單值:jsonjsonfmxmlxmlfm
預設值:json
warningsaserror

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

類型:布林值(詳細資訊
範例:
找出以 Te 為開頭的頁面。
api.php?action=opensearch&search=Te [在沙盒中開啟]

action=options

main | options
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

更改目前使用者的偏好設定。

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

參數:
reset

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

類型:布林值(詳細資訊
resetkinds

當設定 reset 選項時,要重設的選項類型清單。

多值 (以 |alternative 分隔):registeredregistered-multiselectregistered-checkmatrixuserjsspecialunusedall
預設值:all
change

更改列表,以name=value格式化(例如skin=vector)。如果没提供值(甚至没有等号),例如optionname|otheroption|...,选项将重置为默认值。如果任何传递的值包含管道字符(|),请改用替代多值分隔符以正确操作。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
optionname

選項名稱,其應設定為由 optionvalue 所提供的值。

optionvalue

optionname 所指定,用於選項的值。

token

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

此參數為必填。

action=paraminfo

main | paraminfo

獲得有關 API 模組的資訊。

參數:
modules

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

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
helpformat

說明字串的格式。

單值:htmlwikitextrawnone
預設值:none
querymodules
已停用。

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

多值 (以 |alternative 分隔):allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallmessagesallpagesallredirectsallrevisionsalltransclusionsallusersauthmanagerinfobacklinksblockscategoriescategoryinfocategorymemberscontributorsdeletedrevisionsdeletedrevsduplicatefilesembeddedinextlinksexturlusagefilearchivefilerepoinfofileusageimageinfoimagesimageusageinfoiwbacklinksiwlinkslangbacklinkslanglinkslinkslinksherelogeventsmystashedfilespagepropnamespagepropspageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchsiteinfostashimageinfotagstemplatestokenstranscludedinusercontribsuserinfouserswatchlistwatchlistraw
上限值為 50 (機器人為 500)。
mainmodule
已停用。

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

pagesetmodule
已停用。

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

formatmodules
已停用。

格式模組名稱清單(format 參數的值)。請改用 modules

多值 (以 |alternative 分隔):jsonjsonfmnonephpphpfmrawfmxmlxmlfm

action=parse

main | parse

解析內容併回傳解析器輸出。

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

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

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

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

text

要解析的文字。使用 titlecontentmodel 來控制內容模組。

revid

修訂 ID,用於 {{REVISIONID}} 和相似變數。

類型:整數
summary

解析摘要。

page

解析此頁面的內容。不能與 texttitle 一起使用。

pageid

解析此頁面的內容。覆蓋 page

類型:整數
redirects

page 或者 pageid 被設定成重新導向,則解析它。

類型:布林值(詳細資訊
oldid

解析此修訂的內容。覆蓋 pagepageid

類型:整數
prop

要取得的資訊部份:

text
提供 wiki 文字的解析文字。
langlinks
在已解析的 wiki 文字提供語言連結。
categories
在已解析的 wiki 文字提供分類。
categorieshtml
提供分類的 HTML 版本。
links
在已解析的 wiki 文字提供內部連結。
templates
在已解析的 wiki 文字提供模板。
images
在已解析的 wiki 文字提供圖片。
externallinks
在已解析的 wiki 文字提供外部連結。
sections
在已解析的 wiki 文字提供段落。
revid
添加已解析頁面的修訂 ID。
displaytitle
添加已解析 wiki 文字的標題。
headhtml
取得頁面已解析的 <head>
modules
提供在页面中使用的ResourceLoader模块。要加载,请使用mw.loader.using()。无论jsconfigvars还是encodedjsconfigvars都必须与modules共同被请求。
jsconfigvars
针对页面提供JavaScript配置变量。要应用,请使用mw.config.set()
encodedjsconfigvars
指定頁面的 JavaScript 設置變量為 JSON 字串。
indicators
提供页面上使用的页面状态指示器的HTML。
iwlinks
在已解析的 wiki 文字提供跨 wiki 連結。
wikitext
指定被解析的原始 wiki 文字。
properties
指定多項定義在已解析原始 wiki 文字的屬性。
limitreportdata
以结构化的方式提供限制报告。如果disablelimitreport被设定则不提供数据。
limitreporthtml
提供限制报告的HTML版本。当disablelimitreport被设置时不会提供数据。
parsetree
修订内容的XML解析树(需要内容模型wikitext
parsewarnings
提供發生在解析內容時的警告。
headitems
已停用。 提供放置頁面裡的 <head> 之項目。
多值 (以 |alternative 分隔):textlanglinkscategoriescategorieshtmllinkstemplatesimagesexternallinkssectionsreviddisplaytitleheadhtmlmodulesjsconfigvarsencodedjsconfigvarsindicatorsiwlinkswikitextpropertieslimitreportdatalimitreporthtmlparsetreeparsewarningsheaditems
預設值:text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
wrapoutputclass

要用于包裹解析输出的CSS类。

預設值:mw-parser-output
pst

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

類型:布林值(詳細資訊
onlypst

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

類型:布林值(詳細資訊
effectivelanglinks
已停用。

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

類型:布林值(詳細資訊
section

只解析此段数的内容。

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

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

sectiontitle

sectionnew时新段落标题。

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

disablepp
已停用。

請改用disablelimitreport

類型:布林值(詳細資訊
disablelimitreport

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

類型:布林值(詳細資訊
disableeditsection

從解析輸出內容省略編輯段落連結。

類型:布林值(詳細資訊
disabletidy
已停用。

不要在解析輸出裡執行 HTML 內容清理(例如使用 tidy 軟體工具)

類型:布林值(詳細資訊
disablestylededuplication

不要在解析器输出中删除重复的行内样式表。

類型:布林值(詳細資訊
generatexml
已停用。

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

類型:布林值(詳細資訊
preview

在預覽模式下解析。

類型:布林值(詳細資訊
sectionpreview

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

類型:布林值(詳細資訊
disabletoc

在輸出裡忽略目錄。

類型:布林值(詳細資訊
useskin

为解析器输出应用选择的皮肤。会影响以下属性:langlinksheaditemsmodulesjsconfigvarsindicators

單值:colognebluemodernmonobookmoztwvector
contentformat

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

單值:text/x-wikitext/javascriptapplication/jsontext/csstext/plain
contentmodel

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

單值:wikitextjavascriptjsoncsstext

action=patrol

main | patrol
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

巡查頁面或修訂。

參數:
rcid

要巡查的最近變更 ID。

類型:整數
revid

要巡查的修訂 ID。

類型:整數
tags

在巡查日誌裡更改套用到項目的標籤。

多值 (以 |alternative 分隔):
token

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

此參數為必填。

action=protect

main | protect
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

變更頁面的保護層級。

參數:
title

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

pageid

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

類型:整數
protections

保護層級清單,格式為 action=level (例如 edit=sysop)。all 層級代表所有人都可以進行行動,亦即無限制。

注意:未列入清單項目的限制皆會移除。

此參數為必填。
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
expiry

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

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
預設值:infinite
reason

(解除)保護的原因。

預設值:(空)
tags

修改標籤以套用於保護日誌裡的項目。

多值 (以 |alternative 分隔):
cascade

啟用連鎖保護(也就是保護包含於此頁面的頁面)。如果所有提供的保護等級不支援連鎖,就將其忽略。

類型:布林值(詳細資訊
watch
已停用。

如果被設定,就將被(解除)保護的頁面加至目前使用者的監視列表。

類型:布林值(詳細資訊
watchlist

無條件地將該頁面加入至或移除自目前使用者的監視列表、使用偏好設定或不更改監視。

單值:watchunwatchpreferencesnochange
預設值:preferences
token

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

此參數為必填。

action=purge

main | purge
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

為指定標題清除快取。

參數:
forcelinkupdate

更新連結表格。

類型:布林值(詳細資訊
forcerecursivelinkupdate

更新連結表,並更新任何使用此頁面作為模板的頁面之連結表。

類型:布林值(詳細資訊
continue

當有更多結果可用時,使用這個繼續。

titles

要使用的標題清單。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
pageids

要使用的頁面 ID 清單。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
revids

要使用的修訂 ID 清單。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
generator

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

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

allcategories
列舉所有分類。
alldeletedrevisions
依使用者或所在命名空間來列出所有已刪除的修訂。
allfileusages
列出所有檔案用途,包含不存在的。
allimages
按順序列舉所有圖片。
alllinks
列舉所有指向所指定命名空間的連結。
allpages
依序列舉在指定命名空間的所有頁面。
allredirects
列出至命名空間的所有重新導向。
allrevisions
列出所有修訂版本。
alltransclusions
列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。
backlinks
找出連結至指定頁面的所有頁面。
categories
列出頁面隸屬的所有分類。
categorymembers
在指定的分類中列出所有頁面。
deletedrevisions
取得已刪除修訂的資訊。
duplicatefiles
根据哈希值列出此给定文件的所有副本。
embeddedin
查找所有嵌入指定标题的页面。
exturlusage
列舉包含指定 URL 的頁面。
fileusage
尋找使用到指定檔案的所有頁面。
images
回傳指定頁面中包含的所有檔案。
imageusage
尋找使用到指定圖片標題的所有頁面。
iwbacklinks
找出連結至指定跨 wiki 連結的所有頁面。
langbacklinks
找出連結至指定語言連結的所有頁面。
links
回傳指定頁面的所有連結。
linkshere
找出連結至指定頁面的所有頁面。
pageswithprop
列出使用到指定頁面屬性的所有頁面。
prefixsearch
執行頁面標題的前綴搜尋。
protectedtitles
列出所有被限制创建的标题。
querypage
取得透過特殊頁面 QueryPage-based 所提供的清單。
random
取得隨機頁面集合
recentchanges
列舉出最近變更。
redirects
回傳連結至指定頁面的所有重新導向。
revisions
取得修訂的資訊。
search
執行全文搜尋。
templates
回傳指定頁面中所有引用的頁面。
transcludedin
找出嵌入至指定頁面的所有頁面。
watchlist
在当前用户的监视列表中获取对页面的最近更改。
watchlistraw
列出在目前使用者的監視清單裡頭所有頁面。
單值:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

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

類型:布林值(詳細資訊
converttitles

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

類型:布林值(詳細資訊

action=query

main | query

擷取來自及有關MediaWiki的數據。

所有数据修改须首先使用查询来获得令牌,以阻止来自恶意网站的滥用行为。

參數:
prop

替已查詢頁面所要取得的屬性。

categories
列出頁面隸屬的所有分類。
categoryinfo
回傳有關指定分類的資訊。
contributors
获取对一个页面的登录贡献者列表和匿名贡献数。
deletedrevisions
取得已刪除修訂的資訊。
duplicatefiles
根据哈希值列出此给定文件的所有副本。
extlinks
回傳所有指定頁面的外部 URL (非 interwiki)。
fileusage
尋找使用到指定檔案的所有頁面。
imageinfo
回傳檔案資訊與上傳日誌。
images
回傳指定頁面中包含的所有檔案。
info
取得基本頁面訊息。
iwlinks
回傳指定頁面的所有 interwiki 連結。
langlinks
回傳指定頁面的所有跨語言連結。
links
回傳指定頁面的所有連結。
linkshere
找出連結至指定頁面的所有頁面。
pageprops
获取页面内容中定义的各种页面属性。
redirects
回傳連結至指定頁面的所有重新導向。
revisions
取得修訂的資訊。
stashimageinfo
回傳多筆儲藏檔案的檔案資訊。
templates
回傳指定頁面中所有引用的頁面。
transcludedin
找出嵌入至指定頁面的所有頁面。
多值 (以 |alternative 分隔):categoriescategoryinfocontributorsdeletedrevisionsduplicatefilesextlinksfileusageimageinfoimagesinfoiwlinkslanglinkslinkslinksherepagepropsredirectsrevisionsstashimageinfotemplatestranscludedin
list

要取得的清單。

allcategories
列舉所有分類。
alldeletedrevisions
依使用者或所在命名空間來列出所有已刪除的修訂。
allfileusages
列出所有檔案用途,包含不存在的。
allimages
按順序列舉所有圖片。
alllinks
列舉所有指向所指定命名空間的連結。
allpages
依序列舉在指定命名空間的所有頁面。
allredirects
列出至命名空間的所有重新導向。
allrevisions
列出所有修訂版本。
alltransclusions
列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。
allusers
列舉所有已註冊使用者。
backlinks
找出連結至指定頁面的所有頁面。
blocks
列出所有被封鎖使用者與 IP 位址。
categorymembers
在指定的分類中列出所有頁面。
embeddedin
查找所有嵌入指定标题的页面。
exturlusage
列舉包含指定 URL 的頁面。
filearchive
依序列舉所有已刪除檔案。
imageusage
尋找使用到指定圖片標題的所有頁面。
iwbacklinks
找出連結至指定跨 wiki 連結的所有頁面。
langbacklinks
找出連結至指定語言連結的所有頁面。
logevents
從日誌中獲取事件。
mystashedfiles
获取当前用户上传暂存库中的文件列表。
pagepropnames
列出所有在 wiki 使用的頁面屬性名稱。
pageswithprop
列出使用到指定頁面屬性的所有頁面。
prefixsearch
執行頁面標題的前綴搜尋。
protectedtitles
列出所有被限制创建的标题。
querypage
取得透過特殊頁面 QueryPage-based 所提供的清單。
random
取得隨機頁面集合
recentchanges
列舉出最近變更。
search
執行全文搜尋。
tags
列出變更標記。
usercontribs
按使用者來取得所有編輯。
users
取得有關使用者清單的資訊。
watchlist
在当前用户的监视列表中获取对页面的最近更改。
watchlistraw
列出在目前使用者的監視清單裡頭所有頁面。
deletedrevs
已停用。 列出已刪除的修訂。
多值 (以 |alternative 分隔):allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsallusersbacklinksblockscategorymembersembeddedinexturlusagefilearchiveimageusageiwbacklinkslangbacklinkslogeventsmystashedfilespagepropnamespageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangessearchtagsusercontribsuserswatchlistwatchlistrawdeletedrevs
meta

要取得的詮釋資料。

allmessages
返回來自該網站的訊息。
authmanagerinfo
取得目前身分核對狀態的資訊。
filerepoinfo
回傳有關在 wiki 上圖片儲存庫的詮釋資料。
siteinfo
回傳有關站台的一般資訊。
tokens
获取可修改数据的操作的令牌。
userinfo
取得目前使用者的資訊。
多值 (以 |alternative 分隔):allmessagesauthmanagerinfofilerepoinfositeinfotokensuserinfo
indexpageids

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

類型:布林值(詳細資訊
export

匯出所有指定或已產生頁面的目前修訂。

類型:布林值(詳細資訊
exportnowrap

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

類型:布林值(詳細資訊
iwurl

若標題是跨 wiki 連結,是否取得完整的 URL。

類型:布林值(詳細資訊
continue

當有更多結果可用時,使用這個繼續。

rawcontinue

回傳原始的 query-continue 資料來繼續。

類型:布林值(詳細資訊
titles

要使用的標題清單。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
pageids

要使用的頁面 ID 清單。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
revids

要使用的修訂 ID 清單。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
generator

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

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

allcategories
列舉所有分類。
alldeletedrevisions
依使用者或所在命名空間來列出所有已刪除的修訂。
allfileusages
列出所有檔案用途,包含不存在的。
allimages
按順序列舉所有圖片。
alllinks
列舉所有指向所指定命名空間的連結。
allpages
依序列舉在指定命名空間的所有頁面。
allredirects
列出至命名空間的所有重新導向。
allrevisions
列出所有修訂版本。
alltransclusions
列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。
backlinks
找出連結至指定頁面的所有頁面。
categories
列出頁面隸屬的所有分類。
categorymembers
在指定的分類中列出所有頁面。
deletedrevisions
取得已刪除修訂的資訊。
duplicatefiles
根据哈希值列出此给定文件的所有副本。
embeddedin
查找所有嵌入指定标题的页面。
exturlusage
列舉包含指定 URL 的頁面。
fileusage
尋找使用到指定檔案的所有頁面。
images
回傳指定頁面中包含的所有檔案。
imageusage
尋找使用到指定圖片標題的所有頁面。
iwbacklinks
找出連結至指定跨 wiki 連結的所有頁面。
langbacklinks
找出連結至指定語言連結的所有頁面。
links
回傳指定頁面的所有連結。
linkshere
找出連結至指定頁面的所有頁面。
pageswithprop
列出使用到指定頁面屬性的所有頁面。
prefixsearch
執行頁面標題的前綴搜尋。
protectedtitles
列出所有被限制创建的标题。
querypage
取得透過特殊頁面 QueryPage-based 所提供的清單。
random
取得隨機頁面集合
recentchanges
列舉出最近變更。
redirects
回傳連結至指定頁面的所有重新導向。
revisions
取得修訂的資訊。
search
執行全文搜尋。
templates
回傳指定頁面中所有引用的頁面。
transcludedin
找出嵌入至指定頁面的所有頁面。
watchlist
在当前用户的监视列表中获取对页面的最近更改。
watchlistraw
列出在目前使用者的監視清單裡頭所有頁面。
單值:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

自动解决在query+titlesquery+pageidsquery+revids,以及在由query+generator返回的页面中的重定向。

類型:布林值(詳細資訊
converttitles

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

類型:布林值(詳細資訊

prop=categories (cl)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

列出頁面隸屬的所有分類。

參數:
clprop

為各分類所要取得的額外屬性:

sortkey
为每个分类添加关键词(十六进制字符串)和关键词前缀(人类可读部分)。
timestamp
添加當添加分類時的時間戳記。
hidden
標記由 __HIDDENCAT__ 隱藏的分類。
多值 (以 |alternative 分隔):sortkeytimestamphidden
clshow

要顯示出的分類種類。

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

要回傳的分類數量。

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

當有更多結果可用時,使用這個繼續。

clcategories

僅列出這些分類。在檢查某一分類裡是否擁有某一頁面時很有用。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
cldir

列出時所採用的方向。

單值:ascendingdescending
預設值: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

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

多值 (以 |alternative 分隔):botsysopinterface-adminbureaucratemailconfirmed
pcexcludegroup

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

多值 (以 |alternative 分隔):botsysopinterface-adminbureaucratemailconfirmed
pcrights

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

多值 (以 |alternative 分隔):apihighlimitsapplychangetagsautoconfirmedautocreateaccountautopatrolbigdeleteblockblockemailbotbrowsearchivechangetagscreateaccountcreatepagecreatetalkdeletedeletechangetagsdeletedhistorydeletedtextdeletelogentrydeleterevisionediteditcontentmodeleditinterfaceeditprotectededitmyoptionseditmyprivateinfoeditmyusercsseditmyuserjsoneditmyuserjseditmywatchlisteditsemiprotectededitsitecsseditsitejsoneditsitejseditusercssedituserjsonedituserjshideuserimportimportuploadipblock-exemptmanagechangetagsmarkboteditsmergehistoryminoreditmovemovefilemove-categorypagesmove-rootuserpagesmove-subpagesnominornewtalknoratelimitoverride-export-depthpagelangpatrolpatrolmarksprotectpurgereadreuploadreupload-ownreupload-sharedrollbacksendemailsiteadminsuppressionlogsuppressredirectsuppressrevisionunblockselfundeleteunwatchedpagesuploadupload_by_urluserrightsuserrights-interwikiviewmyprivateinfoviewmywatchlistviewsuppressedwriteapinukedeletebatchdeletebatch-spoofskipcaptcharenameuser
上限值為 50 (機器人為 500)。
pcexcluderights

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

多值 (以 |alternative 分隔):apihighlimitsapplychangetagsautoconfirmedautocreateaccountautopatrolbigdeleteblockblockemailbotbrowsearchivechangetagscreateaccountcreatepagecreatetalkdeletedeletechangetagsdeletedhistorydeletedtextdeletelogentrydeleterevisionediteditcontentmodeleditinterfaceeditprotectededitmyoptionseditmyprivateinfoeditmyusercsseditmyuserjsoneditmyuserjseditmywatchlisteditsemiprotectededitsitecsseditsitejsoneditsitejseditusercssedituserjsonedituserjshideuserimportimportuploadipblock-exemptmanagechangetagsmarkboteditsmergehistoryminoreditmovemovefilemove-categorypagesmove-rootuserpagesmove-subpagesnominornewtalknoratelimitoverride-export-depthpagelangpatrolpatrolmarksprotectpurgereadreuploadreupload-ownreupload-sharedrollbacksendemailsiteadminsuppressionlogsuppressredirectsuppressrevisionunblockselfundeleteunwatchedpagesuploadupload_by_urluserrightsuserrights-interwikiviewmyprivateinfoviewmywatchlistviewsuppressedwriteapinukedeletebatchdeletebatch-spoofskipcaptcharenameuser
上限值為 50 (機器人為 500)。
pclimit

要回傳的貢獻人員數量。

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

當有更多結果可用時,使用這個繼續。

prop=deletedrevisions (drv)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

取得已刪除修訂的資訊。

可在很多途径中使用:

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

各修訂所要取得的屬性:

ids
修訂 ID。
flags
修訂標籤(小修改)。
timestamp
修訂的時間戳記。
user
做出修訂的使用者。
userid
修訂創建者的使用者 ID
size
修訂的長度(位元組)。
slotsize
每次修订间隔的长度(字节)。
sha1
修訂的 SHA-1(base 16)。
slotsha1
每次修订间隔的SHA-1(base 16)。
contentmodel
每次修订间隔的内容模型ID。
comment
由用户对修订做出的摘要。
parsedcomment
由用户对修订做出的被解析的摘要。
content
每次修订间隔的内容。
tags
修訂標籤。
roles
List content slot roles that exist in the revision.
parsetree
已停用。 请改用action=expandtemplatesaction=parse。修订内容的XML解析树(需要内容模型wikitext)。
多值 (以 |alternative 分隔):idsflagstimestampuseruseridsizeslotsizesha1slotsha1contentmodelcommentparsedcommentcontenttagsrolesparsetree
預設值:ids|timestamp|flags|comment|user
drvslots

Which revision slots to return data for, when slot-related properties are included in drvprops. If omitted, data from the main slot will be returned in a backwards-compatible format.

多值 (以 |alternative 分隔):main
要指定所有值,請使用*
drvlimit

限制所回傳的修訂數量。

不允許超過 500 (機器人為 5,000)。
類型:整數或max
drvexpandtemplates
已停用。

请改用action=expandtemplates。展开修订内容中的模板(需要drvprop=content)。

類型:布林值(詳細資訊
drvgeneratexml
已停用。

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

類型:布林值(詳細資訊
drvparse
已停用。

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

類型:布林值(詳細資訊
drvsection

只检索此段落数的内容。

drvdiffto
已停用。

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

drvdifftotext
已停用。

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

drvdifftotextpst
已停用。

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

類型:布林值(詳細資訊
drvcontentformat
已停用。

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

單值:text/x-wikitext/javascriptapplication/jsontext/csstext/plain
drvstart

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

類型:時間戳記(允許格式
drvend

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

類型:時間戳記(允許格式
drvdir

列舉的方向:

newer
最舊的優先。注意:drvstart應在drvend之前。
older
最新的優先(預設)。注意:drvstart應在drvend之後。
單值:newerolder
預設值:older
drvtag

僅列出以此標籤所標記的修訂。

drvuser

此列出由該使用者作出的修訂。

類型:使用者名稱
drvexcludeuser

不要列出由該使用者作出的修訂。

類型:使用者名稱
drvcontinue

當有更多結果可用時,使用這個繼續。

prop=duplicatefiles (df)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

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

參數:
dflimit

要回傳的重複檔案數量。

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

當有更多結果可用時,使用這個繼續。

dfdir

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending
dflocalonly

僅查看在本地端儲存庫的檔案。

類型:布林值(詳細資訊
main | query | extlinks

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

參數:
ellimit

要回傳的連結數量。

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

當有更多結果可用時,使用這個繼續。

類型:整數
elprotocol

URL 協定。若為空且有設定 elquery,會是 http 協定。將此與 elquery 一同留空會列出所有外部連結。

單值:可以空白,或 bitcoinftpftpsgeogitgopherhttphttpsircircsmagnetmailtommsnewsnntpredissftpsipsipssmssshsvnteltelneturnworldwindxmpp
預設值:(空)
elquery

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

elexpandurl

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

類型:布林值(詳細資訊
範例:
取得 Main Page 的外部連結清單。
api.php?action=query&prop=extlinks&titles=Main%20Page [在沙盒中開啟]

prop=fileusage (fu)

main | query | fileusage
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

尋找使用到指定檔案的所有頁面。

參數:
fuprop

要取得的屬性。

pageid
各頁面的頁面 ID。
title
各頁面的標題。
redirect
若頁面為重新導向,則做出標記。
多值 (以 |alternative 分隔):pageidtitleredirect
預設值:pageid|title|redirect
funamespace

僅包含這些命名空間的頁面。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
fushow

僅顯示符合這些準則的項目:

redirect:僅顯示重新導向。
!redirect:僅顯示非重新導向。
多值 (以 |alternative 分隔):redirect!redirect
fulimit

要回傳的數量。

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

當有更多結果可用時,使用這個繼續。

prop=imageinfo (ii)

main | query | imageinfo

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

參數:
iiprop

要取得的檔案資訊:

timestamp
添加上傳版本的時間戳記。
user
添加上傳了各檔案版本的使用者。
userid
添加上傳了各檔案版本的使用者 ID。
comment
版本的註釋。
parsedcomment
解析版本上的註釋。
canonicaltitle
添加檔案的規範標題。
url
提供檔案與描述頁面的 URL。
size
添加文件大小(字节)及其高度、宽度和页面数(如果可以)。
dimensions
用于大小的别名。
sha1
替檔案添加 SHA-1 雜湊值。
mime
替檔案添加 MIME 類型。
thumbmime
添加圖片縮圖的 MIME 類型(需要 url 與參數 iiurlwidth)。
mediatype
添加檔案的媒體類型。
metadata
列出檔案版本的 Exif 詮釋資料。
commonmetadata
列出檔案版本的檔案格式通用詮釋資料。
extmetadata
列出结合自多个来源的格式化的元数据。结果均依HTML格式化。
archivename
添加非最新版本的存檔版本檔案名稱。
bitdepth
添加版本的位元深度。
uploadwarning
由 Special:Upload 頁面所使用來取得有關現有檔案的資訊。不適用於 MediaWiki 核心之外。
badfile
無論檔案是否在 MediaWiki:Bad image list 都添加
多值 (以 |alternative 分隔):timestampuseruseridcommentparsedcommentcanonicaltitleurlsizedimensionssha1mimethumbmimemediatypemetadatacommonmetadataextmetadataarchivenamebitdepthuploadwarningbadfile
預設值:timestamp|user
iilimit

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

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

列出的起始時間戳記。

類型:時間戳記(允許格式
iiend

列出的終止時間戳記。

類型:時間戳記(允許格式
iiurlwidth

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

類型:整數
預設值:-1
iiurlheight

與 iiurlwidth 相似。

類型:整數
預設值:-1
iimetadataversion

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

預設值:1
iiextmetadatalanguage

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

預設值:zh-tw
iiextmetadatamultilang

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

類型:布林值(詳細資訊
iiextmetadatafilter

若有指定且非空,僅會為 iiprop=extmetadata 回傳這些鍵。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
iiurlparam

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

預設值:(空)
iibadfilecontexttitle

如果badfilecontexttitleprop=badfile被设置,这会是在评估MediaWiki:Bad image list时使用的页面标题

iicontinue

當有更多結果可用時,使用這個繼續。

iilocalonly

僅查看在本地端儲存庫的檔案。

類型:布林值(詳細資訊

prop=images (im)

main | query | images
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

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

參數:
imlimit

要回傳的檔案數量。

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

當有更多結果可用時,使用這個繼續。

imimages

僅列出這些檔案。在檢查某一頁面是否擁有某一檔案時很有用。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
imdir

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending

prop=info (in)

main | query | info

取得基本頁面訊息。

參數:
inprop

要取得的額外屬性:

protection
列出各頁面的保護層級。
talkid
各非對話頁的對話頁頁面 ID。
watched
列出各頁面的監視狀態。
watchers
監視者的數目,如有允許的話。
visitingwatchers
有訪問頁面近期編輯數的各頁面監視者數目,如有允許的話。
notificationtimestamp
各頁面的監視清單通知時間戳記。
subjectid
各對話頁的父頁面頁面 ID。
url
为每个页面提供一个完整URL、一个编辑URL和规范URL。
readable
已停用。 使用者是否可閱讀此頁面。
preload
取得由 EditFormPreloadText 回傳的文字。
displaytitle
在页面标题实际显示的地方提供方式。
varianttitles
提供网站内容语言所有变体的显示标题。
多值 (以 |alternative 分隔):protectiontalkidwatchedwatchersvisitingwatchersnotificationtimestampsubjectidurlreadablepreloaddisplaytitlevarianttitles
intestactions

測試目前使用者是否可執行頁面上的某項操作。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
intestactionsdetail

Detail level for intestactions. Use the main module's errorformat and errorlang parameters to control the format of the messages returned.

boolean
Return a boolean value for each action.
full
Return messages describing why the action is disallowed, or an empty array if it is allowed.
quick
Like full but skipping expensive checks.
單值:booleanfullquick
預設值:boolean
intoken
已停用。

請改用 action=query&meta=tokens

多值 (以 |alternative 分隔):editdeleteprotectmoveblockunblockemailimportwatch
incontinue

當有更多結果可用時,使用這個繼續。

main | query | iwlinks

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

參數:
iwprop

為各跨語言連結所要取得的額外屬性:

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

僅回傳帶有此前綴的跨 wiki 連結。

iwtitle

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

iwdir

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending
iwlimit

要回傳的跨 Wiki 連結數量。

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

當有更多結果可用時,使用這個繼續。

iwurl
已停用。

是否取得完整的 URL(不能與 iwprop 一同使用)。

類型:布林值(詳細資訊
範例:
從頁面 Main Page 取得跨 wiki 連結。
api.php?action=query&prop=iwlinks&titles=Main%20Page [在沙盒中開啟]
main | query | langlinks

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

參數:
llprop

為各跨語言連結所要取得的額外屬性:

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

僅回傳帶有此語言代碼的語言連結。

lltitle

要搜尋的連結。必須與 lllang 一起使用。

lldir

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending
llinlanguagecode

用於本地化語言名稱的語言代碼。

預設值:zh-tw
lllimit

要回傳的 langlinks 數量。

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

當有更多結果可用時,使用這個繼續。

llurl
已停用。

是否取得完整的 URL(不能與 llprop 一同使用)。

類型:布林值(詳細資訊
main | query | links
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

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

參數:
plnamespace

僅顯示在這些命名空間的連結。

多值 (以 |alternative 分隔):-2、-1、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
pllimit

要回傳的連結數量。

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

當有更多結果可用時,使用這個繼續。

pltitles

僅列出至這些標題的連結。在檢查某一頁面是否連結至某一標題時很有用。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
pldir

列出時所採用的方向。

單值:ascendingdescending
預設值: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
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

找出連結至指定頁面的所有頁面。

參數:
lhprop

要取得的屬性。

pageid
各頁面的頁面 ID。
title
各頁面的標題。
redirect
若頁面為重新導向,則做出標記。
多值 (以 |alternative 分隔):pageidtitleredirect
預設值:pageid|title|redirect
lhnamespace

僅包含這些命名空間的頁面。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
lhshow

僅顯示符合這些準則的項目:

redirect:僅顯示重新導向。
!redirect:僅顯示非重新導向。
多值 (以 |alternative 分隔):redirect!redirect
lhlimit

要回傳的數量。

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

當有更多結果可用時,使用這個繼續。

prop=pageprops (pp)

main | query | pageprops

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

參數:
ppcontinue

當有更多結果可用時,使用這個繼續。

ppprop

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

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
範例:
取得頁面 Main PageMediaWiki 的屬性。
api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki [在沙盒中開啟]

prop=redirects (rd)

main | query | redirects
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

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

參數:
rdprop

要取得的屬性。

pageid
各重新導向的頁面 ID。
title
各重新導向的標題。
fragment
各重新導向的片段,若有的話。
多值 (以 |alternative 分隔):pageidtitlefragment
預設值:pageid|title
rdnamespace

僅包含這些命名空間的頁面。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
rdshow

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

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

要回傳的重新導向數量。

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

當有更多結果可用時,使用這個繼續。

prop=revisions (rv)

main | query | revisions
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

取得修訂的資訊。

可用于以下几个方面:

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

各修訂所要取得的屬性:

ids
修訂 ID。
flags
修訂標籤(小修改)。
timestamp
修訂的時間戳記。
user
做出修訂的使用者。
userid
修訂創建者的使用者 ID
size
修訂的長度(位元組)。
slotsize
每次修订间隔的长度(字节)。
sha1
修訂的 SHA-1(base 16)。
slotsha1
每次修订间隔的SHA-1(base 16)。
contentmodel
每次修订间隔的内容模型ID。
comment
由用户对修订做出的摘要。
parsedcomment
由用户对修订做出的被解析的摘要。
content
每次修订间隔的内容。
tags
修訂標籤。
roles
List content slot roles that exist in the revision.
parsetree
已停用。 请改用action=expandtemplatesaction=parse。修订内容的XML解析树(需要内容模型wikitext)。
多值 (以 |alternative 分隔):idsflagstimestampuseruseridsizeslotsizesha1slotsha1contentmodelcommentparsedcommentcontenttagsrolesparsetree
預設值:ids|timestamp|flags|comment|user
rvslots

Which revision slots to return data for, when slot-related properties are included in rvprops. If omitted, data from the main slot will be returned in a backwards-compatible format.

多值 (以 |alternative 分隔):main
要指定所有值,請使用*
rvlimit

限制所回傳的修訂數量。

僅能在單一頁面使用(模式 #2)。
不允許超過 500 (機器人為 5,000)。
類型:整數或max
rvexpandtemplates
已停用。

请改用action=expandtemplates。展开修订内容中的模板(需要rvprop=content)。

類型:布林值(詳細資訊
rvgeneratexml
已停用。

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

類型:布林值(詳細資訊
rvparse
已停用。

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

類型:布林值(詳細資訊
rvsection

只检索此段落数的内容。

rvdiffto
已停用。

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

rvdifftotext
已停用。

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

rvdifftotextpst
已停用。

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

類型:布林值(詳細資訊
rvcontentformat
已停用。

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

單值:text/x-wikitext/javascriptapplication/jsontext/csstext/plain
rvstartid

从这个修订版本时间戳开始列举。修订版本必须存在,但未必与该页面相关。

僅能在單一頁面使用(模式 #2)。
類型:整數
rvendid

在这个修订版本时间戳停止列举。修订版本必须存在,但未必与该页面相关。

僅能在單一頁面使用(模式 #2)。
類型:整數
rvstart

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

僅能在單一頁面使用(模式 #2)。
類型:時間戳記(允許格式
rvend

列舉至此的時間戳記。

僅能在單一頁面使用(模式 #2)。
類型:時間戳記(允許格式
rvdir

列舉的方向:

newer
最舊的優先。注意:rvstart應在rvend之前。
older
最新的優先(預設)。注意:rvstart應在rvend之後。
僅能在單一頁面使用(模式 #2)。
單值:newerolder
預設值:older
rvuser

僅包含由使用者做出的修訂。

僅能在單一頁面使用(模式 #2)。
類型:使用者名稱
rvexcludeuser

不包含由使用者做出的修訂。

僅能在單一頁面使用(模式 #2)。
類型:使用者名稱
rvtag

僅列出以此標籤所標記的修訂。

rvtoken
已停用。

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

多值 (以 |alternative 分隔):rollback
rvcontinue

當有更多結果可用時,使用這個繼續。

prop=stashimageinfo (sii)

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

參數:
siifilekey

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

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
siisessionkey
已停用。

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

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
siiprop

要取得的檔案資訊:

timestamp
添加上傳版本的時間戳記。
canonicaltitle
添加檔案的規範標題。
url
提供檔案與描述頁面的 URL。
size
添加文件大小(字节)及其高度、宽度和页面数(如果可以)。
dimensions
用于大小的别名。
sha1
替檔案添加 SHA-1 雜湊值。
mime
替檔案添加 MIME 類型。
thumbmime
添加圖片縮圖的 MIME 類型(需要 url 與參數 siiurlwidth)。
metadata
列出檔案版本的 Exif 詮釋資料。
commonmetadata
列出檔案版本的檔案格式通用詮釋資料。
extmetadata
列出结合自多个来源的格式化的元数据。结果均依HTML格式化。
bitdepth
添加版本的位元深度。
badfile
無論檔案是否在 MediaWiki:Bad image list 都添加
多值 (以 |alternative 分隔):timestampcanonicaltitleurlsizedimensionssha1mimethumbmimemetadatacommonmetadataextmetadatabitdepthbadfile
預設值:timestamp|url
siiurlwidth

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

類型:整數
預設值:-1
siiurlheight

與 siiurlwidth 相似。

類型:整數
預設值:-1
siiurlparam

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

預設值:(空)

prop=templates (tl)

main | query | templates
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

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

參數:
tlnamespace

僅顯示在這些命名空間的模板。

多值 (以 |alternative 分隔):-2、-1、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
tllimit

要回傳的模板數量。

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

當有更多結果可用時,使用這個繼續。

tltemplates

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

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
tldir

列出時所採用的方向。

單值:ascendingdescending
預設值: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)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

找出嵌入至指定頁面的所有頁面。

參數:
tiprop

要取得的屬性。

pageid
各頁面的頁面 ID。
title
各頁面的標題。
redirect
若頁面為重新導向,則做出標記。
多值 (以 |alternative 分隔):pageidtitleredirect
預設值:pageid|title|redirect
tinamespace

僅包含這些命名空間的頁面。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
tishow

僅顯示符合這些準則的項目:

redirect:僅顯示重新導向。
!redirect:僅顯示非重新導向。
多值 (以 |alternative 分隔):redirect!redirect
tilimit

回傳的數量。

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

當有更多結果可用時,使用這個繼續。

list=allcategories (ac)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

列舉所有分類。

參數:
acfrom

起始列舉的分類。

accontinue

當有更多結果可用時,使用這個繼續。

acto

終止列舉的分類。

acprefix

搜尋以此值為開頭的所有分類標題。

acdir

排序的方向。

單值:ascendingdescending
預設值:ascending
acmin

僅回傳至少有這樣多成員的分類。

類型:整數
acmax

僅回傳最多有這樣多成員的分類。

類型:整數
aclimit

要回傳的分類數量。

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

要取得的屬性。

size
在分類裡添加頁面數。
hidden
標記由 __HIDDENCAT__ 隱藏的分類。
多值 (以 |alternative 分隔):sizehidden
預設值:(空)
範例:
列出分类及其含有多少页面的信息。
api.php?action=query&list=allcategories&acprop=size [在沙盒中開啟]
为以List的分类检索有关分类页面本身的信息。
api.php?action=query&generator=allcategories&gacprefix=List&prop=info [在沙盒中開啟]

list=alldeletedrevisions (adr)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

依使用者或所在命名空間來列出所有已刪除的修訂。

參數:
adrprop

各修訂所要取得的屬性:

ids
修訂 ID。
flags
修訂標籤(小修改)。
timestamp
修訂的時間戳記。
user
做出修訂的使用者。
userid
修訂創建者的使用者 ID
size
修訂的長度(位元組)。
slotsize
每次修订间隔的长度(字节)。
sha1
修訂的 SHA-1(base 16)。
slotsha1
每次修订间隔的SHA-1(base 16)。
contentmodel
每次修订间隔的内容模型ID。
comment
由用户对修订做出的摘要。
parsedcomment
由用户对修订做出的被解析的摘要。
content
每次修订间隔的内容。
tags
修訂標籤。
roles
List content slot roles that exist in the revision.
parsetree
已停用。 请改用action=expandtemplatesaction=parse。修订内容的XML解析树(需要内容模型wikitext)。
多值 (以 |alternative 分隔):idsflagstimestampuseruseridsizeslotsizesha1slotsha1contentmodelcommentparsedcommentcontenttagsrolesparsetree
預設值:ids|timestamp|flags|comment|user
adrslots

Which revision slots to return data for, when slot-related properties are included in adrprops. If omitted, data from the main slot will be returned in a backwards-compatible format.

多值 (以 |alternative 分隔):main
要指定所有值,請使用*
adrlimit

限制所回傳的修訂數量。

不允許超過 500 (機器人為 5,000)。
類型:整數或max
adrexpandtemplates
已停用。

请改用action=expandtemplates。展开修订内容中的模板(需要adrprop=content)。

類型:布林值(詳細資訊
adrgeneratexml
已停用。

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

類型:布林值(詳細資訊
adrparse
已停用。

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

類型:布林值(詳細資訊
adrsection

只检索此段落数的内容。

adrdiffto
已停用。

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

adrdifftotext
已停用。

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

adrdifftotextpst
已停用。

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

類型:布林值(詳細資訊
adrcontentformat
已停用。

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

單值:text/x-wikitext/javascriptapplication/jsontext/csstext/plain
adruser

此列出由該使用者作出的修訂。

類型:使用者名稱
adrnamespace

僅列出此命名空間的頁面。

多值 (以 |alternative 分隔):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之後。
單值:newerolder
預設值:older
adrfrom

在此標題開始列出。

不能與 adruser 一同使用。
adrto

在此標題停止列出。

不能與 adruser 一同使用。
adrprefix

搜尋以此值為開頭的所有頁面標題。

不能與 adruser 一同使用。
adrexcludeuser

不要列出由該使用者作出的修訂。

不能與 adruser 一同使用。
類型:使用者名稱
adrtag

僅列出以此標籤所標記的修訂。

adrcontinue

當有更多結果可用時,使用這個繼續。

adrgeneratetitles

當作為產生器時使用,產生標題而非修訂 ID。

類型:布林值(詳細資訊

list=allfileusages (af)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

列出所有檔案用途,包含不存在的。

參數:
afcontinue

當有更多結果可用時,使用這個繼續。

affrom

要起始列舉的檔案標題。

afto

要終止列舉的檔案標題。

afprefix

搜尋以此值為開頭的所有檔案標題。

afunique

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

類型:布林值(詳細資訊
afprop

要包含到的資訊部份:

ids
添加使用中頁面的頁面 ID(不能與 afunique 一起使用)。
title
添加檔案標題。
多值 (以 |alternative 分隔):idstitle
預設值:title
aflimit

要回傳的項目總數。

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

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending

list=allimages (ai)

main | query | allimages
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

按順序列舉所有圖片。

參數:
aisort

作為排序順序的屬性。

單值:nametimestamp
預設值:name
aidir

列出時所採用的方向。

單值:ascendingdescendingnewerolder
預設值:ascending
aifrom

要開始列舉的圖片標題。僅能與 aisort=name 一起使用。

aito

要停止列舉的圖片標題。僅能與 aisort=name 一起使用。

aicontinue

當有更多結果可用時,使用這個繼續。

aistart

要開始列舉的時間戳記。僅能與 aisort=timestamp 一起使用。

類型:時間戳記(允許格式
aiend

要停止列舉的時間戳記。僅能與 aisort=timestamp 一起使用。

類型:時間戳記(允許格式
aiprop

要取得的檔案資訊:

timestamp
添加上傳版本的時間戳記。
user
添加上傳了各檔案版本的使用者。
userid
添加上傳了各檔案版本的使用者 ID。
comment
版本的註釋。
parsedcomment
解析版本上的註釋。
canonicaltitle
添加檔案的規範標題。
url
提供檔案與描述頁面的 URL。
size
添加文件大小(字节)及其高度、宽度和页面数(如果可以)。
dimensions
用于大小的别名。
sha1
替檔案添加 SHA-1 雜湊值。
mime
替檔案添加 MIME 類型。
mediatype
添加檔案的媒體類型。
metadata
列出檔案版本的 Exif 詮釋資料。
commonmetadata
列出檔案版本的檔案格式通用詮釋資料。
extmetadata
列出结合自多个来源的格式化的元数据。结果均依HTML格式化。
bitdepth
添加版本的位元深度。
badfile
無論檔案是否在 MediaWiki:Bad image list 都添加
多值 (以 |alternative 分隔):timestampuseruseridcommentparsedcommentcanonicaltitleurlsizedimensionssha1mimemediatypemetadatacommonmetadataextmetadatabitdepthbadfile
預設值:timestamp|url
aiprefix

搜尋所有以此值為開頭的圖片。僅能與 aisort=name 一起使用。

aiminsize

限制圖片至少要有這樣多的位元組。

類型:整數
aimaxsize

限制圖片最多只能這樣多的位元組。

類型:整數
aisha1

圖片的 SHA1 雜湊值。覆蓋 aisha1base36。

aisha1base36

以 base 36 的圖片 SHA1 雜湊值(使用在 MediaWiki)。

aiuser

僅回傳由此使用者上傳的檔案。僅能與 aisort=timestamp 一起使用,且不可與 aifilterbots 一起使用。

類型:使用者名稱
aifilterbots

如何篩選由機器人上傳的檔案。僅能與 aisort=timestamp 一起使用,且不可與 aiuser 一起使用。

單值:allbotsnobots
預設值:all
aimime

所要搜尋的 MIME 類型,例如:image/jpeg

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
ailimit

要回傳的圖片總數。

不允許超過 500 (機器人為 5,000)。
類型:整數或max
預設值:10
main | query | alllinks
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

列舉所有指向所指定命名空間的連結。

參數:
alcontinue

當有更多結果可用時,使用這個繼續。

alfrom

要起始列舉的連結標題。

alto

要終止列舉的連結標題。

alprefix

搜尋以此值為開頭的所有連結標題。

alunique

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

類型:布林值(詳細資訊
alprop

要包含的資訊部份:

ids
添加連結頁面的頁面 ID(不能與 alunique 一起使用)。
title
添加連結標題。
多值 (以 |alternative 分隔):idstitle
預設值:title
alnamespace

要列舉的命名空間。

單值:-2、-1、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
預設值:0
allimit

要回傳的項目總數。

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

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending

list=allpages (ap)

main | query | allpages
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

依序列舉在指定命名空間的所有頁面。

參數:
apfrom

起始列舉的頁面標題。

apcontinue

當有更多結果可用時,使用這個繼續。

apto

終止列舉的頁面標題。

apprefix

搜尋以此值為開頭的所有頁面標題。

apnamespace

要列舉的命名空間。

單值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
預設值:0
apfilterredir

要列出的頁面。

單值:allredirectsnonredirects
預設值:all
apminsize

限制頁面至少要有這樣多的位元組。

類型:整數
apmaxsize

限制頁面最多只能這樣多的位元組。

類型:整數
apprtype

僅限受保護的頁面。

多值 (以 |alternative 分隔):editmoveupload
apprlevel

过滤基于保护等级的保护(必须与apprtype=参数一起使用)。

多值 (以 |alternative 分隔):可以空白,或 autoconfirmedsysop
apprfiltercascade

过滤基于cascadingness的保护(当apprtype未设置时忽略)。

單值:cascadingnoncascadingall
預設值:all
aplimit

要回傳的頁面總數。

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

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending
apfilterlanglinks

过滤基于页面是否有语言链接。注意这可能不考虑由扩展添加的语言链接。

單值:withlanglinkswithoutlanglinksall
預設值:all
apprexpiry

要在页面上过滤的保护期限:

indefinite
只获取带无限期保护的页面。
definite
只获取带指定保护期限的页面。
all
获取任意保护期限的页面。
單值:indefinitedefiniteall
預設值:all

list=allredirects (ar)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

列出至命名空間的所有重新導向。

參數:
arcontinue

當有更多結果可用時,使用這個繼續。

arfrom

要起始列舉的重新導向標題。

arto

要終止列舉的重新導向標題。

arprefix

搜尋以此值為開頭的所有目標頁面。

arunique

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

類型:布林值(詳細資訊
arprop

要包含的資訊部份:

ids
添加重新導向頁面的頁面 ID(不能與 arunique 一起使用)。
title
添加重新導向的標題。
fragment
添加來自重新導向的部份(不能與 arunique 一起使用)。
interwiki
添加來自重新導向的跨 wiki 前綴(不能與 arunique 一起使用)。
多值 (以 |alternative 分隔):idstitlefragmentinterwiki
預設值:title
arnamespace

要列舉的命名空間。

單值:-2、-1、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
預設值:0
arlimit

要回傳的項目總數。

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

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending

list=allrevisions (arv)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

列出所有修訂版本。

參數:
arvprop

各修訂所要取得的屬性:

ids
修訂 ID。
flags
修訂標籤(小修改)。
timestamp
修訂的時間戳記。
user
做出修訂的使用者。
userid
修訂創建者的使用者 ID
size
修訂的長度(位元組)。
slotsize
每次修订间隔的长度(字节)。
sha1
修訂的 SHA-1(base 16)。
slotsha1
每次修订间隔的SHA-1(base 16)。
contentmodel
每次修订间隔的内容模型ID。
comment
由用户对修订做出的摘要。
parsedcomment
由用户对修订做出的被解析的摘要。
content
每次修订间隔的内容。
tags
修訂標籤。
roles
List content slot roles that exist in the revision.
parsetree
已停用。 请改用action=expandtemplatesaction=parse。修订内容的XML解析树(需要内容模型wikitext)。
多值 (以 |alternative 分隔):idsflagstimestampuseruseridsizeslotsizesha1slotsha1contentmodelcommentparsedcommentcontenttagsrolesparsetree
預設值:ids|timestamp|flags|comment|user
arvslots

Which revision slots to return data for, when slot-related properties are included in arvprops. If omitted, data from the main slot will be returned in a backwards-compatible format.

多值 (以 |alternative 分隔):main
要指定所有值,請使用*
arvlimit

限制所回傳的修訂數量。

不允許超過 500 (機器人為 5,000)。
類型:整數或max
arvexpandtemplates
已停用。

请改用action=expandtemplates。展开修订内容中的模板(需要arvprop=content)。

類型:布林值(詳細資訊
arvgeneratexml
已停用。

请改用action=expandtemplatesaction=parse。生成用于修订内容的XML解析树(需要arvprop=content;被arvprop=parsetree所取代)。

類型:布林值(詳細資訊
arvparse
已停用。

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

類型:布林值(詳細資訊
arvsection

只检索此段落数的内容。

arvdiffto
已停用。

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

arvdifftotext
已停用。

请改用action=compare。要比较修订差异的文本。只有修订的有限数字内的差异。覆盖arvdiffto。如果arvsection被设置,只有那个段落将与此文本之间比较差异

arvdifftotextpst
已停用。

请改用action=compare。在编辑文本前对其执行预保存转换。只当与arvdifftotext一起使用时有效。

類型:布林值(詳細資訊
arvcontentformat
已停用。

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

單值:text/x-wikitext/javascriptapplication/jsontext/csstext/plain
arvuser

此列出由該使用者作出的修訂。

類型:使用者名稱
arvnamespace

僅列出此命名空間的頁面。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
arvstart

起始列舉的時間戳記。

類型:時間戳記(允許格式
arvend

終止列舉的時間戳記。

類型:時間戳記(允許格式
arvdir

列舉的方向:

newer
最舊的優先。注意:arvstart應在arvend之前。
older
最新的優先(預設)。注意:arvstart應在arvend之後。
單值:newerolder
預設值:older
arvexcludeuser

不要列出由該使用者作出的修訂。

類型:使用者名稱
arvcontinue

當有更多結果可用時,使用這個繼續。

arvgeneratetitles

當作為產生器時使用,產生標題而非修訂 ID。

類型:布林值(詳細資訊
範例:
列出由使用者 Example 做出的最近 50 個貢獻。
api.php?action=query&list=allrevisions&arvuser=Example&arvlimit=50 [在沙盒中開啟]
列出在主命名空間的前 50 個修訂。
api.php?action=query&list=allrevisions&arvdir=newer&arvlimit=50 [在沙盒中開啟]

list=alltransclusions (at)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

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

參數:
atcontinue

當有更多結果可用時,使用這個繼續。

atfrom

要起始列舉的嵌入標題。

atto

要終止列舉的嵌入標題。

atprefix

搜索所有以此值开头的嵌入的标题。

atunique

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

類型:布林值(詳細資訊
atprop

要包含到的資訊部份:

ids
添加嵌入頁面的頁面 ID(不能與 atunique 一起使用)。
title
添加嵌入的標題。
多值 (以 |alternative 分隔):idstitle
預設值:title
atnamespace

要列舉的命名空間。

單值:-2、-1、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
預設值:10
atlimit

要回傳的項目總數。

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

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending

list=allusers (au)

main | query | allusers

列舉所有已註冊使用者。

參數:
aufrom

起始列舉的使用者名稱。

auto

終止列舉的使用者名稱。

auprefix

搜尋以此值為開頭的所有使用者。

audir

排序的方向。

單值:ascendingdescending
預設值:ascending
augroup

僅包含在指定群組的使用者。

多值 (以 |alternative 分隔):botsysopinterface-adminbureaucratemailconfirmed
auexcludegroup

排除指定群組中的使用者

多值 (以 |alternative 分隔):botsysopinterface-adminbureaucratemailconfirmed
aurights

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

多值 (以 |alternative 分隔):apihighlimitsapplychangetagsautoconfirmedautocreateaccountautopatrolbigdeleteblockblockemailbotbrowsearchivechangetagscreateaccountcreatepagecreatetalkdeletedeletechangetagsdeletedhistorydeletedtextdeletelogentrydeleterevisionediteditcontentmodeleditinterfaceeditprotectededitmyoptionseditmyprivateinfoeditmyusercsseditmyuserjsoneditmyuserjseditmywatchlisteditsemiprotectededitsitecsseditsitejsoneditsitejseditusercssedituserjsonedituserjshideuserimportimportuploadipblock-exemptmanagechangetagsmarkboteditsmergehistoryminoreditmovemovefilemove-categorypagesmove-rootuserpagesmove-subpagesnominornewtalknoratelimitoverride-export-depthpagelangpatrolpatrolmarksprotectpurgereadreuploadreupload-ownreupload-sharedrollbacksendemailsiteadminsuppressionlogsuppressredirectsuppressrevisionunblockselfundeleteunwatchedpagesuploadupload_by_urluserrightsuserrights-interwikiviewmyprivateinfoviewmywatchlistviewsuppressedwriteapinukedeletebatchdeletebatch-spoofskipcaptcharenameuser
上限值為 50 (機器人為 500)。
auprop

要包含的資訊部份:

blockinfo
添加有關使用者目前封鎖的資訊。
groups
列举用户所在的组。这使用更多服务器资源,并可能返回少于限制的结果。
implicitgroups
列出用户自动属于的所有组。
rights
列出使用者所擁有的權限。
editcount
添加使用者的編輯次數。
registration
如果可能,添加用户注册时的时间戳(可能为空白)。
centralids
添加中心ID并为用户附加状态。
多值 (以 |alternative 分隔):blockinfogroupsimplicitgroupsrightseditcountregistrationcentralids
aulimit

要回傳的使用者名稱總數。

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

僅列出有做過編輯的使用者。

類型:布林值(詳細資訊
auactiveusers

僅列出在最近 30 天裡活躍的使用者。

類型:布林值(詳細資訊
auattachedwiki

auprop=centralids一起使用,也表明用户是否附加于此ID定义的wiki。

main | query | backlinks
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

找出連結至指定頁面的所有頁面。

參數:
bltitle

要搜尋的標題。不能與 blpageid 一起使用。

blpageid

要搜尋的頁面 ID。不能與 bltitle 一起使用。

類型:整數
blcontinue

當有更多結果可用時,使用這個繼續。

blnamespace

要列舉的命名空間。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
bldir

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending
blfilterredir

如何过滤重定向。当blredirect被启用时如果设置为nonredirects,这只会应用到第二级。

單值:allredirectsnonredirects
預設值:all
bllimit

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

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

如果链入页面是一个重定向,则寻找所有链接至此重定向的页面。最大限制减半。

類型:布林值(詳細資訊

list=blocks (bk)

main | query | blocks

列出所有被封鎖使用者與 IP 位址。

參數:
bkstart

起始列舉的時間戳記。

類型:時間戳記(允許格式
bkend

終止列舉的時間戳記。

類型:時間戳記(允許格式
bkdir

列舉的方向:

newer
最舊的優先。注意:bkstart應在bkend之前。
older
最新的優先(預設)。注意:bkstart應在bkend之後。
單值:newerolder
預設值:older
bkids

要列出的封鎖 ID 清單(可選)。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
bkusers

要搜尋的使用者清單(可選)。

類型:使用者名稱列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
bkip

取得套用在此 IP 位址或 CIDR 範圍的所有封鎖與所包含的範圍封鎖。不可與 bkusers 一起使用。CIDR 範圍不可超過 IPv4/16 或 IPv6/19。

bklimit

能列出封鎖的最大數量。

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

要取得的屬性。

id
添加封鎖 ID。
user
添加已封鎖使用者的使用者名稱。
userid
添加已封鎖使用者的使用者 ID。
by
添加進行封鎖中的使用者之使用者名稱。
byid
添加進行封鎖中的使用者之使用者 ID。
timestamp
添加當封鎖生效的時間戳記。
expiry
添加當封鎖到期的時間戳記。
reason
添加封鎖的原因。
range
添加受封鎖影響的 IP 地址範圍。
flags
标记编辑禁止(自动封禁、仅限匿名用户等)。
多值 (以 |alternative 分隔):iduseruseridbybyidtimestampexpiryreasonrangeflags
預設值:id|user|by|timestamp|expiry|reason|flags
bkshow

只显示符合这些标准的项目。 例如,要只查看IP地址的无限期封禁,设置bkshow=ip|!temp

多值 (以 |alternative 分隔):account!accounttemp!tempip!iprange!range
bkcontinue

當有更多結果可用時,使用這個繼續。

list=categorymembers (cm)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

在指定的分類中列出所有頁面。

參數:
cmtitle

所要列舉的分類(必要)。必須包含 分類: 前綴。不可與 cmpageid 一同使用。

cmpageid

要列舉的分類之頁面 ID。不能與 cmtitle 同時使用。

類型:整數
cmprop

要包含的資訊部份:

ids
添加頁面 ID。
title
添加標題與頁面的命名空間 ID。
sortkey
添加使用來在分類裡排序的排序鍵(十六進位字串)。
sortkeyprefix
添加用于分类中排序的关键字前缀(关键字的人类可读部分)。
type
添加页面被分类的类型(pagesubcatfile)。
timestamp
添加在頁面有被包含時的時間戳記。
多值 (以 |alternative 分隔):idstitlesortkeysortkeyprefixtypetimestamp
預設值:ids|title
cmnamespace

仅包含这些名字空间的页面。注意cmtype=subcatcmtype=file可能被使用,而不是cmnamespace=146

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
cmtype

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

多值 (以 |alternative 分隔):pagesubcatfile
預設值:page|subcat|file
cmcontinue

當有更多結果可用時,使用這個繼續。

cmlimit

回傳的頁面數量上限。

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

作為排序順序的屬性。

單值:sortkeytimestamp
預設值:sortkey
cmdir

排序的方向。

單值:ascdescascendingdescendingnewerolder
預設值:ascending
cmstart

起始列出的時間戳記。僅能與 cmsort=timestamp 一起使用。

類型:時間戳記(允許格式
cmend

結束列出的時間戳記。僅能與 cmsort=timestamp 一起使用。

類型:時間戳記(允許格式
cmstarthexsortkey

开始列举的关键词,由cmprop=sortkey返回。不能与cmsort=sortkey一起使用。

cmendhexsortkey

结束列举的关键字,由cmprop=sortkey返回。只能与cmsort=sortkey一起使用。

cmstartsortkeyprefix

要开始列举的排序关键词前缀。只能与cmsort=sortkey一起使用。覆盖cmstarthexsortkey

cmendsortkeyprefix

要结束列举before的关键字前缀(而不是at;如果此值出现,它将不被包括!)只能与cmsort=sortkey一起使用。覆盖cmendhexsortkey。

cmstartsortkey
已停用。

請改用 cmstarthexsortkey。

cmendsortkey
已停用。

請改用 cmendhexsortkey。

範例:
取得在 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)

  • 此模組已停用。
  • 此模組需要讀取權限。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

列出已刪除的修訂。

操作于三种模式中:

  1. 为指定标题列举已删除修订,按时间戳排列。
  2. 为指定用户列举已删除贡献,按时间戳排列(未指定标题)。
  3. 在指定名字空间中列举所有已删除修订,按标题和时间戳排列(无指定标题,未设置druser)。

任一参数只应用于一些模式,并忽略其他参数。

參數:
drstart

起始列舉的時間戳記。

模式:1、2
類型:時間戳記(允許格式
drend

終止列舉的時間戳記。

模式:1、2
類型:時間戳記(允許格式
drdir

列舉的方向:

newer
最舊的優先。注意:drstart應在drend之前。
older
最新的優先(預設)。注意:drstart應在drend之後。
模式:1、3
單值:newerolder
預設值:older
drfrom

在此標題開始列出。

模式:3
drto

在此標題停止列出。

模式:3
drprefix

搜尋以此值為開頭的所有頁面標題。

模式:3
drunique

各頁面僅列出一個修訂。

模式:3
類型:布林值(詳細資訊
drnamespace

僅列出此命名空間的頁面。

模式:3
單值:0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
預設值:0
drtag

僅列出以此標籤所標記的修訂。

druser

此列出由該使用者作出的修訂。

類型:使用者名稱
drexcludeuser

不要列出由該使用者作出的修訂。

類型:使用者名稱
drprop

要获取的属性:

revid
添加被删除修订的修订ID。
parentid
添加上一修订的修订ID至页面。
user
添加做出修订的用户。
userid
添加做出修订的用户ID。
comment
添加修订摘要。
parsedcomment
添加解析过的修订摘要。
minor
如果修订是小编辑则加标签。
len
添加修订长度(字节)。
sha1
添加修订的SHA-1(base 16)。
content
添加修订内容。
token
已弃用。提供编辑令牌。
tags
修订标签。
多值 (以 |alternative 分隔):revidparentiduseruseridcommentparsedcommentminorlensha1contenttokentags
預設值:user|comment
drlimit

修訂能列出的最大數量。

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

當有更多結果可用時,使用這個繼續。

範例:
列出最近已删除的对页面Main PageTalk:Main Page的贡献,带内容(模式1)。
api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content [在沙盒中開啟]
列出最近前 50 個已刪除掉由 Bob 所做出的貢獻(模式 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)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

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

參數:
eititle

要搜尋的標題。不能與 eipageid 一起使用。

eipageid

要搜尋的頁面 ID。不能與 eititle 一起使用。

類型:整數
eicontinue

當有更多結果可用時,使用這個繼續。

einamespace

要列舉的命名空間。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
eidir

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending
eifilterredir

如何過濾重新導向。

單值:allredirectsnonredirects
預設值:all
eilimit

要回傳的頁面總數。

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

list=exturlusage (eu)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

列舉包含指定 URL 的頁面。

參數:
euprop

要包含的資訊部份:

ids
添加頁面 ID。
title
添加標題與頁面的命名空間 ID。
url
添加用於頁面的 URL。
多值 (以 |alternative 分隔):idstitleurl
預設值:ids|title|url
euoffset

當有更多結果可用時,使用這個繼續。

類型:整數
euprotocol

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

單值:可以空白,或 bitcoinftpftpsgeogitgopherhttphttpsircircsmagnetmailtommsnewsnntpredissftpsipsipssmssshsvnteltelneturnworldwindxmpp
預設值:(空)
euquery

不帶協定的搜尋字串。請查看 Special:LinkSearch。請留空以列出所有外部連結。

eunamespace

要列舉的頁面命名空間。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
eulimit

要回傳的頁面數量。

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

用标准协议展开协议相关URL。

類型:布林值(詳細資訊

list=filearchive (fa)

依序列舉所有已刪除檔案。

參數:
fafrom

起始列舉的圖片標題。

fato

終止列舉的圖片標題。

faprefix

搜尋以此值為開頭的所有圖片標題。

fadir

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending
fasha1

圖片的 SHA1 雜湊值。覆蓋 fasha1base36。

fasha1base36

以 base 36 的圖片 SHA1 雜湊值(使用在 MediaWiki)。

faprop

要取得的圖片資訊:

sha1
替圖片添加 SHA-1 雜湊值。
timestamp
添加上傳版本的時間戳記。
user
添加上傳該圖片版本的使用者。
size
添加圖片大小(位元組)、高度、寬度、頁面計數(若可套用的話)。
dimensions
用于大小的别名。
description
添加圖片版本的描述。
parseddescription
解析版本的描述。
mime
添加圖片的 MIME。
mediatype
添加圖片的媒體類型。
metadata
列出圖片版本的 Exif 詮釋資料。
bitdepth
添加版本的位元深度。
archivename
添加非最新版本的存檔版本檔案名稱。
多值 (以 |alternative 分隔):sha1timestampusersizedimensionsdescriptionparseddescriptionmimemediatypemetadatabitdeptharchivename
預設值:timestamp
falimit

要回傳的圖片總數。

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

當有更多結果可用時,使用這個繼續。

範例:
顯示所有已刪除檔案的清單。
api.php?action=query&list=filearchive [在沙盒中開啟]

list=imageusage (iu)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

尋找使用到指定圖片標題的所有頁面。

參數:
iutitle

要搜尋的標題。不能與 iupageid 一起使用。

iupageid

要搜尋的頁面 ID。不能與 iutitle 一起使用。

類型:整數
iucontinue

當有更多結果可用時,使用這個繼續。

iunamespace

要列舉的命名空間。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
iudir

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending
iufilterredir

如何过滤重定向。当iuredirect被启用时如果设置为nonredirects,这只会应用到第二级。

單值:allredirectsnonredirects
預設值:all
iulimit

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

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

如果链接页面是重定向,则查找所有链接至该重定向的页面。最大限制减半。

類型:布林值(詳細資訊
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

找出連結至指定跨 wiki 連結的所有頁面。

可用于查找所有有前缀的链接,或是链至某一标题的所有链接(带指定前缀)。两参数均不使用实际上就是“all interwiki links”。

參數:
iwblprefix

跨 wiki 前綴。

iwbltitle

要搜尋的跨 wiki 連結。必須與 iwblblprefix 一起使用。

iwblcontinue

當有更多結果可用時,使用這個繼續。

iwbllimit

要回傳的頁面總數。

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

要取得的屬性。

iwprefix
添加跨 wiki 前綴。
iwtitle
添加跨 wiki 標題。
多值 (以 |alternative 分隔):iwprefixiwtitle
預設值:(空)
iwbldir

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

找出連結至指定語言連結的所有頁面。

可被用于查找所有带某一语言代码的链接,或所有至某一标题的链接(带指定语言)。不使用任何参数就意味着“all language links”。

注意这可能不考虑由扩展添加的语言链接。

參數:
lbllang

用於語言的語言連結。

lbltitle

要搜尋的語言連結。必須與lbllang一同使用。

lblcontinue

當有更多結果可用時,使用這個繼續。

lbllimit

要回傳的頁面總數。

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

要取得的屬性。

lllang
添加用於語言連結的語言代碼。
lltitle
添加語言連結標題。
多值 (以 |alternative 分隔):lllanglltitle
預設值:(空)
lbldir

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending

list=logevents (le)

main | query | logevents

從日誌中獲取事件。

參數:
leprop

要取得的屬性。

ids
添加日誌事件的 ID。
title
添加日誌事件的頁面標題。
type
添加日誌事件的類型。
user
添加承擔日誌事件的使用者。
userid
添加承擔日誌事件的使用者 ID。
timestamp
添加日誌事件的時間戳記。
comment
添加日誌事件的註釋。
parsedcomment
添加日誌事件的解析註釋。
details
列出日誌事件的額外詳細資訊。
tags
列出日誌事件的標籤。
多值 (以 |alternative 分隔):idstitletypeuseruseridtimestampcommentparsedcommentdetailstags
預設值:ids|title|type|user|timestamp|comment|details
letype

篩選僅為此類型的日誌項目。

單值:可以空白,或 renameuserblockprotectrightsdeleteuploadmoveimportpatrolmergesuppresstagmanagetagscontentmodelnewuserscreate
leaction

过滤日志操作为仅限此操作。覆盖letype。在可用值列表中,带星号通配符的值例如action/*可在斜线(/)后拥有不同字符串。

單值:renameuser/renameuserblock/blockblock/reblockblock/unblockcontentmodel/changecontentmodel/newdelete/deletedelete/delete_redirdelete/eventdelete/restoredelete/revisionimport/interwikiimport/uploadmanagetags/activatemanagetags/createmanagetags/deactivatemanagetags/deletemerge/mergemove/movemove/move_redirpatrol/patrolpatrol/autopatrolprotect/modifyprotect/move_protprotect/protectprotect/unprotectrights/autopromoterights/rightssuppress/blocksuppress/deletesuppress/eventsuppress/reblocksuppress/revisiontag/updateupload/overwriteupload/revertupload/uploadnewusers/newusersnewusers/createnewusers/create2newusers/byemailnewusers/autocreatecreate/create
lestart

起始列舉的時間戳記。

類型:時間戳記(允許格式
leend

結束列舉的時間戳記。

類型:時間戳記(允許格式
ledir

列舉的方向:

newer
最舊的優先。注意:lestart應在leend之前。
older
最新的優先(預設)。注意:lestart應在leend之後。
單值:newerolder
預設值:older
leuser

篩選由指定使用者所產生出的項目。

類型:使用者名稱
letitle

篩選與這些頁面關聯的項目。

lenamespace

篩選在這些指定命名空間裡的項目。

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

篩選以此前綴為開頭的項目。

letag

僅列出以此標籤所標記的事件項目。

lelimit

要回傳的事件項目總數。

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

當有更多結果可用時,使用這個繼續。

範例:
列出近期日誌事件。
api.php?action=query&list=logevents [在沙盒中開啟]

list=mystashedfiles (msf)

获取当前用户上传暂存库中的文件列表。

參數:
msfprop

要索取的檔案屬性。

size
索取檔案大小與圖片尺寸。
type
索取檔案的 MIME 類型以及媒體類型。
多值 (以 |alternative 分隔):sizetype
預設值:(空)
msflimit

要取得的檔案數量。

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

當有更多結果可用時,使用這個繼續。

範例:
获取当前用户上传暂存库中的文件的filekey、大小和像素尺寸。
api.php?action=query&list=mystashedfiles&msfprop=size [在沙盒中開啟]

list=pagepropnames (ppn)

列出所有在 wiki 使用的頁面屬性名稱。

參數:
ppncontinue

當有更多結果可用時,使用這個繼續。

ppnlimit

回傳的名稱數量上限。

不允許超過 500 (機器人為 5,000)。
類型:整數或max
預設值:10
範例:
取得前 10 個屬性名稱。
api.php?action=query&list=pagepropnames [在沙盒中開啟]

list=pageswithprop (pwp)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

列出使用到指定頁面屬性的所有頁面。

參數:
pwppropname

要用于列举页面的页面属性(action=query&list=pagepropnames返回正在使用中的页面属性名称)。

此參數為必填。
pwpprop

要包含到的資訊部份:

ids
添加頁面 ID。
title
添加標題與頁面的命名空間 ID。
value
添加頁面屬性的值。
多值 (以 |alternative 分隔):idstitlevalue
預設值:ids|title
pwpcontinue

當有更多結果可用時,使用這個繼續。

pwplimit

回傳的頁面數量上限。

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

排序的方向。

單值:ascendingdescending
預設值:ascending

list=prefixsearch (ps)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

執行頁面標題的前綴搜尋。

尽管名称类似,但此模块不等于Special:PrefixIndex;详见action=query&list=allpages中的apprefix参数。此模块的目的类似action=opensearch:基于用户的输入提供最佳匹配的标题。取决于搜索引擎后端,这可能包括错拼纠正、避免重定向和其他启发性行为。

參數:
pssearch

搜尋字串。

此參數為必填。
psnamespace

搜尋的命名空間。若 pssearch 以有效的命名空間前綴為開頭則會被忽略。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
預設值:0
pslimit

回傳的結果數量上限。

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

當有更多結果可用時,使用這個繼續。

類型:整數
預設值:0
範例:
搜尋開頭為 meaning 的頁面標題。
api.php?action=query&list=prefixsearch&pssearch=meaning [在沙盒中開啟]

list=protectedtitles (pt)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

列出所有被限制创建的标题。

參數:
ptnamespace

僅列出這些命名空間的標題。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
ptlevel

僅列出具有這些保護層級的標題。

多值 (以 |alternative 分隔):autoconfirmedsysop
ptlimit

要回傳的頁面總數。

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

列舉的方向:

newer
最舊的優先。注意:ptstart應在ptend之前。
older
最新的優先(預設)。注意:ptstart應在ptend之後。
單值:newerolder
預設值:older
ptstart

从此保护时间戳开始列举。

類型:時間戳記(允許格式
ptend

列举至此保护时间戳为止。

類型:時間戳記(允許格式
ptprop

要取得的屬性。

timestamp
添加保护被添加时的时间戳。
user
添加做出添加保護操作的使用者。
userid
添加做出添加保護操作的使用者 ID。
comment
添加保護的註釋。
parsedcomment
添加保護的解析註釋。
expiry
添加保护将被提升时的时间戳。
level
添加保護層級。
多值 (以 |alternative 分隔):timestampuseruseridcommentparsedcommentexpirylevel
預設值:timestamp|level
ptcontinue

當有更多結果可用時,使用這個繼續。

list=querypage (qp)

main | query | querypage
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

取得透過特殊頁面 QueryPage-based 所提供的清單。

參數:
qppage

特殊頁面的名稱。註:區分大小寫。

此參數為必填。
單值:AncientpagesBrokenRedirectsDeadendpagesDoubleRedirectsListDuplicatedFilesListredirectsLonelypagesLongpagesMediaStatisticsMostcategoriesMostimagesMostinterwikisMostlinkedcategoriesMostlinkedtemplatesMostlinkedMostrevisionsFewestrevisionsShortpagesUncategorizedcategoriesUncategorizedpagesUncategorizedimagesUncategorizedtemplatesUnusedcategoriesUnusedimagesWantedcategoriesWantedfilesWantedpagesWantedtemplatesUnwatchedpagesUnusedtemplatesWithoutinterwiki
qpoffset

當有更多結果可用時,使用這個繼續。

類型:整數
預設值:0
qplimit

回傳的結果數量。

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

list=random (rn)

main | query | random
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

取得隨機頁面集合

页面列举在一个固定序列中,只有起始点是随机的。这意味着如果Main Page是列表中第一个随机页面的话,List of fictional monkeys总是第二个,List of people on stamps of Vanuatu是第三个等。

參數:
rnnamespace

僅回傳在這些命名空間的頁面。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
rnfilterredir

如何過濾重新導向。

單值:allredirectsnonredirects
預設值:nonredirects
rnredirect
已停用。

請改用 rnfilterredir=redirects

類型:布林值(詳細資訊
rnlimit

限制所回傳的隨機頁面數量。

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

當有更多結果可用時,使用這個繼續。

範例:
從主命名空間回傳兩個隨機頁面。
api.php?action=query&list=random&rnnamespace=0&rnlimit=2 [在沙盒中開啟]
從主命名空間回傳兩個隨機頁面的相關頁面資訊。
api.php?action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info [在沙盒中開啟]

list=recentchanges (rc)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

列舉出最近變更。

參數:
rcstart

起始列舉的時間戳記。

類型:時間戳記(允許格式
rcend

結束列舉的時間戳記。

類型:時間戳記(允許格式
rcdir

列舉的方向:

newer
最舊的優先。注意:rcstart應在rcend之前。
older
最新的優先(預設)。注意:rcstart應在rcend之後。
單值:newerolder
預設值:older
rcnamespace

篩選僅為這些命名空間的更改。

多值 (以 |alternative 分隔):-2、-1、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
rcuser

此列出由該使用者作出的更改。

類型:使用者名稱
rcexcludeuser

不要列出由該使用者作出的更改。

類型:使用者名稱
rctag

僅列出以此標籤所標記的更改。

rcprop

包含的額外資訊部份:

user
添加承擔編輯的使用者,並標記出是否為 IP 使用者。
userid
添加承擔編輯的使用者。
comment
添加編輯的註釋。
parsedcomment
添加編輯的解析註釋。
flags
添加編輯的標籤。
timestamp
添加編輯的時間戳記。
title
添加編輯的頁面標題。
ids
添加頁面 ID、最近更改 ID 以及新舊修訂 ID。
sizes
添加新舊頁面長度(位元組)。
redirect
若頁面為重新導向則標記編輯。
patrolled
将可巡查编辑标记为已巡查或未巡查。
loginfo
添加日誌資訊(日誌 ID、日誌類型、其它)至日誌項目。
tags
列出項目的標籤。
sha1
为与某一修订版本有关的记录添加内容校验和。
多值 (以 |alternative 分隔):useruseridcommentparsedcommentflagstimestamptitleidssizesredirectpatrolledloginfotagssha1
預設值:title|timestamp|ids
rctoken
已停用。

請改用 action=query&meta=tokens

多值 (以 |alternative 分隔):patrol
rcshow

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

多值 (以 |alternative 分隔):minor!minorbot!botanon!anonredirect!redirectpatrolled!patrolledunpatrolledautopatrolled!autopatrolled
rclimit

要回傳變更總數。

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

要顯示的更改類型。

多值 (以 |alternative 分隔):editnewlogexternalcategorize
預設值:edit|new|log|categorize
rctoponly

僅列出最新修訂的更改。

類型:布林值(詳細資訊
rctitle

篩選與這些頁面關聯的項目。

rccontinue

當有更多結果可用時,使用這個繼續。

rcgeneraterevisions

当作为生成器使用时,生成修订ID而不是标题。不带关联修订ID的最近更改记录(例如大多数日志记录)将不会生成任何东西。

類型:布林值(詳細資訊

list=search (sr)

main | query | search
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

執行全文搜尋。

參數:
srsearch

搜索所有匹配此值的页面标题或内容。根据wiki的搜索后端工具,您可以使用搜索字符串以调用特殊搜索功能。

此參數為必填。
srnamespace

僅以這些命名空間搜尋。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
預設值:0
srlimit

要回傳的頁面總數。

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

當有更多結果可用時,使用這個繼續。

類型:整數
預設值:0
srwhat

要執行的搜尋類型。

單值:titletextnearmatch
srinfo

要回傳的詮釋資料。

多值 (以 |alternative 分隔):totalhitssuggestionrewrittenquery
預設值:totalhits|suggestion|rewrittenquery
srprop

要回傳的屬性:

size
添加以位元組為單位的頁面大小。
wordcount
添加頁面的字數。
timestamp
添加頁面自上一次編輯的時間戳記。
snippet
添加已解析的頁面片段。
titlesnippet
添加已解析的頁面標題片段。
redirecttitle
添加符合重新導向的標題。
redirectsnippet
添加已解析的重新導向標題片段。
sectiontitle
添加符合段落的標題。
sectionsnippet
添加已解析的符合段落標題片段。
isfilematch
添加表明搜尋是否符合檔案內容的布林值。
categorysnippet
添加已解析的符合分類片段。
score
已停用。 已忽略
hasrelated
已停用。 已忽略
extensiondata
添加由擴充所產生的額外資料。
多值 (以 |alternative 分隔):sizewordcounttimestampsnippettitlesnippetredirecttitleredirectsnippetsectiontitlesectionsnippetisfilematchcategorysnippetscorehasrelatedextensiondata
預設值:size|wordcount|timestamp|snippet
srinterwiki

若可用的話,在搜尋裡包含跨 wiki 結果。

類型:布林值(詳細資訊
srenablerewrites

启用内部查询重写。一些搜索后端可以重写查询到另一个被认为能提供更好结果的位置,例如纠正拼写错误。

類型:布林值(詳細資訊
srsort

設定回傳結果的排序。

單值:relevance
預設值:relevance

list=tags (tg)

main | query | tags

列出變更標記。

參數:
tgcontinue

當有更多結果可用時,使用這個繼續。

tglimit

能列出標籤的最大數量。

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

要取得的屬性。

displayname
添加標籤的系統訊息。
description
添加標籤的描述。
hitcount
已添加此标签的修订版本与日志数量。
defined
指示標籤是否已定義。
source
获得标签来源,它可能包括用于扩展定义的标签的extension,以及用于可被用户手动应用的标签的manual
active
標籤是否仍被套用。
多值 (以 |alternative 分隔):displaynamedescriptionhitcountdefinedsourceactive
預設值:(空)

list=usercontribs (uc)

按使用者來取得所有編輯。

參數:
uclimit

回傳的貢獻數量上限。

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

返回的起始时间戳。

類型:時間戳記(允許格式
ucend

返回的最终时间戳。

類型:時間戳記(允許格式
uccontinue

當有更多結果可用時,使用這個繼續。

ucuser

要检索贡献的用户。不能与ucuseridsucuserprefix一起使用。

類型:使用者名稱列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
ucuserids

要检索贡献的用户ID。不能与ucuserucuserprefix一起使用。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
ucuserprefix

取得所有用户名以这个值开头的用户的贡献。不能与ucuserucuserids一起使用。

ucdir

列舉的方向:

newer
最舊的優先。注意:ucstart應在ucend之前。
older
最新的優先(預設)。注意:ucstart應在ucend之後。
單值:newerolder
預設值:older
ucnamespace

僅列出這些命名空間的貢獻。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
ucprop

包含的額外資訊部份:

ids
添加頁面 ID 與修訂 ID。
title
添加標題與頁面的命名空間 ID。
timestamp
添加編輯的時間戳記。
comment
添加編輯的註釋。
parsedcomment
添加編輯的解析註釋。
size
添加編輯的新大小。
sizediff
添加与父编辑相比该编辑的大小变化。
flags
添加編輯的標籤。
patrolled
標記已巡查編輯。
tags
列出編輯的標籤。
多值 (以 |alternative 分隔):idstitletimestampcommentparsedcommentsizesizediffflagspatrolledtags
預設值:ids|title|timestamp|comment|size|flags
ucshow

只显示符合这些标准的项目,例如只显示不是小编辑的编辑:ucshow=!minor

如果ucshow=patrolleducshow=!patrolled被设定,早于$wgRCMaxAge(7776000秒)的修订不会被显示。

多值 (以 |alternative 分隔):minor!minorpatrolled!patrolledautopatrolled!autopatrolledtop!topnew!new
uctag

僅列出以此標籤所標記的修訂。

uctoponly
已停用。

僅列出最新修訂的更改。

類型:布林值(詳細資訊
範例:
顯示使用者 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

要包含的資訊部份:

blockinfo
如果用户被封禁就标记,并注明是谁封禁,以何种原因封禁的。
groups
列出各使用者所隸屬的所有群組。
groupmemberships
列举明确分配给每位用户的用户组,包括每个用户组成员的过期时间。
implicitgroups
列举用户自动作为成员之一的所有组。
rights
列出各使用者所擁有的權限。
editcount
添加使用者的編輯數。
registration
添加使用者的註冊時間戳記。
emailable
当用户可以并希望通过Special:Emailuser接收电子邮件时标记。
gender
标记用户性别。返回“male”、“female”或“unknown”。
centralids
添加中心ID并为用户附加状态。
cancreate
表明是否可以为有效但尚未注册的用户名创建一个账户。
多值 (以 |alternative 分隔):blockinfogroupsgroupmembershipsimplicitgroupsrightseditcountregistrationemailablegendercentralidscancreate
usattachedwiki

usprop=centralids一起使用,表明用户是否附加于此ID定义的wiki。

ususers

要獲取的使用者清單。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
ususerids

要獲取的使用者 ID 清單。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
ustoken
已停用。

請改用 action=query&meta=tokens

多值 (以 |alternative 分隔):userrights

list=watchlist (wl)

main | query | watchlist
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

在当前用户的监视列表中获取对页面的最近更改。

參數:
wlallrev

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

類型:布林值(詳細資訊
wlstart

起始列舉的時間戳記。

類型:時間戳記(允許格式
wlend

結束列舉的時間戳記。

類型:時間戳記(允許格式
wlnamespace

过滤更改为仅限指定名字空间。

多值 (以 |alternative 分隔):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之後。
單值:newerolder
預設值:older
wllimit

每個請求要回傳的結果總數。

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

要取得的額外屬性:

ids
添加修訂 ID 與頁面 ID。
title
添加頁面標題。
flags
添加編輯的標籤。
user
添加有做出編輯的使用者。
userid
添加有做出編輯的使用者 ID。
comment
添加編輯的註釋。
parsedcomment
添加編輯的解析註釋。
timestamp
添加編輯的時間戳記。
patrol
標記編輯為已巡查。
sizes
添加頁面舊有與新的長度。
notificationtimestamp
添加最近被通知有关编辑的用户的时间戳。
loginfo
在适当位置添加日志信息。
tags
列出項目的標籤。
多值 (以 |alternative 分隔):idstitleflagsuseruseridcommentparsedcommenttimestamppatrolsizesnotificationtimestamploginfotags
預設值:ids|title|flags
wlshow

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

多值 (以 |alternative 分隔):minor!minorbot!botanon!anonpatrolled!patrolledautopatrolled!autopatrolledunread!unread
wltype

要顯示的更改類型:

edit
一般頁面編輯。
new
頁面建立。
log
日誌項目。
external
外部更改。
categorize
分類成員更改。
多值 (以 |alternative 分隔):editnewlogexternalcategorize
預設值:edit|new|log|categorize
wlowner

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

類型:使用者名稱
wltoken

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

wlcontinue

當有更多結果可用時,使用這個繼續。

範例:
在当前用户的监视列表中列出用于最近更改页面的最新修订。
api.php?action=query&list=watchlist [在沙盒中開啟]
在当前用户的监视列表中检索有关用于最近更改页面的最新修订的额外信息。
api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment [在沙盒中開啟]
在当前用户的监视列表中检索有关所有最近对页面的更改的信息。
api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment [在沙盒中開啟]
在当前用户的监视列表中检索用于最近更改页面的页面信息。
api.php?action=query&generator=watchlist&prop=info [在沙盒中開啟]
在当前用户的监视列表中检索用于对页面最近更改的修订信息。
api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user [在沙盒中開啟]
在用户Example的监视列表中列出用于最近更改页面的最新修订。
api.php?action=query&list=watchlist&wlowner=Example&wltoken=123ABC [在沙盒中開啟]

list=watchlistraw (wr)

  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

列出在目前使用者的監視清單裡頭所有頁面。

參數:
wrcontinue

當有更多結果可用時,使用這個繼續。

wrnamespace

僅列出在指定命名空間的頁面。

多值 (以 |alternative 分隔):0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15
要指定所有值,請使用*
wrlimit

每個請求要回傳的結果總數。

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

要取得的額外屬性:

changed
添加最近被通知有关编辑的用户的时间戳。
多值 (以 |alternative 分隔):changed
wrshow

僅列出符合這些準則的項目。

多值 (以 |alternative 分隔):changed!changed
wrowner

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

類型:使用者名稱
wrtoken

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

wrdir

列出時所採用的方向。

單值:ascendingdescending
預設值:ascending
wrfromtitle

要列举的起始标题(带名字空间前缀)。

wrtotitle

要列举的最终标题(带名字空间前缀)。

範例:
列出在目前使用者的監視清單裡頭頁面。
api.php?action=query&list=watchlistraw [在沙盒中開啟]
索取在目前使用者監視清單裡頁面的頁面資訊。
api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=info [在沙盒中開啟]

meta=allmessages (am)

返回來自該網站的訊息。

參數:
ammessages

要輸出的訊息。*(預設)代表著所有訊息。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
預設值:*
amprop

要取得的屬性。

多值 (以 |alternative 分隔):default
amenableparser

设置以启用解析器,将处理消息的wiki文本(替代魔术字、处理模板等)。

類型:布林值(詳細資訊
amnocontent

若有設定,請不要包含在輸出裡的訊息內容。

類型:布林值(詳細資訊
amincludelocal

也包括本地消息,也就是不存在于软件但存在于MediaWiki名字空间的消息。 这会列举所有MediaWiki名字空间页面,因此它也将列举那些不是真消息的消息,例如Common.js

類型:布林值(詳細資訊
amargs

要替代訊息的引數。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
amfilter

僅回傳名稱包含此字串的訊息。

amcustomised

僅回傳在此自定義狀況下的訊息。

單值:allmodifiedunmodified
預設值:all
amlang

以此語言來回傳訊息。

amfrom

以此訊息來回傳訊息開頭。

amto

以此訊息來回傳訊息結尾。

amtitle

当解析消息时,要用作环境的页面(用于amenableparser选项)。

amprefix

回傳帶有前綴的訊息。

meta=authmanagerinfo (ami)

取得目前身分核對狀態的資訊。

參數:
amisecuritysensitiveoperation

测试用户当前的身份验证状态是否足够用于指定的安全敏感操作。

amirequestsfor

取得指定身份验证操作所需的有关身份验证请求的信息。

單值:loginlogin-continuecreatecreate-continuelinklink-continuechangeremoveunlink
amimergerequestfields

將用於所有身份驗證請求的欄位資訊合併至一個陣列中。

類型:布林值(詳細資訊
amimessageformat

用於回傳訊息的格式。

單值:htmlwikitextrawnone
預設值:wikitext

meta=filerepoinfo (fri)

回傳有關在 wiki 上圖片儲存庫的詮釋資料。

參數:
friprop

要获取的存储库属性(可用属性在其他wiki上可能不同)。

canUpload
文件是否可以上传至此存储库,例如通过CORS和共享身份验证。
displayname
人類可讀的儲存庫 wiki 名稱。
favicon
存储库wiki的网站图标URL,来自$wgFavicon
initialCapital
檔案是否隱式地以大寫字母開頭。
local
儲存庫是否為本地端。
name
存储库的关键词 - 用于例如$wgForeignFileReposimageinfo返回的值。
rootUrl
圖片路徑的根 URL 路徑。
scriptDirUrl
用於儲存庫 wiki 的 MediaWiki 安裝之根 URL 路徑。
thumbUrl
縮圖路徑的根 URL 路徑。
url
公共區域 URL 路徑。
多值 (以 |alternative 分隔):canUploaddisplaynamefaviconinitialCapitallocalnamerootUrlscriptDirUrlthumbUrlurl
預設值:canUpload|displayname|favicon|initialCapital|local|name|rootUrl|scriptDirUrl|thumbUrl|url

meta=siteinfo (si)

main | query | siteinfo

回傳有關站台的一般資訊。

參數:
siprop

要取得的資訊:

general
全面系統資訊。
namespaces
注册的名字空间及其规范名称列表。
namespacealiases
已註冊命名空間別名清單。
specialpagealiases
特殊頁面別名清單。
magicwords
魔術字及其別名清單。
interwikimap
返回跨wiki映射(可选过滤,可选择使用siinlanguagecode本地化)。
dbrepllag
返回数据库服务器与最高反应延迟。
statistics
返回网站统计。
usergroups
返回用户组及其相关权限。
libraries
回傳安裝在 wiki 上的函式庫。
extensions
回傳安裝在 wiki 上的擴充功能。
fileextensions
返回允许上传的文件扩展名(文件类型)列表。
rightsinfo
当可用时返回wiki的版权(许可协议)信息。
restrictions
返回可用的编辑限制(保护)类型信息。
languages
返回MediaWiki支持的语言列表(可选择使用siinlanguagecode本地化)。
languagevariants
当启用了语言转换器,并且每个语言变体都受支持时,返回语言代码列表。
skins
返回所有启用的皮肤列表(可选择使用siinlanguagecode本地化,否则是内容语言)。
extensiontags
返回解析器扩展标签列表。
functionhooks
返回解析器函数钩列表。
showhooks
返回所有订阅的钩列表($wgHooks的内容)。
variables
返回变量ID列表。
protocols
返回外部链接中允许的协议列表。
defaultoptions
返回用户设置的默认值。
uploaddialog
返回上传对话框的配置。
多值 (以 |alternative 分隔):generalnamespacesnamespacealiasesspecialpagealiasesmagicwordsinterwikimapdbrepllagstatisticsusergroupslibrariesextensionsfileextensionsrightsinforestrictionslanguageslanguagevariantsskinsextensiontagsfunctionhooksshowhooksvariablesprotocolsdefaultoptionsuploaddialog
預設值:general
sifilteriw

只返回跨wiki地图中的本地或非本地记录。

單值:local!local
sishowalldb

列出所有資料庫伺服器,不是只有最延遲的那台。

類型:布林值(詳細資訊
sinumberingroup

列出在使用者群組裡的使用者數目。

類型:布林值(詳細資訊
siinlanguagecode

用於本地化語言的語言代碼(盡可能)與外觀名稱。

meta=tokens

main | query | tokens

获取可修改数据的操作的令牌。

參數:
type

要求的權杖類型。

多值 (以 |alternative 分隔):createaccountcsrfloginpatrolrollbackuserrightswatch
預設值:csrf

meta=userinfo (ui)

main | query | userinfo

取得目前使用者的資訊。

參數:
uiprop

要包含的資訊部份:

blockinfo
如果当前用户被封禁就标记,并注明是谁封禁,以何种原因封禁的。
hasmsg
若目前使用者有等待訊息,添加 messages 標籤。
groups
列出目前使用者所隸屬的所有群組。
groupmemberships
列举明确分配给当前用户的用户组,包括每个用户组成员的过期时间。
implicitgroups
列举当前用户的所有自动成为成员的用户组。
rights
列出目前使用者所擁有的權限。
changeablegroups
列举当前用户可以添加并移除的用户组。
options
列出目前使用者已設定過的所有偏好設定。
editcount
添加目前使用者的編輯數。
ratelimits
列出所有套用到目前使用者的速率限制。
email
添加使用者的電子郵件地址與電子郵件驗證日期。
realname
添加使用者的真實姓名。
acceptlang
重复由客户端以结构化格式发送的Accept-Language标头。
registrationdate
添加使用者的註冊日期。
unreadcount
添加用户监视列表上的未独页面计数(最高999;如果更多则返回1000+)。
centralids
添加中心ID并为用户附加状态。
preferencestoken
已停用。 获取令牌以更改当前用户的参数设置。
多值 (以 |alternative 分隔):blockinfohasmsggroupsgroupmembershipsimplicitgroupsrightschangeablegroupsoptionseditcountratelimitsemailrealnameacceptlangregistrationdateunreadcountcentralidspreferencestoken
uiattachedwiki

uiprop=centralids一起使用,表明用户是否附加于此ID定义的wiki。

action=removeauthenticationdata

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

為目前使用者移除身分核對資料。

參數:
request

使用此身份驗證請求,透過自action=query&meta=authmanagerinfo回傳的idamirequestsfor=remove

此參數為必填。
token

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

此參數為必填。
範例:
嘗試移除目前使用者用於 FooAuthenticationRequest 的資料。
api.php?action=removeauthenticationdata&request=FooAuthenticationRequest&token=123ABC [在沙盒中開啟]

action=resetpassword

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

寄送重新設定密碼的電子郵件給使用者。

參數:
user

正重新設定的使用者。

類型:使用者名稱
email

正被重新設定使用者的電子郵件地址。

token

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

此參數為必填。
範例:
向使用者 Example 寄送重新設定密碼用的電子郵件。
api.php?action=resetpassword&user=Example&token=123ABC [在沙盒中開啟]
向所有电子邮件地址为user@example.com的用户发送密码重置邮件。
api.php?action=resetpassword&user=user@example.com&token=123ABC [在沙盒中開啟]

action=revisiondelete

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

刪除和取消刪除修訂。

參數:
type

正在执行的修订版本删除类型。

此參數為必填。
單值:revisionarchiveoldimagefilearchivelogging
target

要进行修订版本删除的页面标题,如果对某一类型需要。

ids

用于将被删除的修订的标识符。

此參數為必填。
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
hide

各修訂所要隱藏的內容。

多值 (以 |alternative 分隔):contentcommentuser
show

各修訂所要取消隱藏的內容。

多值 (以 |alternative 分隔):contentcommentuser
suppress

是否對管理者及其他使用者禁止資料。

單值:yesnonochange
預設值:nochange
reason

刪除或取消刪除的原因。

tags

在刪除日誌裡套用到項目的標籤。

多值 (以 |alternative 分隔):
token

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

此參數為必填。

action=rollback

main | rollback
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

復原頁面的最後一次編輯。

如果上一对页面做出编辑的用户连续做出了多次编辑,它们将全数被回退。

參數:
title

要回退的頁面標題。不可與 pageid 同時使用。

pageid

要回退的頁面 ID。不可與 title 同時使用。

類型:整數
tags

套用到回退的標籤。

多值 (以 |alternative 分隔):
user

做出要回退的编辑的用户名称。

此參數為必填。
類型:使用者名稱
summary

自定義編輯摘要。若為空,則使用預設摘要。

預設值:(空)
markbot

将被回退的编辑和回退操作标记为机器人编辑。

類型:布林值(詳細資訊
watchlist

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

單值:watchunwatchpreferencesnochange
預設值:preferences
token

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

為顧及相容性,web UI中使用的代碼(Token)也是可接受的。

此參數為必填。
範例:
回退由使用者 Example 對頁面 Main 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

匯出一個簡易探索(Really Simple Discovery、RSD)架構。

範例:
匯出 RSD 架構。
api.php?action=rsd [在沙盒中開啟]

action=setnotificationtimestamp

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

更新監視頁面的通知時間戳記。

这会影响监视列表和历史中已更改页面的高亮度,并且如果“當我的監視清單中的頁面或檔案有變更時,傳送電子郵件通知我”设置被启用的话,也会影响电子邮件的发送。

參數:
entirewatchlist

在所有已監視頁面運作。

類型:布林值(詳細資訊
timestamp

要设置通知时间戳的时间戳。

類型:時間戳記(允許格式
torevid

要设置通知时间戳的修订(只限一个页面)。

類型:整數
newerthanrevid

要设置通知时间戳的较新修订(只限一个页面)。

類型:整數
continue

當有更多結果可用時,使用這個繼續。

titles

要使用的標題清單。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
pageids

要使用的頁面 ID 清單。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
revids

要使用的修訂 ID 清單。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
generator

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

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

allcategories
列舉所有分類。
alldeletedrevisions
依使用者或所在命名空間來列出所有已刪除的修訂。
allfileusages
列出所有檔案用途,包含不存在的。
allimages
按順序列舉所有圖片。
alllinks
列舉所有指向所指定命名空間的連結。
allpages
依序列舉在指定命名空間的所有頁面。
allredirects
列出至命名空間的所有重新導向。
allrevisions
列出所有修訂版本。
alltransclusions
列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。
backlinks
找出連結至指定頁面的所有頁面。
categories
列出頁面隸屬的所有分類。
categorymembers
在指定的分類中列出所有頁面。
deletedrevisions
取得已刪除修訂的資訊。
duplicatefiles
根据哈希值列出此给定文件的所有副本。
embeddedin
查找所有嵌入指定标题的页面。
exturlusage
列舉包含指定 URL 的頁面。
fileusage
尋找使用到指定檔案的所有頁面。
images
回傳指定頁面中包含的所有檔案。
imageusage
尋找使用到指定圖片標題的所有頁面。
iwbacklinks
找出連結至指定跨 wiki 連結的所有頁面。
langbacklinks
找出連結至指定語言連結的所有頁面。
links
回傳指定頁面的所有連結。
linkshere
找出連結至指定頁面的所有頁面。
pageswithprop
列出使用到指定頁面屬性的所有頁面。
prefixsearch
執行頁面標題的前綴搜尋。
protectedtitles
列出所有被限制创建的标题。
querypage
取得透過特殊頁面 QueryPage-based 所提供的清單。
random
取得隨機頁面集合
recentchanges
列舉出最近變更。
redirects
回傳連結至指定頁面的所有重新導向。
revisions
取得修訂的資訊。
search
執行全文搜尋。
templates
回傳指定頁面中所有引用的頁面。
transcludedin
找出嵌入至指定頁面的所有頁面。
watchlist
在当前用户的监视列表中获取对页面的最近更改。
watchlistraw
列出在目前使用者的監視清單裡頭所有頁面。
單值:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

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

類型:布林值(詳細資訊
converttitles

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

類型:布林值(詳細資訊
token

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

此參數為必填。
範例:
重新設定整個監視清單的通知狀態。
api.php?action=setnotificationtimestamp&entirewatchlist=&token=123ABC [在沙盒中開啟]
重新設定用於 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=setpagelanguage

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

更改頁面的語言。

您不被允許在此 wiki 上變更頁面的語言。

請啟用 $wgPageLanguageUseDB 來進行此操作。

參數:
title

您希望更改语言的页面标题。不能与pageid一起使用。

pageid

您希望更改语言的页面ID。不能与title一起使用。

類型:整數
lang

更改页面的目标语言的语言代码。使用default以重置页面为wiki的默认内容语言。

此參數為必填。
單值:defaultababsaceadyady-cyrlaebaeb-arabaeb-latnafakalnamananganpararcarnarqaryarzasaseastatjavavkawaayazazbbabanbarbbcbbc-latnbccbclbebe-taraskbgbgnbhbhobibjnbmbnbobpybqibrbrhbsbtmbtobugbxrcacbk-zamcdocecebchchrchyckbcocpscrcrhcrh-cyrlcrh-latncscsbcucvcydadede-atde-chde-formaldindiqdsbdtpdtydvdzeeeglelemlenen-caen-gbeoeses-formaleteuextfafffifitfjfofrfrcfrpfrrfurfygagaggangan-hansgan-hantgcrgdglglkgngomgom-devagom-latngorgotgrcgswgugvhahakhawhehihifhif-latnhilhrhrxhsbhthuhu-formalhyhywiaidieigiiikike-cansike-latniloinhioisitiujajamjbojutjvkakaakabkbdkbd-cyrlkbpkgkhwkikiukkkk-arabkk-cnkk-cyrlkk-kzkk-latnkk-trklkmknkoko-kpkoikrckrikrjkrlksks-arabks-devakshkuku-arabku-latnkumkvkwkylaladlblbelezlfnlglilijlivlkilmolnlolozlrcltltglusluzlvlzhlzzmaimap-bmsmdfmgmhrmiminmkmlmnmnimnwmomrmrjmsmtmwlmymyvmznnanahnannapnbndsnds-nlnenewniunlnl-informalnnnovnrmnsonvnynysocoloomorospapagpampappcdpdcpdtpflpipihplpmspnbpntprgpsptpt-brququgrgnrifrmrmyroroa-tararuruerupruqruq-cyrlruq-latnrwsasahsatscscnscosdsdcsdhseseisessgsgsshshishnshy-latnsiskskrskr-arabslslismsmasnsosqsrsr-ecsr-elsrnssststqstysusvswszltataytcytetettgtg-cyrltg-latnthtitktltlytntotpitrtrutstttt-cyrltt-latntwtytyvtzmudmugug-arabug-latnukuruzvevecvepvivlsvmfvovotvrowawarwowuuxalxhxmfyiyoyuezazeazghzhzh-cnzh-hanszh-hantzh-hkzh-mozh-myzh-sgzh-twzu
reason

變更的原因。

tags

更改對應自此項操作所導致出日誌項目的標籤。

多值 (以 |alternative 分隔):
token

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

此參數為必填。
範例:
更改 Main Page 的語言成巴斯克語。
api.php?action=setpagelanguage&title=Main%20Page&lang=eu&token=123ABC [在沙盒中開啟]
將 ID 是 123 頁面的語言更改為 wiki 的預設內容語言。
api.php?action=setpagelanguage&pageid=123&lang=default&token=123ABC [在沙盒中開啟]

action=stashedit

main | stashedit
  • 此模組是內部的或不穩定的。它的操作可能更改而不另行通知。
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

在分享快取裡預備編輯。

这是打算通过使用来自编辑表单的AJAX以改进页面保存的性能。

參數:
title

正在編輯此頁面的標題。

此參數為必填。
section

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

sectiontitle

新段落的标题。

text

頁面內容。

stashedtexthash

要使用的来自先前暂存处的页面内容哈希。

summary

更改摘要。

contentmodel

新內容的內容模組。

此參數為必填。
單值:wikitextjavascriptjsoncsstext
contentformat

用於輸入文字的內容序列化格式。

此參數為必填。
單值:text/x-wikitext/javascriptapplication/jsontext/csstext/plain
baserevid

基本修訂的修訂 ID。

此參數為必填。
類型:整數
token

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

此參數為必填。

action=tag

main | tag
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

从个别修订或日志记录中添加或移除更改标签。

參數:
rcid

要添加或移除标签的一个或更多的最近更改ID。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
revid

要添加或移除标签的一个或更多的修订ID。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
logid

要添加或移除标签的一个或更多的日志记录ID。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
add

要添加的标签。只有手动定义的标签可以添加。

多值 (以 |alternative 分隔):
remove

要移除的标签。只有手动定义或完全不明确的标签可以被移除。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
reason

變更的原因。

預設值:(空)
tags

要应用到将被创建为此操作结果的日志实体的标签。

多值 (以 |alternative 分隔):
token

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

此參數為必填。
範例:
vandalism标签添加至修订ID 123,而不指定原因
api.php?action=tag&revid=123&add=vandalism&token=123ABC [在沙盒中開啟]
从日志记录ID 123移除spam标签,原因为Wrongly applied
api.php?action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC [在沙盒中開啟]

action=tokens

main | tokens
  • 此模組已停用。
  • 此模組需要讀取權限。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

取得資料修改動作的密鑰。

此模組已因支援 action=query&meta=tokens 而停用。

參數:
type

要请求的令牌类型。

多值 (以 |alternative 分隔):blockcreateaccountcsrfdeleteeditemailimportloginmoveoptionspatrolprotectrollbackunblockuserrightswatch
預設值:edit
範例:
检索一个编辑令牌(默认)。
api.php?action=tokens [在沙盒中開啟]
检索一个电子邮件令牌和一个移动令牌。
api.php?action=tokens&type=email|move [在沙盒中開啟]

action=unblock

main | unblock
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

解除封鎖一位使用者。

參數:
id

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

類型:整數
user

要封鎖的使用者名稱、IP 位址或 IP 範圍。不能與 iduserid 一起使用

userid

要封鎖的使用者 ID。不可與 iduser 一同使用。

類型:整數
reason

解除封鎖的原因。

預設值:(空)
tags

在封鎖日誌裡更改套用到項目的標籤。

多值 (以 |alternative 分隔):
token

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

此參數為必填。

action=undelete

main | undelete
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

恢復已刪除頁面的修訂。

被删除修订的列表(包括时间戳)可通过prop=deletedrevisions检索到,并且被删除的文件ID列表可通过list=filearchive检索到。

參數:
title

要恢復的頁面標題。

此參數為必填。
reason

還原的原因。

預設值:(空)
tags

在刪除日誌裡更改套用到項目的標籤。

多值 (以 |alternative 分隔):
timestamps

要回复的修订的时间戳。如果timestampsfileids都为空,所有将被恢复。

類型:時間戳記列表(允許格式
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
fileids

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

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
watchlist

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

單值:watchunwatchpreferencesnochange
預設值:preferences
token

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

此參數為必填。

action=unlinkaccount

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

移除目前使用者所連結到的第三方帳號。

參數:
request

使用此身份驗證請求,透過自action=query&meta=authmanagerinfo回傳的idamirequestsfor=unlink

此參數為必填。
token

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

此參數為必填。
範例:
尝试移除当前用户的,与FooAuthenticationRequest相关联提供方的链接。
api.php?action=unlinkaccount&request=FooAuthenticationRequest&token=123ABC [在沙盒中開啟]

action=upload

main | upload
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

上傳檔案,或取得等待上傳的狀態。

可以使用的几种方法:

  • 直接上传文件内容,使用file参数。
  • 成批上传文件,使用filesizechunkoffset参数。
  • 有MediaWiki服务器从URL检索一个文件,使用url参数。
  • 完成一次由于警告而失败的早前上传,使用filekey参数。

需要注意,当发送file时,HTTP POST必须做为一次文件上传(也就是使用multipart/form-data)完成。

參數:
filename

目標檔案名稱。

comment

上傳註釋。如果 text 未指定的話,也會作為新檔案用的初始頁面文字。

預設值:(空)
tags

更改标签以应用于上传日志记录和文件页面修订中。

多值 (以 |alternative 分隔):
text

用於新檔案的初始頁面文字。

watch
已停用。

監視頁面。

類型:布林值(詳細資訊
watchlist

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

單值:watchpreferencesnochange
預設值:preferences
ignorewarnings

忽略所有警告。

類型:布林值(詳細資訊
file

檔案內容。

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

索取檔案的來源 URL。

filekey

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

sessionkey
已停用。

与filekey相同,基于向后兼容而维护。

stash

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

類型:布林值(詳細資訊
filesize

整體上傳的檔案大小。

數值必須在 0 與 104,857,600 之間。
類型:整數
offset

数据块的偏移量(字节)。

數值不可小於 0。
類型:整數
chunk

大量內容。

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

在可能的情況下讓潛在的大型檔案非同步處理。

類型:布林值(詳細資訊
checkstatus

只检索指定文件密钥的上传状态。

類型:布林值(詳細資訊
token

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

此參數為必填。

action=userrights

  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

變更一位使用者的群組成員。

參數:
user

使用者名稱。

類型:使用者名稱
userid

使用者ID。

類型:整數
add

加入使用者至這些群組;若已是成員,則更新失效時間。

多值 (以 |alternative 分隔):botsysopinterface-adminbureaucratemailconfirmed
expiry

到期时间戳。可以是相对值(例如5 months2 weeks)或绝对值(例如2014-09-18T12:34:56Z)。如果只设置一个时间戳,它将被用于所有传递给add参数的组。对于永不过时的用户组,使用infiniteindefiniteinfinitynever

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
預設值:infinite
remove

從這些群組移除使用者。

多值 (以 |alternative 分隔):botsysopinterface-adminbureaucratemailconfirmed
reason

變更的原因。

預設值:(空)
token

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

為顧及相容性,web UI中使用的代碼(Token)也是可接受的。

此參數為必填。
tags

要在用户权限日志中应用到实体的更改标签。

多值 (以 |alternative 分隔):
範例:
将用户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 [在沙盒中開啟]
添加使用者 SometimeSysop 至群組 sysop 為期一個月時間。
api.php?action=userrights&user=SometimeSysop&add=sysop&expiry=1%20month&token=123ABC [在沙盒中開啟]

action=validatepassword

  • 此模組需要讀取權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

驗證密碼是否符合 wiki 的密碼方針。

如果密码可以接受,就报告有效性为Good,如果密码可用于登录但必须更改,则报告为Change,或如果密码不可使用,则报告为Invalid

參數:
password

要驗證的密碼。

此參數為必填。
user

使用者名稱,用於測試帳號建立。所命名的使用者必須未存在。

類型:使用者名稱
email

電子郵件地址,用於當測試帳號建立時使用。

realname

真實姓名,用於當測試帳號建立時使用。

範例:
驗證目前使用者的密碼 foobar
api.php?action=validatepassword&password=foobar [在沙盒中開啟]
為建立的使用者 Example 驗證密碼 qwerty
api.php?action=validatepassword&password=querty&user=Example [在沙盒中開啟]

action=watch

main | watch
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 協定:GPL-2.0-or-later

從目前使用者的監視清單添加或移除頁面。

參數:
title
已停用。

要(取消)监视的页面。也可使用titles

unwatch

如果设置页面将被取消监视而不是被监视。

類型:布林值(詳細資訊
continue

當有更多結果可用時,使用這個繼續。

titles

要使用的標題清單。

將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
pageids

要使用的頁面 ID 清單。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
revids

要使用的修訂 ID 清單。

類型:整數列表
將幾個值以 |alternative 分隔。 上限值為 50 (機器人為 500)。
generator

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

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

allcategories
列舉所有分類。
alldeletedrevisions
依使用者或所在命名空間來列出所有已刪除的修訂。
allfileusages
列出所有檔案用途,包含不存在的。
allimages
按順序列舉所有圖片。
alllinks
列舉所有指向所指定命名空間的連結。
allpages
依序列舉在指定命名空間的所有頁面。
allredirects
列出至命名空間的所有重新導向。
allrevisions
列出所有修訂版本。
alltransclusions
列出所有嵌入页面(使用{{x}}嵌入的页面),包括不存在的。
backlinks
找出連結至指定頁面的所有頁面。
categories
列出頁面隸屬的所有分類。
categorymembers
在指定的分類中列出所有頁面。
deletedrevisions
取得已刪除修訂的資訊。
duplicatefiles
根据哈希值列出此给定文件的所有副本。
embeddedin
查找所有嵌入指定标题的页面。
exturlusage
列舉包含指定 URL 的頁面。
fileusage
尋找使用到指定檔案的所有頁面。
images
回傳指定頁面中包含的所有檔案。
imageusage
尋找使用到指定圖片標題的所有頁面。
iwbacklinks
找出連結至指定跨 wiki 連結的所有頁面。
langbacklinks
找出連結至指定語言連結的所有頁面。
links
回傳指定頁面的所有連結。
linkshere
找出連結至指定頁面的所有頁面。
pageswithprop
列出使用到指定頁面屬性的所有頁面。
prefixsearch
執行頁面標題的前綴搜尋。
protectedtitles
列出所有被限制创建的标题。
querypage
取得透過特殊頁面 QueryPage-based 所提供的清單。
random
取得隨機頁面集合
recentchanges
列舉出最近變更。
redirects
回傳連結至指定頁面的所有重新導向。
revisions
取得修訂的資訊。
search
執行全文搜尋。
templates
回傳指定頁面中所有引用的頁面。
transcludedin
找出嵌入至指定頁面的所有頁面。
watchlist
在当前用户的监视列表中获取对页面的最近更改。
watchlistraw
列出在目前使用者的監視清單裡頭所有頁面。
單值:allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

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

類型:布林值(詳細資訊
converttitles

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

類型:布林值(詳細資訊
token

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

此參數為必填。

format=json

main | json

使用 JSON 格式輸出資料。

參數:
callback

如果指定,将输出内容包裹在一个指定的函数调用中。出于安全考虑,所有用户相关的数据将被限制。

utf8

如果指定,使用十六进制转义序列将大多数(但不是全部)非ASCII的字符编码为UTF-8,而不是替换它们。默认当formatversion不是1时。

類型:布林值(詳細資訊
ascii

如果指定,使用十六进制转义序列将所有非ASCII编码。默认当formatversion1时。

類型:布林值(詳細資訊
formatversion

输出格式:

1
向后兼容格式(XML样式布尔值、用于内容节点的*键等)。
2
实验现代格式。细节可能更改!
latest
使用最新格式(当前为2),格式可能在没有警告的情况下更改。
單值:12latest
預設值:1

format=jsonfm

main | jsonfm

使用 JSON 格式輸出資料 (使用 HTML 格式顯示)。

參數:
wrappedhtml

作为一个JSON对象返回优质打印的HTML和关联的ResouceLoader模块。

類型:布林值(詳細資訊
callback

如果指定,将输出内容包裹在一个指定的函数调用中。出于安全考虑,所有用户相关的数据将被限制。

utf8

如果指定,使用十六进制转义序列将大多数(但不是全部)非ASCII的字符编码为UTF-8,而不是替换它们。默认当formatversion不是1时。

類型:布林值(詳細資訊
ascii

如果指定,使用十六进制转义序列将所有非ASCII编码。默认当formatversion1时。

類型:布林值(詳細資訊
formatversion

输出格式:

1
向后兼容格式(XML样式布尔值、用于内容节点的*键等)。
2
实验现代格式。细节可能更改!
latest
使用最新格式(当前为2),格式可能在没有警告的情况下更改。
單值:12latest
預設值:1

format=none

main | none

不輸出。

format=php

main | php

使用序列化 PHP 格式輸出資料。

參數:
formatversion

输出格式:

1
向后兼容格式(XML样式布尔值、用于内容节点的*键等)。
2
实验现代格式。细节可能更改!
latest
使用最新格式(当前为2),格式可能在没有警告的情况下更改。
單值:12latest
預設值:1

format=phpfm

main | phpfm

使用序列化 PHP 格式輸出資料 (使用 HTML 格式顯示)。

參數:
wrappedhtml

作为一个JSON对象返回优质打印的HTML和关联的ResouceLoader模块。

類型:布林值(詳細資訊
formatversion

输出格式:

1
向后兼容格式(XML样式布尔值、用于内容节点的*键等)。
2
实验现代格式。细节可能更改!
latest
使用最新格式(当前为2),格式可能在没有警告的情况下更改。
單值:12latest
預設值:1

format=rawfm

main | rawfm

使用 JSON 格式的除錯元素輸出資料 (使用 HTML 格式顯示)。

參數:
wrappedhtml

作为一个JSON对象返回优质打印的HTML和关联的ResouceLoader模块。

類型:布林值(詳細資訊

format=xml

main | xml

使用 XML 格式輸出資料。

參數:
xslt

如果指定,加入已命名的页面作为一个XSL样式表。值必须是在MediaWiki名字空间以.xsl为结尾的标题。

includexmlnamespace

若有指定,添加一個 XML 命名空間。

類型:布林值(詳細資訊

format=xmlfm

main | xmlfm

使用 XML 格式輸出資料 (使用 HTML 格式顯示)。

參數:
wrappedhtml

作为一个JSON对象返回优质打印的HTML和关联的ResouceLoader模块。

類型:布林值(詳細資訊
xslt

如果指定,加入已命名的页面作为一个XSL样式表。值必须是在MediaWiki名字空间以.xsl为结尾的标题。

includexmlnamespace

若有指定,添加一個 XML 命名空間。

類型:布林值(詳細資訊

資料類型

至MediaWiki的輸入值應為NFC標準化的UTF-8。MediaWiki可以嘗試轉換其他輸入值,但這可能導致一些操作失敗(例如附帶MD5檢查的編輯)。

一些在API請求中的參數類型需要更進一步解釋:

boolean
布林參數產生作用就像HTML複選框一樣:如果參數被指定,無論何值都被視為真(true)。如果要假值(false),則必須省略參數。
timestamp
時間戳記可被指定為多種格式。推荐使用ISO 8601日期和時間標準。所有時間為UTC時間,包含的任何時區都會被忽略。
  • ISO 8601日期和時間,2001-01-15T14:56:00Z(標點和Z為選用)
  • 帶小數秒(會被忽略)的ISO 8601日期和時間,2001-01-15T14:56:00.00001Z(破折號、冒號和Z為選用)
  • MediaWiki格式,20010115145600
  • 一般數字格式,2001-01-15 14:56:00GMT+##-##的選用時區會被忽略)
  • EXIF格式,2001:01:15 14:56:00
  • RFC 2822格式(時區可省略),Mon, 15 Jan 2001 14:56:00
  • RFC 850格式(時區可省略),Monday, 15-Jan-2001 14:56:00
  • C ctime格式,Mon Jan 15 14:56:00 2001
  • 從1970-01-01T00:00:00Z開始的秒數,作為1到13位數的整數(除了0
  • 字串now
替代多值分隔符號
使用多個值的參數通常會與垂直線符號(|)分隔的值一起提交,例如param=value1|value2param=value1%7Cvalue2。如果值必須包含垂直線符號,使用U+001F(單位分隔符號)作為分隔符號,並且在值前加前綴U+001F,例如param=%1Fvalue1%1Fvalue2

模板參數

模板参数支持API模块需要为每个其他参数赋值的情况。例如如果有API模块请求水果,它会有参数水果指定请求的水果,以及模板参数{水果}-数量以指定每种水果请求多少。需要1个苹果、5个香蕉和20个草莓的API客户端可以做出类似水果=苹果|香蕉|草莓&苹果-数量=1&香蕉-数量=5&草莓-数量=20的请求。

製作群

API 開發人員:

  • Roan Kattouw (首席開發者 Sep 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (創立者,首席開發者 Sep 2006–Sep 2007)
  • Brad Jorsch (首席開發者 2013–present)

請傳送您的評論、建議以及問題至 mediawiki-api@lists.wikimedia.org 或者回報問題至 https://phabricator.wikimedia.org/。