MediaWiki API 說明

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

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

主要模組

（main）

來源：MediaWiki
授權條款：GPL-2.0-or-later

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

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

測試：要簡化 API 請求的測試過程，請見 Special:ApiSandbox。

參數：

action

要執行的動作。

block: 封鎖使用者。
categorytree: 用於 CategoryTree 擴充套件的內部模組。
changeauthenticationdata: 為目前使用者變更身分核對資料。
checktoken: 檢查來自 action=query&meta=tokens 的權杖有效性。
clearhasmsg: 清除目前使用者的 hasmsg 標記。
clientlogin: 使用互動流程來登入 wiki。
compare: 比較 2 個頁面間的差異。
createaccount: 建立新使用者帳號。
cspreport: 由瀏覽器所使用來回報違反內容安全方針。此模組應永不使用，除了是在被由兼容內容安全方針的網路瀏覽器所使用情況下。
delete: 刪除頁面。
edit: 建立與編輯頁面。
emailuser: 寄送電子郵件給使用者。
expandtemplates: 展開所有於 wikitext 中模板。
feedcontributions: 回傳使用者貢獻摘要。
feedrecentchanges: 返回近期變更摘要。
feedwatchlist: 返回監視清單摘要。
filerevert: 回退檔案至舊的版本。
help: 顯示指定模組的說明。
imagerotate: 旋轉一張或多張圖片。
import: 從其它 wiki 或 XML 檔案來匯入頁面。
linkaccount: 從第三方供應者來連結帳號至目前的使用者。
login: 登入並取得身分核對 cookies
logout: 登出並清除 session 資料。
managetags: 執行相關到更改標籤的管理任務。
mergehistory: 合併頁面歷史
mobileview: 回傳手機檢視需要的資料。
move: 移動頁面。
oathvalidate: 驗證雙因素驗證（OATH）權杖。
opensearch: 使用 OpenSearch 協定搜尋本 wiki。
options: 更改目前使用者的偏好設定。
paraminfo: 獲得有關 API 模組的資訊。
parse: 解析內容併回傳解析器輸出。
patrol: 巡查頁面或修訂。
protect: 變更頁面的保護層級。
purge: 為指定標題清除快取。
query: 擷取來自及有關MediaWiki的數據。
removeauthenticationdata: 為目前使用者移除身分核對資料。
resetpassword: 寄送重新設定密碼的電子郵件給使用者。
revisiondelete: 刪除和取消刪除修訂。
rollback: 復原頁面的最後一次編輯。
rsd: 匯出一個簡易探索（Really Simple Discovery、RSD）架構。
scribunto-console: 來自 Scribunto 主控台用於服務 XHR 請求的內部模組。
setnotificationtimestamp: 更新監視頁面的通知時間戳記。
setpagelanguage: 更改頁面的語言。
spamblacklist: 驗證一個或多個URL是否觸發垃圾連結黑名單。
stashedit: 在分享快取裡預備編輯。
tag: 從各別修訂或日誌項目添加或移除變更標籤。
titleblacklist: 檢驗一個頁面的標題、檔案名稱或使用者名稱是否觸發標題黑名單。
unblock: 解除封鎖一位使用者。
undelete: 恢復已刪除頁面的修訂。
unlinkaccount: 移除目前使用者所連結到的第三方帳號。
upload: 上傳檔案，或取得等待上傳的狀態。
userrights: 變更一位使用者的群組成員。
validatepassword: 驗證密碼是否符合 wiki 的密碼方針。
watch: 從目前使用者的監視清單添加或移除頁面。
webapp-manifest: 回傳 webapp manifest。
tokens: 已停用。取得資料修改動作的權杖。

單值：block、categorytree、changeauthenticationdata、checktoken、clearhasmsg、clientlogin、compare、createaccount、cspreport、delete、edit、emailuser、expandtemplates、feedcontributions、feedrecentchanges、feedwatchlist、filerevert、help、imagerotate、import、linkaccount、login、logout、managetags、mergehistory、mobileview、move、oathvalidate、opensearch、options、paraminfo、parse、patrol、protect、purge、query、removeauthenticationdata、resetpassword、revisiondelete、rollback、rsd、scribunto-console、setnotificationtimestamp、setpagelanguage、spamblacklist、stashedit、tag、titleblacklist、unblock、undelete、unlinkaccount、upload、userrights、validatepassword、watch、webapp-manifest、tokens

預設值：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，會確認使用者是否已登入；若設為bot，會確認是否擁有機械人權限。

單值：user、bot

assertuser

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

類型：使用者名稱

requestid

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

servedby

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

類型：布林值（詳細資訊）

curtimestamp

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

類型：布林值（詳細資訊）

responselanginfo

在結果中包括uselang和errorlang所用的語言。

類型：布林值（詳細資訊）

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-Origin 與 Access-Control-Allow-Credentials 標頭。

對於非認證請求，會指定值 *。這會產生 Access-Control-Allow-Origin 標頭有被設定；但 Access-Control-Allow-Credentials 會是 false 值，且所有使用者指定資料會受限制。

uselang

訊息翻譯採用的語言。使用 action=query&meta=siteinfo 與 siprop=languages 會回傳語言代碼清單、或指定 user 來使用目前使用者的語言偏好設定、或是指定 content 來使用此 wiki 的內容語言。

預設值：user

errorformat

用於警告和錯誤文字輸出的格式。

plaintext：移除掉 HTML 標籤，且實體已替換的 wiki 文字。
wikitext：未解析的 wiki 文字。
html：HTML。
raw：訊息鍵值與參數。
none：無文字輸出，僅含有錯誤代碼。
bc：用於 MediaWiki 1.29 之前版本的格式。會忽略 errorlang 與 errorsuselocal。

單值：plaintext、wikitext、html、raw、none、bc

預設值：bc

errorlang

警告與錯誤採用的語言。使用 action=query&meta=siteinfo 與 siprop=languages 會回傳語言代碼清單、或指定 content 來使用此 wiki 的內容語言、或是指定 uselang 來使用與 uselang 參數相同的值。

預設值：uselang

errorsuselocal

若有指定，錯誤文字會使用來自 MediaWiki 命名空間的本地自定義訊息。

類型：布林值（詳細資訊）

範例：

主模組使用說明: api.php?action=help [在沙盒中開啟]
一個頁面中的所有說明。: api.php?action=help&recursivesubmodules=1 [在沙盒中開啟]

權限：

writeapi: 使用寫入 API; 已授權給: all、user 和 bot
apihighlimits: 在 API 查詢使用較高的限制（慢速查詢：500；快速查詢：5000）。慢速查詢的限制也適用於多值參數。; 已授權給: bot 和 sysop

action=block

（main | block）

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

封鎖使用者。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Block

參數：

user: 要封鎖的使用者名稱、IP 位址或 IP 範圍。不能與 userid 一起使用; 類型：使用者名稱
userid: 要封鎖的使用者 ID。不可與 user 一同使用。; 類型：整數
expiry: 期限時間。可以是相對時間（例如：5 months 或 2 weeks）或是絕對時間（例如：2014-09-18T12:34:56Z）。如果設定成 infinite、indefinite、或 never，封鎖將會無期限。; 預設值：never
reason: 封鎖原因。; 預設值：(空)
anononly: 僅封鎖匿名使用者 (禁止這個 IP 位址的匿名使用者編輯)。; 類型：布林值（詳細資訊）
nocreate: 禁止建立帳號。; 類型：布林值（詳細資訊）
autoblock: 自動封鎖最後使用的 IP 位址，以及在這之後嘗試登入的 IP 位址。; 類型：布林值（詳細資訊）
noemail: 禁止使用者透過 Wiki 寄送電子郵件。 (需要 blockemail 權限)。; 類型：布林值（詳細資訊）
hidename: 隱藏封鎖日誌的使用者名稱。 (需要 hideuser 權限)。; 類型：布林值（詳細資訊）
allowusertalk: 允許使用者編輯自己的對話頁面 (依據 $wgBlockAllowsUTEdit 的設定)。; 類型：布林值（詳細資訊）
reblock: 若使用者已被封鎖，覆寫既有的封鎖設定值。; 類型：布林值（詳細資訊）
watchuser: 監視使用者或 IP 位址的使用者頁面與對話頁面。; 類型：布林值（詳細資訊）
tags: 在封鎖日誌裡更改套用到項目的標籤。; 多值 (以 | 或 alternative 分隔)：
token: 自 action=query&meta=tokens 接收的「csrf」權杖。; 此參數為必填。

範例：

封鎖 IP 位址 192.0.2.5 三天，原因為 First strike。: api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC [在沙盒中開啟]
永久封鎖用戶 Vandal，原因為 Vandalism，並防止建立新帳號及發送電子郵件。: api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC [在沙盒中開啟]

action=categorytree

（main | categorytree）

此模組是內部的或不穩定的。它的操作可能更改而不另行通知。
此模組需要讀取權限。
來源：CategoryTree
授權條款：GPL-2.0-or-later

用於 CategoryTree 擴充套件的內部模組。

參數：

category: 在分類命名空間中的標題，若有字首則會忽略。; 此參數為必填。
options: 供 CategoryTree 建構子的 JSON 物件參數。depth 項目預設為 1。

action=changeauthenticationdata （changeauth）

（main | changeauthenticationdata）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Manage_authentication_data

參數：

changeauthrequest: 使用此身份驗證請求，透過自action=query&meta=authmanagerinfo回傳的id與amirequestsfor=change。; 此參數為必填。
changeauthtoken: 自 action=query&meta=tokens 接收的「csrf」權杖。; 此參數為必填。
*: 此模組允許額外參數，取決於可用的身份驗證請求。使用action=query&meta=authmanagerinfo与amirequestsfor=change（或之前來自此模組的回應，如果合適）以決定可用請求及其使用的欄位。

範例：

嘗試更改目前使用者的密碼至 ExamplePassword。: api.php?action=changeauthenticationdata&changeauthrequest=MediaWiki%5CAuth%5CPasswordAuthenticationRequest&password=ExamplePassword&retype=ExamplePassword&changeauthtoken=123ABC [在沙盒中開啟]

action=checktoken

（main | checktoken）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

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

參數：

type: 要測試的權杖類型。; 此參數為必填。; 單值：createaccount、csrf、login、patrol、rollback、userrights、watch
token: 要測試的權杖。; 此參數為必填。
maxtokenage: 權杖的有效期間，以秒為單位。; 類型：整數

範例：

測試 csrf 權杖的有效性。: api.php?action=checktoken&type=csrf&token=123ABC [在沙盒中開啟]

action=clearhasmsg

（main | clearhasmsg）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:ClearHasMsg

範例：

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

action=clientlogin （login）

（main | clientlogin）

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

使用互動流程來登入 wiki。

使用此模組的一般步驟是：

透過 amirequestsfor=login 取得來自 action=query&meta=authmanagerinfo 的可用欄位，和來自 action=query&meta=tokens 的login權杖。
向使用者顯示欄位，並獲得其提交的內容。
提交（POST）至此模組，提供 loginreturnurl 及任何相關欄位。
在回應中檢查 status。
- 如果您收到了 PASS（成功）或FAIL（失敗），則認為操作結束。成功與否如上句所示。
- 如果您收到了 UI，向使用者顯示新欄位，並再次獲取其提交的內容。然後再次使用 logincontinue，向本模組提交相關欄位，並重復第四步。
- 如果您收到了 REDIRECT，將使用者指向redirecttarget 中的目標，等待其返回loginreturnurl。然後再次使用 logincontinue，向本模組提交返回 URL 中提供的一切欄位，並重復第四步。
- 如果您收到了 RESTART，表示身份驗證正常運作，但我們沒有連結的使用者帳戶。您可以將此視為 UI或FAIL。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Login

參數：

loginrequests

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

將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

loginmessageformat

用於回傳訊息的格式。

單值：html、wikitext、raw、none

預設值：wikitext

loginmergerequestfields

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

類型：布林值（詳細資訊）

loginpreservestate

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

類型：布林值（詳細資訊）

loginreturnurl

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

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

logincontinue

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

類型：布林值（詳細資訊）

logintoken

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

此參數為必填。

*

此模組允許額外參數，取決於可用的身份驗證請求。使用action=query&meta=authmanagerinfo与amirequestsfor=login（或之前來自此模組的回應，如果合適）以決定可用請求及其使用的欄位。

範例：

開始以使用者 Example 與密碼 ExamplePassword 來登入至 wiki 的過程。: api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [在沙盒中開啟]
在 UI 回應雙因素驗證後繼續登入，提供 987654 的 OATHToken。: api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [在沙盒中開啟]

action=compare

（main | compare）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

比較 2 個頁面間的差異。

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

參數：

fromtitle

要比對的第一個標題。

fromid

要比對的第一個頁面 ID。

類型：整數

fromrev

要比對的第一個修訂。

類型：整數

fromslots

覆蓋由 fromtitle、fromid 或 fromrev 指定的修訂內容。

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

多值 (以 | 或 alternative 分隔)：main

fromtext-{slot}

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

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

fromsection-{slot}

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

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

fromcontentformat-{slot}

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

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

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

fromcontentmodel-{slot}

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

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

單值：GadgetDefinition、Scribunto、wikitext、javascript、json、css、text

frompst

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

類型：布林值（詳細資訊）

fromtext

已停用。

指定 fromslots=main 並改用 fromtext-main。

fromcontentformat

已停用。

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

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

fromcontentmodel

已停用。

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

單值：GadgetDefinition、Scribunto、wikitext、javascript、json、css、text

fromsection

已停用。

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

totitle

要比對的第二個標題。

toid

要比對的第二個頁面 ID。

類型：整數

torev

要比對的第二個修訂。

類型：整數

torelative

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

單值：prev、next、cur

toslots

覆蓋由 totitle、toid 或 torev 指定的修訂內容。

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

多值 (以 | 或 alternative 分隔)：main

totext-{slot}

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

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

tosection-{slot}

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

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

tocontentformat-{slot}

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

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

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

tocontentmodel-{slot}

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

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

單值：GadgetDefinition、Scribunto、wikitext、javascript、json、css、text

topst

在 totext 執行預先保存轉換。

類型：布林值（詳細資訊）

totext

已停用。

