MediaWiki API 說明

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

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

主要模組

main

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

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

參數:
action

要執行的動作。

block
封鎖使用者。
changeauthenticationdata
為目前使用者變更身分核對資料。
changecontentmodel
變更頁面的內容模型
checktoken
檢查來自 action=query&meta=tokens 的權杖有效性。
clearhasmsg
清除目前使用者的 hasmsg 標記。
clientlogin
使用互動流程來登入 wiki。
compare
比較 2 個頁面間的差異。
createaccount
建立新使用者帳號。
delete
刪除頁面。
edit
建立與編輯頁面。
emailuser
寄送電子郵件給使用者。
expandtemplates
展開所有於 wikitext 中模板。
feedcontributions
回傳使用者貢獻摘要。
feedrecentchanges
返回近期變更摘要。
feedwatchlist
返回監視清單摘要。
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
更改頁面的語言。
spamblacklist
驗證一個或多個URL是否觸發垃圾連結黑名單。
tag
從各別修訂或日誌項目添加或移除變更標籤。
titleblacklist
檢驗一個頁面的標題、檔案名稱或使用者名稱是否觸發標題黑名單。
unblock
解除封鎖一位使用者。
undelete
恢復已刪除頁面的修訂。
unlinkaccount
移除目前使用者所連結到的第三方帳號。
upload
上傳檔案,或取得等待上傳的狀態。
userrights
變更一位使用者的群組成員。
validatepassword
驗證密碼是否符合 wiki 的密碼方針。
watch
從目前使用者的監視清單添加或移除頁面。
cspreport
內部。由瀏覽器所使用來回報違反內容安全方針。此模組應永不使用,除了是在被由兼容內容安全方針的網路瀏覽器所使用情況下。
oathvalidate
內部。驗證雙因素驗證(OATH)權杖。
stashedit
內部。在分享快取裡預備編輯。
單值:block、​changeauthenticationdata、​changecontentmodel、​checktoken、​clearhasmsg、​clientlogin、​compare、​createaccount、​delete、​edit、​emailuser、​expandtemplates、​feedcontributions、​feedrecentchanges、​feedwatchlist、​filerevert、​help、​imagerotate、​import、​linkaccount、​login、​logout、​managetags、​mergehistory、​move、​opensearch、​options、​paraminfo、​parse、​patrol、​protect、​purge、​query、​removeauthenticationdata、​resetpassword、​revisiondelete、​rollback、​rsd、​setnotificationtimestamp、​setpagelanguage、​spamblacklist、​tag、​titleblacklist、​unblock、​undelete、​unlinkaccount、​upload、​userrights、​validatepassword、​watch、​cspreport、​oathvalidate、​stashedit
預設值:help
format

輸出的格式。

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

最大延遲可在當 MediaWiki 安裝於資料庫複寫叢集時使用。為了保存引起更多站台複寫延遲的操作,此參數可讓客戶端等待至複寫延遲小於指定值為止。在過渡延遲的情況下,錯誤碼 maxlag 會帶有著像是 Waiting for $host: $lag seconds lagged 的訊息內容回傳。
請查看手冊:Maxlag 參數來獲取更多資訊。

類型:整數
smaxage

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

類型:整數
預設值:0
maxage

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

類型:整數
預設值:0
assert

若設成 user,會確認使用者是否已登入;若設成 anon,會確認是否沒有登入;若設成 bot,會確認是否為機械人使用者。

單值:anon、​bot、​user
assertuser

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

類型:使用者,按使用者名稱
requestid

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

servedby

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

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

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

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

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

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

當使用跨網域 AJAX 請求(cross-domain AJAX request、CORS)來存取 API 時,設定此為起始網域。這必須包含在任何預檢請求裡,因此得是請求 URI 的一部份(不是 POST 主體)。

對於已認證請求,這必須準確地符合在 Origin 標頭裡其一的起始點,因此會被設定成像是 https://zh.wikipedia.org 或是 https://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标签的wikitext被移除并且实体被替换。
wikitext
未解析的 wikitext。
html
HTML
raw
訊息鍵與參數。
none
沒有文字輸出,僅有錯誤代碼。
bc
MediaWiki 1.29 之前使用的格式。會忽略 errorlangerrorsuselocal
單值:bc、​html、​none、​plaintext、​raw、​wikitext
預設值: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 範圍和使用者 ID(例如:"#12345")
userid
已棄用。

改成指定user=#ID

類型:整數
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 分隔):
partial

封鎖使用者訪問特殊頁面或命名空間,而不是整個網站。

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

封鎖使用者做出編輯的標題清單。僅在 partial 被設定為 true 時套用。

類型:首頁標題
將幾個值以 |alternative 分隔。
值的最大數量為 10。
僅接受存在的頁面。
namespacerestrictions

封鎖使用者做出編輯的命名空間 ID 清單。僅在 partial 被設定為 true 時套用。

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

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

變更頁面的內容模型

參數:
title

您所想要更改內容模組的頁面標題。不能與 pageid 同時使用。

pageid

您所想要更改內容模組的頁面 ID。不能與 title 同時使用。

類型:整數
summary

編輯摘要與日誌項目原因

tags

更改標籤來套用到日誌項目並編輯。

多值 (以 |alternative 分隔):
model

新內容的內容模組。

此參數已棄用。
單值:css、​javascript、​json、​text、​wikitext
bot

標記帶有機器人標籤的內容模組。

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

action=query&meta=tokens 接收的「csrf」權杖。

此參數已棄用。

action=checktoken

檢查來自 action=query&meta=tokens 的權杖有效性。

參數:
type

要測試的權杖類型。

此參數已棄用。
單值:createaccount、​csrf、​login、​patrol、​rollback、​userrights、​watch
token

要測試的權杖。

此參數已棄用。
maxtokenage

權杖的有效期間,以秒為單位。

類型:整數

action=clearhasmsg

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

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

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

action=clientlogin (login)

  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 授權條款:GPL-2.0-or-later

使用互動流程來登入 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

用於回傳訊息的格式。

單值:html、​none、​raw、​wikitext
預設值: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(或之前來自此模組的回應,如果合適)以決定可用請求及其使用的欄位。
範例:
開始以使用者 Example 與密碼 ExamplePassword 來登入至 wiki 的過程。
api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [在沙盒中開啟]
UI 回應雙因素驗證後繼續登入,提供 987654OATHToken
api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [在沙盒中開啟]

action=compare

main | compare

比較 2 個頁面間的差異。

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

參數:
fromtitle

要比對的第一個標題。

fromid

要比對的第一個頁面 ID。

類型:整數
fromrev

要比對的第一個修訂。

類型:整數
fromslots

覆蓋由 fromtitlefromidfromrev 指定的修訂內容。

此參數指定要變動的間隔。使用 fromtext-{slot}fromcontentmodel-{slot}、與 fromcontentformat-{slot} 來指定各間隔的內容。

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

指定間隔的文字。若忽略的話,間隔會從修訂中移除。

此為模板參數。當做出請求時,在參數名稱裡的 {slot} 應替換成 fromslots 的值。
fromsection-{slot}

fromtext-{slot} 是單一段落的內容時,這代表是段落的號碼。這會合併至由 fromtitlefromidfromrev 指定的修訂,就像用於段落編輯。

此為模板參數。當做出請求時,在參數名稱裡的 {slot} 應替換成 fromslots 的值。
fromcontentformat-{slot}

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

此為模板參數。當做出請求時,在參數名稱裡的 {slot} 應替換成 fromslots 的值。
單值:application/json、​application/octet-stream、​application/unknown、​application/x-binary、​text/css、​text/javascript、​text/plain、​text/unknown、​text/x-wiki、​unknown/unknown
fromcontentmodel-{slot}

fromtext-{slot} 內容模組。若不提供,則會根據其它參數猜測。

此為模板參數。當做出請求時,在參數名稱裡的 {slot} 應替換成 fromslots 的值。
單值:css、​javascript、​json、​text、​unknown、​wikitext
frompst

fromtext-{slot} 進行預先儲存轉換。

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

指定 fromslots=main 並改用 fromtext-main

fromcontentformat
已棄用。

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

單值:application/json、​application/octet-stream、​application/unknown、​application/x-binary、​text/css、​text/javascript、​text/plain、​text/unknown、​text/x-wiki、​unknown/unknown
fromcontentmodel
已棄用。

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

單值:css、​javascript、​json、​text、​unknown、​wikitext
fromsection
已棄用。

僅使用 'from' 內容的指定段落。

totitle

要比對的第二個標題。

toid

要比對的第二個頁面 ID。

類型:整數
torev

要比對的第二個修訂。

類型:整數
torelative

使用判定自 fromtitlefromid、或 fromrev 之修訂相關的修訂。所有其它的 'to' 選項將會忽略。

單值:cur、​next、​prev
toslots

覆蓋由 totitletoidtorev 指定的修訂內容。

此參數指定要變動的間隔。使用 totext-{slot}tocontentmodel-{slot}、與 tocontentformat-{slot} 來指定各間隔的內容。

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

指定間隔的文字。若忽略的話,間隔會從修訂中移除。

此為模板參數。當做出請求時,在參數名稱裡的 {slot} 應替換成 toslots 的值。
tosection-{slot}

totext-{slot} 是單一段落的內容時,這代表是段落的號碼。這會合併至由 totitletoidtorev 指定的修訂,就像用於段落編輯。

此為模板參數。當做出請求時,在參數名稱裡的 {slot} 應替換成 toslots 的值。
tocontentformat-{slot}

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

此為模板參數。當做出請求時,在參數名稱裡的 {slot} 應替換成 toslots 的值。
單值:application/json、​application/octet-stream、​application/unknown、​application/x-binary、​text/css、​text/javascript、​text/plain、​text/unknown、​text/x-wiki、​unknown/unknown
tocontentmodel-{slot}

totext-{slot} 內容模組。若不提供,則會基於其它參數來猜測。

此為模板參數。當做出請求時,在參數名稱裡的 {slot} 應替換成 toslots 的值。
單值:css、​javascript、​json、​text、​unknown、​wikitext
topst

totext 執行預先儲存轉換。

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

指定 toslots=main 並改用 totext-main

tocontentformat
已棄用。

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

單值:application/json、​application/octet-stream、​application/unknown、​application/x-binary、​text/css、​text/javascript、​text/plain、​text/unknown、​text/x-wiki、​unknown/unknown
tocontentmodel
已棄用。

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

單值:css、​javascript、​json、​text、​unknown、​wikitext
tosection
已棄用。

僅使用 'to' 內容的指定段落。

prop

要取得的資訊部份。

diff
HTML 差異。
diffsize
以位元組為單位的 HTML 差異大小。
rel
'from' 之前與 'to' 之後修訂的修訂 ID,若有的話。
ids
「from」與「to」修訂的頁面與修訂 ID。
title
「from」與「to」修訂的頁面標題。
user
「from」與「to」修訂的使用者名稱與 ID。若是已刪除修訂的使用者,會回傳 fromuserhiddentouserhidden 屬性。
comment
「from」與「to」修訂的註釋。若修訂裡註釋已被刪除,會回傳 fromcommenthiddentocommenthidden 屬性。
parsedcomment
「from」與「to」修訂的解析註釋。若是已刪除修訂的註釋,會回傳 fromcommenthiddentocommenthidden 屬性。
size
「from」與「to」修訂的大小。
timestamp
(無描述)
多值 (以 |alternative 分隔):comment、​diff、​diffsize、​ids、​parsedcomment、​rel、​size、​timestamp、​title、​user
預設值:diff|ids|title
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

用於回傳訊息的格式。

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

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

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

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

如果 action=query&meta=authmanagerinfo 回傳 hasprimarypreservedstate 的 true 值,標記成 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

由瀏覽器所使用來回報違反內容安全方針。此模組應永不使用,除了是在被由兼容內容安全方針的網路瀏覽器所使用情況下。

參數:
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

使用偏好設定無條件地將頁面加入至或移除自目前使用者的監視清單(略過機器人使用者),或不更改監視。

單值:nochange、​preferences、​unwatch、​watch
預設值: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

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

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

基於修訂的 ID,可用來檢測編輯衝突。也可透過 action=query&prop=revisions 取得。若有設定 basetimestamp 的話,自我衝突會導致編輯失敗。

類型:整數
basetimestamp

基於修訂的時間戳記,可用來檢測編輯衝突。也可透過 action=query&prop=revisions&rvprop=timestamp 取得。自我衝突則會被忽略。

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

當編輯程序開始的時間戳記,用於偵測編輯衝突。當編輯程序開始時(例如:當載入要編輯的頁面內容),使用 curtimestamp 可以取得一個適當值。

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

覆蓋有關頁面在此期間已被刪除的任何錯誤。

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

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

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

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

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

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

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

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

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

使用偏好設定無條件地將頁面加入至或移除自目前使用者的監視清單(略過機器人使用者),或不更改監視。

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

text 參數、或是 prependtext 和 appendtext 參數連接的 MD5 雜湊。若有設定,除非雜湊正確否則編輯不會完成。

prependtext

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

appendtext

添加至頁面結尾的文字。覆蓋text。

使用 section=new 來添加新的段落,而非此參數。

undo

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

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

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

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

自動化解決重新導向。

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

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

單值:application/json、​application/octet-stream、​application/unknown、​application/x-binary、​text/css、​text/javascript、​text/plain、​text/unknown、​text/x-wiki、​unknown/unknown
contentmodel

新內容的內容模組。

單值:css、​javascript、​json、​text、​unknown、​wikitext
token

action=query&meta=tokens 接收的「csrf」權杖。

權杖應用為發送的最後參數,或至少在 text 參數之後。

此參數已棄用。

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

所要取得的資訊部份。

請注意若沒有選定值,結果會包含wikitext,但輸出內容會採用棄用格式。

wikitext
展開的 wikitext。
categories
任何呈現在輸入中,且未在 wikitext 輸出裡表現出的分類。
properties
透過在 wikitext 裡擴充魔術字所定義的頁面屬性。
volatile
輸出內容是否易變,且是否不應在頁面其它位置裡重複使用。
ttl
結果的快取應失效後的最長時間。
modules
已請求添加至輸出內容之解析器功能的任何 ResourceLoader 模組。要載入請使用 mw.loader.using()jsconfigvarsencodedjsconfigvars 其一必須與 modules 一同被請求。
jsconfigvars
指定頁面的 JavaScript 設置變量。
encodedjsconfigvars
指定頁面的 JavaScript 設置變量為 JSON 字串。
parsetree
輸出的 XML 解析樹狀。
多值 (以 |alternative 分隔):categories、​encodedjsconfigvars、​jsconfigvars、​modules、​parsetree、​properties、​ttl、​volatile、​wikitext
includecomments