指定 toslots=main 並改用 totext-main。

tocontentformat

已停用。

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

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

tocontentmodel

已停用。

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

單值：GadgetDefinition、Scribunto、wikitext、javascript、json、css、text

tosection

已停用。

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

prop

要取得的資訊部份。

diff: HTML 差異。
diffsize: 以位元組為單位的 HTML 差異大小。
rel: 'from' 之前與 'to' 之後修訂的修訂 ID，若有的話。
ids: 「from」與「to」修訂的頁面與修訂 ID。
title: 「from」與「to」修訂的頁面標題。
user: 「from」與「to」修訂的使用者名稱與 ID。
comment: 「from」與「to」修訂的註釋。
parsedcomment: 「from」與「to」修訂的解析註釋。
size: 「from」與「to」修訂的大小。

多值 (以 | 或 alternative 分隔)：diff、diffsize、rel、ids、title、user、comment、parsedcomment、size

預設值：diff|ids|title

slots

回傳這些間隔的個別差異，而不是由所有間隔所合併出的單一差異。

多值 (以 | 或 alternative 分隔)：main

要指定所有值，請使用*。

範例：

建立修訂 1 與 1 的差異檔: api.php?action=compare&fromrev=1&torev=2 [在沙盒中開啟]

action=createaccount （create）

（main | createaccount）

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

建立新使用者帳號。

使用此模組的一般步驟是：

透過 amirequestsfor=create 取得來自 action=query&meta=authmanagerinfo 的可用欄位，和來自 action=query&meta=tokens 的createaccount權杖。
向使用者顯示欄位，並獲得其提交的內容。
提交（POST）至此模組，提供 createreturnurl 及任何相關欄位。
在回應中檢查 status。
- 如果您收到了 PASS（成功）或FAIL（失敗），則認為操作結束。成功與否如上句所示。
- 如果您收到了 UI，向使用者顯示新欄位，並再次獲取其提交的內容。然後再次使用 createcontinue，向本模組提交相關欄位，並重復第四步。
- 如果您收到了 REDIRECT，將使用者指向redirecttarget 中的目標，等待其返回createreturnurl。然後再次使用 createcontinue，向本模組提交返回 URL 中提供的一切欄位，並重復第四步。
- 如果您收到了 RESTART，表示身份驗證正常運作，但我們沒有連結的使用者帳戶。您可以將此視為 UI或FAIL。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Account_creation

參數：

createrequests

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

將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

createmessageformat

用於回傳訊息的格式。

單值：html、wikitext、raw、none

預設值：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

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

類型：布林值（詳細資訊）

createtoken

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

此參數為必填。

*

此模組允許額外參數，取決於可用的身份驗證請求。使用action=query&meta=authmanagerinfo与amirequestsfor=create（或之前來自此模組的回應，如果合適）以決定可用請求及其使用的欄位。

範例：

開始建立使用者 Example 與密碼 ExamplePassword 的過程。: api.php?action=createaccount&username=Example&password=ExamplePassword&retype=ExamplePassword&createreturnurl=http://example.org/&createtoken=123ABC [在沙盒中開啟]

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

刪除頁面。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Delete

參數：

title: 您欲刪除的頁面標題。無法與 pageid 同時使用。
pageid: 您欲刪除頁面的頁面 ID。無法與 title 同時使用。; 類型：整數
reason: 刪除的原因。若未設定，將會使用自動產生的原因。
tags: 在刪除日誌裡更改套用到項目的標籤。; 多值 (以 | 或 alternative 分隔)：
watch: 已停用。; 加入目前頁面至您的監視清單。; 類型：布林值（詳細資訊）
watchlist: 使用偏好設定無條件地將頁面加入至或移除自目前使用者的監視清單，或不更改監視。; 單值：watch、unwatch、preferences、nochange; 預設值：preferences
unwatch: 已停用。; 從您的監視清單中移除目前頁面。; 類型：布林值（詳細資訊）
oldimage: 由 action=query&prop=imageinfo&iiprop=archivename 所提供要刪除的舊圖片名稱。
token: 自 action=query&meta=tokens 接收的「csrf」權杖。; 此參數為必填。

範例：

刪除 Main Page。: api.php?action=delete&title=Main%20Page&token=123ABC [在沙盒中開啟]
刪除 Main Page 原因為 Preparing for move。: api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move [在沙盒中開啟]

action=edit

（main | edit）

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

建立與編輯頁面。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Edit

參數：

title

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

pageid

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

類型：整數

section

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

sectiontitle

新章節的標題。

text

頁面內容。

summary

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

tags

更改套用到修訂的標籤。

多值 (以 | 或 alternative 分隔)：

minor

標記此編輯為小編輯。

類型：布林值（詳細資訊）

notminor

不要標記此編輯為小編輯，即使有設定到「預設標記所有的編輯為次要修訂」使用者偏好設定。

類型：布林值（詳細資訊）

bot

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

類型：布林值（詳細資訊）

basetimestamp

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

類型：時間戳記（允許格式）

starttimestamp

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

類型：時間戳記（允許格式）

recreate

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

類型：布林值（詳細資訊）

createonly

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

類型：布林值（詳細資訊）

nocreate

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

類型：布林值（詳細資訊）

watch

已停用。

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

類型：布林值（詳細資訊）

unwatch

已停用。

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

類型：布林值（詳細資訊）

watchlist

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

單值：watch、unwatch、preferences、nochange

預設值：preferences

md5

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

prependtext

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

appendtext

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

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

undo

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

數值不可小於 0。

類型：整數

undoafter

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

數值不可小於 0。

類型：整數

redirect

自動化解決重新導向。

類型：布林值（詳細資訊）

contentformat

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

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

contentmodel

新內容的內容模組。

單值：GadgetDefinition、Scribunto、wikitext、javascript、json、css、text

token

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

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

此參數為必填。

captchaword

回答驗證碼

captchaid

之前請求的驗證碼ID

範例：

編輯頁面: api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [在沙盒中開啟]
前置頁面的 __NOTOC__。: api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%0A&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [在沙盒中開啟]
撤銷從 13579 至 13585 之間的修訂，並帶自動生成的摘要。: api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [在沙盒中開啟]

action=emailuser

（main | emailuser）

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

寄送電子郵件給使用者。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Email

參數：

target: 電子郵件的收件使用者。; 此參數為必填。
subject: 郵件主旨。
text: 郵件內容。; 此參數為必填。
ccme: 寄送一份此郵件的複本給我。; 類型：布林值（詳細資訊）
token: 自 action=query&meta=tokens 接收的「csrf」權杖。; 此參數為必填。

範例：

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

action=expandtemplates

（main | expandtemplates）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

展開所有於 wikitext 中模板。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Parsing_wikitext#expandtemplates

參數：

title

頁面標題。

text

要轉換的 Wikitext。

此參數為必填。

revid

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

類型：整數

prop

所要取得的資訊部份。

請注意若沒有選定值，結果會包含 wiki 文字，輸出內容會採用棄用格式。

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

多值 (以 | 或 alternative 分隔)：wikitext、categories、properties、volatile、ttl、modules、jsconfigvars、encodedjsconfigvars、parsetree

includecomments

輸出裡是否包含 HTML 註解。

類型：布林值（詳細資訊）

generatexml

已停用。

產生 XML 解析樹狀（以 prop=parsetree 取代）。

類型：布林值（詳細資訊）

範例：

展開 wiki 文字{{Project:Sandbox}}。: api.php?action=expandtemplates&text={{Project:Sandbox}} [在沙盒中開啟]

action=feedcontributions

（main | feedcontributions）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

回傳使用者貢獻摘要。

參數：

feedformat: 摘要的格式。; 單值：rss、atom; 預設值：rss
user: 要取得哪些使用者的貢獻。; 此參數為必填。; 類型：使用者名稱
namespace: 要篩選貢獻的命名空間。; 單值：0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303
year: 起始年份（更早之前）。; 類型：整數
month: 起始月份（更早之前）。; 類型：整數
tagfilter: 篩選有這些標籤的貢獻。; 多值 (以 | 或 alternative 分隔)：mw-contentmodelchange、mw-new-redirect、mw-removed-redirect、mw-changed-redirect-target、mw-blank、mw-replace、mw-rollback、mw-undo、mobile edit、mobile web edit、advanced mobile edit; 預設值：(空)
deletedonly: 僅顯示已刪除的貢獻。; 類型：布林值（詳細資訊）
toponly: 只顯示最新修訂的編輯。; 類型：布林值（詳細資訊）
newonly: 只顯示建立頁面的編輯。; 類型：布林值（詳細資訊）
hideminor: 隱藏小編輯。; 類型：布林值（詳細資訊）
showsizediff: 顯示修訂版本之間的差異大小。; 類型：布林值（詳細資訊）

範例：

返回使用者Example的貢獻。: api.php?action=feedcontributions&user=Example [在沙盒中開啟]

action=feedrecentchanges

（main | feedrecentchanges）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

返回近期變更摘要。

參數：

feedformat: 摘要格式。; 單值：rss、atom; 預設值：rss
namespace: 用於限制結果的命名空間。; 單值：0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303
invert: 除所選定者外的所有命名空間。; 類型：布林值（詳細資訊）
associated: 包含相關的（對話或主要）命名空間。; 類型：布林值（詳細資訊）
days: 用於限制結果的天數。; 數值不可小於 1。; 類型：整數; 預設值：7
limit: 回傳的結果數量上限。; 數值必須在 1 與 50 之間。; 類型：整數; 預設值：50
from: 顯示自那時以來的更改。; 類型：時間戳記（允許格式）
hideminor: 隱藏小更改。; 類型：布林值（詳細資訊）
hidebots: 隱藏由機器人做的變更。; 類型：布林值（詳細資訊）
hideanons: 隱藏匿名使用者做的變更。; 類型：布林值（詳細資訊）
hideliu: 隱藏已註冊使用者做的變更。; 類型：布林值（詳細資訊）
hidepatrolled: 隱藏已巡查的變更。; 類型：布林值（詳細資訊）
hidemyself: 隱藏由目前使用者做出的更改。; 類型：布林值（詳細資訊）
hidecategorization: 隱藏分類成員更改。; 類型：布林值（詳細資訊）
tagfilter: 按標籤篩選。
target: 僅顯示從該頁面所連結頁面上的變更。
showlinkedto: 改成顯示出連結到所選頁面的那些頁面之變更。; 類型：布林值（詳細資訊）

範例：

顯示近期變更。: api.php?action=feedrecentchanges [在沙盒中開啟]
顯示近期30天內的變動: api.php?action=feedrecentchanges&days=30 [在沙盒中開啟]

action=feedwatchlist

（main | feedwatchlist）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

返回監視清單摘要。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Watchlist_feed

參數：

feedformat

摘要的格式。

單值：rss、atom

預設值：rss

hours

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

數值必須在 1 與 72 之間。

類型：整數

預設值：24

linktosections

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

類型：布林值（詳細資訊）

allrev

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

類型：布林值（詳細資訊）

wlowner

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

類型：使用者名稱

wltoken

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

wlshow

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

多值 (以 | 或 alternative 分隔)：minor、!minor、bot、!bot、anon、!anon、patrolled、!patrolled、autopatrolled、!autopatrolled、unread、!unread

wltype

要顯示的更改類型：

edit: 一般頁面編輯。
new: 頁面建立。
log: 日誌項目。
external: 外部更改。
categorize: 分類成員更改。

多值 (以 | 或 alternative 分隔)：edit、new、log、external、categorize

預設值：edit|new|log|categorize

wlexcludeuser

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

類型：使用者名稱

範例：

顯示監視清單摘要。: api.php?action=feedwatchlist [在沙盒中開啟]
顯示過去 6 小時在監視頁面的所有更改。: api.php?action=feedwatchlist&allrev=&hours=6 [在沙盒中開啟]

action=filerevert

（main | filerevert）

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

回退檔案至舊的版本。

參數：

filename: 目標檔案名稱，不需包含「File:」這樣的前綴字元。; 此參數為必填。
comment: 上載意見。; 預設值：(空)
archivename: 要復原的修訂存檔名稱。; 此參數為必填。
token: 自 action=query&meta=tokens 接收的「csrf」權杖。; 此參數為必填。

範例：

回退 Wiki.png 至 2011-03-05T15:27:40Z 的版本。: api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=123ABC [在沙盒中開啟]

action=help

（main | help）

來源：MediaWiki
授權條款：GPL-2.0-or-later

顯示指定模組的說明。

參數：

modules: 顯示說明的模組（action 與 format 參數的值、或 main）。可透過 + 來指定子模組。; 將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。; 預設值：main
submodules: 包含用於命名模組之子模組的說明。; 類型：布林值（詳細資訊）
recursivesubmodules: 包含遞迴子模組的說明。; 類型：布林值（詳細資訊）
wrap: 在標準 API 回應結構裡包裹輸出。; 類型：布林值（詳細資訊）
toc: 在 HTML 輸出裡包含目錄。; 類型：布林值（詳細資訊）

範例：

主模組使用說明: api.php?action=help [在沙盒中開啟]
用於 action=query 與其所有子模組的幫助。: api.php?action=help&modules=query&submodules=1 [在沙盒中開啟]
一個頁面中的所有說明。: api.php?action=help&recursivesubmodules=1 [在沙盒中開啟]
說明模組自身的說明。: api.php?action=help&modules=help [在沙盒中開啟]
兩個查詢子模組的說明。: api.php?action=help&modules=query+info|query+categorymembers [在沙盒中開啟]

action=imagerotate

（main | 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

自動解決在 titles、pageids、revids，以及由 generator 所回傳頁面裡的重新導向。

類型：布林值（詳細資訊）

converttitles

如有需要，轉換標題成其它變體。這僅在 wiki 的內容語言支援變體轉換時有用。支援變體轉換的語言包含有en、crh、gan、iu、kk、ku、shi、sr、tg、uz 和 zh。

類型：布林值（詳細資訊）

token

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

此參數為必填。

範例：

90 度旋轉 File:Example.png。: api.php?action=imagerotate&titles=File:Example.jpg&rotation=90&token=123ABC [在沙盒中開啟]
180 度旋轉所有在 Category:Flip 裡的圖片。: api.php?action=imagerotate&generator=categorymembers&gcmtitle=Category:Flip&gcmtype=file&rotation=180&token=123ABC [在沙盒中開啟]

action=import

（main | import）

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

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

請注意當發送用於 xml 參數的檔案時，必須以 HTTP POST 作為檔案上傳（註：使用 multipart/form-data）。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Import

參數：

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、828、829、2300、2301、2302、2303
assignknownusers: 分配編輯至所命名使用者已存在本地的本地使用者。; 類型：布林值（詳細資訊）
rootpage: 匯入作為此頁面的子頁面。無法與 namespace 一起使用。
tags: 更改標籤套用到在匯入日誌裡的項目，以及在匯入頁面裡的無效修訂。; 多值 (以 | 或 alternative 分隔)：
token: 自 action=query&meta=tokens 接收的「csrf」權杖。; 此參數為必填。

範例：

以完整歷史紀錄匯入 meta:Help:ParserFunctions 至命名空間 100。: api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory=&token=123ABC [在沙盒中開啟]

action=linkaccount （link）

（main | linkaccount）

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

從第三方供應者來連結帳號至目前的使用者。

使用此模組的一般步驟是：

透過 amirequestsfor=link 取得來自 action=query&meta=authmanagerinfo 的可用欄位，和來自 action=query&meta=tokens 的csrf權杖。
向使用者顯示欄位，並獲得其提交的內容。
提交（POST）至此模組，提供 linkreturnurl 及任何相關欄位。
在回應中檢查 status。
- 如果您收到了 PASS（成功）或FAIL（失敗），則認為操作結束。成功與否如上句所示。
- 如果您收到了 UI，向使用者顯示新欄位，並再次獲取其提交的內容。然後再次使用 linkcontinue，向本模組提交相關欄位，並重復第四步。
- 如果您收到了 REDIRECT，將使用者指向redirecttarget 中的目標，等待其返回linkreturnurl。然後再次使用 linkcontinue，向本模組提交返回 URL 中提供的一切欄位，並重復第四步。
- 如果您收到了 RESTART，表示身份驗證正常運作，但我們沒有連結的使用者帳戶。您可以將此視為 UI或FAIL。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Linkaccount

參數：

linkrequests

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

將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

linkmessageformat

用於回傳訊息的格式。

單值：html、wikitext、raw、none

預設值：wikitext

linkmergerequestfields

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

類型：布林值（詳細資訊）

linkreturnurl

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

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

linkcontinue

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

類型：布林值（詳細資訊）

linktoken

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

此參數為必填。

*

此模組允許額外參數，取決於可用的身份驗證請求。使用action=query&meta=authmanagerinfo与amirequestsfor=link（或之前來自此模組的回應，如果合適）以決定可用請求及其使用的欄位。

範例：

開始進行從 Example 連結至帳號的程序。: api.php?action=linkaccount&provider=Example&linkreturnurl=http://example.org/&linktoken=123ABC [在沙盒中開啟]

（main | login）

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

登入並取得身分核對 cookies

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Login

參數：

lgname: 使用者名稱。
lgpassword: 密碼。
lgdomain: 網域名稱（可有可無）。
lgtoken: 自 action=query&meta=tokens 接收的「login」權杖。

範例：

登入: api.php?action=login&lgname=user&lgpassword=password&lgtoken=123ABC [在沙盒中開啟]

action=logout

（main | logout）

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

登出並清除 session 資料。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Logout

參數：

token: 自 action=query&meta=tokens 接收的「csrf」權杖。; 此參數為必填。

範例：

登出當前使用者: api.php?action=logout&token=123ABC [在沙盒中開啟]

action=managetags

（main | managetags）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Tag_management

參數：

operation

要執行的操作：

create：創建一個供手動使用的新更改標籤。
delete：從資料庫移除一個更改標籤，包含移除來自於所有修訂、近期變更項目以及日誌項目的所被使用標籤。
activate：啟用一個更改標籤，允許使用者手動套用。
deactivate：棄用一個更改標籤，不允許使用者手動套用。

此參數為必填。

單值：create、delete、activate、deactivate

tag

要創建、刪除、啟用或停用的標籤。要標籤創建，標籤必須不存在。要標籤刪除，標籤必須存在。要標籤啟用，標籤必須存在且不能被任何擴充使用到。要標籤停用，標籤必須目前為啟用並且有被手動定義。

此參數為必填。

reason

創建、刪除、啟用、或停用標籤的原因（可選）。

ignorewarnings

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

類型：布林值（詳細資訊）

tags

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

多值 (以 | 或 alternative 分隔)：

token

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

此參數為必填。

範例：

建立名為 spam 的標籤，原因：For use in edit patrolling: api.php?action=managetags&operation=create&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC [在沙盒中開啟]
以原因 Misspelt 來刪除 vandlaism 標籤: api.php?action=managetags&operation=delete&tag=vandlaism&reason=Misspelt&token=123ABC [在沙盒中開啟]
啟用名為 spam 的標籤，原因：For use in edit patrolling: api.php?action=managetags&operation=activate&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC [在沙盒中開啟]
停用名為 spam 的標籤，原因：No longer required: api.php?action=managetags&operation=deactivate&tag=spam&reason=No+longer+required&token=123ABC [在沙盒中開啟]

action=mergehistory

（main | mergehistory）

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

合併頁面歷史

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Mergehistory

參數：

from: 要合併歷史的頁面標題。不能與 fromid 一起使用。
fromid: 要合併歷史的頁面之頁面 ID。不能與 from 一起使用。; 類型：整數
to: 要合併歷史的頁面標題。不能與 toid 一起使用。
toid: 要合併歷史的頁面之頁面 ID。不能與 to 一起使用。; 類型：整數
timestamp: 要從來源頁面歷史裡移動至目標頁面歷史之修訂的時間戳記。若省略掉的話，來源頁面的整個頁面歷史將會合併至目標頁面。; 類型：時間戳記（允許格式）
reason: 合併歷史的原因。; 預設值：(空)
token: 自 action=query&meta=tokens 接收的「csrf」權杖。; 此參數為必填。

範例：

將Oldpage的整個歷史合併至Newpage。: api.php?action=mergehistory&from=Oldpage&to=Newpage&token=123ABC&reason=Reason [在沙盒中開啟]
將Oldpage直至2015-12-31T04:37:41Z的頁面修訂版本合併至Newpage。: api.php?action=mergehistory&from=Oldpage&to=Newpage&token=123ABC&reason=Reason&timestamp=2015-12-31T04%3A37%3A41Z [在沙盒中開啟]

action=mobileview

（main | mobileview）

此模組需要讀取權限。
來源：MobileFrontend
授權條款：GPL-2.0-or-later

回傳手機檢視需要的資料。

https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:MobileFrontend#API

參數：

page

要處理的頁面標題。

此參數為必填。

redirect

是否允許重新導向。

單值：yes、no

預設值：yes

sections

用於回傳文字的以豎線區分章節號碼清單。「all」用於回傳所有內容。範圍格式「1-4」代表取得第 1、2、3、4 章節。不帶第二個數字的範圍格式，例如「1-」代表著取得第 1 段之後到底的所以內容。「references」可用於指定回傳所有包含到參考資料的章節。

prop

要取得的資訊：

text：已選的 HTML 段落。
sections：有關頁面上所有段落的資訊。
normalizedtitle: 標準化頁面標題。
lastmodified：用於頁面最後修改時的 ISO 8601 時間戳記，例如：「2014-04-13T22: 42:14Z」。
lastmodifiedby：有關最後對頁面修改的使用者資訊。
revision：回傳頁面目前的修訂 ID。
protection：有關保護層級的資訊。
editable：目前使用者是否可編輯此頁面。此包含所有對於登入使用者，且不對匿名使用者封鎖狀態的要素。
languagecount：頁面可用的語言數目。
hasvariants：頁面是否在其它語言變體裡可用。
displaytitle：頁面的呈現標題，帶有像 {{DISPLAYTITLE}} 這樣套用的內容。
pageprops：頁面屬性。

多值 (以 | 或 alternative 分隔)：id、text、sections、normalizedtitle、lastmodified、lastmodifiedby、revision、protection、editable、languagecount、hasvariants、displaytitle、pageprops、description、contentmodel、namespace、image、thumb

預設值：text|sections|normalizedtitle

sectionprop

要取得的章節相關資訊。

多值 (以 | 或 alternative 分隔)：toclevel、level、line、number、index、fromtitle、anchor

預設值：toclevel|line

pageprops

回傳的頁面屬性，豎線字元「|」分隔的清單、或是對應所有屬性的「*」。

預設值：notoc|noeditsection|wikibase_item

variant

內容轉換為此語言變體。

預設值：(空)

noimages

回傳不含圖片的 HTML。

類型：布林值（詳細資訊）

noheadings

輸出時不包含標頭。

類型：布林值（詳細資訊）

notransform

不要改變 HTML 至手機特定版。

類型：布林值（詳細資訊）

onlyrequestedsections

僅回傳像 prop=sections 的請求章節。

類型：布林值（詳細資訊）

offset

將所有文字結果考慮成單一字串，並限制結果至此長度。

數值不可小於 0。

類型：整數

預設值：0

maxlen

將所有文字結果考慮成單一字串，並限制結果至此長度。

數值不可小於 0。

類型：整數

預設值：0

revision

請求一個特定的修訂。

數值不可小於 0。

類型：整數

預設值：0

thumbheight

最大縮圖高度。

數值不可小於 0。

類型：整數

thumbwidth

最大縮圖寬度。

數值不可小於 0。

類型：整數

thumbsize

最大縮圖尺寸。

數值不可小於 0。

類型：整數

範例：

取得關於 Doom metal 的第 0 章節的資訊: api.php?action=mobileview&page=Doom_metal&sections=0 [在沙盒中開啟]
取得第 0 段章節，以及包含 Candlemass 的參考資料之章節相關資訊: api.php?action=mobileview&page=Candlemass&sections=0|references [在沙盒中開啟]
取得包含第 1 段章節之後，以及包含 Candlemass 的參考資料之章節相關資訊: api.php?action=mobileview&page=Candlemass&sections=1-|references [在沙盒中開啟]

action=move

（main | move）

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

移動頁面。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Move

參數：

from: 重新命名本頁面的標題。不能與 fromid 一起出現。
fromid: 重新命名本頁面的 ID 。不能與 fromid 一起出現。; 類型：整數
to: 將本頁面的標題重新命名為; 此參數為必填。
reason: 重新命名的原因。; 預設值：(空)
movetalk: 如果討論頁存在，變更討論頁名稱。; 類型：布林值（詳細資訊）
movesubpages: 如果適用，則重新命名子頁面。; 類型：布林值（詳細資訊）
noredirect: 不要建立重新導向。; 類型：布林值（詳細資訊）
watchlist: 使用偏好設定無條件地將頁面加入至或移除自目前使用者的監視清單，或不更改監視。; 單值：watch、unwatch、preferences、nochange; 預設值：preferences
ignorewarnings: 忽略所有警告。; 類型：布林值（詳細資訊）
tags: 更改標籤套用到在移動日誌裡的項目，以及在目標頁面裡的無效修訂。; 多值 (以 | 或 alternative 分隔)：
token: 自 action=query&meta=tokens 接收的「csrf」權杖。; 此參數為必填。

範例：

將Badtitle移動至Goodtitle，不留下重定向。: api.php?action=move&from=Badtitle&to=Goodtitle&token=123ABC&reason=Misspelled%20title&movetalk=&noredirect= [在沙盒中開啟]

action=oathvalidate

（main | oathvalidate）

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

驗證雙因素驗證（OATH）權杖。

參數：

user: 要驗證令牌的使用者。預設是目前使用者。; 類型：使用者名稱
totp: 已停用。; 雙因素驗證（OATH）權杖。已經陳舊，應使用"data"參數代替。
data: 用於進行驗證使用者的目前有效模組之預期 JSON 編碼資料
token: 自 action=query&meta=tokens 接收的「csrf」權杖。; 此參數為必填。

範例：

驗證目前使用者的令牌: api.php?action=oathvalidate&totp=123456&token=123ABC [在沙盒中開啟]
驗證使用者 Example 的令牌: api.php?action=oathvalidate&user=Example&totp=123456&token=123ABC [在沙盒中開啟]
為使用者 Example 驗證 JSON 資料: api.php?action=oathvalidate&user=Example&data={"totp":"123456"}&token=123ABC [在沙盒中開啟]

action=opensearch

（main | opensearch）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

使用 OpenSearch 協定搜尋本 wiki。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Opensearch

參數：

search

搜尋字串。

此參數為必填。

namespace

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

多值 (以 | 或 alternative 分隔)：0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303

要指定所有值，請使用*。

預設值：0

limit

回傳的結果數量上限。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

suggest

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

類型：布林值（詳細資訊）

redirects

如何處理重定向：

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

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

單值：return、resolve

format

輸出的格式。

單值：json、jsonfm、xml、xmlfm

預設值：json

warningsaserror

若警告以 format=json 提升時，回傳 API 錯誤而非忽略掉。

類型：布林值（詳細資訊）

範例：

找出以 Te 為開頭的頁面。: api.php?action=opensearch&search=Te [在沙盒中開啟]

action=options

（main | options）

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

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

僅有註冊在核心或是已安裝擴充功能之一、或是帶有 userjs- 前綴的鍵之選項（由使用者手稿所使用）可被設定。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Options

參數：

reset: 重設偏好設定為網站預設值。; 類型：布林值（詳細資訊）
resetkinds: 當設定 reset 選項時，要重設的選項類型清單。; 多值 (以 | 或 alternative 分隔)：registered、registered-multiselect、registered-checkmatrix、userjs、special、unused、all; 預設值：all
change: 更改清單，格式化為「名稱 = 值」（例如：skin=vector）。如果未提供值（甚至沒有等號），像是：optionname|otheroption|...，那麼選項將會重新設定成預設值。如果傳遞的任何值包含豎線字元（|），請使用替代多值分隔符號以便正確操作。; 將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。
optionname: 選項名稱，其應設定為由 optionvalue 所提供的值。
optionvalue: 由 optionname 所指定，用於選項的值。
token: 自 action=query&meta=tokens 接收的「csrf」權杖。; 此參數為必填。