輸出裡是否包含 HTML 註解。

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

產生 XML 解析樹狀(以 prop=parsetree 取代)。

類型:布林值(詳細資訊

action=feedcontributions

回傳使用者貢獻摘要。

參數:
feedformat

摘要的格式。

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

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

此參數已棄用。
類型:使用者,按任何使用者名稱、​IP、​IP 範圍、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
namespace

要篩選貢獻的命名空間。

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

起始年份(更早之前)。

類型:整數
month

起始月份(更早之前)。

類型:整數
tagfilter

篩選有這些標籤的貢獻。

多值 (以 |alternative 分隔):mw-add-media、​mw-blank、​mw-changed-redirect-target、​mw-contentmodelchange、​mw-manual-revert、​mw-new-redirect、​mw-remove-media、​mw-removed-redirect、​mw-replace、​mw-reverted、​mw-rollback、​mw-server-side-upload、​mw-undo
預設值:(空)
deletedonly

僅顯示已刪除的貢獻。

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

只顯示最新修訂的編輯。

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

只顯示建立頁面的編輯。

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

隱藏小編輯。

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

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

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

action=feedrecentchanges

返回近期變更摘要。

參數:
feedformat

摘要格式。

單值:atom、​rss
預設值: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

返回監視清單摘要。

參數:
feedformat

摘要的格式。

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

列出在幾小時內的頁面變動。

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

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

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

以指定時間範圍來包含同一頁面的多個修訂。

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

與 token 一起使用以存取不同使用者的監視清單。

類型:使用者,按使用者名稱
wltoken

允許存取其他使用者監視清單的安全權杖(可在使用者的偏好設定找到)。

wlshow

僅顯示符合這些標準的項目。例如,僅查看由登入使用者做出的小編輯,請設定 show=minor|!anon。

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

要顯示的更改類型:

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

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

類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
範例:
顯示監視清單摘要。
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

順時針旋轉圖片的度數。

此參數已棄用。
單值:90、​180、​270
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
列出在目前使用者的監視清單裡頭所有頁面。
單值:allcategories、​alldeletedrevisions、​allfileusages、​allimages、​alllinks、​allpages、​allredirects、​allrevisions、​alltransclusions、​backlinks、​categories、​categorymembers、​deletedrevisions、​duplicatefiles、​embeddedin、​exturlusage、​fileusage、​images、​imageusage、​iwbacklinks、​langbacklinks、​links、​linkshere、​pageswithprop、​prefixsearch、​protectedtitles、​querypage、​random、​recentchanges、​redirects、​revisions、​search、​templates、​transcludedin、​watchlist、​watchlistraw
redirects

自動解決在 titlespageidsrevids,以及由 generator 所回傳頁面裡的重新導向。

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

如有需要,轉換標題成其它變體。這僅在 wiki 的內容語言支援變體轉換時有用。支援變體轉換的語言包含有ban、​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

用於回傳訊息的格式。

單值:html、​none、​raw、​wikitext
預設值: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
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 授權條款:GPL-2.0-or-later

登入並取得身分核對 cookies

此操作僅用於與 Special:BotPasswords 一起使用,用於主帳號登入的功能已棄用,並且可能會在不帶有警告的情況下失敗。要安全登入主帳號,請使用 action=clientlogin

參數:
lgname

使用者名稱。

lgpassword

密碼。

lgdomain

網域名稱(可有可無)。

lgtoken

action=query&meta=tokens 接收的「login」權杖。

action=logout

main | logout
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 授權條款:GPL-2.0-or-later

登出並清除 session 資料。

參數:
token

action=query&meta=tokens 接收的「csrf」權杖。

此參數已棄用。

action=managetags

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

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

參數:
operation

要執行的操作:

create:創建一個供手動使用的新更改標籤。
delete:從資料庫移除一個更改標籤,包含移除來自於所有修訂、近期變更項目以及日誌項目的所被使用標籤。
activate:啟用一個更改標籤,允許使用者手動套用。
deactivate:棄用一個更改標籤,不允許使用者手動套用。
此參數已棄用。
單值:activate、​create、​deactivate、​delete
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

使用偏好設定無條件地將頁面加入至或移除自目前使用者的監視清單(略過機器人使用者),或不更改監視。

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

忽略所有警告。

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

更改標籤套用到在移動日誌裡的項目,以及在目標頁面裡的無效修訂。

多值 (以 |alternative 分隔):
token

action=query&meta=tokens 接收的「csrf」權杖。

此參數已棄用。

action=oathvalidate

  • 此模組是內部的或不穩定的。它的操作可能更改而不另行通知。
  • 此模組需要讀取權限。
  • 此模組僅接受 POST 請求。
  • 來源:OATHAuth
  • 授權條款:GPL-2.0-or-later AND GPL-3.0-or-later

驗證雙因素驗證(OATH)權杖。

參數:
user

要驗證權杖的使用者。預設是目前使用者。

類型:使用者,按任何使用者名稱、​IP、​IP 範圍和跨 wiki 名稱(例如:"prefix>ExampleName")
totp
已棄用。

雙重認證(OATH)權杖。已過時,應使用「data」參數代替。

data

用於進行驗證使用者的目前有效模組之預期 JSON 編碼資料

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

回傳的結果數量上限。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
suggest
已棄用。

不再使用。

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

如何處理重定向:

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

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

單值:resolve、​return
format

輸出的格式。

單值:json、​jsonfm、​xml、​xmlfm
預設值: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 分隔):all、​registered、​registered-checkmatrix、​registered-multiselect、​special、​unused、​userjs
預設值:all
change

更改清單,格式化為「名稱 = 值」(例如: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

說明字串的格式。

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

查詢模組名稱清單(propmeta、或 list 參數的值)。使用 modules=query+foo,而非 querymodules=foo

多值 (以 |alternative 分隔):allcategories、​alldeletedrevisions、​allfileusages、​allimages、​alllinks、​allmessages、​allpages、​allredirects、​allrevisions、​alltransclusions、​allusers、​authmanagerinfo、​backlinks、​blocks、​categories、​categoryinfo、​categorymembers、​contributors、​deletedrevisions、​deletedrevs、​duplicatefiles、​embeddedin、​extlinks、​exturlusage、​filearchive、​filerepoinfo、​fileusage、​imageinfo、​images、​imageusage、​info、​iwbacklinks、​iwlinks、​langbacklinks、​langlinks、​languageinfo、​links、​linkshere、​logevents、​mystashedfiles、​oath、​pagepropnames、​pageprops、​pageswithprop、​prefixsearch、​protectedtitles、​querypage、​random、​recentchanges、​redirects、​revisions、​search、​siteinfo、​stashimageinfo、​tags、​templates、​tokens、​transcludedin、​usercontribs、​userinfo、​users、​watchlist、​watchlistraw
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
mainmodule
已棄用。

如同取得有關主要(最高級別)模組的資訊。可改用 modules=main

pagesetmodule
已棄用。

如同取得有關頁面設定模組(提供 titles= 與友人)的資訊。

formatmodules
已棄用。

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

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

action=parse

main | parse

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

查看 action=query 的各種道具模組來從目前頁面版本取得資訊。

以下有幾種方式來解析指定文字:

  1. 要指定頁面或修訂,請使用 pagepageid、或是 oldid
  2. 要指定明確內容,請使用 texttitlerevid 以及 contentmodel
  3. 要指定解析的摘要,prop 應提供一個空值。
參數:
title

文字所屬的頁面標題。若省略,需要指定 contentmodel,且 API 會用為標題使用。

text

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

revid

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

類型:整數
summary

解析摘要。

page

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

pageid

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

類型:整數
redirects

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

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

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

類型:整數
prop

要取得的資訊部份:

text
提供 wikitext 的解析文字。
langlinks
在已解析的 wikitext 提供語言連結。
categories
在已解析的 wikitext 提供分類。
categorieshtml
提供分類的 HTML 版本。
links
在已解析的 wikitext 提供內部連結。
templates
在已解析的 wikitext 提供模板。
images
在已解析的 wikitext 提供圖片。
externallinks
在已解析的 wikitext 提供外部連結。
sections
在已解析的 wikitext 提供段落。
revid
添加已解析頁面的修訂 ID。
displaytitle
添加已解析 wikitext 的標題。
subtitle
為解析頁面添加頁面副標題。
headhtml
給予頁面已解析的 doctype、開啟的 <html><head> 元素、以及開啟的 <body>
modules
在頁面提供使用的 ResourceLoader 模組。要載入請使用 mw.loader.using()jsconfigvarsencodedjsconfigvars 其一必須與 modules 一同被請求。
jsconfigvars
針對頁面提供指定的 JavaScript 設置變數。若要套用,請使用 mw.config.set()
encodedjsconfigvars
指定頁面的 JavaScript 設置變量為 JSON 字串。
indicators
提供使用在頁面的頁面狀態指示 HTML。
iwlinks
在已解析的 wikitext 提供跨 wiki 連結。
wikitext
指定被解析的原始 wikitext。
properties
指定多項定義在已解析原始 wikitext 的屬性。
limitreportdata
取得結構化限制報告。當有設定 disablelimitreport 時,則不會給予資料。
limitreporthtml
取得限制報告的 HTML 版本。當有設定 disablelimitreport 時,則不會給予資料。
parsetree
修訂內容的 XML 解析樹狀(需要內容模組 wikitext
parsewarnings
提供發生在解析內容時的警告(以 wikitext)。
parsewarningshtml
提供發生在解析內容時的警告(以 HTML)。
headitems
已棄用。提供放置頁面裡的 <head> 之項目。
多值 (以 |alternative 分隔):categories、​categorieshtml、​displaytitle、​encodedjsconfigvars、​externallinks、​headhtml、​images、​indicators、​iwlinks、​jsconfigvars、​langlinks、​limitreportdata、​limitreporthtml、​links、​modules、​parsetree、​parsewarnings、​parsewarningshtml、​properties、​revid、​sections、​subtitle、​templates、​text、​wikitext、​headitems
預設值:text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
wrapoutputclass

要包在解析器輸出內容的 CSS 類別。

預設值:mw-parser-output
pst

在解析之前執行在輸入裡的預先儲存轉換。僅當與文字使用時有效。

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

在輸入裡進行預先儲存轉換(pre-save transform、PST)但不解析。在 PST 已套用後回傳相同的 wikitext。僅與 text 使用時有效。

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

包含由擴充提供的語言連結(與 prop=langlinks 一起使用)。

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

僅解析此段落號碼的內容。

當為 new 時,解析 textsectiontitle,如同添加新段落至頁面裡。

new 僅在有指定 text 時允許。

sectiontitle

新段落標題當 sectionnew 時。

不像頁面編輯,當省略或為空時不會退至 summary

disablepp
已棄用。

請改用disablelimitreport

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

從解析輸出內容裡省略限制報告("NewPP limit report")。

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

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

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

不要在解析結果去除重複的行內樣式表。

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

產生 XML 解析樹狀(需要被 prop=parsetree 給取代的 wikitext 內容模組)。

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

在預覽模式下解析。

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

在段落預覽模式下解析(要同時啟用預覽模式)。

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

在輸出裡忽略目錄。

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

套用所選的外觀至解析輸出。可能會影響以下參數:langlinksheaditemsmodulesjsconfigvarsindicators

單值:monobook、​timeless、​vector
contentformat

用於輸入文字的內容序列格式。僅與 text 一起使用時有效。

單值:application/json、​application/octet-stream、​application/unknown、​application/x-binary、​text/css、​text/javascript、​text/plain、​text/unknown、​text/x-wiki、​unknown/unknown
contentmodel

輸入文字的內容模組。若省略則必須指定 title,且預設會是指定標題的模組。僅在與 text 一起使用時有效。

單值:css、​javascript、​json、​text、​unknown、​wikitext

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

使用偏好設定無條件地將頁面加入至或移除自目前使用者的監視清單(略過機器人使用者),或不更改監視。

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

action=query&meta=tokens 接收的「csrf」權杖。

此參數已棄用。

action=purge

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

為指定標題清除快取。

參數:
forcelinkupdate

更新連結表格,並更新其它次級資料。

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

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

類型:布林值(詳細資訊
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
列出在目前使用者的監視清單裡頭所有頁面。
單值:allcategories、​alldeletedrevisions、​allfileusages、​allimages、​alllinks、​allpages、​allredirects、​allrevisions、​alltransclusions、​backlinks、​categories、​categorymembers、​deletedrevisions、​duplicatefiles、​embeddedin、​exturlusage、​fileusage、​images、​imageusage、​iwbacklinks、​langbacklinks、​links、​linkshere、​pageswithprop、​prefixsearch、​protectedtitles、​querypage、​random、​recentchanges、​redirects、​revisions、​search、​templates、​transcludedin、​watchlist、​watchlistraw
redirects

自動解決在 titlespageidsrevids,以及由 generator 所回傳頁面裡的重新導向。

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

如有需要,轉換標題成其它變體。這僅在 wiki 的內容語言支援變體轉換時有用。支援變體轉換的語言包含有ban、​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 分隔):categories、​categoryinfo、​contributors、​deletedrevisions、​duplicatefiles、​extlinks、​fileusage、​imageinfo、​images、​info、​iwlinks、​langlinks、​links、​linkshere、​pageprops、​redirects、​revisions、​stashimageinfo、​templates、​transcludedin
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 分隔):allcategories、​alldeletedrevisions、​allfileusages、​allimages、​alllinks、​allpages、​allredirects、​allrevisions、​alltransclusions、​allusers、​backlinks、​blocks、​categorymembers、​embeddedin、​exturlusage、​filearchive、​imageusage、​iwbacklinks、​langbacklinks、​logevents、​mystashedfiles、​pagepropnames、​pageswithprop、​prefixsearch、​protectedtitles、​querypage、​random、​recentchanges、​search、​tags、​usercontribs、​users、​watchlist、​watchlistraw、​deletedrevs
meta

要取得的詮釋資料。

allmessages
返回來自該網站的訊息。
authmanagerinfo
取得目前身分核對狀態的資訊。
filerepoinfo
回傳有關在 wiki 上圖片儲存庫的詮釋資料。
languageinfo
回傳有關可用語言的資訊。
siteinfo
回傳有關站台的一般資訊。
tokens
取得資料修改操作的權杖。
userinfo
取得目前使用者的資訊。
oath
內部。檢查是否有替使用者啟用雙因素驗證(OATH)。
多值 (以 |alternative 分隔):allmessages、​authmanagerinfo、​filerepoinfo、​languageinfo、​siteinfo、​tokens、​userinfo、​oath
indexpageids

包含一個列出所有回傳頁面 ID 的額外 pageids 段落 。

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

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

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

回傳不包裹在 XML 結果裡的匯出 XML(與 Special:Export 格式相同)。僅能與 query+export 一起使用。

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

指名在匯出時 XML 傾印格式的特定版本。僅能以 query+export 來使用。

單值:0.10、​0.11
預設值:0.11
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
列出在目前使用者的監視清單裡頭所有頁面。
單值:allcategories、​alldeletedrevisions、​allfileusages、​allimages、​alllinks、​allpages、​allredirects、​allrevisions、​alltransclusions、​backlinks、​categories、​categorymembers、​deletedrevisions、​duplicatefiles、​embeddedin、​exturlusage、​fileusage、​images、​imageusage、​iwbacklinks、​langbacklinks、​links、​linkshere、​pageswithprop、​prefixsearch、​protectedtitles、​querypage、​random、​recentchanges、​redirects、​revisions、​search、​templates、​transcludedin、​watchlist、​watchlistraw
redirects

自動解決在 query+titlesquery+pageidsquery+revids,以及由 query+generator 所回傳頁面裡的重新導向。

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

如有需要,轉換標題成其它變體。這僅在 wiki 的內容語言支援變體轉換時有用。支援變體轉換的語言包含有ban、​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 分隔):hidden、​sortkey、​timestamp
clshow