範例：

重設所有偏好設定: api.php?action=options&reset=&token=123ABC [在沙盒中開啟]
更改skin和hideminor偏好設定。: api.php?action=options&change=skin=vector|hideminor=1&token=123ABC [在沙盒中開啟]
重置所有偏好設定，然後再設定 skin 與 nickname。: api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC [在沙盒中開啟]

action=paraminfo

（main | paraminfo）

來源：MediaWiki
授權條款：GPL-2.0-or-later

獲得有關 API 模組的資訊。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Parameter_information

參數：

modules: 模組名稱（action 與 format 參數的值、或是 main）清單。能以 + 指定子模組、或以 +* 指定所有子模組、或是以 +** 指定所有遞迴子模組。; 將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。
helpformat: 說明字串的格式。; 單值：html、wikitext、raw、none; 預設值：none
querymodules: 已停用。; 查詢模組名稱清單（prop、meta、或 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、extracts、exturlusage、filearchive、filerepoinfo、fileusage、gadgetcategories、gadgets、imageinfo、images、imageusage、info、iwbacklinks、iwlinks、langbacklinks、langlinks、languageinfo、links、linkshere、logevents、mystashedfiles、oath、pageimages、pagepropnames、pageprops、pageswithprop、prefixsearch、protectedtitles、querypage、random、recentchanges、redirects、references、revisions、search、siteinfo、stashimageinfo、tags、templates、tokens、transcludedin、usercontribs、userinfo、users、watchlist、watchlistraw; 上限值為 50（機器人為 500）。
mainmodule: 已停用。; 如同取得有關主要（最高級別）模組的資訊。可改用 modules=main。
pagesetmodule: 已停用。; 如同取得有關頁面設定模組（提供 titles= 與友人）的資訊。
formatmodules: 已停用。; 格式模組名稱清單（format 參數的值）。請改用 modules 。; 多值 (以 | 或 alternative 分隔)：json、jsonfm、none、php、phpfm、rawfm、xml、xmlfm

範例：

顯示 action=parse、format=jsonfm、action=query&list=allpages、和 action=query&meta=siteinfo 的資訊。: api.php?action=paraminfo&modules=parse|phpfm|query%2Ballpages|query%2Bsiteinfo [在沙盒中開啟]
顯示 action=query 所有子模組的資訊。: api.php?action=paraminfo&modules=query%2B* [在沙盒中開啟]

action=parse

（main | parse）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

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

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

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

要指定頁面或修訂，請使用 page、pageid、或是 oldid。
要指定明確內容，請使用 text、title、revid 以及 contentmodel。
要指定解析的摘要，prop 應提供一個空值。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Parsing_wikitext#parse

參數：

title

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

text

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

revid

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

類型：整數

summary

解析摘要。

page

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

pageid

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

類型：整數

redirects

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

類型：布林值（詳細資訊）

oldid

解析此修訂的內容。覆蓋 page 與 pageid。

類型：整數

prop

要取得的資訊部份：

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

多值 (以 | 或 alternative 分隔)：text、langlinks、categories、categorieshtml、links、templates、images、externallinks、sections、revid、displaytitle、headhtml、modules、jsconfigvars、encodedjsconfigvars、indicators、iwlinks、wikitext、properties、limitreportdata、limitreporthtml、parsetree、parsewarnings、headitems

wrapoutputclass

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

預設值：mw-parser-output

pst

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

類型：布林值（詳細資訊）

onlypst

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

類型：布林值（詳細資訊）

effectivelanglinks

已停用。

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

類型：布林值（詳細資訊）

section

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

當為 new 時，解析 text 與 sectiontitle，如同添加新段落至頁面裡。

new 僅在有指定 text 時允許。

sectiontitle

新段落標題當 section 為 new 時。

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

disablepp

已停用。

請改用disablelimitreport。

類型：布林值（詳細資訊）

disablelimitreport

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

類型：布林值（詳細資訊）

disableeditsection

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

類型：布林值（詳細資訊）

disabletidy

已停用。

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

類型：布林值（詳細資訊）

disablestylededuplication

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

類型：布林值（詳細資訊）

generatexml

已停用。

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

類型：布林值（詳細資訊）

preview

在預覽模式下解析。

類型：布林值（詳細資訊）

sectionpreview

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

類型：布林值（詳細資訊）

disabletoc

在輸出裡忽略目錄。

類型：布林值（詳細資訊）

useskin

套用所選的外觀至解析輸出。可能會影響以下參數：langlinks、headitems、modules、jsconfigvars、indicators。

單值：monobook、timeless、vector

contentformat

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

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

contentmodel

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

單值：GadgetDefinition、Scribunto、wikitext、javascript、json、css、text

mobileformat

以適合於行動裝置的格式回傳解析輸出內容。

類型：布林值（詳細資訊）

noimages

在手機輸出中停用圖片。

類型：布林值（詳細資訊）

mainpage

套用手機首頁轉換。

類型：布林值（詳細資訊）

範例：

解析頁面。: api.php?action=parse&page=Project:Sandbox [在沙盒中開啟]
解析 wikitext。: api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext [在沙盒中開啟]
解析 wikitext，指定頁面標題。: api.php?action=parse&text={{PAGENAME}}&title=Test [在沙盒中開啟]
解析摘要。: api.php?action=parse&summary=Some+[[link]]&prop= [在沙盒中開啟]

action=patrol

（main | patrol）

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

巡查頁面或修訂。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Patrol

參數：

rcid: 要巡查的最近變更 ID。; 類型：整數
revid: 要巡查的修訂 ID。; 類型：整數
tags: 在巡查日誌裡更改套用到項目的標籤。; 多值 (以 | 或 alternative 分隔)：
token: 自 action=query&meta=tokens 接收的「patrol」權杖。; 此參數為必填。

範例：

巡查一次近期變更。: api.php?action=patrol&token=123ABC&rcid=230672766 [在沙盒中開啟]
巡查一個修訂。: api.php?action=patrol&token=123ABC&revid=230672766 [在沙盒中開啟]

action=protect

（main | protect）

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

變更頁面的保護層級。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Protect

參數：

title

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

pageid

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

類型：整數

protections

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

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

此參數為必填。

將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

expiry

期限時間戳記，若只設定一個時間戳記，該時間戳記將會套用至所有的保護層級。使用 infinite、indefinite、infinity 或 never 來設定保護層級期限為永遠。

將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

預設值：infinite

reason

（解除）保護的原因。

預設值：(空)

tags

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

多值 (以 | 或 alternative 分隔)：

cascade

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

類型：布林值（詳細資訊）

watch

已停用。

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

類型：布林值（詳細資訊）

watchlist

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

單值：watch、unwatch、preferences、nochange

預設值：preferences

token

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

此參數為必填。

範例：

保護一個頁面。: api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never [在沙盒中開啟]
透過設定為 all（註：代表任何人都可以執行操作），來解除對頁面的保護。: api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=all|move=all&reason=Lifting%20restrictions [在沙盒中開啟]
透過設定為沒有限制，來解除對頁面的保護。: api.php?action=protect&title=Main%20Page&token=123ABC&protections=&reason=Lifting%20restrictions [在沙盒中開啟]

action=purge

（main | purge）

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

為指定標題清除快取。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Purge

參數：

forcelinkupdate

更新連結表格。

類型：布林值（詳細資訊）

forcerecursivelinkupdate

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

類型：布林值（詳細資訊）

continue

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

titles

要使用的標題清單。

將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

pageids

要使用的頁面 ID 清單。

類型：整數列表

將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

revids

要使用的修訂 ID 清單。

類型：整數列表

將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

generator

按執行指定查詢模組來取得進行的頁面清單。

注意：產生器參數名稱必須以 "g" 作為前綴，請查看範例。

allcategories: 列舉所有分類。
alldeletedrevisions: 依使用者或所在命名空間來列出所有已刪除的修訂。
allfileusages: 列出所有檔案用途，包含不存在的。
allimages: 按順序列舉所有圖片。
alllinks: 列舉所有指向所指定命名空間的連結。
allpages: 依序列舉在指定命名空間的所有頁面。
allredirects: 列出至命名空間的所有重新導向。
allrevisions: 列出所有修訂版本。
alltransclusions: 列出所有嵌入（頁面使用 {{x}} 來內嵌），包含不存在的。
backlinks: 找出連結至指定頁面的所有頁面。
categories: 列出頁面隸屬的所有分類。
categorymembers: 在指定的分類中列出所有頁面。
deletedrevisions: 取得已刪除修訂的資訊。
duplicatefiles: 基於雜湊值來列出指定檔案裡的所有重複檔案。
embeddedin: 找出內嵌（嵌入）指定頁面的所有頁面。
exturlusage: 列舉包含指定 URL 的頁面。
fileusage: 尋找使用到指定檔案的所有頁面。
images: 回傳指定頁面中包含的所有檔案。
imageusage: 尋找使用到指定圖片標題的所有頁面。
iwbacklinks: 找出連結至指定跨 wiki 連結的所有頁面。
langbacklinks: 找出連結至指定語言連結的所有頁面。
links: 回傳指定頁面的所有連結。
linkshere: 找出連結至指定頁面的所有頁面。
pageswithprop: 列出使用到指定頁面屬性的所有頁面。
prefixsearch: 執行頁面標題的前綴搜尋。
protectedtitles: 列出所有被創建保護的標題。
querypage: 取得透過特殊頁面 QueryPage-based 所提供的清單。
random: 取得隨機頁面集合
recentchanges: 列舉出近期變更。
redirects: 回傳連結至指定頁面的所有重新導向。
revisions: 取得修訂的資訊。
search: 執行全文搜尋。
templates: 回傳指定頁面中所有引用的頁面。
transcludedin: 找出嵌入至指定頁面的所有頁面。
watchlist: 取得在目前使用者的監視清單裡，頁面的近期變更。
watchlistraw: 列出在目前使用者的監視清單裡頭所有頁面。

redirects

自動解決在 titles、pageids、revids，以及由 generator 所回傳頁面裡的重新導向。

類型：布林值（詳細資訊）

converttitles

如有需要，轉換標題成其它變體。這僅在 wiki 的內容語言支援變體轉換時有用。支援變體轉換的語言包含有en、crh、gan、iu、kk、ku、shi、sr、tg、uz 和 zh。

類型：布林值（詳細資訊）

範例：

清除 Main Page 與 API 頁面。: api.php?action=purge&titles=Main_Page|API [在沙盒中開啟]
重新整理主要命名空間的前10個頁面。: api.php?action=purge&generator=allpages&gapnamespace=0&gaplimit=10 [在沙盒中開啟]

action=query

（main | query）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

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

所有資料變動將會先使用查詢來取得權杖，以避免來自惡意網站的濫用行為。

參數：

prop

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

categories: 列出頁面隸屬的所有分類。
categoryinfo: 回傳有關指定分類的資訊。
contributors: 取得頁面上登入貢獻者以及匿名貢獻者數量的清單。
deletedrevisions: 取得已刪除修訂的資訊。
duplicatefiles: 基於雜湊值來列出指定檔案裡的所有重複檔案。
extlinks: 回傳所有指定頁面的外部 URL (非 interwiki)。
extracts: 回傳純文字或受限的指定頁面 HTML 匯出。
fileusage: 尋找使用到指定檔案的所有頁面。
imageinfo: 回傳檔案資訊與上傳日誌。
images: 回傳指定頁面中包含的所有檔案。
info: 取得基本頁面訊息。
iwlinks: 回傳指定頁面的所有 interwiki 連結。
langlinks: 回傳指定頁面的所有跨語言連結。
links: 回傳指定頁面的所有連結。
linkshere: 找出連結至指定頁面的所有頁面。
pageimages: 回傳有關在頁面上圖片的資訊，例如縮圖和照片展示內容。
pageprops: 取得定義在頁面內容的各樣頁面屬性。
redirects: 回傳連結至指定頁面的所有重新導向。
references: 回傳與指定頁面關聯之參考文獻的資料描述。
revisions: 取得修訂的資訊。
stashimageinfo: 回傳多筆儲藏檔案的檔案資訊。
templates: 回傳指定頁面中所有引用的頁面。
transcludedin: 找出嵌入至指定頁面的所有頁面。

多值 (以 | 或 alternative 分隔)：categories、categoryinfo、contributors、deletedrevisions、duplicatefiles、extlinks、extracts、fileusage、imageinfo、images、info、iwlinks、langlinks、links、linkshere、pageimages、pageprops、redirects、references、revisions、stashimageinfo、templates、transcludedin

list

要取得的清單。

allcategories: 列舉所有分類。
alldeletedrevisions: 依使用者或所在命名空間來列出所有已刪除的修訂。
allfileusages: 列出所有檔案用途，包含不存在的。
allimages: 按順序列舉所有圖片。
alllinks: 列舉所有指向所指定命名空間的連結。
allpages: 依序列舉在指定命名空間的所有頁面。
allredirects: 列出至命名空間的所有重新導向。
allrevisions: 列出所有修訂版本。
alltransclusions: 列出所有嵌入（頁面使用 {{x}} 來內嵌），包含不存在的。
allusers: 列舉所有已註冊使用者。
backlinks: 找出連結至指定頁面的所有頁面。
blocks: 列出所有被封鎖使用者與 IP 位址。
categorymembers: 在指定的分類中列出所有頁面。
embeddedin: 找出內嵌（嵌入）指定頁面的所有頁面。
exturlusage: 列舉包含指定 URL 的頁面。
filearchive: 依序列舉所有已刪除檔案。
gadgetcategories: 回傳小工具分類清單。
gadgets: 回傳在此 wiki 使用過的小工具清單。
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、gadgetcategories、gadgets、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: 回傳有關可用語言的資訊。
oath: 檢查是否有替使用者啟用雙因素驗證（OATH）。
siteinfo: 回傳有關站台的一般資訊。
tokens: 取得資料修改操作的權杖。
userinfo: 取得目前使用者的資訊。

多值 (以 | 或 alternative 分隔)：allmessages、authmanagerinfo、filerepoinfo、languageinfo、oath、siteinfo、tokens、userinfo

indexpageids

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

類型：布林值（詳細資訊）

export

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

類型：布林值（詳細資訊）

exportnowrap

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

類型：布林值（詳細資訊）

exportschema

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

單值：0.10、0.11

預設值：0.10

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: 列出在目前使用者的監視清單裡頭所有頁面。

redirects

自動解決在 query+titles、query+pageids、query+revids，以及由 query+generator 所回傳頁面裡的重新導向。

類型：布林值（詳細資訊）

converttitles

如有需要，轉換標題成其它變體。這僅在 wiki 的內容語言支援變體轉換時有用。支援變體轉換的語言包含有en、crh、gan、iu、kk、ku、shi、sr、tg、uz 和 zh。

類型：布林值（詳細資訊）

範例：

索取 Main Page 的站台資訊與修訂。: api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment&continue= [在沙盒中開啟]
索取以 API/ 為開頭的頁面修訂。: api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue= [在沙盒中開啟]

prop=categories （cl）

（main | query | categories）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Categories

參數：

clprop

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

sortkey: 添加用於分類的排序鍵值（十六進位字串）與排序鍵值字首（人類可讀的部份）。
timestamp: 添加當添加分類時的時間戳記。
hidden: 標記由 __HIDDENCAT__ 隱藏的分類。

多值 (以 | 或 alternative 分隔)：sortkey、timestamp、hidden

clshow

要顯示出的分類種類。

多值 (以 | 或 alternative 分隔)：hidden、!hidden

cllimit

要回傳的分類數量。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：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）

（main | query | categoryinfo）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Categoryinfo

參數：

cicontinue: 當有更多結果可用時，使用這個繼續。

範例：

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

prop=contributors （pc）

（main | query | contributors）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Contributors

參數：

pcgroup: 僅包含在指定群組的使用者。不包含隱含或是自動晉升群組，像是：*、使用者、或是自動確認。; 多值 (以 | 或 alternative 分隔)：bot、sysop、interface-admin、bureaucrat、suppress
pcexcludegroup: 排除在指定群組的使用者。不包含隱含或是自動晉升群組，像是：*、使用者、或是自動確認。; 多值 (以 | 或 alternative 分隔)：bot、sysop、interface-admin、bureaucrat、suppress
pcrights: 僅包含有指定權限的使用者。不包含透過由隱含或是自動晉升群組所授予的權限，像是：*、使用者、或是自動確認。; 多值 (以 | 或 alternative 分隔)：apihighlimits、applychangetags、autoconfirmed、autocreateaccount、autopatrol、bigdelete、block、blockemail、bot、browsearchive、changetags、createaccount、createpage、createtalk、delete、deletechangetags、deletedhistory、deletedtext、deletelogentry、deleterevision、edit、editcontentmodel、editinterface、editprotected、editmyoptions、editmyprivateinfo、editmyusercss、editmyuserjson、editmyuserjs、editmyuserjsredirect、editmywatchlist、editsemiprotected、editsitecss、editsitejson、editsitejs、editusercss、edituserjson、edituserjs、hideuser、import、importupload、ipblock-exempt、managechangetags、markbotedits、mergehistory、minoredit、move、movefile、move-categorypages、move-rootuserpages、move-subpages、nominornewtalk、noratelimit、override-export-depth、pagelang、patrol、patrolmarks、protect、purge、read、reupload、reupload-own、reupload-shared、rollback、sendemail、siteadmin、suppressionlog、suppressredirect、suppressrevision、unblockself、undelete、unwatchedpages、upload、upload_by_url、userrights、userrights-interwiki、viewmyprivateinfo、viewmywatchlist、viewsuppressed、writeapi、skipcaptcha、gadgets-edit、gadgets-definition-edit、nuke、oathauth-enable、oathauth-api-all、oathauth-disable-for-user、oathauth-view-log、renameuser、replacetext、spamblacklistlog、tboverride、tboverride-account、titleblacklistlog、deleteperm、interwiki; 上限值為 50（機器人為 500）。
pcexcluderights: 排除有指定權限的使用者。不包含透過由隱含或是自動晉升群組所授予的權限，像是：*、使用者、或是自動確認。; 多值 (以 | 或 alternative 分隔)：apihighlimits、applychangetags、autoconfirmed、autocreateaccount、autopatrol、bigdelete、block、blockemail、bot、browsearchive、changetags、createaccount、createpage、createtalk、delete、deletechangetags、deletedhistory、deletedtext、deletelogentry、deleterevision、edit、editcontentmodel、editinterface、editprotected、editmyoptions、editmyprivateinfo、editmyusercss、editmyuserjson、editmyuserjs、editmyuserjsredirect、editmywatchlist、editsemiprotected、editsitecss、editsitejson、editsitejs、editusercss、edituserjson、edituserjs、hideuser、import、importupload、ipblock-exempt、managechangetags、markbotedits、mergehistory、minoredit、move、movefile、move-categorypages、move-rootuserpages、move-subpages、nominornewtalk、noratelimit、override-export-depth、pagelang、patrol、patrolmarks、protect、purge、read、reupload、reupload-own、reupload-shared、rollback、sendemail、siteadmin、suppressionlog、suppressredirect、suppressrevision、unblockself、undelete、unwatchedpages、upload、upload_by_url、userrights、userrights-interwiki、viewmyprivateinfo、viewmywatchlist、viewsuppressed、writeapi、skipcaptcha、gadgets-edit、gadgets-definition-edit、nuke、oathauth-enable、oathauth-api-all、oathauth-disable-for-user、oathauth-view-log、renameuser、replacetext、spamblacklistlog、tboverride、tboverride-account、titleblacklistlog、deleteperm、interwiki; 上限值為 50（機器人為 500）。
pclimit: 要回傳的貢獻人員數量。; 不允許超過 500 (機器人為 5,000)。; 類型：整數或max; 預設值：10
pccontinue: 當有更多結果可用時，使用這個繼續。

範例：

顯示頁面 Main Page 的貢獻者。: api.php?action=query&prop=contributors&titles=Main_Page [在沙盒中開啟]

prop=deletedrevisions （drv）

（main | query | deletedrevisions）

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

取得已刪除修訂的資訊。

能以多種方式使用：

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Deletedrevisions

參數：

drvprop

各修訂所要取得的屬性：

ids: 修訂 ID。
flags: 修訂標籤（小修改）。
timestamp: 修訂的時間戳記。
user: 做出修訂的使用者。
userid: 修訂創建者的使用者 ID
size: 修訂的長度（位元組）。
slotsize: 各修訂間隔的長度（位元組）。
sha1: 修訂的 SHA-1（base 16）。
slotsha1: 各修訂間隔的 SHA-1（base 16）。
contentmodel: 各修訂間隔的內容模組 ID。
comment: 由使用者對於修訂所做出的註釋。
parsedcomment: 由使用者對於修訂所解析的註釋。
content: 各修訂間隔的內容。
tags: 修訂標籤。
roles: 列出存在於修訂的內容間隔作用。
parsetree: 已停用。請改用 action=expandtemplates 或 action=parse。修訂內容的 XML 解析樹狀（需要內容模組 wikitext）。

多值 (以 | 或 alternative 分隔)：ids、flags、timestamp、user、userid、size、slotsize、sha1、slotsha1、contentmodel、comment、parsedcomment、content、tags、roles、parsetree

預設值：ids|timestamp|flags|comment|user

drvslots

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

多值 (以 | 或 alternative 分隔)：main

要指定所有值，請使用*。

drvlimit

限制所回傳的修訂數量。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

drvexpandtemplates

已停用。

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

類型：布林值（詳細資訊）

drvgeneratexml

已停用。

請改用 action=expandtemplates 或 action=parse。產生用於修訂內容的 XML 解析樹狀（需要 drvprop=content）。

類型：布林值（詳細資訊）

drvparse

已停用。

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

類型：布林值（詳細資訊）

drvsection

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

drvdiffto

已停用。

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

drvdifftotext

已停用。

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

drvdifftotextpst

已停用。

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

類型：布林值（詳細資訊）

drvcontentformat

已停用。

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

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

drvstart

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

類型：時間戳記（允許格式）

drvend

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

類型：時間戳記（允許格式）

drvdir

列舉的方向：

newer: 最舊的優先。注意：drvstart應在drvend之前。
older: 最新的優先（預設）。注意：drvstart應在drvend之後。

單值：newer、older

預設值：older

drvtag

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

drvuser

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

類型：使用者名稱

drvexcludeuser

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

類型：使用者名稱

drvcontinue

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

範例：

列出頁面 Main Page 與 Talk:Main Page 包含到內容的已刪除修訂。: api.php?action=query&prop=deletedrevisions&titles=Main%20Page|Talk:Main%20Page&drvslots=*&drvprop=user|comment|content [在沙盒中開啟]
列出已刪除修訂 123456 的資訊。: api.php?action=query&prop=deletedrevisions&revids=123456 [在沙盒中開啟]

prop=duplicatefiles （df）

（main | query | duplicatefiles）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Duplicatefiles

參數：

dflimit: 要回傳的重複檔案數量。; 不允許超過 500 (機器人為 5,000)。; 類型：整數或max; 預設值：10
dfcontinue: 當有更多結果可用時，使用這個繼續。
dfdir: 列出時所採用的方向。; 單值：ascending、descending; 預設值：ascending
dflocalonly: 僅查看在本地端儲存庫的檔案。; 類型：布林值（詳細資訊）

範例：

尋找重複 File:Albert Einstein Head.jpg 的檔案。: api.php?action=query&titles=File:Albert_Einstein_Head.jpg&prop=duplicatefiles [在沙盒中開啟]
查看全部有重複到的檔案。: api.php?action=query&generator=allimages&prop=duplicatefiles [在沙盒中開啟]

prop=extlinks （el）

（main | query | extlinks）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Extlinks

參數：

ellimit: 要回傳的連結數量。; 不允許超過 500 (機器人為 5,000)。; 類型：整數或max; 預設值：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=extracts （ex）

（main | query | extracts）

此模組需要讀取權限。
來源：TextExtracts
授權條款：GPL-2.0-or-later

回傳純文字或受限的指定頁面 HTML 匯出。

https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:TextExtracts#API

參數：

exchars

要回傳的字元數量。實際回傳的文字可能會稍多。

數值必須在 1 與 1,200 之間。

類型：整數

exsentences

要回傳的文句數量。

數值必須在 1 與 10 之間。

類型：整數

exlimit

要回傳的匯出數量。（若 exintro 設定成 true 可回傳多個提取。）

不允許超過 20 (機器人為 20)。

類型：整數或max

預設值：20

exintro

僅回傳在首個段落前的內容。

類型：布林值（詳細資訊）

explaintext

回傳匯出為純文字而非受限的 HTML 內容

類型：布林值（詳細資訊）

exsectionformat

在純文字模式如何格式化段落：

plain：無格式。
wiki：Wiki 文字樣式格式（== 例如像這樣 ==）。
raw：此模組的內建呈現方法（帶有 <ASCII 1><ASCII 2><section level><ASCII 2><ASCII 1> 的段落標題前綴）。

單值：plain、wiki、raw

預設值：wiki

excontinue

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

類型：整數

範例：

取得 175-字元匯出內容: api.php?action=query&prop=extracts&exchars=175&titles=Therion [在沙盒中開啟]

prop=fileusage （fu）

（main | query | fileusage）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Fileusage

參數：

fuprop

要取得的屬性。

pageid: 各頁面的頁面 ID。
title: 各頁面的標題。
redirect: 若頁面為重新導向，則做出標記。

多值 (以 | 或 alternative 分隔)：pageid、title、redirect

預設值：pageid|title|redirect

funamespace

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

多值 (以 | 或 alternative 分隔)：0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303

要指定所有值，請使用*。

fushow

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

redirect：僅顯示重新導向。
!redirect：僅顯示非重新導向。

多值 (以 | 或 alternative 分隔)：redirect、!redirect

fulimit

要回傳的數量。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

fucontinue

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

範例：

取得使用到 File:Example.jpg 的頁面清單。: api.php?action=query&prop=fileusage&titles=File%3AExample.jpg [在沙盒中開啟]
取得使用到 File:Example.jpg 的頁面相關資訊。: api.php?action=query&generator=fileusage&titles=File%3AExample.jpg&prop=info [在沙盒中開啟]

prop=imageinfo （ii）

（main | query | imageinfo）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Imageinfo

參數：

iiprop

要取得的檔案資訊：

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

多值 (以 | 或 alternative 分隔)：timestamp、user、userid、comment、parsedcomment、canonicaltitle、url、size、dimensions、sha1、mime、thumbmime、mediatype、metadata、commonmetadata、extmetadata、archivename、bitdepth、uploadwarning、badfile

預設值：timestamp|user

iilimit

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

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：1

iistart

列出的起始時間戳記。

類型：時間戳記（允許格式）

iiend

列出的終止時間戳記。

類型：時間戳記（允許格式）

iiurlwidth

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

類型：整數

預設值：-1

iiurlheight

與 iiurlwidth 相似。

類型：整數

預設值：-1

iimetadataversion

要使用的詮釋資料版本。若有指定 latest，會使用最新版本。預設為 1，以便向下兼容。

預設值：1

iiextmetadatalanguage

要檢索 extmetadata 的語言。此會影響檢索到的翻譯，若有多個可用語言的話，還會影響到像是數字與各種值的格式。

預設值：zh-hant

iiextmetadatamultilang

若用於 extmetadata 屬性的翻譯可用，則全部索取。

類型：布林值（詳細資訊）

iiextmetadatafilter

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

將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

iiurlparam

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

預設值：(空)

iibadfilecontexttitle

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

iicontinue

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

iilocalonly

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

類型：布林值（詳細資訊）

範例：

取得關於 File:Albert Einstein Head.jpg 目前版本的資訊.: api.php?action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo [在沙盒中開啟]
索取 File:Test.jpg 自 2008 年以來的版本資訊。: api.php?action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&iiend=2007-12-31T23:59:59Z&iiprop=timestamp|user|url [在沙盒中開啟]

prop=images （im）

（main | query | images）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Images

參數：

imlimit: 要回傳的檔案數量。; 不允許超過 500 (機器人為 5,000)。; 類型：整數或max; 預設值：10
imcontinue: 當有更多結果可用時，使用這個繼續。
imimages: 僅列出這些檔案。在檢查某一頁面是否擁有某一檔案時很有用。; 將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。
imdir: 列出時所採用的方向。; 單值：ascending、descending; 預設值：ascending