要顯示出的分類種類。

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

要回傳的分類數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
clcontinue

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

clcategories

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

將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
cldir

列出時所採用的方向。

單值:ascending、​descending
預設值:ascending
範例:
取得屬於在頁面 Albert Einstein 的分類清單。
api.php?action=query&prop=categories&titles=Albert%20Einstein [在沙盒中開啟]
取得使用在 Albert Einstein 頁面裡所有分類的相關資訊。
api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info [在沙盒中開啟]

prop=categoryinfo (ci)

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

參數:
cicontinue

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

範例:
取得有關 Category:FooCategory:Bar 的資訊。
api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar [在沙盒中開啟]

prop=contributors (pc)

取得頁面上登入貢獻者以及匿名貢獻者數量的清單。

參數:
pcgroup

僅包含在指定群組的使用者。不包含隱含或是自動晉升群組,像是:*、使用者、或是自動確認。

多值 (以 |alternative 分隔):bot、​bureaucrat、​interface-admin、​suppress、​sysop
pcexcludegroup

排除在指定群組的使用者。不包含隱含或是自動晉升群組,像是:*、使用者、或是自動確認。

多值 (以 |alternative 分隔):bot、​bureaucrat、​interface-admin、​suppress、​sysop
pcrights

僅包含有指定權限的使用者。不包含透過由隱含或是自動晉升群組所授予的權限,像是:*、使用者、或是自動確認。

多值 (以 |alternative 分隔):apihighlimits、​applychangetags、​autoconfirmed、​autocreateaccount、​autopatrol、​bigdelete、​block、​blockemail、​bot、​browsearchive、​changetags、​createaccount、​createpage、​createtalk、​delete、​delete-redirect、​deletechangetags、​deletedhistory、​deletedtext、​deletelogentry、​deleterevision、​edit、​editcontentmodel、​editinterface、​editmyoptions、​editmyprivateinfo、​editmyusercss、​editmyuserjs、​editmyuserjson、​editmyuserjsredirect、​editmywatchlist、​editprotected、​editsemiprotected、​editsitecss、​editsitejs、​editsitejson、​editusercss、​edituserjs、​edituserjson、​hideuser、​import、​importupload、​ipblock-exempt、​managechangetags、​markbotedits、​mergehistory、​minoredit、​move、​move-categorypages、​move-rootuserpages、​move-subpages、​movefile、​nominornewtalk、​noratelimit、​oathauth-api-all、​oathauth-disable-for-user、​oathauth-enable、​oathauth-verify-user、​oathauth-view-log、​override-export-depth、​pagelang、​patrol、​patrolmarks、​protect、​purge、​read、​reupload、​reupload-own、​reupload-shared、​rollback、​sendemail、​siteadmin、​skipcaptcha、​spamblacklistlog、​suppressionlog、​suppressredirect、​suppressrevision、​tboverride、​tboverride-account、​titleblacklistlog、​unblockself、​undelete、​unwatchedpages、​upload、​upload_by_url、​userrights、​userrights-interwiki、​viewmyprivateinfo、​viewmywatchlist、​viewsuppressed、​writeapi
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
pcexcluderights

排除有指定權限的使用者。不包含透過由隱含或是自動晉升群組所授予的權限,像是:*、使用者、或是自動確認。

多值 (以 |alternative 分隔):apihighlimits、​applychangetags、​autoconfirmed、​autocreateaccount、​autopatrol、​bigdelete、​block、​blockemail、​bot、​browsearchive、​changetags、​createaccount、​createpage、​createtalk、​delete、​delete-redirect、​deletechangetags、​deletedhistory、​deletedtext、​deletelogentry、​deleterevision、​edit、​editcontentmodel、​editinterface、​editmyoptions、​editmyprivateinfo、​editmyusercss、​editmyuserjs、​editmyuserjson、​editmyuserjsredirect、​editmywatchlist、​editprotected、​editsemiprotected、​editsitecss、​editsitejs、​editsitejson、​editusercss、​edituserjs、​edituserjson、​hideuser、​import、​importupload、​ipblock-exempt、​managechangetags、​markbotedits、​mergehistory、​minoredit、​move、​move-categorypages、​move-rootuserpages、​move-subpages、​movefile、​nominornewtalk、​noratelimit、​oathauth-api-all、​oathauth-disable-for-user、​oathauth-enable、​oathauth-verify-user、​oathauth-view-log、​override-export-depth、​pagelang、​patrol、​patrolmarks、​protect、​purge、​read、​reupload、​reupload-own、​reupload-shared、​rollback、​sendemail、​siteadmin、​skipcaptcha、​spamblacklistlog、​suppressionlog、​suppressredirect、​suppressrevision、​tboverride、​tboverride-account、​titleblacklistlog、​unblockself、​undelete、​unwatchedpages、​upload、​upload_by_url、​userrights、​userrights-interwiki、​viewmyprivateinfo、​viewmywatchlist、​viewsuppressed、​writeapi
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
pclimit

要回傳的貢獻人員數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
pccontinue

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

prop=deletedrevisions (drv)

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

取得已刪除修訂的資訊。

能以多種方式使用:

  1. 透過設定標題或頁面 ID,來取得頁面集的已刪除修訂。排序是依照標題和時間戳記。
  2. 透過以修訂 ID 來設定它們的 ID,來取得已刪除修訂集的相關資料。排序是依照修訂 ID。
參數:
drvprop

各修訂所要取得的屬性:

ids
修訂 ID。
flags
修訂標籤(小修改)。
timestamp
修訂的時間戳記。
user
做出修訂的使用者。若是已刪除修訂的使用者,會回傳 userhidden 屬性。
userid
修訂創建者的使用者 ID。若是已刪除修訂的使用者,會回傳 userhidden 屬性。
size
修訂的長度(位元組)。
slotsize
各修訂間隔的長度(位元組)。
sha1
修訂的 SHA-1(base 16)。若是已刪除修訂的內容,會回傳 sha1hidden 屬性。
slotsha1
各修訂間隔的 SHA-1(base 16)。若是已刪除修訂的內容,會回傳 sha1hidden 屬性。
contentmodel
各修訂間隔的內容模組 ID。
comment
由使用者對於修訂所做出的註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
parsedcomment
由使用者對於修訂所解析的註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
content
各修訂間隔的內容。若是已刪除修訂的內容,會回傳 texthidden 屬性。
tags
修訂標籤。
roles
列出存在於修訂的內容間隔作用。
parsetree
已棄用。請改用 action=expandtemplatesaction=parse。修訂內容的 XML 解析樹狀(需要內容模組 wikitext)。
多值 (以 |alternative 分隔):comment、​content、​contentmodel、​flags、​ids、​parsedcomment、​roles、​sha1、​size、​slotsha1、​slotsize、​tags、​timestamp、​user、​userid、​parsetree
預設值:ids|timestamp|flags|comment|user
drvslots

當間隔相關屬性包含在 drvprops 時,要回傳資料的修訂間隔。若忽略的話,來自 main 間隔的資料會以向下兼容格式回傳。

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

限制所回傳的修訂數量。

類型:整數或max
數值必須在 1 與 500 之間。
drvexpandtemplates
已棄用。

請改用 action=expandtemplates。在修訂內容裡展開模板(需要 drvprop=content)。

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

請改用 action=expandtemplatesaction=parse。產生用於修訂內容的 XML 解析樹狀(需要 drvprop=content)。

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

請改用 action=parse。解析修訂內容(需要 drvprop=content)。基於效能緣故,若有使用此選項,drvlimit 會被強制為 1。

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

僅檢索此段落號碼的內容。

drvdiffto
已棄用。

請改用 action=compare。要比較各修訂差異的修訂 ID。prevnextcur 分別用於上一個、下一個、以及目前的修訂。

drvdifftotext
已棄用。

請改用 action=compare。要比較各修訂差異的文字。僅能比對受限數目的修訂。覆蓋 drvdiffto。若 drvsection 有設定,僅能比對該與文字有差別的段落。

drvdifftotextpst
已棄用。

請改用 action=compare。在區別前,執行在文字上的預先儲存轉換。僅與 drvdifftotext 使用有效。

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

使用於 drvdifftotext 的序列化格式並預期用於內容輸出。

單值:application/json、​application/octet-stream、​application/unknown、​application/x-binary、​text/css、​text/javascript、​text/plain、​text/unknown、​text/x-wiki、​unknown/unknown
drvstart

要開始列舉的時間戳記。當處理修訂 ID 清單時會被忽略。

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

要停止列舉的時間戳記。當處理修訂 ID 清單時會被忽略。

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

列舉的方向:

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

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

drvuser

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

類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
drvexcludeuser

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

類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
drvcontinue

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

prop=duplicatefiles (df)

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

基於雜湊值來列出指定檔案裡的所有重複檔案。

參數:
dflimit

要回傳的重複檔案數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
dfcontinue

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

dfdir

列出時所採用的方向。

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

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

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

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

參數:
ellimit

要回傳的連結數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
elcontinue

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

elprotocol

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

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

不以協議來搜尋字串,對於檢查某頁面是否包含某個外部 URL 時很有用。

elexpandurl

以規範協議的擴充協議關聯 URL。

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

prop=fileusage (fu)

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

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

參數:
fuprop

要取得的屬性。

pageid
各頁面的頁面 ID。
title
各頁面的標題。
redirect
若頁面為重新導向,則做出標記。
多值 (以 |alternative 分隔):pageid、​redirect、​title
預設值: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

要回傳的數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
fucontinue

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

prop=imageinfo (ii)

main | query | imageinfo

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

參數:
iiprop

要取得的檔案資訊:

timestamp
添加上傳版本的時間戳記。
user
添加上傳了各檔案版本的使用者。若是已刪除修訂的使用者,會回傳 userhidden 屬性。
userid
添加上傳了各檔案版本的使用者 ID。若修訂裡使用者已被刪除,會回傳 userhidden 屬性。
comment
版本的註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
parsedcomment
解析版本上的註釋。若是已刪除修訂的解析註釋,會回傳 commenthidden 屬性。
canonicaltitle
添加檔案的規範標題。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
url
提供檔案與描述頁面的 URL。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
size
添加以位元組為單位的檔案大小、高度、寬度、頁面計數(若可套用的話)。
dimensions
大小的別名。
sha1
替檔案添加 SHA-1 雜湊值。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
mime
替檔案添加 MIME 類型。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
thumbmime
添加圖片縮圖的 MIME 類型(需要 url 與參數 iiurlwidth)。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
mediatype
添加檔案的媒體類型。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
metadata
列出檔案版本的 Exif 詮釋資料。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
commonmetadata
列出檔案版本的檔案格式通用詮釋資料。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
extmetadata
列出結合多個來源的格式化詮釋資料。結果內容為 HTML 格式。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
archivename
添加非最新版本的存檔版本檔案名稱。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
bitdepth
添加版本的位元深度。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
uploadwarning
由 Special:Upload 頁面所使用來取得有關現有檔案的資訊。不適用於 MediaWiki 核心之外。
badfile
無論檔案是否在 MediaWiki:Bad image list 都添加
多值 (以 |alternative 分隔):archivename、​badfile、​bitdepth、​canonicaltitle、​comment、​commonmetadata、​dimensions、​extmetadata、​mediatype、​metadata、​mime、​parsedcomment、​sha1、​size、​thumbmime、​timestamp、​uploadwarning、​url、​user、​userid
預設值:timestamp|user
iilimit

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

類型:整數或max
數值必須在 1 與 500 之間。
預設值: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

處理器特定參數字串。例如 PDFs 可使用 page15-100px。必須要使用到 iiurlwidth 且要與 iiurlparam 一致。

預設值:(空)
iibadfilecontexttitle

若有設定 badfilecontexttitleprop=badfile,此頁面使用在當評估 MediaWiki:Bad image list 的時候

iicontinue

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

iilocalonly

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

類型:布林值(詳細資訊

prop=images (im)

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

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

參數:
imlimit

要回傳的檔案數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
imcontinue

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

imimages

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

將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
imdir

列出時所採用的方向。

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

prop=info (in)

main | query | info

取得基本頁面訊息。

參數:
inprop

要取得的額外屬性:

protection
列出各頁面的保護層級。
talkid
各非對話頁的對話頁頁面 ID。
watched
列出各頁面的監視狀態。
watchers
監視者的數目,如有允許的話。
visitingwatchers
有訪問頁面近期編輯數的各頁面監視者數目,如有允許的話。
notificationtimestamp
各頁面的監視清單通知時間戳記。
subjectid
各對話頁的父頁面頁面 ID。
associatedpage
The prefixed title of the associated subject or talk page.
url
替各頁面給予一個完整 URL、一個編輯 URL,以及一個規範 URL。
readable
已棄用。使用者是否可閱讀此頁面。請改用 intestactions=read
preload
取得由 EditFormPreloadText 回傳的文字。
displaytitle
在頁面標題實際顯示處提供方式。
varianttitles
指定網站內容語言裡所有變體的顯示標題。
linkclasses
若它們出現在名為 inlinkcontext 的頁面上,給予使用於連結到此頁面的額外 CSS 類別(例如:連結色彩)。
多值 (以 |alternative 分隔):associatedpage、​displaytitle、​linkclasses、​notificationtimestamp、​preload、​protection、​subjectid、​talkid、​url、​varianttitles、​visitingwatchers、​watched、​watchers、​readable
inlinkcontext

inprop 包含 linkclasses 時,在確認的額外 CSS 類別(例如:連結色彩)時使用的上下文標題。

類型:首頁標題
接受不存在的頁面。
預設值:首頁
intestactions

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

將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
intestactionsdetail

intestactions 的詳情級別。使用主模組errorformaterrorlang 參數來控制訊息所回傳格式。

boolean
回傳各操作的布林值。
full
回傳描述出為何操作被禁止的訊息,或為允許則回傳空陣列。
quick
像是 full;但跳過耗費的檢查。
單值:boolean、​full、​quick
預設值:boolean
incontinue

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

main | query | iwlinks

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

參數:
iwprop

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

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

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

iwtitle

要搜尋的跨 wiki 連結。必須與 iwprefix 一起使用。

iwdir

列出時所採用的方向。

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

要回傳的跨 Wiki 連結數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值: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 分隔):autonym、​langname、​url
lllang

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