範例：

取得使用在 Main Page 的檔案清單。: api.php?action=query&prop=images&titles=Main%20Page [在沙盒中開啟]
取得在 Main Page 所有使用到檔案的相關資訊。: api.php?action=query&generator=images&titles=Main%20Page&prop=info [在沙盒中開啟]

prop=info （in）

（main | query | info）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

取得基本頁面訊息。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Info

參數：

inprop

要取得的額外屬性：

protection: 列出各頁面的保護層級。
talkid: 各非對話頁的對話頁頁面 ID。
watched: 列出各頁面的監視狀態。
watchers: 監視者的數目，如有允許的話。
visitingwatchers: 有訪問頁面近期編輯數的各頁面監視者數目，如有允許的話。
notificationtimestamp: 各頁面的監視清單通知時間戳記。
subjectid: 各對話頁的父頁面頁面 ID。
url: 替各頁面給予一個完整 URL、一個編輯 URL，以及一個規範 URL。
readable: 已停用。使用者是否可閱讀此頁面。請改用 intestactions=read。
preload: 取得由 EditFormPreloadText 回傳的文字。
displaytitle: 在頁面標題實際顯示處提供方式。
varianttitles: 指定網站內容語言裡所有變體的顯示標題。

多值 (以 | 或 alternative 分隔)：protection、talkid、watched、watchers、visitingwatchers、notificationtimestamp、subjectid、url、readable、preload、displaytitle、varianttitles

intestactions

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

將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

intestactionsdetail

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

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

單值：boolean、full、quick

預設值：boolean

intoken

已停用。

請改用 action=query&meta=tokens。

多值 (以 | 或 alternative 分隔)：edit、delete、protect、move、block、unblock、email、import、watch

incontinue

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

範例：

取得有關頁面 Main Page 的資訊。: api.php?action=query&prop=info&titles=Main%20Page [在沙盒中開啟]
取得有關 Main Page 的一般與保護資訊。: api.php?action=query&prop=info&inprop=protection&titles=Main%20Page [在沙盒中開啟]

prop=iwlinks （iw）

（main | query | iwlinks）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Iwlinks

參數：

iwprop

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

url: 添加完整的 URL。

多值 (以 | 或 alternative 分隔)：url

iwprefix

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

iwtitle

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

iwdir

列出時所採用的方向。

單值：ascending、descending

預設值：ascending

iwlimit

要回傳的跨 Wiki 連結數量。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

iwcontinue

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

iwurl

已停用。

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

類型：布林值（詳細資訊）

範例：

從頁面 Main Page 取得跨 wiki 連結。: api.php?action=query&prop=iwlinks&titles=Main%20Page [在沙盒中開啟]

prop=langlinks （ll）

（main | query | langlinks）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Langlinks

參數：

llprop

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

url: 添加完整的 URL。
langname: 添加本地化語言名稱（盡可能）。使用 llinlanguagecode 來控制語言。
autonym: 添加本地語言名稱。

多值 (以 | 或 alternative 分隔)：url、langname、autonym

lllang

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

lltitle

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

lldir

列出時所採用的方向。

單值：ascending、descending

預設值：ascending

llinlanguagecode

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

預設值：zh-hant

lllimit

要回傳的 langlinks 數量。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

llcontinue

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

llurl

已停用。

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

類型：布林值（詳細資訊）

範例：

從頁面 Main Page 取得跨語言連結。: api.php?action=query&prop=langlinks&titles=Main%20Page&redirects= [在沙盒中開啟]

prop=links （pl）

（main | query | links）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Links

參數：

plnamespace: 僅顯示在這些命名空間的連結。; 多值 (以 | 或 alternative 分隔)：-2、-1、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303; 要指定所有值，請使用*。
pllimit: 要回傳的連結數量。; 不允許超過 500 (機器人為 5,000)。; 類型：整數或max; 預設值：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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Linkshere

參數：

lhprop

要取得的屬性。

pageid: 各頁面的頁面 ID。
title: 各頁面的標題。
redirect: 若頁面為重新導向，則做出標記。

多值 (以 | 或 alternative 分隔)：pageid、title、redirect

預設值：pageid|title|redirect

lhnamespace

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

多值 (以 | 或 alternative 分隔)：0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303

要指定所有值，請使用*。

lhshow

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

redirect：僅顯示重新導向。
!redirect：僅顯示非重新導向。

多值 (以 | 或 alternative 分隔)：redirect、!redirect

lhlimit

要回傳的數量。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

lhcontinue

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

範例：

取得連結至 Main Page 的頁面清單。: api.php?action=query&prop=linkshere&titles=Main%20Page [在沙盒中開啟]
取得連結至 Main Page 的相關頁面資訊。: api.php?action=query&generator=linkshere&titles=Main%20Page&prop=info [在沙盒中開啟]

prop=pageimages （pi）

（main | query | pageimages）

此模組需要讀取權限。
來源：PageImages
授權條款：WTFPL

回傳有關在頁面上圖片的資訊，例如縮圖和照片展示內容。

https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:PageImages#API

參數：

piprop

會回傳的資訊：

thumbnail：關聯此頁面的縮圖 URL 以及尺寸（如有存在的情況下）。
original：關聯此頁面的圖片 URL 以及原始尺寸（如有存在的情況下）。
name：圖片的標題。

多值 (以 | 或 alternative 分隔)：thumbnail、name、original

預設值：thumbnail|name

pithumbsize

縮圖的像素最大寬度。

類型：整數

預設值：50

pilimit

回傳頁面數量的屬性。

不允許超過 50 (機器人為 100)。

類型：整數或max

預設值：50

pilicense

限制頁面圖片至特定許可權限類型

單值：free、any

預設值：free

picontinue

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

類型：整數

範例：

取得在 Albert Einstein 頁面上圖片的名稱以及 100 像素縮圖。: api.php?action=query&prop=pageimages&titles=Albert%20Einstein&pithumbsize=100 [在沙盒中開啟]

prop=pageprops （pp）

（main | query | pageprops）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

取得定義在頁面內容的各樣頁面屬性。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Pageprops

參數：

ppcontinue: 當有更多結果可用時，使用這個繼續。
ppprop: 僅列出這些頁面屬性（action=query&list=pagepropnames 會回傳在使用的頁面屬性名稱）。在檢查是否有頁面使用到某一頁面屬性時很有用。; 將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

範例：

取得頁面 Main Page 與 MediaWiki 的屬性。: api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki [在沙盒中開啟]

prop=redirects （rd）

（main | query | redirects）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Redirects

參數：

rdprop

要取得的屬性。

pageid: 各重新導向的頁面 ID。
title: 各重新導向的標題。
fragment: 各重新導向的片段，若有的話。

多值 (以 | 或 alternative 分隔)：pageid、title、fragment

預設值：pageid|title

rdnamespace

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

多值 (以 | 或 alternative 分隔)：0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303

要指定所有值，請使用*。

rdshow

僅顯示符合這些標準的項目：

fragment：僅顯示帶部分內容的重新導向。
!fragment：僅顯示不帶部分內容的重新導向。

多值 (以 | 或 alternative 分隔)：fragment、!fragment

rdlimit

要回傳的重新導向數量。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

rdcontinue

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

範例：

取得 Main Page 的重新導向清單: api.php?action=query&prop=redirects&titles=Main%20Page [在沙盒中開啟]
取得所有重新導向至 Main Page 的資訊。: api.php?action=query&generator=redirects&titles=Main%20Page&prop=info [在沙盒中開啟]

prop=references （rf）

（main | query | references）

此模組需要讀取權限。
來源：Cite
授權條款：GPL-2.0-or-later

回傳與指定頁面關聯之參考文獻的資料描述。

參數：

rfcontinue: 當有更多結果可用時，使用這個繼續。

範例：

與 Albert Einstein 關聯的參考文獻。: api.php?action=query&prop=references&titles=Albert%20Einstein [在沙盒中開啟]

prop=revisions （rv）

（main | query | revisions）

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

取得修訂的資訊。

能以多種方式使用：

透過設定標題或頁面 ID 來取得有關頁面集（最新修訂）的資料。
透過使用標題或是帶有起始、結束、限制的頁面 ID 來取得指定頁面的修訂。
透過以 revid 設定 ID 來取得有關修訂集的資料。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Revisions

參數：

rvprop

各修訂所要取得的屬性：

ids: 修訂 ID。
flags: 修訂標籤（小修改）。
timestamp: 修訂的時間戳記。
user: 做出修訂的使用者。
userid: 修訂創建者的使用者 ID
size: 修訂的長度（位元組）。
slotsize: 各修訂間隔的長度（位元組）。
sha1: 修訂的 SHA-1（base 16）。
slotsha1: 各修訂間隔的 SHA-1（base 16）。
contentmodel: 各修訂間隔的內容模組 ID。
comment: 由使用者對於修訂所做出的註釋。
parsedcomment: 由使用者對於修訂所解析的註釋。
content: 各修訂間隔的內容。
tags: 修訂標籤。
roles: 列出存在於修訂的內容間隔作用。
parsetree: 已停用。請改用 action=expandtemplates 或 action=parse。修訂內容的 XML 解析樹狀（需要內容模組 wikitext）。

多值 (以 | 或 alternative 分隔)：ids、flags、timestamp、user、userid、size、slotsize、sha1、slotsha1、contentmodel、comment、parsedcomment、content、tags、roles、parsetree

預設值：ids|timestamp|flags|comment|user

rvslots

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

多值 (以 | 或 alternative 分隔)：main

要指定所有值，請使用*。

rvlimit

限制所回傳的修訂數量。

僅能在單一頁面使用（模式 #2）。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

rvexpandtemplates

已停用。

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

類型：布林值（詳細資訊）

rvgeneratexml

已停用。

請改用 action=expandtemplates 或 action=parse。產生用於修訂內容的 XML 解析樹狀（需要 rvprop=content）。

類型：布林值（詳細資訊）

rvparse

已停用。

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

類型：布林值（詳細資訊）

rvsection

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

rvdiffto

已停用。

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

rvdifftotext

已停用。

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

rvdifftotextpst

已停用。

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

類型：布林值（詳細資訊）

rvcontentformat

已停用。

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

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

rvstartid

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

僅能在單一頁面使用（模式 #2）。

類型：整數

rvendid

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

僅能在單一頁面使用（模式 #2）。

類型：整數

rvstart

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

僅能在單一頁面使用（模式 #2）。

類型：時間戳記（允許格式）

rvend

列舉至此的時間戳記。

僅能在單一頁面使用（模式 #2）。

類型：時間戳記（允許格式）

rvdir

列舉的方向：

newer: 最舊的優先。注意：rvstart應在rvend之前。
older: 最新的優先（預設）。注意：rvstart應在rvend之後。

僅能在單一頁面使用（模式 #2）。

單值：newer、older

預設值：older

rvuser

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

僅能在單一頁面使用（模式 #2）。

類型：使用者名稱

rvexcludeuser

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

僅能在單一頁面使用（模式 #2）。

類型：使用者名稱

rvtag

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

rvtoken

已停用。

各修訂所要獲得的權杖。

多值 (以 | 或 alternative 分隔)：rollback

rvcontinue

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

範例：

取得用於標題 API 與 Main Page 最新修訂內容的資料。: api.php?action=query&prop=revisions&titles=API|Main%20Page&rvslots=*&rvprop=timestamp|user|comment|content [在沙盒中開啟]
取得 Main Page 的最近 5 筆修訂。: api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment [在沙盒中開啟]
取得 Main Page 的最早前 5 筆修訂。: api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer [在沙盒中開啟]
取得 Main Page 自 2006-05-01 後做的前 5 筆修訂。: api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z [在沙盒中開啟]
取得 Main Page 裡並非由匿名使用者 127.0.0.1 所做出的最早前 5 筆修訂。: api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1 [在沙盒中開啟]
取得 Main Page 裡由使用者 MediaWiki default 所做出的最早前 5 筆修訂。: api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvuser=MediaWiki%20default [在沙盒中開啟]

prop=stashimageinfo （sii）

（main | query | stashimageinfo）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Stashimageinfo

參數：

siifilekey

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

將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

siisessionkey

已停用。

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

將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

siiprop

要取得的檔案資訊：

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

多值 (以 | 或 alternative 分隔)：timestamp、canonicaltitle、url、size、dimensions、sha1、mime、thumbmime、metadata、commonmetadata、extmetadata、bitdepth、badfile

預設值：timestamp|url

siiurlwidth

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

類型：整數

預設值：-1

siiurlheight

與 siiurlwidth 相似。

類型：整數

預設值：-1

siiurlparam

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

預設值：(空)

範例：

回傳儲藏檔案的檔案資訊。: api.php?action=query&prop=stashimageinfo&siifilekey=124sd34rsdf567 [在沙盒中開啟]
回傳縮圖或兩個已儲藏檔案。: api.php?action=query&prop=stashimageinfo&siifilekey=b34edoe3|bceffd4&siiurlwidth=120&siiprop=url [在沙盒中開啟]

prop=templates （tl）

（main | query | templates）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Templates

參數：

tlnamespace: 僅顯示在這些命名空間的模板。; 多值 (以 | 或 alternative 分隔)：-2、-1、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303; 要指定所有值，請使用*。
tllimit: 要回傳的模板數量。; 不允許超過 500 (機器人為 5,000)。; 類型：整數或max; 預設值：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）

（main | query | transcludedin）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Transcludedin

參數：

tiprop

要取得的屬性。

pageid: 各頁面的頁面 ID。
title: 各頁面的標題。
redirect: 若頁面為重新導向，則做出標記。

多值 (以 | 或 alternative 分隔)：pageid、title、redirect

預設值：pageid|title|redirect

tinamespace

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

多值 (以 | 或 alternative 分隔)：0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303

要指定所有值，請使用*。

tishow

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

redirect：僅顯示重新導向。
!redirect：僅顯示非重新導向。

多值 (以 | 或 alternative 分隔)：redirect、!redirect

tilimit

回傳的數量。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

ticontinue

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

範例：

取得嵌入 Main Page 的頁面清單。: api.php?action=query&prop=transcludedin&titles=Main%20Page [在沙盒中開啟]
取得有關嵌入 Main Page 的頁面之資訊。: api.php?action=query&generator=transcludedin&titles=Main%20Page&prop=info [在沙盒中開啟]

list=allcategories （ac）

（main | query | allcategories）

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

列舉所有分類。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allcategories

參數：

acfrom

起始列舉的分類。

accontinue

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

acto

終止列舉的分類。

acprefix

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

acdir

排序的方向。

單值：ascending、descending

預設值：ascending

acmin

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

類型：整數

acmax

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

類型：整數

aclimit

要回傳的分類數量。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

acprop

要取得的屬性。

size: 在分類裡添加頁面數。
hidden: 標記由 __HIDDENCAT__ 隱藏的分類。

多值 (以 | 或 alternative 分隔)：size、hidden

預設值：(空)

範例：

列出分類以及各包含多少頁面的資訊。: api.php?action=query&list=allcategories&acprop=size [在沙盒中開啟]
替以 List 開頭的分類索取該分類頁面本身的資訊。: api.php?action=query&generator=allcategories&gacprefix=List&prop=info [在沙盒中開啟]

list=alldeletedrevisions （adr）

（main | query | alldeletedrevisions）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Alldeletedrevisions

參數：

adrprop

各修訂所要取得的屬性：

ids: 修訂 ID。
flags: 修訂標籤（小修改）。
timestamp: 修訂的時間戳記。
user: 做出修訂的使用者。
userid: 修訂創建者的使用者 ID
size: 修訂的長度（位元組）。
slotsize: 各修訂間隔的長度（位元組）。
sha1: 修訂的 SHA-1（base 16）。
slotsha1: 各修訂間隔的 SHA-1（base 16）。
contentmodel: 各修訂間隔的內容模組 ID。
comment: 由使用者對於修訂所做出的註釋。
parsedcomment: 由使用者對於修訂所解析的註釋。
content: 各修訂間隔的內容。
tags: 修訂標籤。
roles: 列出存在於修訂的內容間隔作用。
parsetree: 已停用。請改用 action=expandtemplates 或 action=parse。修訂內容的 XML 解析樹狀（需要內容模組 wikitext）。

多值 (以 | 或 alternative 分隔)：ids、flags、timestamp、user、userid、size、slotsize、sha1、slotsha1、contentmodel、comment、parsedcomment、content、tags、roles、parsetree

預設值：ids|timestamp|flags|comment|user

adrslots

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

多值 (以 | 或 alternative 分隔)：main

要指定所有值，請使用*。

adrlimit

限制所回傳的修訂數量。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

adrexpandtemplates

已停用。

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

類型：布林值（詳細資訊）

adrgeneratexml

已停用。

請改用 action=expandtemplates 或 action=parse。產生用於修訂內容的 XML 解析樹狀（需要 adrprop=content）。

類型：布林值（詳細資訊）

adrparse

已停用。

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

類型：布林值（詳細資訊）

adrsection

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

adrdiffto

已停用。

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

adrdifftotext

已停用。

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

adrdifftotextpst

已停用。

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

類型：布林值（詳細資訊）

adrcontentformat

已停用。

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

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

adruser

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

類型：使用者名稱

adrnamespace

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

多值 (以 | 或 alternative 分隔)：0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303

要指定所有值，請使用*。

adrstart

起始列舉的時間戳記。

僅與 adruser 一同使用。

類型：時間戳記（允許格式）

adrend

終止列舉的時間戳記。

僅與 adruser 一同使用。

類型：時間戳記（允許格式）

adrdir

列舉的方向：

newer: 最舊的優先。注意：adrstart應在adrend之前。
older: 最新的優先（預設）。注意：adrstart應在adrend之後。

單值：newer、older

預設值：older

adrfrom

在此標題開始列出。

不能與 adruser 一同使用。

adrto

在此標題停止列出。

不能與 adruser 一同使用。

adrprefix

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

不能與 adruser 一同使用。

adrexcludeuser

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

不能與 adruser 一同使用。

類型：使用者名稱

adrtag

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

adrcontinue

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

adrgeneratetitles

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

類型：布林值（詳細資訊）

範例：

列出由使用者 Example 做出的最近 50 個貢獻。: api.php?action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50 [在沙盒中開啟]
列出在主命名空間的前 50 個已刪除修訂。: api.php?action=query&list=alldeletedrevisions&adrdir=newer&adrnamespace=0&adrlimit=50 [在沙盒中開啟]

list=allfileusages （af）

（main | query | allfileusages）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allfileusages

參數：

afcontinue

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

affrom

要起始列舉的檔案標題。

afto

要終止列舉的檔案標題。

afprefix

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

afunique

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

類型：布林值（詳細資訊）

afprop

要包含到的資訊部份：

ids: 添加使用中頁面的頁面 ID（不能與 afunique 一起使用）。
title: 添加檔案標題。

多值 (以 | 或 alternative 分隔)：ids、title

預設值：title

aflimit

要回傳的項目總數。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

afdir

列出時所採用的方向。

單值：ascending、descending

預設值：ascending

範例：

列出檔案標題，包含頁面 ID 以 B 為起始的遺失項目。: api.php?action=query&list=allfileusages&affrom=B&afprop=ids|title [在沙盒中開啟]
列出唯一的檔案標題。: api.php?action=query&list=allfileusages&afunique=&affrom=B [在沙盒中開啟]
取得所有檔案標題，標記為遺失。: api.php?action=query&generator=allfileusages&gafunique=&gaffrom=B [在沙盒中開啟]
取得包含檔案的頁面。: api.php?action=query&generator=allfileusages&gaffrom=B [在沙盒中開啟]

list=allimages （ai）

（main | query | allimages）

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

按順序列舉所有圖片。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allimages

參數：

aisort

作為排序順序的屬性。

單值：name、timestamp

預設值：name

aidir

列出時所採用的方向。

單值：ascending、descending、newer、older

預設值：ascending

aifrom

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

aito

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

aicontinue

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

aistart

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

類型：時間戳記（允許格式）

aiend

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

類型：時間戳記（允許格式）

aiprop

要取得的檔案資訊：

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

多值 (以 | 或 alternative 分隔)：timestamp、user、userid、comment、parsedcomment、canonicaltitle、url、size、dimensions、sha1、mime、mediatype、metadata、commonmetadata、extmetadata、bitdepth、badfile

預設值：timestamp|url

aiprefix

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

aiminsize

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

類型：整數

aimaxsize

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

類型：整數

aisha1

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

aisha1base36

以 base 36 的圖片 SHA1 雜湊值（使用在 MediaWiki）。

aiuser

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

類型：使用者名稱

aifilterbots

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

單值：all、bots、nobots

預設值：all

aimime

所要搜尋的 MIME 類型，例如：image/jpeg。

將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

ailimit

要回傳的圖片總數。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

範例：

搜尋以字母 B 為開頭的所有檔案清單。: api.php?action=query&list=allimages&aifrom=B [在沙盒中開啟]
顯示近期已上傳檔案的清單，類似於 Special:NewFiles。: api.php?action=query&list=allimages&aiprop=user|timestamp|url&aisort=timestamp&aidir=older [在沙盒中開啟]
顯示帶有 MIME 類型為 image/png 或 image/gif 的檔案清單: api.php?action=query&list=allimages&aimime=image/png|image/gif [在沙盒中開啟]
顯示 4 個以 T 為開頭的檔案之資訊。: api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo [在沙盒中開啟]

list=alllinks （al）

（main | query | alllinks）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Alllinks

參數：

alcontinue

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

alfrom

要起始列舉的連結標題。

alto

要終止列舉的連結標題。

alprefix

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

alunique

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

類型：布林值（詳細資訊）

alprop

要包含的資訊部份：

ids: 添加連結頁面的頁面 ID（不能與 alunique 一起使用）。
title: 添加連結標題。

多值 (以 | 或 alternative 分隔)：ids、title

預設值：title

alnamespace

要列舉的命名空間。

單值：-2、-1、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303

預設值：0

allimit

要回傳的項目總數。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

aldir

列出時所採用的方向。

單值：ascending、descending

預設值：ascending

範例：

列出連結標題，包含頁面 ID 以 B 為起始的遺失項目。: api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title [在沙盒中開啟]
列出唯一的連結標題。: api.php?action=query&list=alllinks&alunique=&alfrom=B [在沙盒中開啟]
取得所有已連結標題，標記為遺失。: api.php?action=query&generator=alllinks&galunique=&galfrom=B [在沙盒中開啟]
取得包含連結的頁面。: api.php?action=query&generator=alllinks&galfrom=B [在沙盒中開啟]

list=allpages （ap）

（main | query | allpages）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allpages

參數：

apfrom

起始列舉的頁面標題。

apcontinue

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

apto

終止列舉的頁面標題。

apprefix

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

apnamespace

要列舉的命名空間。

單值：0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303

預設值：0

apfilterredir

要列出的頁面。

單值：all、redirects、nonredirects

預設值：all

apminsize

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

類型：整數

apmaxsize

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

類型：整數

apprtype

僅限受保護的頁面。

多值 (以 | 或 alternative 分隔)：edit、move、upload

apprlevel

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

多值 (以 | 或 alternative 分隔)：可以空白，或 autoconfirmed、sysop

apprfiltercascade

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

單值：cascading、noncascading、all

預設值：all

aplimit

要回傳的頁面總數。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

apdir

列出時所採用的方向。

單值：ascending、descending

預設值：ascending

apfilterlanglinks

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

單值：withlanglinks、withoutlanglinks、all

預設值：all

apprexpiry

篩選頁面的保護期限：

indefinite：只取得無限期保護的頁面。
definite：只取得帶有特定保護期限的頁面。
all：取得任何保護期限的頁面。

單值：indefinite、definite、all

預設值：all

範例：

顯示以字母 B 為開頭的所有頁面清單。: api.php?action=query&list=allpages&apfrom=B [在沙盒中開啟]
顯示 4 個以 T 為開頭的頁面之資訊。: api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info [在沙盒中開啟]
顯示前 2 個以 Re 為開頭的非重新導向頁面內容。: api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content [在沙盒中開啟]

list=allredirects （ar）

（main | query | allredirects）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allredirects

參數：

arcontinue

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

arfrom

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

arto

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

arprefix

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

arunique

僅秀出各別的目標頁面。不可與 arprop=ids|fragment|interwiki 一同使用。當作為產生器使用時，會產生目標頁面而非來源頁面。

類型：布林值（詳細資訊）

arprop

要包含的資訊部份：

ids: 添加重新導向頁面的頁面 ID（不能與 arunique 一起使用）。
title: 添加重新導向的標題。
fragment: 添加來自重新導向的部份（不能與 arunique 一起使用）。
interwiki: 添加來自重新導向的跨 wiki 前綴（不能與 arunique 一起使用）。

多值 (以 | 或 alternative 分隔)：ids、title、fragment、interwiki

預設值：title

arnamespace

要列舉的命名空間。

單值：-2、-1、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303

預設值：0

arlimit

要回傳的項目總數。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

ardir

列出時所採用的方向。

單值：ascending、descending

預設值：ascending

範例：

列出目標頁面，包含頁面 ID 以 B 為起始的遺失項目。: api.php?action=query&list=allredirects&arfrom=B&arprop=ids|title [在沙盒中開啟]
列出唯一目標頁面。: api.php?action=query&list=allredirects&arunique=&arfrom=B [在沙盒中開啟]
取得所有目標頁面，標記為遺失。: api.php?action=query&generator=allredirects&garunique=&garfrom=B [在沙盒中開啟]
取得包含重新導向的頁面。: api.php?action=query&generator=allredirects&garfrom=B [在沙盒中開啟]

list=allrevisions （arv）

（main | query | allrevisions）

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

列出所有修訂版本。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allrevisions

參數：

arvprop

各修訂所要取得的屬性：

ids: 修訂 ID。
flags: 修訂標籤（小修改）。
timestamp: 修訂的時間戳記。
user: 做出修訂的使用者。
userid: 修訂創建者的使用者 ID
size: 修訂的長度（位元組）。
slotsize: 各修訂間隔的長度（位元組）。
sha1: 修訂的 SHA-1（base 16）。
slotsha1: 各修訂間隔的 SHA-1（base 16）。
contentmodel: 各修訂間隔的內容模組 ID。
comment: 由使用者對於修訂所做出的註釋。
parsedcomment: 由使用者對於修訂所解析的註釋。
content: 各修訂間隔的內容。
tags: 修訂標籤。
roles: 列出存在於修訂的內容間隔作用。
parsetree: 已停用。請改用 action=expandtemplates 或 action=parse。修訂內容的 XML 解析樹狀（需要內容模組 wikitext）。

多值 (以 | 或 alternative 分隔)：ids、flags、timestamp、user、userid、size、slotsize、sha1、slotsha1、contentmodel、comment、parsedcomment、content、tags、roles、parsetree

預設值：ids|timestamp|flags|comment|user

arvslots

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

多值 (以 | 或 alternative 分隔)：main

要指定所有值，請使用*。

arvlimit

限制所回傳的修訂數量。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

arvexpandtemplates

已停用。

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

類型：布林值（詳細資訊）

arvgeneratexml

已停用。

請改用 action=expandtemplates 或 action=parse。產生用於修訂內容的 XML 解析樹狀（需要 arvprop=content）。

類型：布林值（詳細資訊）

arvparse

已停用。

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

類型：布林值（詳細資訊）

arvsection

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

arvdiffto

已停用。

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

arvdifftotext

已停用。

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

arvdifftotextpst

已停用。

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

類型：布林值（詳細資訊）

arvcontentformat

已停用。

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

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

arvuser

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

類型：使用者名稱

arvnamespace

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

多值 (以 | 或 alternative 分隔)：0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303

要指定所有值，請使用*。

arvstart

起始列舉的時間戳記。

類型：時間戳記（允許格式）

arvend

終止列舉的時間戳記。

類型：時間戳記（允許格式）

arvdir

列舉的方向：

newer: 最舊的優先。注意：arvstart應在arvend之前。
older: 最新的優先（預設）。注意：arvstart應在arvend之後。

單值：newer、older