lltitle

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

lldir

列出時所採用的方向。

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

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

預設值:zh-tw
lllimit

要回傳的 langlinks 數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
llcontinue

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

llurl
已棄用。

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

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

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

參數:
plnamespace

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

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

要回傳的連結數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
plcontinue

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

pltitles

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

將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
pldir

列出時所採用的方向。

單值:ascending、​descending
預設值:ascending
範例:
從頁面 Main Page 取得連結。
api.php?action=query&prop=links&titles=Main%20Page [在沙盒中開啟]
取得在 Main Page 頁面的連結頁面相關資訊。
api.php?action=query&generator=links&titles=Main%20Page&prop=info [在沙盒中開啟]
取得來自 使用者 與 模板 命名空間的頁面 Main Page 之連結。
api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10 [在沙盒中開啟]

prop=linkshere (lh)

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

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

參數:
lhprop

要取得的屬性。

pageid
各頁面的頁面 ID。
title
各頁面的標題。
redirect
若頁面為重新導向,則做出標記。
多值 (以 |alternative 分隔):pageid、​redirect、​title
預設值: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

要回傳的數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值: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 分隔):fragment、​pageid、​title
預設值: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

要回傳的重新導向數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
rdcontinue

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

prop=revisions (rv)

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

取得修訂的資訊。

能以多種方式使用:

  1. 透過設定標題或頁面 ID 來取得有關頁面集(最新修訂)的資料。
  2. 透過使用標題或是帶有起始、結束、限制的頁面 ID 來取得指定頁面的修訂。
  3. 透過以 revid 設定 ID 來取得有關修訂集的資料。
參數:
rvprop

各修訂所要取得的屬性:

ids
修訂 ID。
flags
修訂標籤(小修改)。
timestamp
修訂的時間戳記。
user
做出修訂的使用者。若是已刪除修訂的使用者,會回傳 userhidden 屬性。
userid
修訂創建者的使用者 ID。若是已刪除修訂的使用者,會回傳 userhidden 屬性。
size
修訂的長度(位元組)。
slotsize
各修訂間隔的長度(位元組)。
sha1
修訂的 SHA-1(base 16)。若是已刪除修訂的內容,會回傳 sha1hidden 屬性。
slotsha1
各修訂間隔的 SHA-1(base 16)。若是已刪除修訂的內容,會回傳 sha1hidden 屬性。
contentmodel
各修訂間隔的內容模組 ID。
comment
由使用者對於修訂所做出的註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
parsedcomment
由使用者對於修訂所解析的註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
content
各修訂間隔的內容。若是已刪除修訂的內容,會回傳 texthidden 屬性。
tags
修訂標籤。
roles
列出存在於修訂的內容間隔作用。
parsetree
已棄用。請改用 action=expandtemplatesaction=parse。修訂內容的 XML 解析樹狀(需要內容模組 wikitext)。
多值 (以 |alternative 分隔):comment、​content、​contentmodel、​flags、​ids、​parsedcomment、​roles、​sha1、​size、​slotsha1、​slotsize、​tags、​timestamp、​user、​userid、​parsetree
預設值:ids|timestamp|flags|comment|user
rvslots

當間隔相關屬性包含在 rvprops 時,要回傳資料的修訂間隔。若忽略的話,來自 main 間隔的資料會以向下兼容格式回傳。

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

限制所回傳的修訂數量。

僅能在單一頁面使用(模式 #2)。
類型:整數或max
數值必須在 1 與 500 之間。
rvexpandtemplates
已棄用。

請改用 action=expandtemplates。在修訂內容裡展開模板(需要 rvprop=content)。

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

請改用 action=expandtemplatesaction=parse。產生用於修訂內容的 XML 解析樹狀(需要 rvprop=content)。

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

請改用 action=parse。解析修訂內容(需要 rvprop=content)。基於效能緣故,若有使用此選項,rvlimit 會被強制為 1。

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

僅檢索此段落號碼的內容。

rvdiffto
已棄用。

請改用 action=compare。要比較各修訂差異的修訂 ID。prevnextcur 分別用於上一個、下一個、以及目前的修訂。

rvdifftotext
已棄用。

請改用 action=compare。要比較各修訂差異的文字。僅能比對受限數目的修訂。覆蓋 rvdiffto。若 rvsection 有設定,僅能比對該與文字有差別的段落。

rvdifftotextpst
已棄用。

請改用 action=compare。在區別前,執行在文字上的預先儲存轉換。僅與 rvdifftotext 使用有效。

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

使用於 rvdifftotext 的序列化格式並預期用於內容輸出。

單值:application/json、​application/octet-stream、​application/unknown、​application/x-binary、​text/css、​text/javascript、​text/plain、​text/unknown、​text/x-wiki、​unknown/unknown
rvstartid

從這個修訂時間戳記開始列舉。修訂必須要存在,但不需屬於此頁面。

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

在這個修訂時間戳記停止列舉。修訂必須要存在,但不需屬於此頁面。

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

從哪個修訂時間戳記來開始列舉。

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

列舉至此的時間戳記。

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

列舉的方向:

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

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

僅能在單一頁面使用(模式 #2)。
類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
rvexcludeuser

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

僅能在單一頁面使用(模式 #2)。
類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
rvtag

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

rvcontinue

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

prop=stashimageinfo (sii)

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

參數:
siifilekey

識別前一個為臨時儲藏上傳的鍵。

將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
siisessionkey
已棄用。

siifilekey的別名,用於向下相容性。

將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
siiprop

要取得的檔案資訊:

timestamp
添加上傳版本的時間戳記。
canonicaltitle
添加檔案的規範標題。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
url
提供檔案與描述頁面的 URL。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
size
添加以位元組為單位的檔案大小、高度、寬度、頁面計數(若可套用的話)。
dimensions
大小的別名。
sha1
替檔案添加 SHA-1 雜湊值。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
mime
替檔案添加 MIME 類型。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
thumbmime
添加圖片縮圖的 MIME 類型(需要 url 與參數 siiurlwidth)。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
metadata
列出檔案版本的 Exif 詮釋資料。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
commonmetadata
列出檔案版本的檔案格式通用詮釋資料。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
extmetadata
列出結合多個來源的格式化詮釋資料。結果內容為 HTML 格式。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
bitdepth
添加版本的位元深度。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
badfile
無論檔案是否在 MediaWiki:Bad image list 都添加
多值 (以 |alternative 分隔):badfile、​bitdepth、​canonicaltitle、​commonmetadata、​dimensions、​extmetadata、​metadata、​mime、​sha1、​size、​thumbmime、​timestamp、​url
預設值:timestamp|url
siiurlwidth

若 siiprop=url 有設定,會回傳前至縮放成此寬度圖片的 URL。 出於效能因素,若有使用此項目時不會回傳超過 50 張縮放圖片。

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

與 siiurlwidth 相似。

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

處理器特定參數字串。例如 PDFs 可使用 page15-100px。必須要使用到 siiurlwidth 且要與 siiurlparam 一致。

預設值:(空)

prop=templates (tl)

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

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

參數:
tlnamespace

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

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

要回傳的模板數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
tlcontinue

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

tltemplates

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

將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
tldir

列出時所採用的方向。

單值:ascending、​descending
預設值:ascending
範例:
取得在頁面 Main Page 使用到的模坂。
api.php?action=query&prop=templates&titles=Main%20Page [在沙盒中開啟]
取得使用在 Main Page 的模版頁面相關資訊。
api.php?action=query&generator=templates&titles=Main%20Page&prop=info [在沙盒中開啟]
取得嵌入在頁面 Main Page 裡的 使用者 與 模板 命名空間之頁面。
api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10 [在沙盒中開啟]

prop=transcludedin (ti)

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

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

參數:
tiprop

要取得的屬性。

pageid
各頁面的頁面 ID。
title
各頁面的標題。
redirect
若頁面為重新導向,則做出標記。
多值 (以 |alternative 分隔):pageid、​redirect、​title
預設值: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

回傳的數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
ticontinue

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

list=allcategories (ac)

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

列舉所有分類。

參數:
acfrom

起始列舉的分類。

accontinue

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

acto

終止列舉的分類。

acprefix

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

acdir

排序的方向。

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

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

類型:整數
acmax

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

類型:整數
aclimit

要回傳的分類數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
acprop

要取得的屬性。

size
在分類裡添加頁面數。
hidden
標記由 __HIDDENCAT__ 隱藏的分類。
多值 (以 |alternative 分隔):hidden、​size
預設值:(空)
範例:
列出分類以及各包含多少頁面的資訊。
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
做出修訂的使用者。若是已刪除修訂的使用者,會回傳 userhidden 屬性。
userid
修訂創建者的使用者 ID。若是已刪除修訂的使用者,會回傳 userhidden 屬性。
size
修訂的長度(位元組)。
slotsize
各修訂間隔的長度(位元組)。
sha1
修訂的 SHA-1(base 16)。若是已刪除修訂的內容,會回傳 sha1hidden 屬性。
slotsha1
各修訂間隔的 SHA-1(base 16)。若是已刪除修訂的內容,會回傳 sha1hidden 屬性。
contentmodel
各修訂間隔的內容模組 ID。
comment
由使用者對於修訂所做出的註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
parsedcomment
由使用者對於修訂所解析的註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
content
各修訂間隔的內容。若是已刪除修訂的內容,會回傳 texthidden 屬性。
tags
修訂標籤。
roles
列出存在於修訂的內容間隔作用。
parsetree
已棄用。請改用 action=expandtemplatesaction=parse。修訂內容的 XML 解析樹狀(需要內容模組 wikitext)。
多值 (以 |alternative 分隔):comment、​content、​contentmodel、​flags、​ids、​parsedcomment、​roles、​sha1、​size、​slotsha1、​slotsize、​tags、​timestamp、​user、​userid、​parsetree
預設值:ids|timestamp|flags|comment|user
adrslots

當間隔相關屬性包含在 adrprops 時,要回傳資料的修訂間隔。若忽略的話,來自 main 間隔的資料會以向下兼容格式回傳。

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

限制所回傳的修訂數量。

類型:整數或max
數值必須在 1 與 500 之間。
adrexpandtemplates
已棄用。

請改用 action=expandtemplates。在修訂內容裡展開模板(需要 adrprop=content)。

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

請改用 action=expandtemplatesaction=parse。產生用於修訂內容的 XML 解析樹狀(需要 adrprop=content)。

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

請改用 action=parse。解析修訂內容(需要 adrprop=content)。基於效能緣故,若有使用此選項,adrlimit 會被強制為 1。

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

僅檢索此段落號碼的內容。

adrdiffto
已棄用。

請改用 action=compare。要比較各修訂差異的修訂 ID。prevnextcur 分別用於上一個、下一個、以及目前的修訂。

adrdifftotext
已棄用。

請改用 action=compare。要比較各修訂差異的文字。僅能比對受限數目的修訂。覆蓋 adrdiffto。若 adrsection 有設定,僅能比對該與文字有差別的段落。

adrdifftotextpst
已棄用。

請改用 action=compare。在區別前,執行在文字上的預先儲存轉換。僅與 adrdifftotext 使用有效。

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

使用於 adrdifftotext 的序列化格式並預期用於內容輸出。

單值:application/json、​application/octet-stream、​application/unknown、​application/x-binary、​text/css、​text/javascript、​text/plain、​text/unknown、​text/x-wiki、​unknown/unknown
adruser

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

類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
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之後。
單值:newer、​older
預設值:older
adrfrom

在此標題開始列出。

不能與 adruser 一同使用。
adrto

在此標題停止列出。

不能與 adruser 一同使用。
adrprefix

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

不能與 adruser 一同使用。
adrexcludeuser

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

不能與 adruser 一同使用。
類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
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 分隔):ids、​title
預設值:title
aflimit

要回傳的項目總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
afdir

列出時所採用的方向。

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

list=allimages (ai)

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

按順序列舉所有圖片。

參數:
aisort

作為排序順序的屬性。

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

列出時所採用的方向。

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

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

aito

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

aicontinue

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

aistart

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

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

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

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

要取得的檔案資訊:

timestamp
添加上傳版本的時間戳記。
user
添加上傳了各檔案版本的使用者。若是已刪除修訂的使用者,會回傳 userhidden 屬性。
userid
添加上傳了各檔案版本的使用者 ID。若修訂裡使用者已被刪除,會回傳 userhidden 屬性。
comment
版本的註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
parsedcomment
解析版本上的註釋。若是已刪除修訂的解析註釋,會回傳 commenthidden 屬性。
canonicaltitle
添加檔案的規範標題。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
url
提供檔案與描述頁面的 URL。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
size
添加以位元組為單位的檔案大小、高度、寬度、頁面計數(若可套用的話)。
dimensions
大小的別名。
sha1
替檔案添加 SHA-1 雜湊值。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
mime
替檔案添加 MIME 類型。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
mediatype
添加檔案的媒體類型。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
metadata
列出檔案版本的 Exif 詮釋資料。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
commonmetadata
列出檔案版本的檔案格式通用詮釋資料。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
extmetadata
列出結合多個來源的格式化詮釋資料。結果內容為 HTML 格式。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
bitdepth
添加版本的位元深度。若是已刪除修訂的檔案,會回傳 filehidden 屬性。
badfile
無論檔案是否在 MediaWiki:Bad image list 都添加
多值 (以 |alternative 分隔):badfile、​bitdepth、​canonicaltitle、​comment、​commonmetadata、​dimensions、​extmetadata、​mediatype、​metadata、​mime、​parsedcomment、​sha1、​size、​timestamp、​url、​user、​userid
預設值:timestamp|url
aiprefix

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

aiminsize

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

類型:整數
aimaxsize

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

類型:整數
aisha1

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

aisha1base36

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

aiuser

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

類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
aifilterbots

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

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

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

將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
ailimit

要回傳的圖片總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
main | query | alllinks
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 授權條款:GPL-2.0-or-later

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

參數:
alcontinue

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

alfrom

要起始列舉的連結標題。

alto

要終止列舉的連結標題。

alprefix

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

alunique

僅秀出各別的連結標題。不可與 alprop=ids 一同使用。 當作為產生器使用時,會產生目標頁面而非來源頁面。

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

要包含的資訊部份:

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

要列舉的命名空間。

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

要回傳的項目總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
aldir

列出時所採用的方向。

單值:ascending、​descending
預設值: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

要列出的頁面。

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

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

類型:整數
apmaxsize

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

類型:整數
apprtype

僅限受保護的頁面。

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

篩選基於保護級別的保護(必須與 apprtype= 參數一起使用)。

多值 (以 |alternative 分隔):可以留空,或是autoconfirmed、​sysop
apprfiltercascade

基於 cascadingness 的篩選保護(當 apprtype 未設定時忽略)。

單值:all、​cascading、​noncascading
預設值:all
aplimit

要回傳的頁面總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
apdir

列出時所採用的方向。

單值:ascending、​descending
預設值:ascending
apfilterlanglinks

篩選基於頁面是否有語言連結。請注意這可能不會考慮由擴充所添加的語言連結。

單值:all、​withlanglinks、​withoutlanglinks
預設值:all
apprexpiry

篩選頁面的保護期限:

indefinite:只取得無限期保護的頁面。
definite:只取得帶有特定保護期限的頁面。
all:取得任何保護期限的頁面。
單值:all、​definite、​indefinite
預設值: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 分隔):fragment、​ids、​interwiki、​title
預設值:title
arnamespace

要列舉的命名空間。

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

要回傳的項目總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
ardir

列出時所採用的方向。

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

list=allrevisions (arv)

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

列出所有修訂版本。

參數:
arvprop

各修訂所要取得的屬性:

ids
修訂 ID。
flags
修訂標籤(小修改)。
timestamp
修訂的時間戳記。
user
做出修訂的使用者。若是已刪除修訂的使用者,會回傳 userhidden 屬性。
userid
修訂創建者的使用者 ID。若是已刪除修訂的使用者,會回傳 userhidden 屬性。
size
修訂的長度(位元組)。
slotsize
各修訂間隔的長度(位元組)。
sha1
修訂的 SHA-1(base 16)。若是已刪除修訂的內容,會回傳 sha1hidden 屬性。
slotsha1
各修訂間隔的 SHA-1(base 16)。若是已刪除修訂的內容,會回傳 sha1hidden 屬性。
contentmodel
各修訂間隔的內容模組 ID。
comment
由使用者對於修訂所做出的註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
parsedcomment
由使用者對於修訂所解析的註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
content
各修訂間隔的內容。若是已刪除修訂的內容,會回傳 texthidden 屬性。
tags
修訂標籤。
roles
列出存在於修訂的內容間隔作用。
parsetree
已棄用。請改用 action=expandtemplatesaction=parse。修訂內容的 XML 解析樹狀(需要內容模組 wikitext)。
多值 (以 |alternative 分隔):comment、​content、​contentmodel、​flags、​ids、​parsedcomment、​roles、​sha1、​size、​slotsha1、​slotsize、​tags、​timestamp、​user、​userid、​parsetree
預設值:ids|timestamp|flags|comment|user
arvslots

當間隔相關屬性包含在 arvprops 時,要回傳資料的修訂間隔。若忽略的話,來自 main 間隔的資料會以向下兼容格式回傳。

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

限制所回傳的修訂數量。

類型:整數或max
數值必須在 1 與 500 之間。
arvexpandtemplates
已棄用。

請改用 action=expandtemplates。在修訂內容裡展開模板(需要 arvprop=content)。

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

請改用 action=expandtemplatesaction=parse。產生用於修訂內容的 XML 解析樹狀(需要 arvprop=content)。

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

請改用 action=parse。解析修訂內容(需要 arvprop=content)。基於效能緣故,若有使用此選項,arvlimit 會被強制為 1。

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

僅檢索此段落號碼的內容。

arvdiffto
已棄用。

請改用 action=compare。要比較各修訂差異的修訂 ID。prevnextcur 分別用於上一個、下一個、以及目前的修訂。

arvdifftotext
已棄用。

請改用 action=compare。要比較各修訂差異的文字。僅能比對受限數目的修訂。覆蓋 arvdiffto。若 arvsection 有設定,僅能比對該與文字有差別的段落。

arvdifftotextpst
已棄用。

請改用 action=compare。在區別前,執行在文字上的預先儲存轉換。僅與 arvdifftotext 使用有效。

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

使用於 arvdifftotext 的序列化格式並預期用於內容輸出。

單值:application/json、​application/octet-stream、​application/unknown、​application/x-binary、​text/css、​text/javascript、​text/plain、​text/unknown、​text/x-wiki、​unknown/unknown
arvuser

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

類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
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之後。
單值:newer、​older
預設值:older
arvexcludeuser

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

類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
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 分隔):ids、​title
預設值:title
atnamespace

要列舉的命名空間。

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

要回傳的項目總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
atdir

列出時所採用的方向。

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

list=allusers (au)

main | query | allusers

列舉所有已註冊使用者。

參數:
aufrom

起始列舉的使用者名稱。

auto

終止列舉的使用者名稱。

auprefix

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

audir

排序的方向。

單值:ascending、​descending
預設值:ascending
augroup

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

多值 (以 |alternative 分隔):bot、​bureaucrat、​interface-admin、​suppress、​sysop
auexcludegroup

排除指定群組中的使用者

多值 (以 |alternative 分隔):bot、​bureaucrat、​interface-admin、​suppress、​sysop
aurights

僅包含有指定權限的使用者。不包含透過由隱含或是自動晉升群組所授予的權限,像是:*、使用者、或是自動確認。

多值 (以 |alternative 分隔):apihighlimits、​applychangetags、​autoconfirmed、​autocreateaccount、​autopatrol、​bigdelete、​block、​blockemail、​bot、​browsearchive、​changetags、​createaccount、​createpage、​createtalk、​delete、​delete-redirect、​deletechangetags、​deletedhistory、​deletedtext、​deletelogentry、​deleterevision、​edit、​editcontentmodel、​editinterface、​editmyoptions、​editmyprivateinfo、​editmyusercss、​editmyuserjs、​editmyuserjson、​editmyuserjsredirect、​editmywatchlist、​editprotected、​editsemiprotected、​editsitecss、​editsitejs、​editsitejson、​editusercss、​edituserjs、​edituserjson、​hideuser、​import、​importupload、​ipblock-exempt、​managechangetags、​markbotedits、​mergehistory、​minoredit、​move、​move-categorypages、​move-rootuserpages、​move-subpages、​movefile、​nominornewtalk、​noratelimit、​oathauth-api-all、​oathauth-disable-for-user、​oathauth-enable、​oathauth-verify-user、​oathauth-view-log、​override-export-depth、​pagelang、​patrol、​patrolmarks、​protect、​purge、​read、​reupload、​reupload-own、​reupload-shared、​rollback、​sendemail、​siteadmin、​skipcaptcha、​spamblacklistlog、​suppressionlog、​suppressredirect、​suppressrevision、​tboverride、​tboverride-account、​titleblacklistlog、​unblockself、​undelete、​unwatchedpages、​upload、​upload_by_url、​userrights、​userrights-interwiki、​viewmyprivateinfo、​viewmywatchlist、​viewsuppressed、​writeapi
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
auprop

要包含的資訊部份:

blockinfo
添加有關使用者目前封鎖的資訊。
groups
列出使用者所在的群組。這會使用到較多伺服器資源,並且可能會回傳少於限制條件的結果。
implicitgroups
列出使用者自動列入的所有群組。
rights
列出使用者所擁有的權限。
editcount
添加使用者的編輯次數。
registration
若可能的話,添加當使用者註冊時的時間戳記(可能為空白)。
centralids
替使用者添加中心 ID 與附加狀態。
多值 (以 |alternative 分隔):blockinfo、​centralids、​editcount、​groups、​implicitgroups、​registration、​rights
aulimit

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

類型:整數或max
數值必須在 1 與 500 之間。
預設值: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

列出時所採用的方向。

單值:ascending、​descending
預設值:ascending
blfilterredir

如何篩選重新導向。當 blredirect 啟用時若設定成 nonredirects,這僅會套用到第二級別。

單值:all、​nonredirects、​redirects
預設值:all
bllimit

要回傳的總頁面。若 blredirect 有啟用,套用至各個層級(這代表會回傳多至 2 * bllimit 個結果)。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
blredirect

若連結頁面為重新導向,則找尋連結至該重新導向的所有頁面。最大限制為一半。

類型:布林值(詳細資訊

list=blocks (bk)

main | query | blocks

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

參數:
bkstart

起始列舉的時間戳記。

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

終止列舉的時間戳記。

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

列舉的方向:

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

要列出的封鎖 ID 清單(可選)。

類型:整數列表
將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
bkusers

要搜尋的使用者清單(可選)。

類型:使用者清單,按任何使用者名稱、​IP和IP 範圍
將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
bkip

取得套用在此 IP 位址或 CIDR 範圍的所有封鎖與所包含的範圍封鎖。不可與 bkusers 一起使用。CIDR 範圍不可超過 IPv4/16 或 IPv6/19。

bklimit

能列出封鎖的最大數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
bkprop

要取得的屬性。

id
添加封鎖 ID。
user
添加已封鎖使用者的使用者名稱。
userid
添加已封鎖使用者的使用者 ID。
by
添加進行封鎖中的使用者之使用者名稱。
byid
添加進行封鎖中的使用者之使用者 ID。
timestamp
添加當封鎖生效的時間戳記。
expiry
添加當封鎖到期的時間戳記。
reason
添加封鎖的原因。
range
添加受封鎖影響的 IP 地址範圍。
flags
以自動封鎖、僅限匿名、或其它來標記該禁令。
restrictions
若封鎖非整個網站範圍,添加部份封鎖限制。
多值 (以 |alternative 分隔):by、​byid、​expiry、​flags、​id、​range、​reason、​restrictions、​timestamp、​user、​userid
預設值:id|user|by|timestamp|expiry|reason|flags
bkshow

僅顯示符合這些標準的項目。 例如僅想查看在 IP 地址的無限期封鎖,請設定 bkshow=ip|!temp

多值 (以 |alternative 分隔):!account、​!ip、​!range、​!temp、​account、​ip、​range、​temp
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 分隔):ids、​sortkey、​sortkeyprefix、​timestamp、​title、​type
預設值: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 分隔):file、​page、​subcat
預設值:page|subcat|file
cmcontinue

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

cmlimit

回傳的頁面數量上限。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
cmsort

作為排序順序的屬性。

單值:sortkey、​timestamp
預設值:sortkey
cmdir

排序的方向。

單值:asc、​ascending、​desc、​descending、​newer、​older
預設值:ascending
cmstart

起始列出的時間戳記。僅能與 cmsort=timestamp 一起使用。

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

結束列出的時間戳記。僅能與 cmsort=timestamp 一起使用。

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

開始列出的排序鍵值,由 cmprop=sortkey 所回傳。僅能與 cmsort=sortkey 一起使用。

cmendhexsortkey

終止列出的排序鍵值,由 cmprop=sortkey 所回傳。僅能與 cmsort=sortkey 一起使用。

cmstartsortkeyprefix

開始列出的排序鍵值字首,僅能與 cmsort=sortkey 一起使用。覆蓋 cmstarthexsortkey

cmendsortkeyprefix

終止列出 before 的排序鍵值字首(並不是 at,若此值有出現將不會被包含到!),僅能與 cmsort=sortkey 一起使用。覆蓋 cmendhexsortkey。

cmstartsortkey
已棄用。

請改用 cmstarthexsortkey。

cmendsortkey
已棄用。

請改用 cmendhexsortkey。

範例:
取得在 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
單值:newer、​older
預設值:older
drfrom

在此標題開始列出。

模式:3
drto

在此標題停止列出。

模式:3
drprefix

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

模式:3
drunique

各頁面僅列出一個修訂。