預設值：older

arvexcludeuser

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

類型：使用者名稱

arvcontinue

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

arvgeneratetitles

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

類型：布林值（詳細資訊）

範例：

列出由使用者 Example 做出的最近 50 個貢獻。: api.php?action=query&list=allrevisions&arvuser=Example&arvlimit=50 [在沙盒中開啟]
列出在主命名空間的前 50 個修訂。: api.php?action=query&list=allrevisions&arvdir=newer&arvlimit=50 [在沙盒中開啟]

list=alltransclusions （at）

（main | query | alltransclusions）

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

列出所有嵌入（頁面使用 {{x}} 來內嵌），包含不存在的。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Alltransclusions

參數：

atcontinue

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

atfrom

要起始列舉的嵌入標題。

atto

要終止列舉的嵌入標題。

atprefix

搜尋以此值為開頭的所有嵌入標題。

atunique

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

類型：布林值（詳細資訊）

atprop

要包含到的資訊部份：

ids: 添加嵌入頁面的頁面 ID（不能與 atunique 一起使用）。
title: 添加嵌入的標題。

多值 (以 | 或 alternative 分隔)：ids、title

預設值：title

atnamespace

要列舉的命名空間。

單值：-2、-1、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303

預設值：10

atlimit

要回傳的項目總數。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

atdir

列出時所採用的方向。

單值：ascending、descending

預設值：ascending

範例：

列出嵌入標題，包含頁面 ID 以 B 為起始的遺失項目。: api.php?action=query&list=alltransclusions&atfrom=B&atprop=ids|title [在沙盒中開啟]
列出獨一嵌入標題。: api.php?action=query&list=alltransclusions&atunique=&atfrom=B [在沙盒中開啟]
取得所有嵌入標題，標記為遺失。: api.php?action=query&generator=alltransclusions&gatunique=&gatfrom=B [在沙盒中開啟]
取得包含嵌入的頁面。: api.php?action=query&generator=alltransclusions&gatfrom=B [在沙盒中開啟]

list=allusers （au）

（main | query | allusers）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

列舉所有已註冊使用者。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allusers

參數：

aufrom

起始列舉的使用者名稱。

auto

終止列舉的使用者名稱。

auprefix

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

audir

排序的方向。

單值：ascending、descending

預設值：ascending

augroup

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

多值 (以 | 或 alternative 分隔)：bot、sysop、interface-admin、bureaucrat、suppress

auexcludegroup

排除指定群組中的使用者

多值 (以 | 或 alternative 分隔)：bot、sysop、interface-admin、bureaucrat、suppress

aurights

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

多值 (以 | 或 alternative 分隔)：apihighlimits、applychangetags、autoconfirmed、autocreateaccount、autopatrol、bigdelete、block、blockemail、bot、browsearchive、changetags、createaccount、createpage、createtalk、delete、deletechangetags、deletedhistory、deletedtext、deletelogentry、deleterevision、edit、editcontentmodel、editinterface、editprotected、editmyoptions、editmyprivateinfo、editmyusercss、editmyuserjson、editmyuserjs、editmyuserjsredirect、editmywatchlist、editsemiprotected、editsitecss、editsitejson、editsitejs、editusercss、edituserjson、edituserjs、hideuser、import、importupload、ipblock-exempt、managechangetags、markbotedits、mergehistory、minoredit、move、movefile、move-categorypages、move-rootuserpages、move-subpages、nominornewtalk、noratelimit、override-export-depth、pagelang、patrol、patrolmarks、protect、purge、read、reupload、reupload-own、reupload-shared、rollback、sendemail、siteadmin、suppressionlog、suppressredirect、suppressrevision、unblockself、undelete、unwatchedpages、upload、upload_by_url、userrights、userrights-interwiki、viewmyprivateinfo、viewmywatchlist、viewsuppressed、writeapi、skipcaptcha、gadgets-edit、gadgets-definition-edit、nuke、oathauth-enable、oathauth-api-all、oathauth-disable-for-user、oathauth-view-log、renameuser、replacetext、spamblacklistlog、tboverride、tboverride-account、titleblacklistlog、deleteperm、interwiki

上限值為 50（機器人為 500）。

auprop

要包含的資訊部份：

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

多值 (以 | 或 alternative 分隔)：blockinfo、groups、implicitgroups、rights、editcount、registration、centralids

aulimit

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

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

auwitheditsonly

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

類型：布林值（詳細資訊）

auactiveusers

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

類型：布林值（詳細資訊）

auattachedwiki

與 auprop=centralids 使用，另外表明使用者是否附加於由此 ID 所識別出的 wiki。

範例：

列出以Y開頭的使用者。: api.php?action=query&list=allusers&aufrom=Y [在沙盒中開啟]

list=backlinks （bl）

（main | query | backlinks）

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

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Backlinks

參數：

bltitle: 要搜尋的標題。不能與 blpageid 一起使用。
blpageid: 要搜尋的頁面 ID。不能與 bltitle 一起使用。; 類型：整數
blcontinue: 當有更多結果可用時，使用這個繼續。
blnamespace: 要列舉的命名空間。; 多值 (以 | 或 alternative 分隔)：0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303; 要指定所有值，請使用*。
bldir: 列出時所採用的方向。; 單值：ascending、descending; 預設值：ascending
blfilterredir: 如何篩選重新導向。當 blredirect 啟用時若設定成 nonredirects，這僅會套用到第二級別。; 單值：all、redirects、nonredirects; 預設值：all
bllimit: 要回傳的總頁面。若 blredirect 有啟用，套用至各個層級（這代表會回傳多至 2 * bllimit 個結果）。; 不允許超過 500 (機器人為 5,000)。; 類型：整數或max; 預設值：10
blredirect: 若連結頁面為重新導向，則找尋連結至該重新導向的所有頁面。最大限制為一半。; 類型：布林值（詳細資訊）

範例：

顯示至 Main page 的連結。: api.php?action=query&list=backlinks&bltitle=Main%20Page [在沙盒中開啟]
取得連結至 Main page 的相關頁面資訊。: api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info [在沙盒中開啟]

list=blocks （bk）

（main | query | blocks）

此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

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

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Blocks

參數：

bkstart

起始列舉的時間戳記。

類型：時間戳記（允許格式）

bkend

終止列舉的時間戳記。

類型：時間戳記（允許格式）

bkdir

列舉的方向：

newer: 最舊的優先。注意：bkstart應在bkend之前。
older: 最新的優先（預設）。注意：bkstart應在bkend之後。

單值：newer、older

預設值：older

bkids

要列出的封鎖 ID 清單（可選）。

類型：整數列表

將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

bkusers

要搜尋的使用者清單（可選）。

類型：使用者名稱列表

將幾個值以 | 或 alternative 分隔。上限值為 50（機器人為 500）。

bkip

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

bklimit

能列出封鎖的最大數量。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

bkprop

要取得的屬性。

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

多值 (以 | 或 alternative 分隔)：id、user、userid、by、byid、timestamp、expiry、reason、range、flags、restrictions

bkshow

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

多值 (以 | 或 alternative 分隔)：account、!account、temp、!temp、ip、!ip、range、!range

bkcontinue

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

範例：

列出封鎖。: api.php?action=query&list=blocks [在沙盒中開啟]
列出使用者 Alice 與 Bob 的封鎖。: api.php?action=query&list=blocks&bkusers=Alice|Bob [在沙盒中開啟]

list=categorymembers （cm）

（main | query | categorymembers）

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

在指定的分類中列出所有頁面。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Categorymembers

參數：

cmtitle

所要列舉的分類（必要）。必須包含 分類: 前綴。不可與 cmpageid 一同使用。

cmpageid

要列舉的分類之頁面 ID。不能與 cmtitle 同時使用。

類型：整數

cmprop

要包含的資訊部份：

ids: 添加頁面 ID。
title: 添加標題與頁面的命名空間 ID。
sortkey: 添加使用來在分類裡排序的排序鍵值（十六進位字串）。
sortkeyprefix: 添加用於在分類裡排序的排序鍵值字首（排序鍵值中人類可讀的部份）。
type: 添加頁面已被分類的類型（page、subcat 或 file）。
timestamp: 添加在頁面有被包含時的時間戳記。

多值 (以 | 或 alternative 分隔)：ids、title、sortkey、sortkeyprefix、type、timestamp

預設值：ids|title

cmnamespace

僅包含在這些命名空間的頁面。請注意可能會使用 cmtype=subcat 或 cmtype=file，而非 cmnamespace=14 或 6。

多值 (以 | 或 alternative 分隔)：0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303

要指定所有值，請使用*。

cmtype

包含的分類成員類型。當有設定 cmsort=timestamp 時忽略。

多值 (以 | 或 alternative 分隔)：page、subcat、file

預設值：page|subcat|file

cmcontinue

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

cmlimit

回傳的頁面數量上限。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

cmsort

作為排序順序的屬性。

單值：sortkey、timestamp

預設值：sortkey

cmdir

排序的方向。

單值：asc、desc、ascending、descending、newer、older

預設值：ascending

cmstart

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

類型：時間戳記（允許格式）

cmend

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

類型：時間戳記（允許格式）

cmstarthexsortkey

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

cmendhexsortkey

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

cmstartsortkeyprefix

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

cmendsortkeyprefix

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

cmstartsortkey

已停用。

請改用 cmstarthexsortkey。

cmendsortkey

已停用。

請改用 cmendhexsortkey。

範例：

取得在 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）

（main | query | deletedrevs）

此模組已停用。
此模組需要讀取權限。
來源：MediaWiki
授權條款：GPL-2.0-or-later

列出已刪除的修訂。

以三種模式操作：

列出指定標題的已刪除修訂，按時間戳記排序。
列出指定使用者的已刪除貢獻，按時間戳記排序（無指定標題）。
列出在指定命名空間內的所有已刪除修訂，按標題與時間戳記排序（無指定標題、未設定 druser）。

一些參數僅套用於某些模式，並且其它模式裡會被忽略。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Deletedrevs

參數：

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、828、829、2300、2301、2302、2303

預設值：0

drtag

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

druser

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

類型：使用者名稱

drexcludeuser

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

類型：使用者名稱

drprop

要取得的參數：

revidv：添加已刪除修訂的修訂 ID。
parentid：添加前一個修訂的修訂 ID 至頁面。
user：添加做出修訂的使用者。
userid：添加做出修訂的使用者 ID。
comment：添加修訂的註釋。
parsedcomment：添加修訂的解析註釋。
minor：標記修訂是否為小編輯。
len：添加修訂的長度（位元組）。
sha1：添加修訂的 SHA-1 雜湊（base 16）。
content：添加修訂內容。
token：已棄用。提供編輯權杖。
tags：修訂的標籤。

多值 (以 | 或 alternative 分隔)：revid、parentid、user、userid、comment、parsedcomment、minor、len、sha1、content、token、tags

預設值：user|comment

drlimit

修訂能列出的最大數量。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

預設值：10

drcontinue

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

範例：

以帶有內容（模式 1）列出頁面 Main Page 與 Talk: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）

（main | query | embeddedin）

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

找出內嵌（嵌入）指定頁面的所有頁面。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Embeddedin

參數：

eititle: 要搜尋的標題。不能與 eipageid 一起使用。
eipageid: 要搜尋的頁面 ID。不能與 eititle 一起使用。; 類型：整數
eicontinue: 當有更多結果可用時，使用這個繼續。
einamespace: 要列舉的命名空間。; 多值 (以 | 或 alternative 分隔)：0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、828、829、2300、2301、2302、2303; 要指定所有值，請使用*。
eidir: 列出時所採用的方向。; 單值：ascending、descending; 預設值：ascending
eifilterredir: 如何過濾重新導向。; 單值：all、redirects、nonredirects; 預設值：all
eilimit: 要回傳的頁面總數。; 不允許超過 500 (機器人為 5,000)。; 類型：整數或max; 預設值：10

範例：

顯示嵌入 Template:Stub 的頁面。: api.php?action=query&list=embeddedin&eititle=Template:Stub [在沙盒中開啟]
取得有關嵌入 Template:Stub 的頁面之資訊。: api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info [在沙盒中開啟]

list=exturlusage （eu）

（main | query | exturlusage）

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

列舉包含指定 URL 的頁面。

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Exturlusage

參數：

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、828、829、2300、2301、2302、2303

要指定所有值，請使用*。

eulimit

要回傳的頁面數量。

不允許超過 500 (機器人為 5,000)。

類型：整數或max

MediaWiki API 說明

主要模組

action=block

action=categorytree

action=changeauthenticationdata （changeauth）

action=checktoken

action=clearhasmsg

action=clientlogin （login）

action=compare

action=createaccount （create）

action=cspreport

action=delete

action=edit

action=emailuser

action=expandtemplates

action=feedcontributions

action=feedrecentchanges

action=feedwatchlist

action=filerevert

action=help

action=imagerotate

action=import

action=linkaccount （link）

action=login （lg）

action=logout

action=managetags

action=mergehistory

action=mobileview

action=move

action=oathvalidate

action=opensearch

action=options

action=paraminfo

action=parse

action=patrol

action=protect

action=purge

action=query

prop=categories （cl）

prop=categoryinfo （ci）

prop=contributors （pc）

prop=deletedrevisions （drv）

prop=duplicatefiles （df）

prop=extlinks （el）

prop=extracts （ex）

prop=fileusage （fu）

prop=imageinfo （ii）

prop=images （im）

prop=info （in）

prop=iwlinks （iw）

prop=langlinks （ll）

prop=links （pl）

prop=linkshere （lh）

prop=pageimages （pi）

prop=pageprops （pp）

prop=redirects （rd）

prop=references （rf）

prop=revisions （rv）

prop=stashimageinfo （sii）

prop=templates （tl）

prop=transcludedin （ti）

list=allcategories （ac）

list=alldeletedrevisions （adr）

list=allfileusages （af）

list=allimages （ai）

list=alllinks （al）

list=allpages （ap）

list=allredirects （ar）

list=allrevisions （arv）

list=alltransclusions （at）

list=allusers （au）

list=backlinks （bl）

list=blocks （bk）

list=categorymembers （cm）

list=deletedrevs （dr）

list=embeddedin （ei）

list=exturlusage （eu）