模式:3
類型:布林值(詳細資訊
drnamespace

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

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

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

druser

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

類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
drexcludeuser

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

類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
drprop

要取得的參數:

revidv:添加已刪除修訂的修訂 ID。
parentid:添加前一個修訂的修訂 ID 至頁面。
user:添加做出修訂的使用者。
userid:添加做出修訂的使用者 ID。
comment:添加修訂的註釋。
parsedcomment:添加修訂的解析註釋。
minor:標記修訂是否為小編輯。
len:添加修訂的長度(位元組)。
sha1:添加修訂的 SHA-1 雜湊(base 16)。
content:添加修訂內容。
token:已棄用。提供編輯權杖。
tags:修訂的標籤。
多值 (以 |alternative 分隔):comment、​content、​len、​minor、​parentid、​parsedcomment、​revid、​sha1、​tags、​token、​user、​userid
預設值:user|comment
drlimit

修訂能列出的最大數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
drcontinue

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

範例:
以帶有內容(模式 1)列出頁面 Main PageTalk:Main Page 的最新刪除修訂。
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

列出時所採用的方向。

單值:ascending、​descending
預設值:ascending
eifilterredir

如何過濾重新導向。

單值:all、​nonredirects、​redirects
預設值:all
eilimit

要回傳的頁面總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10

list=exturlusage (eu)

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

列舉包含指定 URL 的頁面。

參數:
euprop

要包含的資訊部份:

ids
添加頁面 ID。
title
添加標題與頁面的命名空間 ID。
url
添加用於頁面的 URL。
多值 (以 |alternative 分隔):ids、​title、​url
預設值:ids|title|url
eucontinue

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

euprotocol

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

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

不帶協定的搜尋字串。請查看 Special:LinkSearch。請留空以列出所有外部連結。

eunamespace

要列舉的頁面命名空間。

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

要回傳的頁面數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
euexpandurl

以規範協議的擴充協議關聯 URL。

類型:布林值(詳細資訊

list=filearchive (fa)

依序列舉所有已刪除檔案。

參數:
fafrom

起始列舉的圖片標題。

fato

終止列舉的圖片標題。

faprefix

搜尋以此值為開頭的所有圖片標題。

fadir

列出時所採用的方向。

單值:ascending、​descending
預設值:ascending
fasha1

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

fasha1base36

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

faprop

要取得的圖片資訊:

sha1
替圖片添加 SHA-1 雜湊值。
timestamp
添加上傳版本的時間戳記。
user
添加上傳該圖片版本的使用者。
size
添加圖片大小(位元組)、高度、寬度、頁面計數(若可套用的話)。
dimensions
大小的別名。
description
添加圖片版本的描述。
parseddescription
解析版本的描述。
mime
添加圖片的 MIME。
mediatype
添加圖片的媒體類型。
metadata
列出圖片版本的 Exif 詮釋資料。
bitdepth
添加版本的位元深度。
archivename
添加非最新版本的存檔版本檔案名稱。
多值 (以 |alternative 分隔):archivename、​bitdepth、​description、​dimensions、​mediatype、​metadata、​mime、​parseddescription、​sha1、​size、​timestamp、​user
預設值:timestamp
falimit

要回傳的圖片總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值: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

列出時所採用的方向。

單值:ascending、​descending
預設值:ascending
iufilterredir

如何篩選重新導向。當 iuredirect 啟用時若設定成非重新導向,這僅會套用到第二級別。

單值:all、​nonredirects、​redirects
預設值:all
iulimit

要回傳的總頁面。若 iuredirect 有啟用,套用至各個層級(這代表會回傳多至 2 * iulimit 個結果)。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
iuredirect

若連結頁面為重新導向,則找尋連結至該重新導向的所有頁面。最大限制為一半。

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

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

可用於找尋所有帶前綴的連結、或是所有至某一標題(帶有指定前綴)的連結。兩參數均不使用則會是「所有內部 wiki 連結」。

參數:
iwblprefix

跨 wiki 前綴。

iwbltitle

要搜尋的跨 wiki 連結。必須與 iwblblprefix 一起使用。

iwblcontinue

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

iwbllimit

要回傳的頁面總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
iwblprop

要取得的屬性。

iwprefix
添加跨 wiki 前綴。
iwtitle
添加跨 wiki 標題。
多值 (以 |alternative 分隔):iwprefix、​iwtitle
預設值:(空)
iwbldir

列出時所採用的方向。

單值:ascending、​descending
預設值:ascending
  • 此模組需要讀取權限。
  • 此模組可作為產生器使用。
  • 來源:MediaWiki
  • 授權條款:GPL-2.0-or-later

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

可用來查找帶有語言代碼的所有連結、或是所有標題連結(帶指定語言)。不使用任何參數代表著「所有語言連結」。

請注意這可能不會考慮由擴充功能所添加的語言連結。

參數:
lbllang

用於語言的語言連結。

lbltitle

要搜尋的語言連結。必須與lbllang一同使用。

lblcontinue

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

lbllimit

要回傳的頁面總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
lblprop

要取得的屬性。

lllang
添加用於語言連結的語言代碼。
lltitle
添加語言連結標題。
多值 (以 |alternative 分隔):lllang、​lltitle
預設值:(空)
lbldir

列出時所採用的方向。

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

list=logevents (le)

main | query | logevents

從日誌中獲取事件。

參數:
leprop

要取得的屬性。

ids
添加日誌事件的 ID。
title
添加日誌事件的頁面標題。
type
添加日誌事件的類型。
user
添加承擔日誌事件的使用者。
userid
添加承擔日誌事件的使用者 ID。
timestamp
添加日誌事件的時間戳記。
comment
添加日誌事件的註釋。
parsedcomment
添加日誌事件的解析註釋。
details
列出日誌事件的額外詳細資訊。
tags
列出日誌事件的標籤。
多值 (以 |alternative 分隔):comment、​details、​ids、​parsedcomment、​tags、​timestamp、​title、​type、​user、​userid
預設值:ids|title|type|user|timestamp|comment|details
letype

篩選僅為此類型的日誌項目。

單值:可以留空,或是block、​contentmodel、​create、​delete、​import、​managetags、​merge、​move、​newusers、​oath、​patrol、​protect、​rights、​spamblacklist、​suppress、​tag、​titleblacklist、​upload
leaction

篩選日誌操作僅限於此操作。覆蓋 letype。在可用值清單裡,與像是 action/* 這種帶有萬用字元的值,可以在斜線(/)後方帶有不同字串。

單值:block/block、​block/reblock、​block/unblock、​contentmodel/change、​contentmodel/new、​create/create、​delete/delete、​delete/delete_redir、​delete/delete_redir2、​delete/event、​delete/restore、​delete/revision、​import/interwiki、​import/upload、​managetags/activate、​managetags/create、​managetags/deactivate、​managetags/delete、​merge/merge、​move/move、​move/move_redir、​newusers/autocreate、​newusers/byemail、​newusers/create、​newusers/create2、​newusers/newusers、​oath/*、​patrol/autopatrol、​patrol/patrol、​protect/modify、​protect/move_prot、​protect/protect、​protect/unprotect、​rights/autopromote、​rights/rights、​spamblacklist/*、​suppress/block、​suppress/delete、​suppress/event、​suppress/reblock、​suppress/revision、​tag/update、​titleblacklist/*、​upload/overwrite、​upload/revert、​upload/upload
lestart

起始列舉的時間戳記。

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

結束列舉的時間戳記。

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

列舉的方向:

newer
最早的優先。注意:lestart應在leend之前。
older
最新的優先(預設)。注意:lestart應在leend之後。
單值:newer、​older
預設值:older
leuser

篩選由指定使用者所產生出的項目。

類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
letitle

篩選與這些頁面關聯的項目。

lenamespace

篩選在這些指定命名空間裡的項目。

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

篩選以此前綴為開頭的項目。

letag

僅列出以此標籤所標記的事件項目。

lelimit

要回傳的事件項目總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
lecontinue

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

範例:
列出近期日誌事件。
api.php?action=query&list=logevents [在沙盒中開啟]

list=mystashedfiles (msf)

取得在目前使用者上傳儲藏裡的檔案清單。

參數:
msfprop

要索取的檔案屬性。

size
索取檔案大小與圖片尺寸。
type
索取檔案的 MIME 類型以及媒體類型。
多值 (以 |alternative 分隔):size、​type
預設值:(空)
msflimit

要取得的檔案數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
msfcontinue

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

範例:
取得檔案鍵、檔案大小、以及在目前使用者上傳儲藏裡的檔案像素尺寸。
api.php?action=query&list=mystashedfiles&msfprop=size [在沙盒中開啟]

list=pagepropnames (ppn)

列出所有在 wiki 使用的頁面屬性名稱。

參數:
ppncontinue

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

ppnlimit

回傳的名稱數量上限。

類型:整數或max
數值必須在 1 與 500 之間。
預設值: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 分隔):ids、​title、​value
預設值:ids|title
pwpcontinue

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

pwplimit

回傳的頁面數量上限。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
pwpdir

排序的方向。

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

list=prefixsearch (ps)

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

執行頁面標題的前綴搜尋。

儘管名稱上相似,此模組不代表相同於 Special:PrefixIndex。對於此請以 apprefix 參數來查看 action=query&list=allpages。此模組的目的相似於 action=opensearch:獲取使用者的輸入內容,並提供最相符的標題。依搜尋引擎後端的情況,可能會有包含錯別字修正、避免重新導向、或是其它探索的行為。

參數:
pssearch

搜尋字串。

此參數已棄用。
psnamespace

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

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

回傳的結果數量上限。

類型:整數或max
數值必須在 1 與 500 之間。
預設值: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 分隔):autoconfirmed、​sysop
ptlimit

要回傳的頁面總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
ptdir

列舉的方向:

newer
最早的優先。注意:ptstart應在ptend之前。
older
最新的優先(預設)。注意:ptstart應在ptend之後。
單值:newer、​older
預設值:older
ptstart

在此保護時間戳記開始列出。

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

在此保護時間戳記停止列出。

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

要取得的屬性。

timestamp
添加當保護被添加時的時間戳記。
user
添加做出添加保護操作的使用者。
userid
添加做出添加保護操作的使用者 ID。
comment
添加保護的註釋。
parsedcomment
添加保護的解析註釋。
expiry
添加當保護被提升時的時間戳記。
level
添加保護層級。
多值 (以 |alternative 分隔):comment、​expiry、​level、​parsedcomment、​timestamp、​user、​userid
預設值:timestamp|level
ptcontinue

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

list=querypage (qp)

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

取得透過特殊頁面 QueryPage-based 所提供的清單。

參數:
qppage

特殊頁面的名稱。註:區分大小寫。

此參數已棄用。
單值:Ancientpages、​BrokenRedirects、​Deadendpages、​DoubleRedirects、​Fewestrevisions、​ListDuplicatedFiles、​Listredirects、​Lonelypages、​Longpages、​MediaStatistics、​Mostcategories、​Mostimages、​Mostinterwikis、​Mostlinked、​Mostlinkedcategories、​Mostlinkedtemplates、​Mostrevisions、​Shortpages、​Uncategorizedcategories、​Uncategorizedimages、​Uncategorizedpages、​Uncategorizedtemplates、​Unusedcategories、​Unusedimages、​Unusedtemplates、​Unwatchedpages、​Wantedcategories、​Wantedfiles、​Wantedpages、​Wantedtemplates、​Withoutinterwiki
qpoffset

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

類型:整數
預設值:0
qplimit

回傳的結果數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值: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

如何過濾重新導向。

單值:all、​nonredirects、​redirects
預設值:nonredirects
rnredirect
已棄用。

請改用 rnfilterredir=redirects

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

限制所回傳的隨機頁面數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值: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之後。
單值:newer、​older
預設值:older
rcnamespace

篩選僅為這些命名空間的更改。

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

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

類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
rcexcludeuser

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

類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
rctag

僅列出以此標籤所標記的更改。

rcprop

包含的額外資訊部份:

user
添加承擔編輯的使用者,並標記出是否為 IP 使用者。若是已刪除修訂的使用者,會回傳 userhidden 屬性。
userid
添加承擔該編輯的使用者 ID。若是已刪除修訂的使用者,會回傳 userhidden 屬性。
comment
添加編輯的註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
parsedcomment
添加編輯的解析註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
flags
添加編輯的標籤。
timestamp
添加編輯的時間戳記。
title
添加編輯的頁面標題。
ids
添加頁面 ID、近期變更 ID 以及新舊修訂 ID。
sizes
添加新舊頁面長度(位元組)。
redirect
若頁面為重新導向則標記編輯。
patrolled
標記可巡查編輯為已巡查或未巡查。
loginfo
添加日誌資訊(日誌 ID、日誌類型、其它)至日誌項目。
tags
列出項目的標籤。
sha1
替與修訂關聯的項目添加內容核對和。若是已刪除修訂的內容,會回傳 sha1hidden 屬性。
多值 (以 |alternative 分隔):comment、​flags、​ids、​loginfo、​parsedcomment、​patrolled、​redirect、​sha1、​sizes、​tags、​timestamp、​title、​user、​userid
預設值:title|timestamp|ids
rcshow

僅顯示符合這些標準的項目。例如,僅查看由登入使用者做出的小編輯,請設定 rcshow=minor|!anon。

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

要回傳變更總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
rctype

要顯示的更改類型。

多值 (以 |alternative 分隔):categorize、​edit、​external、​log、​new
預設值:edit|new|log|categorize
rctoponly

僅列出最新修訂的更改。

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

篩選與這些頁面關聯的項目。

rccontinue

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

rcgeneraterevisions

當作為產生器時使用,產生修訂 ID 而非標題。不帶關聯修訂 ID 的近期變更項目(例如多數日誌項目)不會產生任何內容。

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

僅列出涉及命名字段的更改。

單值:main

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

要回傳的頁面總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
sroffset

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

類型:整數
預設值:0
srwhat

要執行的搜尋類型。

單值:nearmatch、​text、​title
srinfo

要回傳的詮釋資料。

多值 (以 |alternative 分隔):rewrittenquery、​suggestion、​totalhits
預設值:totalhits|suggestion|rewrittenquery
srprop

要回傳的屬性:

size
添加以位元組為單位的頁面大小。
wordcount
添加頁面的字數。
timestamp
添加頁面自上一次編輯的時間戳記。
snippet
添加已解析的頁面片段。
titlesnippet
添加已解析的頁面標題片段。
redirecttitle
添加符合重新導向的標題。
redirectsnippet
添加已解析的重新導向標題片段。
sectiontitle
添加符合段落的標題。
sectionsnippet
添加已解析的符合段落標題片段。
isfilematch
添加表明搜尋是否符合檔案內容的布林值。
categorysnippet
添加已解析的符合分類片段。
score
已棄用。已忽略
hasrelated
已棄用。已忽略
extensiondata
添加由擴充所產生的額外資料。
多值 (以 |alternative 分隔):categorysnippet、​extensiondata、​isfilematch、​redirectsnippet、​redirecttitle、​sectionsnippet、​sectiontitle、​size、​snippet、​timestamp、​titlesnippet、​wordcount、​hasrelated、​score
預設值:size|wordcount|timestamp|snippet
srinterwiki

若可用的話,在搜尋裡包含跨 wiki 結果。

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

啟用內部查詢重新寫入。一些搜尋後端可重新寫入查詢成其它被認為能提供更好的結果,比如糾正拼寫錯誤。

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

設定回傳結果的排序。

單值:relevance
預設值:relevance

list=tags (tg)

main | query | tags

列出變更標記。

參數:
tgcontinue

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

tglimit

能列出標籤的最大數量。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
tgprop

要取得的屬性。

displayname
添加標籤的系統訊息。
description
添加標籤的描述。
hitcount
添加含有此標籤之修訂與日誌項目的數量。
defined
指示標籤是否已定義。
source
取得標籤來源,可能有包含用於擴充定義標籤的 extension 以及用於透過使用者手動套用標籤的 manual
active
標籤是否仍被套用。
多值 (以 |alternative 分隔):active、​defined、​description、​displayname、​hitcount、​source
預設值:(空)

list=usercontribs (uc)

按使用者來取得所有編輯。

參數:
uclimit

回傳的貢獻數量上限。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
ucstart

回傳的起始時間戳記。即為此時間戳記之前的修訂。

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

回傳的終止時間戳記。即為此時間戳記之後的修訂。

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

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

ucuser

要檢索貢獻的使用者。不能與 ucuseridsucuserprefix 一起使用。

類型:使用者清單,按任何使用者名稱、​IP和跨 wiki 名稱(例如:"prefix>ExampleName")
將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
ucuserids

要檢索貢獻的使用者 ID。不能與 ucuserucuserprefix 一起使用。

類型:整數列表
將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
ucuserprefix

索取所有名稱以此值為開頭使用者的貢獻。不能與 ucuserucuserids 一起使用。

ucdir

列舉的方向:

newer
最早的優先。注意:ucstart應在ucend之前。
older
最新的優先(預設)。注意:ucstart應在ucend之後。
單值:newer、​older
預設值: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
添加編輯的註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
parsedcomment
添加編輯的解析註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
size
添加編輯的新大小。
sizediff
添加對於其父級編輯的編輯大小增量。
flags
添加編輯的標籤。
patrolled
標記已巡查編輯。
tags
列出編輯的標籤。
多值 (以 |alternative 分隔):comment、​flags、​ids、​parsedcomment、​patrolled、​size、​sizediff、​tags、​timestamp、​title
預設值:ids|title|timestamp|comment|size|flags
ucshow

僅顯示符合這些標準的項目,例如僅顯示非小編輯內容為:ucshow=!minor

若有設定 ucshow=patrolleducshow=!patrolled,早於 $wgRCMaxAge(604800 秒)的修訂不會顯示出。

多值 (以 |alternative 分隔):!autopatrolled、​!minor、​!new、​!patrolled、​!top、​autopatrolled、​minor、​new、​patrolled、​top
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 分隔):blockinfo、​cancreate、​centralids、​editcount、​emailable、​gender、​groupmemberships、​groups、​implicitgroups、​registration、​rights
usattachedwiki

usprop=centralids 來表明使用者是否附加於由此 ID 所識別出的 wiki。

ususers

要獲取的使用者清單。

將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
ususerids

要獲取的使用者 ID 清單。

類型:整數列表
將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。

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

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

類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
wlexcludeuser

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

類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
wldir

列舉的方向:

newer
最早的優先。注意:wlstart應在wlend之前。
older
最新的優先(預設)。注意:wlstart應在wlend之後。
單值:newer、​older
預設值:older
wllimit

每個請求要回傳的結果總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
wlprop

要取得的額外屬性:

ids
添加修訂 ID 與頁面 ID。
title
添加頁面標題。
flags
添加編輯的標籤。
user
添加有做出編輯的使用者。若是已刪除修訂的使用者,會回傳 userhidden 屬性。
userid
添加有做出編輯的使用者 ID。若是已刪除修訂的使用者,會回傳 userhidden 屬性。
comment
添加編輯的註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
parsedcomment
添加編輯的解析註釋。若是已刪除修訂的註釋,會回傳 commenthidden 屬性。
timestamp
添加編輯的時間戳記。
patrol
標記編輯為已巡查。
sizes
添加頁面舊有與新的長度。
notificationtimestamp
添加使用者上一次被通知到有關編輯的時間戳記。
loginfo
在適當處添加日誌資訊。
tags
列出項目的標籤。
expiry
(無描述)
多值 (以 |alternative 分隔):comment、​expiry、​flags、​ids、​loginfo、​notificationtimestamp、​parsedcomment、​patrol、​sizes、​tags、​timestamp、​title、​user、​userid
預設值:ids|title|flags
wlshow

僅顯示符合這些標準的項目。例如,僅查看由登入使用者做出的小編輯,請設定 wlshow=minor|!anon。

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

要顯示的更改類型:

edit
一般頁面編輯。
new
頁面建立。
log
日誌項目。
external
外部更改。
categorize
分類成員更改。
多值 (以 |alternative 分隔):categorize、​edit、​external、​log、​new
預設值: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&wlprop=ids|title|timestamp|user|comment|expiry [在沙盒中開啟]
索取在目前使用者監視清單裡所有近期變更頁面的資訊。
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

每個請求要回傳的結果總數。

類型:整數或max
數值必須在 1 與 500 之間。
預設值:10
wrprop

要取得的額外屬性:

changed
添加使用者上一次被通知到有關編輯的時間戳記。
多值 (以 |alternative 分隔):changed
wrshow

僅列出符合這些準則的項目。

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

與 wrtoken 一起使用以存取不同使用者的監視清單。

類型:使用者,按使用者名稱
wrtoken

允許存取其他使用者監視清單的安全權杖(可在使用者的偏好設定找到)。

wrdir

列出時所採用的方向。

單值:ascending、​descending
預設值: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

設定成啟用解析器,將會處理訊息的 wikitext(替代魔術字、處理模板、等等其它)。

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

若有設定,請不要包含在輸出裡的訊息內容。

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

另外包含本地訊息,也就是不會存在於軟體但存在像是 MediaWiki 命名空間的訊息。 此列出所有 MediaWiki 命名空間頁面,因此也會列出那些不會像是 Common.js 的實際訊息。

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

要替代訊息的引數。

將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
amfilter

僅回傳名稱包含此字串的訊息。

amcustomised

僅回傳在此自定義狀況下的訊息。

單值:all、​modified、​unmodified
預設值:all
amlang

以此語言來回傳訊息。

amfrom

以此訊息來回傳訊息開頭。

amto

以此訊息來回傳訊息結尾。

amtitle

當解析訊息時作為脈絡的頁面名稱(用於 amenableparser 選項)。

amprefix

回傳帶有前綴的訊息。

meta=authmanagerinfo (ami)

取得目前身分核對狀態的資訊。

參數:
amisecuritysensitiveoperation

測試使用者的目前驗證狀態是否足夠於指定的安全敏感操作。

amirequestsfor

索取關於指定驗證操作所需的驗證請求方面資訊。

單值:change、​create、​create-continue、​link、​link-continue、​login、​login-continue、​remove、​unlink
amimergerequestfields

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

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

用於回傳訊息的格式。

單值:html、​none、​raw、​wikitext
預設值: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 分隔):canUpload、​displayname、​favicon、​initialCapital、​local、​name、​rootUrl、​scriptDirUrl、​thumbUrl、​url
預設值:canUpload|displayname|favicon|initialCapital|local|name|rootUrl|scriptDirUrl|thumbUrl|url

meta=languageinfo (li)

回傳有關可用語言的資訊。

若在一次請求中索取資訊耗費時間太長,可套用 Continuation

參數:
liprop

替各語言所要取得的資訊。

code
語言代碼。(此代碼是 MediaWiki 指定,與其它標準部份相同。)
bcp47
BCP-47 語言代碼。
dir
語言的書寫方向(ltrrtl)。
autonym
語言的本語稱呼,也就是該語言用自己語言本身寫出的名稱。
name
在由 uselang 參數所指定語言裡的語言名稱,如有需要可套用語言遞補。
fallbacks
替此語言設置的遞補語言之語言代碼。「en」不包括在內含的最後遞補(但一些語言可明確地指定「en」為最後遞補)。
variants
由此語言所支援的變體語言代碼。
多值 (以 |alternative 分隔):autonym、​bcp47、​code、​dir、​fallbacks、​name、​variants
預設值:code
licode

所應要回傳的語言該語言代碼,或是以 * 來表示為全部語言。

將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
預設值:*
licontinue

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

範例:
取得所有支援語言的語言代碼。
api.php?action=query&meta=languageinfo [在沙盒中開啟]
取得所有支援語言的本語稱呼和德語名稱。
api.php?action=query&meta=languageinfo&liprop=autonym|name&uselang=de [在沙盒中開啟]
取得遞補語言與奧克語的變體。
api.php?action=query&meta=languageinfo&liprop=fallbacks|variants&licode=oc [在沙盒中開啟]
取得 BCP-47 語言代碼與所有支援語言的書寫方向。
api.php?action=query&meta=languageinfo&liprop=bcp47|dir [在沙盒中開啟]

meta=oath (oath)

main | query | oath

檢查是否有替使用者啟用雙因素驗證(OATH)。

參數:
oathuser

要取得有關資訊的使用者。預設是目前使用者。

類型:使用者,按任何使用者名稱、​IP、​IP 範圍和跨 wiki 名稱(例如:"prefix>ExampleName")
oathreason

查詢 OATH 狀態的原因。

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
在啟用了 LanguageConverter 且支援各語言變化時,回傳語言代碼清單。
skins
回傳所有已啟用的外觀清單(可透過 siinlanguagecode 來選用本地化,不然會是內容語言)。
extensiontags
回傳解析擴充標籤清單。
functionhooks
回傳解析器函式掛勾清單。
showhooks
回傳所有訂閱掛勾清單($wgHooks 的內容)。
variables
回傳變數 ID 清單。
protocols
回傳在外部連結裡所允許的協議清單。
defaultoptions
回傳用於使用者偏好設定的預設值。
uploaddialog
回傳上傳對話框的設置。
多值 (以 |alternative 分隔):dbrepllag、​defaultoptions、​extensions、​extensiontags、​fileextensions、​functionhooks、​general、​interwikimap、​languages、​languagevariants、​libraries、​magicwords、​namespacealiases、​namespaces、​protocols、​restrictions、​rightsinfo、​showhooks、​skins、​specialpagealiases、​statistics、​uploaddialog、​usergroups、​variables
預設值:general
sifilteriw

僅回傳跨 wiki 地圖的本地端或非本地端項目。

單值:!local、​local
sishowalldb

列出所有資料庫伺服器,不是只有最延遲的那台。

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

列出在使用者群組裡的使用者數目。

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

用於本地化語言的語言代碼(盡可能)與外觀名稱。

meta=tokens

main | query | tokens

取得資料修改操作的權杖。

參數:
type

要求的權杖類型。

多值 (以 |alternative 分隔):createaccount、​csrf、​login、​patrol、​rollback、​userrights、​watch
預設值:csrf
範例:
接收 csrf 權杖(預設)。
api.php?action=query&meta=tokens [在沙盒中開啟]
接收監視權杖以及巡邏權杖。
api.php?action=query&meta=tokens&type=watch|patrol [在沙盒中開啟]

meta=userinfo (ui)

main | query | userinfo

取得目前使用者的資訊。

參數:
uiprop

要包含的資訊部份:

blockinfo
若目前使用者被封鎖則標記出由誰做出,以及出於何種原因。
hasmsg
若目前使用者有等待訊息,添加 messages 標籤。
groups
列出目前使用者所隸屬的所有群組。
groupmemberships
列出明確分配目前使用者的群組,包含各群組成員的逾期日期。
implicitgroups
列出目前使用者自動列入為成員的所有群組。
rights
列出目前使用者所擁有的權限。
changeablegroups
列出目前使用者可以做出添加以及移除的群組。
options
列出目前使用者已設定過的所有偏好設定。
editcount
添加目前使用者的編輯數。
ratelimits
列出所有套用到目前使用者的速率限制。
theoreticalratelimits
若根據使用者權限或 IP,他們並非不受所有速率限制的約束,列出所有套用在目前使用者的速率限制
email
添加使用者的電子郵件地址與電子郵件驗證日期。
realname
添加使用者的真實姓名。
acceptlang
回響由在架構化格式客戶端所發送的 Accept-Language 標頭。
registrationdate
添加使用者的註冊日期。
unreadcount
添加使用者監視清單上的未讀頁面數量(最多999;如有更多則回傳1000+)。
centralids
替使用者添加中心 ID 與附加狀態。
latestcontrib
添加使用者最新貢獻的日期。
多值 (以 |alternative 分隔):acceptlang、​blockinfo、​centralids、​changeablegroups、​editcount、​email、​groupmemberships、​groups、​hasmsg、​implicitgroups、​latestcontrib、​options、​ratelimits、​realname、​registrationdate、​rights、​theoreticalratelimits、​unreadcount
要指定所有值,請使用*
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 [在沙盒中開啟]
對所有電子郵件地址為 [email protected] 的使用者發送重新設定密碼電郵。
api.php?action=resetpassword&[email protected]&token=123ABC [在沙盒中開啟]

action=revisiondelete

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

刪除和取消刪除修訂。

參數:
type

正執行的修訂刪除類型。

此參數已棄用。
單值:archive、​filearchive、​logging、​oldimage、​revision
target

要修訂刪除的頁面標題,若類型有所需要。

ids

要刪除的修訂識別碼。

此參數已棄用。
將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
hide

各修訂所要隱藏的內容。

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

各修訂所要取消隱藏的內容。

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

是否對管理者及其他使用者禁止資料。

單值:no、​nochange、​yes
預設值: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

編輯被回退的使用者名稱。

此參數已棄用。
類型:使用者,按任何使用者名稱、​IP、​跨 wiki 名稱(例如:"prefix>ExampleName")和使用者 ID(例如:"#12345")
summary

自定義編輯摘要。若為空,則使用預設摘要。

預設值:(空)
markbot

將回退的編輯以及回退操作標記為機器人所做編輯。

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

使用偏好設定無條件地將頁面加入至或移除自目前使用者的監視清單(略過機器人使用者),或不更改監視。

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

action=query&meta=tokens 接收的「rollback」權杖。

為顧及相容性,web UI 中使用的權杖(Token)也是可接受的。

此參數已棄用。
範例:
回退由使用者 Example 對頁面 Main Page 所做的最新編輯。
api.php?action=rollback&title=Main%20Page&user=Example&token=123ABC [在沙盒中開啟]
帶編輯摘要 Reverting vandalism 來回退由 IP 使用者 192.0.2.5 對頁面 Main Page 所做的最新編輯,並標記這些編輯與回退為機器人做出的編輯。
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
列出在目前使用者的監視清單裡頭所有頁面。
單值:allcategories、​alldeletedrevisions、​allfileusages、​allimages、​alllinks、​allpages、​allredirects、​allrevisions、​alltransclusions、​backlinks、​categories、​categorymembers、​deletedrevisions、​duplicatefiles、​embeddedin、​exturlusage、​fileusage、​images、​imageusage、​iwbacklinks、​langbacklinks、​links、​linkshere、​pageswithprop、​prefixsearch、​protectedtitles、​querypage、​random、​recentchanges、​redirects、​revisions、​search、​templates、​transcludedin、​watchlist、​watchlistraw
redirects

自動解決在 titlespageidsrevids,以及由 generator 所回傳頁面裡的重新導向。

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

如有需要,轉換標題成其它變體。這僅在 wiki 的內容語言支援變體轉換時有用。支援變體轉換的語言包含有ban、​en、​crh、​gan、​iu、​kk、​ku、​shi、​sr、​tg、​uz和zh。

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

action=query&meta=tokens 接收的「csrf」權杖。

此參數已棄用。

action=setpagelanguage

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

更改頁面的語言。

您不被允許在此 wiki 上變更頁面的語言。

請啟用 $wgPageLanguageUseDB 來進行此操作。

參數:
title

您所想要更改語言的頁面之標題。不能與 pageid 一起使用。

pageid

您所想要更改語言的頁面之頁面 ID。不能與 title 一起使用。

類型:整數
lang

要更改頁面的語言之代碼。使用 default 來重新設定頁面成 wiki 的預設內容語言。

此參數已棄用。
單值:ab、​abs、​ace、​ady、​ady-cyrl、​aeb、​aeb-arab、​aeb-latn、​af、​ak、​aln、​alt、​am、​ami、​an、​ang、​anp、​ar、​arc、​arn、​arq、​ary、​arz、​as、​ase、​ast、​atj、​av、​avk、​awa、​ay、​az、​azb、​ba、​ban、​ban-bali、​bar、​bbc、​bbc-latn、​bcc、​bci、​bcl、​be、​be-tarask、​bg、​bgn、​bh、​bho、​bi、​bjn、​bm、​bn、​bo、​bpy、​bqi、​br、​brh、​bs、​btm、​bto、​bug、​bxr、​ca、​cbk-zam、​cdo、​ce、​ceb、​ch、​chr、​chy、​ckb、​co、​cps、​cr、​crh、​crh-cyrl、​crh-latn、​cs、​csb、​cu、​cv、​cy、​da、​dag、​de、​de-at、​de-ch、​de-formal、​default、​din、​diq、​dsb、​dtp、​dty、​dv、​dz、​ee、​egl、​el、​eml、​en、​en-ca、​en-gb、​eo、​es、​es-formal、​et、​eu、​ext、​fa、​ff、​fi、​fit、​fj、​fo、​fr、​frc、​frp、​frr、​fur、​fy、​ga、​gag、​gan、​gan-hans、​gan-hant、​gcr、​gd、​gl、​glk、​gn、​gom、​gom-deva、​gom-latn、​gor、​got、​grc、​gsw、​gu、​guc、​guw、​gv、​ha、​hak、​haw、​he、​hi、​hif、​hif-latn、​hil、​hr、​hrx、​hsb、​ht、​hu、​hu-formal、​hy、​hyw、​ia、​id、​ie、​ig、​ii、​ik、​ike-cans、​ike-latn、​ilo、​inh、​io、​is、​it、​iu、​ja、​jam、​jbo、​jut、​jv、​ka、​kaa、​kab、​kbd、​kbd-cyrl、​kbp、​kcg、​kg、​khw、​ki、​kiu、​kjp、​kk、​kk-arab、​kk-cn、​kk-cyrl、​kk-kz、​kk-latn、​kk-tr、​kl、​km、​kn、​ko、​ko-kp、​koi、​krc、​kri、​krj、​krl、​ks、​ks-arab、​ks-deva、​ksh、​ku、​ku-arab、​ku-latn、​kum、​kv、​kw、​ky、​la、​lad、​lb、​lbe、​lez、​lfn、​lg、​li、​lij、​liv、​lki、​lld、​lmo、​ln、​lo、​loz、​lrc、​lt、​ltg、​lus、​luz、​lv、​lzh、​lzz、​mad、​mai、​map-bms、​mdf、​mg、​mhr、​mi、​min、​mk、​ml、​mn、​mni、​mnw、​mo、​mr、​mrh、​mrj、​ms、​ms-arab、​mt、​mwl、​my、​myv、​mzn、​na、​nah、​nan、​nap、​nb、​nds、​nds-nl、​ne、​new、​nia、​niu、​nl、​nl-informal、​nn、​nov、​nqo、​nrm、​nso、​nv、​ny、​nys、​oc、​ojb、​olo、​om、​or、​os、​pa、​pag、​pam、​pap、​pcd、​pdc、​pdt、​pfl、​pi、​pih、​pl、​pms、​pnb、​pnt、​prg、​ps、​pt、​pt-br、​pwn、​qu、​qug、​rgn、​rif、​rm、​rmc、​rmy、​ro、​roa-tara、​ru、​rue、​rup、​ruq、​ruq-cyrl、​ruq-latn、​rw、​sa、​sah、​sat、​sc、​scn、​sco、​sd、​sdc、​sdh、​se、​sei、​ses、​sg、​sgs、​sh、​shi、​shn、​shy、​shy-latn、​si、​sjd、​sje、​sk、​skr、​skr-arab、​sl、​sli、​sm、​sma、​smn、​sn、​so、​sq、​sr、​sr-ec、​sr-el、​srn、​ss、​st、​stq、​sty、​su、​sv、​sw、​szl、​szy、​ta、​tay、​tcy、​te、​tet、​tg、​tg-cyrl、​tg-latn、​th、​ti、​tk、​tl、​tly、​tn、​to、​tpi、​tr、​tru、​trv、​ts、​tt、​tt-cyrl、​tt-latn、​tw、​ty、​tyv、​tzm、​udm、​ug、​ug-arab、​ug-latn、​uk、​ur、​uz、​ve、​vec、​vep、​vi、​vls、​vmf、​vo、​vot、​vro、​wa、​war、​wls、​wo、​wuu、​xal、​xh、​xmf、​xsy、​yi、​yo、​yue、​za、​zea、​zgh、​zh、​zh-cn、​zh-hans、​zh-hant、​zh-hk、​zh-mo、​zh-my、​zh-sg、​zh-tw、​zu
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=spamblacklist

  • 此模組需要讀取權限。
  • 來源:SpamBlacklist
  • 授權條款:GPL-2.0-or-later

驗證一個或多個URL是否觸發垃圾連結黑名單。

參數:
url

要驗證是否觸發黑名單的URL。

此參數已棄用。
將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。

action=stashedit

main | stashedit
  • 此模組是內部的或不穩定的。它的操作可能更改而不另行通知。
  • 此模組需要讀取權限。
  • 此模組需要寫入權限。
  • 此模組僅接受 POST 請求。
  • 來源:MediaWiki
  • 授權條款:GPL-2.0-or-later

在分享快取裡預備編輯。

此意指使用透過自編輯表單的 AJAX 來改善頁面儲存的效能。

參數:
title

正在編輯此頁面的標題。

此參數已棄用。
section

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

sectiontitle

新章節的標題。

text

頁面內容。

stashedtexthash

要替代使用的來自先前儲藏裡頁面內容雜湊。

summary

更改摘要。

預設值:(空)
contentmodel

新內容的內容模組。

此參數已棄用。
單值:css、​javascript、​json、​text、​unknown、​wikitext
contentformat

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

此參數已棄用。
單值:application/json、​application/octet-stream、​application/unknown、​application/x-binary、​text/css、​text/javascript、​text/plain、​text/unknown、​text/x-wiki、​unknown/unknown
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」權杖。

此參數已棄用。
範例:
不指明原因將 ID 為 123 的修訂添加 vandalism 標籤
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=titleblacklist (tb)

  • 此模組需要讀取權限。
  • 來源:TitleBlacklist
  • 授權條款:GPL-2.0-or-later

檢驗一個頁面的標題、檔案名稱或使用者名稱是否觸發標題黑名單。

參數:
tbtitle

要用來檢驗黑名單的字串。

此參數已棄用。
tbaction

要檢查的操作。

單值:create、​createpage、​createtalk、​edit、​move、​new-account、​upload
預設值:edit
tbnooverride

不要嘗試覆蓋標題黑名單。

類型:布林值(詳細資訊

action=unblock

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

解除封鎖一位使用者。

參數:
id

要解封的封鎖 ID(可透過 list=blocks 取得)。不可與 user 一起使用。

類型:整數
user

要解封的使用者。不能與 id 一起使用。

類型:使用者,按任何使用者名稱、​IP、​IP 範圍和使用者 ID(例如:"#12345")
userid
已棄用。

改成指定 user=#ID

類型:整數
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

使用偏好設定無條件地將頁面加入至或移除自目前使用者的監視清單(略過機器人使用者),或不更改監視。

單值:nochange、​preferences、​unwatch、​watch
預設值: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 參數。
  • 分批上傳檔案,請使用 filesizechunk、以及 offset 參數。
  • 擁有 MediaWiki 伺服器來從 URL 來檢索檔案,請使用 url 參數。
  • 要完成一個稍早出於警告而失敗的上傳,請使用 filekey 參數。

請注意當發送 file 時,HTTP POST 必須用做為檔案上傳(註:使用 multipart/form-data)。

參數:
filename

目標檔案名稱。

comment

上傳註釋。如果 text 未指定的話,也會作為新檔案用的初始頁面文字。

預設值:(空)
tags

更改標籤來套用到上傳日誌項目以及檔案頁面修訂。

多值 (以 |alternative 分隔):
text

用於新檔案的初始頁面文字。

watch
已棄用。

監視頁面。

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

使用偏好設定無條件地將頁面加入至或移除自目前使用者的監視清單(略過機器人使用者),或不更改監視。

單值:nochange、​preferences、​watch
預設值: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

使用者。

類型:使用者,按任何使用者名稱和使用者 ID(例如:"#12345")
userid
已棄用。

改成指定 user=#ID

類型:整數
add

加入使用者至這些群組;若已是成員,則更新期限時間。

多值 (以 |alternative 分隔):bot、​bureaucrat、​interface-admin、​suppress、​sysop
expiry

期限時間戳記。可以是相對時間(例如:5 months2 weeks)或是絕對時間(例如:2014-09-18T12:34:56Z)。如果僅設定一個時間戳記,會為所有群組傳遞給 add 參數。對於永不逾期的群組,請使用 infiniteinfinity、或 never

將幾個值以 |alternative 分隔。
值的最大數目為 50(用於客戶端允許的較高限制為 500)。
預設值:infinite
remove

從這些群組移除使用者。

多值 (以 |alternative 分隔):bot、​bureaucrat、​interface-admin、​suppress、​sysop
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 的使用者至群組 bot,並從群組 sysopbureaucrat 裡移除。
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

使用者名稱,用於測試帳號建立。所命名的使用者必須未存在。

類型:使用者,按任何使用者名稱和使用者 ID(例如:"#12345")
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
列出在目前使用者的監視清單裡頭所有頁面。
單值:allcategories、​alldeletedrevisions、​allfileusages、​allimages、​alllinks、​allpages、​allredirects、​allrevisions、​alltransclusions、​backlinks、​categories、​categorymembers、​deletedrevisions、​duplicatefiles、​embeddedin、​exturlusage、​fileusage、​images、​imageusage、​iwbacklinks、​langbacklinks、​links、​linkshere、​pageswithprop、​prefixsearch、​protectedtitles、​querypage、​random、​recentchanges、​redirects、​revisions、​search、​templates、​transcludedin、​watchlist、​watchlistraw
redirects

自動解決在 titlespageidsrevids,以及由 generator 所回傳頁面裡的重新導向。

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

如有需要,轉換標題成其它變體。這僅在 wiki 的內容語言支援變體轉換時有用。支援變體轉換的語言包含有ban、​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),可能會不警告做出改變。
單值:1、​2、​latest
預設值:1

format=jsonfm

main | jsonfm

使用 JSON 格式輸出資料(使用HTML格式顯示)。

參數:
wrappedhtml

回傳作為 JSON 物件的美觀列印 HTML 內容以及關聯 ResourceLoader 模組。

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

若有指定,將輸出包在指定的函式呼叫。出於安全考量,會限制所有使用者特定資料。

utf8

若有指定的話,將多數(並非全部)非 ASCII 字元編碼成 UTF-8,而不是以十六進位轉義序列來取代掉。預設是當 formatversion 不是 1 時。

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

若有指定,編碼所有使用十六進位跳脫序列的非 ASCII 字碼。預設當 formatversion1 時。

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

輸出格式

1
(無描述)
2
(無描述)
latest
(無描述)
單值:1、​2、​latest
預設值:1

format=none

main | none

不輸出。

format=php

main | php

使用序列化 PHP 格式輸出資料。

參數:
formatversion

輸出格式

1
向下相容格式(XML-樣式的布林類型、以 * 鍵作為內容節點等等)。
2
現代格式。
latest
使用最新格式(目前為 2),可能會不警告做出改變。
單值:1、​2、​latest
預設值:1

format=phpfm

main | phpfm

使用序列化 PHP 格式輸出資料 (使用 HTML 格式顯示)。

參數:
wrappedhtml

回傳作為 JSON 物件的美觀列印 HTML 內容以及關聯 ResourceLoader 模組。

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

輸出格式

1
(無描述)
2
(無描述)
latest
(無描述)
單值:1、​2、​latest
預設值:1

format=rawfm

main | rawfm

使用 JSON 格式的除錯元素輸出資料 (使用 HTML 格式顯示)。

參數:
wrappedhtml

回傳作為 JSON 物件的美觀列印 HTML 內容以及關聯 ResourceLoader 模組。

類型:布林值(詳細資訊

format=xml

main | xml

使用 XML 格式輸出資料。

參數:
xslt

若有指定,添加命名頁面成 XSL 樣式表。值必須是在 .xsl 結尾處 MediaWiki 命名空間裡的標題。

includexmlnamespace

若有指定,添加一個 XML 命名空間。

類型:布林值(詳細資訊

format=xmlfm

main | xmlfm

使用 XML 格式輸出資料 (使用 HTML 格式顯示)。

參數:
wrappedhtml

回傳作為 JSON 物件的美觀列印 HTML 內容以及關聯 ResourceLoader 模組。

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

若有指定,添加命名頁面成 XSL 樣式表。值必須是在 .xsl 結尾處 MediaWiki 命名空間裡的標題。

includexmlnamespace

若有指定,添加一個 XML 命名空間。

類型:布林值(詳細資訊

資料類型

輸入到 MediaWiki 應為 NFC-標準化的 UTF-8。雖然 MediaWiki 會嘗試轉換成其它輸入,但這可能會引發一些操作上錯誤(例如像以 MD5 核對的編輯)。

帶有多項值的參數通常是以豎線字元做區分來提交,例如:param=value1|value2 或是 param=value1%7Cvalue2。如果值的內容必須包含豎線字元,請使用 U+001F(單位分隔)來做為區分,並且讓值的字首加上 U+001F,例如:param=%1Fvalue1%1Fvalue2

在 API 請求中的某些參數需要進一步解釋:

boolean

布林值參數運作上就像 HTML 的勾選框:若有指定參數,不論值的內容為何都視為 true。對於 false 值,則是將參數整個省略。

expiry

到期時間。可以是相對時間(例如:5 months2 weeks)或是絕對時間(例如:2014-09-18T12:34:56Z)。如果要無期限,請使用 infiniteindefiniteinfinity、或 never

timestamp

時間戳記能以數種格式指定,請查看在 mediawiki.org 上的時間戳記函式庫輸入格式文件來獲得更多資訊。推薦採用 ISO 8601 日期與時間格式:2001-01-15T14:56:00Z。另外,字串 now 能用來指定目前時刻的時間戳記。

模板參數

模板參數可支援當 API 模組需要替某些參數值給予值的情況。舉例來說,如果有個用來請求水果的 API 模組,可能會有一個用來指定水果的 fruits 參數,以及用來指定有多少顆水果的模板參數 {fruit}-quantity。若一個 API 客戶端想要 1 顆蘋果、5 條香蕉、以及 20 粒草莓時,可以做出像是 fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20 這樣的請求。

製作群

API 開發人員:

  • Roan Kattouw (首席開發者 Sep 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (創立者,首席開發者 Sep 2006–Sep 2007)
  • Brad Jorsch (首席開發者 2013–present)

請傳送您的評論、建議以及問題至 [email protected] 或者回報問題至 https://phabricator.wikimedia.org/。