MediaWiki API ヘルプ

このページは自動生成された MediaWiki API の説明文書ページです。

説明文書と例: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

メイン モジュール

状態: MediaWiki APIは、積極的にサポートされ、改善された成熟した安定したインターフェースです。避けようとはしていますが、時には壊れた変更が加えられるかもしれません。更新の通知を受け取るには、mediawiki-api-announce メーリングリストに参加してください。

誤ったリクエスト: 誤ったリクエストが API に送られた場合、"MediaWiki-API-Error" HTTP ヘッダーが送信され、そのヘッダーの値と送り返されるエラーコードは同じ値にセットされます。より詳しい情報は API: Errors and warnings を参照してください。

パラメーター:
action

実行する操作です。

abusefiltercheckmatch
Check to see if an AbuseFilter matches a set of variables, an edit, or a logged AbuseFilter event.
abusefilterchecksyntax
不正利用フィルターの構文を確認します。
abusefilterevalexpression
不正利用フィルターの式を評価します。
abusefilterunblockautopromote
Unblocks a user from receiving autopromotions due to an abusefilter consequence.
abuselogprivatedetails
View private details of an AbuseLog entry.
ask
API module to query Semantic MediaWiki using the ask language.
askargs
API module to query Semantic MediaWiki using the ask language as list of conditions, printouts and parameters.
block
利用者をブロックします。
changeauthenticationdata
現在の利用者の認証データを変更します。
changecontentmodel
Change the content model of a page
checktoken
action=query&meta=tokens のトークンの妥当性を確認します。
cirrus-config-dump
CirrusSearch の設定をダンプします。
cirrus-mapping-dump
このウィキの CirrusSearch のマッピングをダンプします。
cirrus-profiles-dump
このウィキの CirrusSearch の設定をダンプします。
cirrus-settings-dump
このウィキの CirrusSearch の設定をダンプします。
clearhasmsg
現在の利用者の hasmsg フラグを消去します。
clientlogin
インタラクティブフローを使用してウィキにログインします。
compare
2つの版間の差分を取得します。
createaccount
新しい利用者アカウントを作成します。
delete
ページを削除します。
echomarkread
現在の利用者への通知を既読にする。
echomarkseen
Mark notifications as seen for the current user.
echomute
Mute or unmute notifications from certain users or pages.
edit
ページを作成、編集します。
emailuser
利用者にメールを送信します。
expandtemplates
ウィキテキストに含まれるすべてのテンプレートを展開します。
feedcontributions
利用者の投稿記録フィードを返します。
feedrecentchanges
最近の更新フィードを返します。
feedwatchlist
ウォッチリストのフィードを返します。
filerevert
ファイルを古い版に差し戻します。
flow
Allows actions to be taken on Structured Discussions pages.
flow-parsoid-utils
Convert text between wikitext and HTML.
flowthank
コメントに対して感謝の通知を送信する。
help
指定したモジュールのヘルプを表示します。
imagerotate
1つ以上の画像を回転させます。
import
他のWikiまたはXMLファイルからページを取り込む。
linkaccount
Link an account from a third-party provider to the current user.
login
ログインして認証クッキーを取得します。
logout
ログアウトしてセッションデータを消去します。
managetags
Perform management tasks relating to change tags.
mergehistory
ページの履歴を統合する。
move
ページを移動します。
opensearch
OpenSearch プロトコルを使用してWiki内を検索します。
options
現在の利用者の設定を変更します。
paraminfo
API モジュールに関する情報を取得します。
parse
Parses content and returns parser output.
patrol
ページまたは版を巡回済みにする。
protect
ページの保護レベルを変更します。
purge
指定されたページのキャッシュを破棄します。
query
MediaWikiからデータを取得します。
removeauthenticationdata
Remove authentication data for the current user.
resetpassword
Send a password reset email to a user.
revisiondelete
版の削除および復元を行います。
rollback
ページの最後の編集を取り消す。
rsd
Export an RSD (Really Simple Discovery) schema.
setnotificationtimestamp
Update the notification timestamp for watched pages.
setpagelanguage
ページの言語を変更します。
smwbrowse
API module to support browse activities for different entity types in Semantic MediaWiki.
smwinfo
API module to retrieve information about Semantic MediaWiki statistics and other meta information.
smwtask
API module to execute Semantic MediaWiki related tasks (for internal use only, not for public use).
spamblacklist
1件以上の URL についてスパムブラックリストに登録されているか検証します。
tag
個々の版または記録項目に対しタグの追加または削除を行います。
templatedata
Fetch data stored by the TemplateData extension.
thank
編集者に感謝の通知を送信する。
titleblacklist
Validate a page title, filename, or username against the TitleBlacklist.
unblock
利用者のブロックを解除します。
undelete
削除されたページの版を復元します。
unlinkaccount
Remove a linked third-party account from the current user.
upload
Upload a file, or get the status of pending uploads.
userrights
利用者の所属グループを変更します。
validatepassword
Validate a password against the wiki's password policies.
watch
現在の利用者のウォッチリストにページを追加/除去します。
webapp-manifest
Returns a webapp manifest.
browsebyproperty
廃止予定です。 API module to retrieve information about a property or list of properties.
browsebysubject
廃止予定です。 API module to retrieve information about a subject.
mobileview
廃止予定です。 Returns data needed for mobile views.
tokens
廃止予定です。 Get tokens for data-modifying actions.
categorytree
内部で使用。 カテゴリツリー拡張機能の内部モジュール。
cspreport
内部で使用。 Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser.
oathvalidate
内部で使用。 Validate a two-factor authentication (OATH) token.
scribunto-console
内部で使用。 Internal module for servicing XHR requests from the Scribunto console.
stashedit
内部で使用。 Prepare an edit in shared cache.
visualeditor
内部で使用。 Returns HTML5 for a page from the Parsoid service.
visualeditoredit
内部で使用。 HTML5ページを MediaWiki として保存する (Parsoidサービスを利用してウィキテキストに変換されます)
値 (次の値のいずれか1つ): abusefiltercheckmatchabusefilterchecksyntaxabusefilterevalexpressionabusefilterunblockautopromoteabuselogprivatedetailsaskaskargsblockchangeauthenticationdatachangecontentmodelchecktokencirrus-config-dumpcirrus-mapping-dumpcirrus-profiles-dumpcirrus-settings-dumpclearhasmsgclientlogincomparecreateaccountdeleteechomarkreadechomarkseenechomuteeditemailuserexpandtemplatesfeedcontributionsfeedrecentchangesfeedwatchlistfilerevertflow-parsoid-utilsflowflowthankhelpimagerotateimportlinkaccountloginlogoutmanagetagsmergehistorymoveopensearchoptionsparaminfoparsepatrolprotectpurgequeryremoveauthenticationdataresetpasswordrevisiondeleterollbackrsdsetnotificationtimestampsetpagelanguagesmwbrowsesmwinfosmwtaskspamblacklisttagtemplatedatathanktitleblacklistunblockundeleteunlinkaccountuploaduserrightsvalidatepasswordwatchwebapp-manifestbrowsebypropertybrowsebysubjectmobileviewtokenscategorytreecspreportoathvalidatescribunto-consolestasheditvisualeditorvisualeditoredit
Default: help
format

出力する形式です。

json
データを JSON 形式で出力します。
jsonfm
データを JSON 形式 (HTML に埋め込んだ形式) で出力します。
none
何も出力しません。
php
データを PHP のシリアル化した形式で出力します。
phpfm
データを PHP のシリアル化した形式 (HTML に埋め込んだ形式) で出力します。
rawfm
データをデバッグ要素付きで JSON 形式 (HTML に埋め込んだ形式) で出力します。
xml
データを XML 形式で出力します。
xmlfm
データを XML 形式 (HTML に埋め込んだ形式) で出力します。
値 (次の値のいずれか1つ): jsonjsonfmnonephpphpfmrawfmxmlxmlfm
Default: jsonfm
maxlag

Maximum lag can be used when MediaWiki is installed on a database replicated cluster. To save actions causing any more site replication lag, this parameter can make the client wait until the replication lag is less than the specified value. In case of excessive lag, error code maxlag is returned with a message like Waiting for $host: $lag seconds lagged.
See Manual: Maxlag parameter for more information.

型: 整数
smaxage

s-maxage HTTP キャッシュ コントロール ヘッダー に、この秒数を設定します。エラーがキャッシュされることはありません。

型: 整数
Default: 0
maxage

max-age HTTP キャッシュ コントロール ヘッダー に、この秒数を設定します。エラーがキャッシュされることはありません。

型: 整数
Default: 0
assert

user を設定した場合は利用者がログイン済みかどうかを、bot を指定した場合はボット権限があるかどうかを、それぞれ検証します。

値 (次の値のいずれか1つ): anon、bot、user
assertuser

現在の利用者が指定された利用者であることを確認します。

型: 利用者名を使った利用者
requestid

任意の値を指定でき、その値が結果に含められます。リクエストを識別するために使用できます。

servedby

リクエストを処理したホスト名を結果に含めます。

型: 真偽値 (詳細)
curtimestamp

現在のタイムスタンプを結果に含めます。

型: 真偽値 (詳細)
responselanginfo

結果にuselangerrorlangに使用される言語を含めます。

型: 真偽値 (詳細)
origin

When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body).

For authenticated requests, this must match one of the origins in the Origin header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is whitelisted, the Access-Control-Allow-Origin and Access-Control-Allow-Credentials headers will be set.

For non-authenticated requests, specify the value *. This will cause the Access-Control-Allow-Origin header to be set, but Access-Control-Allow-Credentials will be false and all user-specific data will be restricted.

uselang

メッセージの翻訳に使用する言語です。action=query&meta=siteinfosiprop=languages を付けると言語コードの一覧を返します。user を指定することで現在の利用者の個人設定の言語を、content を指定することでこのウィキの本文の言語を使用することもできます。

Default: user
errorformat

Format to use for warning and error text output.

plaintext
Wikitext with HTML tags removed and entities replaced.
wikitext
Unparsed wikitext.
html
HTML.
raw
Message key and parameters.
none
No text output, only the error codes.
bc
Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.
値 (次の値のいずれか1つ): bc、html、none、plaintext、raw、wikitext
Default: bc
errorlang

Language to use for warnings and errors. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify content to use this wiki's content language, or specify uselang to use the same value as the uselang parameter.

Default: uselang
errorsuselocal

指定された場合、エラーテキストはMediaWiki名前空間からローカルにカスタマイズされたメッセージを使用します。

型: 真偽値 (詳細)
例:
メイン モジュールのヘルプ
api.php?action=help [サンドボックスで開く]
すべてのヘルプを1つのページに
api.php?action=help&recursivesubmodules=1 [サンドボックスで開く]
権限:
writeapi
書き込み API を使用
権限を持つグループ: all、user および bot
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
権限を持つグループ: bot および sysop

action=abusefiltercheckmatch

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Abuse Filter
  • ライセンス: GPL-2.0-or-later

Check to see if an AbuseFilter matches a set of variables, an edit, or a logged AbuseFilter event.

vars、rcid、またはlogidが必要です。 ただし、使用できるのは1つだけです。

パラメーター:
filter

一致チェックの対象となるフィルター文全文

このパラメーターは必須です。
vars

テストする変数のJSONエンコードされた配列。

rcid

確認する最近の変更ID。

型: 整数
logid

検査対象となる不正利用フィルターのログID

型: 整数
例:
最近の変更ID 15が単純なフィルターに一致するかどうかをテストする
api.php?action=abusefiltercheckmatch&filter=!("autoconfirmed"%20in%20user_groups)&rcid=15 [サンドボックスで開く]

action=abusefilterchecksyntax

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Abuse Filter
  • ライセンス: GPL-2.0-or-later

不正利用フィルターの構文を確認します。

パラメーター:
filter

構文チェックの対象となるフィルター文全文

このパラメーターは必須です。

action=abusefilterevalexpression

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Abuse Filter
  • ライセンス: GPL-2.0-or-later

不正利用フィルターの式を評価します。

パラメーター:
expression

評価する式。

このパラメーターは必須です。
prettyprint

Whether the result should be pretty-printed.

型: 真偽値 (詳細)

action=abusefilterunblockautopromote

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Abuse Filter
  • ライセンス: GPL-2.0-or-later

Unblocks a user from receiving autopromotions due to an abusefilter consequence.

パラメーター:
user

ブロック解除する利用者の利用者名。

このパラメーターは必須です。
型: 利用者名、IP、IP範囲 および インターウィキの名前(例: "prefix>ExampleName")のいずれかを使った利用者
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=abuselogprivatedetails

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Abuse Filter
  • ライセンス: GPL-2.0-or-later

View private details of an AbuseLog entry.

パラメーター:
logid

The ID of the AbuseLog entry to be checked.

型: 整数
reason

A valid reason for performing the check.

token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。
例:
Get private details for the AbuseLog entry with ID 1, using the reason "example".
api.php?action=abuselogprivatedetails&logid=1&reason=example&token=ABC123 [サンドボックスで開く]

action=ask

(main | ask)
  • このモジュールは読み取りの権限を必要とします。
  • ソース: Semantic MediaWiki
  • ライセンス: GPL-2.0-or-later

API module to query Semantic MediaWiki using the ask language.

パラメーター:
query
⧼apihelp-ask-param-query⧽
このパラメーターは必須です。
api_version

Output formatting:

2
Backwards-compatible format using {} for the result list.
3
Experimental format using [] as result list.
値 (次の値のいずれか1つ): 2、3
Default: 2

action=askargs

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Semantic MediaWiki
  • ライセンス: GPL-2.0-or-later

API module to query Semantic MediaWiki using the ask language as list of conditions, printouts and parameters.

パラメーター:
conditions
⧼apihelp-askargs-param-conditions⧽
このパラメーターは必須です。
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
printouts
⧼apihelp-askargs-param-printouts⧽
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
既定値: (空)
parameters
⧼apihelp-askargs-param-parameters⧽
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
既定値: (空)
api_version

Output formatting:

2
Backwards-compatible format using {} for the result list.
3
Experimental format using [] as result list.
値 (次の値のいずれか1つ): 2、3
Default: 2

action=block

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

利用者をブロックします。

パラメーター:
user

ブロックする利用者。

型: 利用者名、IP、IP範囲 および 利用者ID(例: #12345)のいずれかを使った利用者
userid
廃止予定です。

代わりに user=#ID を指定してください。

型: 整数
expiry

有効期限。相対的 (例: 5 months または 2 weeks) または絶対的 (e.g. 2014-09-18T12:34:56Z) どちらでも構いません。infinite, indefinite, もしくは never と設定した場合, 無期限ブロックとなります。

Default: never
reason

ブロックの理由。

既定値: (空)
anononly

匿名利用者のみブロックします(つまり、このIPアドレスからの匿名での編集を不可能にします)。

型: 真偽値 (詳細)
nocreate

アカウントの作成を禁止します。

型: 真偽値 (詳細)
autoblock

その利用者が最後に使用したIPアドレスと、ブロック後に編集を試みた際のIPアドレスを自動的にブロックします。

型: 真偽値 (詳細)
noemail

ウィキを通してメールを送信することを禁止します。(blockemail 権限が必要です)

型: 真偽値 (詳細)
hidename

ブロック記録から利用者名を秘匿します。(hideuser 権限が必要です)

型: 真偽値 (詳細)
allowusertalk

自身のトークページの編集を許可する ($wgBlockAllowsUTEdit に依存)。

型: 真偽値 (詳細)
reblock

その利用者がすでにブロックされている場合、ブロックを上書きします。

型: 真偽値 (詳細)
watchuser

その利用者またはIPアドレスの利用者ページとトークページをウォッチします。

型: 真偽値 (詳細)
tags

ブロック記録の項目に適用する変更タグ。

値 (|もしくは別の文字列で区切る):
partial

サイト全体ではなく特定のページまたは名前空間での編集をブロックします。

型: 真偽値 (詳細)
pagerestrictions

利用者が編集できないようにするページのタイトルのリスト。partial に true が設定されている場合のみ適用します。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 10 です。
namespacerestrictions

利用者が編集できないようにする名前空間のID。partial に true が設定されている場合のみ適用します。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。
例:
IPアドレス 192.0.2.5 を何らかの理由で3日ブロックする。
api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC [サンドボックスで開く]
利用者 Vandal を何らかの理由で無期限ブロックし、新たなアカウント作成とメールの送信を禁止する。
api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC [サンドボックスで開く]

action=browsebyproperty

  • このモジュールは廃止予定です。
  • このモジュールは読み取りの権限を必要とします。
  • ソース: Semantic MediaWiki
  • ライセンス: GPL-2.0-or-later

API module to retrieve information about a property or list of properties.

パラメーター:
property
⧼apihelp-browsebyproperty-param-property⧽
limit
⧼apihelp-browsebyproperty-param-limit⧽
Default: 50
lang
⧼apihelp-browsebyproperty-param-lang⧽
listonly
⧼apihelp-browsebyproperty-param-listonly⧽
既定値: (空)

action=browsebysubject

  • このモジュールは廃止予定です。
  • このモジュールは読み取りの権限を必要とします。
  • ソース: Semantic MediaWiki
  • ライセンス: GPL-2.0-or-later

API module to retrieve information about a subject.

パラメーター:
subject
⧼apihelp-browsebysubject-param-subject⧽
このパラメーターは必須です。
ns
⧼apihelp-browsebysubject-param-ns⧽
型: 整数
Default: 0
iw
⧼apihelp-browsebysubject-param-iw⧽
既定値: (空)
subobject
⧼apihelp-browsebysubject-param-subobject⧽
既定値: (空)
type
⧼apihelp-browsebysubject-param-type⧽
既定値: (空)
options
⧼apihelp-browsebysubject-param-options⧽
既定値: (空)

action=categorytree

  • このモジュールは内部的または不安定です。動作が予告なく変更される場合があります。
  • このモジュールは読み取りの権限を必要とします。
  • ソース: CategoryTree
  • ライセンス: GPL-2.0-or-later

カテゴリツリー拡張機能の内部モジュール。

パラメーター:
category

カテゴリ名前空間におけるページ名、接頭辞は指定しても無視される。

このパラメーターは必須です。
options

CategoryTreeコンストラクターのオプションをJSONオブジェクトとして指定。depthオプションの既定値は1です。

action=changeauthenticationdata (changeauth)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

現在の利用者の認証データを変更します。

パラメーター:
changeauthrequest

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

このパラメーターは必須です。
changeauthtoken

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。
*
This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=change (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.

action=changecontentmodel

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Change the content model of a page

パラメーター:
title

Title of the page to change the contentmodel of. Cannot be used together with pageid.

pageid

Page ID of the page to change the contentmodel of. Cannot be used together with title.

型: 整数
summary

Edit summary and log entry reason

tags

Change tags to apply to the log entry and edit.

値 (|もしくは別の文字列で区切る):
model

Content model of the new content.

このパラメーターは必須です。
値 (次の値のいずれか1つ): GadgetDefinition、Scribunto、css、javascript、json、smw/schema、text、wikitext
bot

Mark the content model change with a bot flag.

型: 真偽値 (詳細)
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=checktoken

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

action=query&meta=tokens のトークンの妥当性を確認します。

パラメーター:
type

調べるトークンの種類。

このパラメーターは必須です。
値 (次の値のいずれか1つ): createaccount、csrf、login、patrol、rollback、userrights、watch
token

調べるトークン。

このパラメーターは必須です。
maxtokenage

トークンの最大有効期限 (秒)。

型: 整数

action=cirrus-config-dump

  • このモジュールは読み取りの権限を必要とします。
  • ソース: CirrusSearch
  • ライセンス: GPL-2.0-or-later

CirrusSearch の設定をダンプします。

例:
CirrusSearch の設定のダンプを取得します。
api.php?action=cirrus-config-dump [サンドボックスで開く]

action=cirrus-mapping-dump

  • このモジュールは読み取りの権限を必要とします。
  • ソース: CirrusSearch
  • ライセンス: GPL-2.0-or-later

このウィキの CirrusSearch のマッピングをダンプします。

例:
このウィキの CirrusSearch のマッピングのダンプを取得します。
api.php?action=cirrus-mapping-dump [サンドボックスで開く]

action=cirrus-profiles-dump

  • このモジュールは読み取りの権限を必要とします。
  • ソース: CirrusSearch
  • ライセンス: GPL-2.0-or-later

このウィキの CirrusSearch の設定をダンプします。

パラメーター:
verbose

設定の内容のダンプを取得

型: 真偽値 (詳細)
例:
このウィキの CirrusSearch の設定のダンプを取得します。
api.php?action=cirrus-profiles-dump [サンドボックスで開く]

action=cirrus-settings-dump

  • このモジュールは読み取りの権限を必要とします。
  • ソース: CirrusSearch
  • ライセンス: GPL-2.0-or-later

このウィキの CirrusSearch の設定をダンプします。

例:
このウィキの CirrusSearch の設定のダンプを取得します。
api.php?action=cirrus-settings-dump [サンドボックスで開く]

action=clearhasmsg

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

現在の利用者の hasmsg フラグを消去します。

例:
現在の利用者の hasmsg フラグを消去する。
api.php?action=clearhasmsg [サンドボックスで開く]

action=clientlogin (login)

  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

インタラクティブフローを使用してウィキにログインします。

The general procedure to use this module is:

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

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

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
loginmessageformat

Format to use for returning messages.

値 (次の値のいずれか1つ): html、none、raw、wikitext
Default: wikitext
loginmergerequestfields

Merge field information for all authentication requests into one array.

型: 真偽値 (詳細)
loginpreservestate

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

型: 真偽値 (詳細)
loginreturnurl

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

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

logincontinue

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

型: 真偽値 (詳細)
logintoken

action=query&meta=tokens から取得した「login」トークン

このパラメーターは必須です。
*
This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=login (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.
例:
利用者 Example としてのログイン処理をパスワード ExamplePassword で開始する
api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [サンドボックスで開く]
987654OATHTokenを提供する2段階認証のUIレスポンスの後にログインを続けます。
api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [サンドボックスで開く]

action=compare

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

2つの版間の差分を取得します。

"from" と "to" の両方の版番号、ページ名、もしくはページIDを渡す必要があります。

パラメーター:
fromtitle

比較する1つ目のページ名。

fromid

比較する1つ目のページID。

型: 整数
fromrev

比較する1つ目の版。

型: 整数
fromslots

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

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

値 (|もしくは別の文字列で区切る): main
fromtext-{slot}

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

This is a templated parameter. When making the request, {slot} in the parameter's name should be replaced with values of fromslots.
fromsection-{slot}

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

This is a templated parameter. When making the request, {slot} in the parameter's name should be replaced with values of fromslots.
fromcontentformat-{slot}

Content serialization format of fromtext-{slot}.

This is a templated parameter. When making the request, {slot} in the parameter's name should be replaced with values of fromslots.
値 (次の値のいずれか1つ): application/json、text/css、text/javascript、text/plain、text/x-wiki
fromcontentmodel-{slot}

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

This is a templated parameter. When making the request, {slot} in the parameter's name should be replaced with values of fromslots.
値 (次の値のいずれか1つ): GadgetDefinition、Scribunto、css、flow-board、javascript、json、smw/schema、text、wikitext
frompst

fromtext-{slot}に保存前変換を行います。

型: 真偽値 (詳細)
fromtext
廃止予定です。

fromslots=mainを指定し、代わりにfromtext-main を使用してください。

fromcontentformat
廃止予定です。

fromslots=mainを指定し、代わりにfromcontentformat-main を使用してください。

値 (次の値のいずれか1つ): application/json、text/css、text/javascript、text/plain、text/x-wiki
fromcontentmodel
廃止予定です。

fromslots=mainを指定し、代わりにfromcontentmodel-main を使用してください。

値 (次の値のいずれか1つ): GadgetDefinition、Scribunto、css、flow-board、javascript、json、smw/schema、text、wikitext
fromsection
廃止予定です。

'from' の内容のうち指定された節のみを使用します。

totitle

比較する2つ目のページ名。

toid

比較する2つ目のページID。

型: 整数
torev

比較する2つ目の版。

型: 整数
torelative

Use a revision relative to the revision determined from fromtitle, fromid or fromrev. All of the other 'to' options will be ignored.

値 (次の値のいずれか1つ): cur、next、prev
toslots

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

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

値 (|もしくは別の文字列で区切る): main
totext-{slot}

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

This is a templated parameter. When making the request, {slot} in the parameter's name should be replaced with values of toslots.
tosection-{slot}

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

This is a templated parameter. When making the request, {slot} in the parameter's name should be replaced with values of toslots.
tocontentformat-{slot}

Content serialization format of totext-{slot}.

This is a templated parameter. When making the request, {slot} in the parameter's name should be replaced with values of toslots.
値 (次の値のいずれか1つ): application/json、text/css、text/javascript、text/plain、text/x-wiki
tocontentmodel-{slot}

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

This is a templated parameter. When making the request, {slot} in the parameter's name should be replaced with values of toslots.
値 (次の値のいずれか1つ): GadgetDefinition、Scribunto、css、flow-board、javascript、json、smw/schema、text、wikitext
topst

totextに保存前変換を行います。

型: 真偽値 (詳細)
totext
廃止予定です。

toslots=mainを指定し、代わりにtotext-main を使用してください。

tocontentformat
廃止予定です。

toslots=mainを指定し、代わりにtocontentformat-main を使用してください。

値 (次の値のいずれか1つ): application/json、text/css、text/javascript、text/plain、text/x-wiki
tocontentmodel
廃止予定です。

toslots=mainを指定し、代わりにtocontentmodel-main を使用してください。

値 (次の値のいずれか1つ): GadgetDefinition、Scribunto、css、flow-board、javascript、json、smw/schema、text、wikitext
tosection
廃止予定です。

'to' の内容のうち指定された節のみを使用します。

prop

どの情報を取得するか:

diff
差分HTML。
diffsize
差分HTMLのサイズ (バイト数)。
rel
存在する場合、'from' の直前、および 'to' の直後の版ID。
ids
'from' および 'to' の版のページIDおよび版ID。
title
'from' および 'to' の版のページ名。
user
'from' および 'to' の版の投稿者の利用者名およびID。
comment
'from' および 'to' の版のコメント。
parsedcomment
'from' および 'to' の版の整形済みコメント。
size
'from' および 'to' の版のサイズ。
timestamp
(説明なし)
値 (|もしくは別の文字列で区切る): comment、diff、diffsize、ids、parsedcomment、rel、size、timestamp、title、user
Default: diff|ids|title
slots

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

値 (|もしくは別の文字列で区切る): main
すべての値を指定するには、*を用いてください。

action=createaccount (create)

  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

新しい利用者アカウントを作成します。

The general procedure to use this module is:

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

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

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
createmessageformat

Format to use for returning messages.

値 (次の値のいずれか1つ): html、none、raw、wikitext
Default: wikitext
createmergerequestfields

Merge field information for all authentication requests into one array.

型: 真偽値 (詳細)
createpreservestate

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

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

型: 真偽値 (詳細)
createreturnurl

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

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

createcontinue

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

型: 真偽値 (詳細)
createtoken

action=query&meta=tokens から取得した「createaccount」トークン

このパラメーターは必須です。
*
This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=create (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.

action=cspreport

  • このモジュールは内部的または不安定です。動作が予告なく変更される場合があります。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser.

パラメーター:
reportonly

Mark as being a report from a monitoring policy, not an enforced policy

型: 真偽値 (詳細)
source

このレポートをトリガしたCSPヘッダを生成した内容

Default: internal

action=delete

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページを削除します。

パラメーター:
title

削除するページ名です。pageid とは同時に使用できません。

pageid

削除するページIDです。title とは同時に使用できません。

型: 整数
reason

削除の理由です。入力しない場合、自動的に生成された理由が使用されます。

tags

タグを変更し、削除記録の項目に適用します。

値 (|もしくは別の文字列で区切る):
watch
廃止予定です。

そのページを現在の利用者のウォッチリストに追加します。

型: 真偽値 (詳細)
watchlist

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

値 (次の値のいずれか1つ): nochange、preferences、unwatch、watch
Default: preferences
unwatch
廃止予定です。

そのページを現在の利用者のウォッチリストから除去します。

型: 真偽値 (詳細)
oldimage

削除する古い画像のaction=query&prop=imageinfo&iiprop=archivename で取得できるような名前。

token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=echomarkread

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Echo
  • ライセンス: MIT

現在の利用者への通知を既読にする。

パラメーター:
list

既読にする通知IDのリスト。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
unreadlist

未読にする通知IDのリスト。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
all

設定すると、すべての通知を既読にします。

型: 真偽値 (詳細)
sections

A list of sections to mark as read.

値 (|もしくは別の文字列で区切る): alert、message
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=echomarkseen

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Echo
  • ライセンス: MIT

Mark notifications as seen for the current user.

パラメーター:
type

既読としてマークする通知の種類:'alert'、'message'、あるいは 'all'。

このパラメーターは必須です。
値 (次の値のいずれか1つ): alert、all、message
timestampFormat

Timestamp format to use for output, 'ISO_8601' or 'MW'. 'MW' is deprecated here, so all clients should switch to 'ISO_8601'. This parameter will be removed, and 'ISO_8601' will become the only output format.

値 (次の値のいずれか1つ): ISO_8601、MW
Default: MW

action=echomute

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Echo
  • ライセンス: MIT

Mute or unmute notifications from certain users or pages.

パラメーター:
type

Which mute list to add to or remove from

このパラメーターは必須です。
値 (次の値のいずれか1つ): page-linked-title、user
mute

Pages or users to add to the mute list

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
unmute

Pages or users to remove from the mute list

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=edit

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページを作成、編集します。

パラメーター:
title

編集するページ名です。pageid とは同時に使用できません。

pageid

編集するページIDです。title とは同時に使用できません。

型: 整数
section

節番号です。先頭の節の場合は 0、新しい節の場合は newを指定します。

sectiontitle

新しい節の名前です。

text

ページの本文。

summary

編集の要約。section=new で sectiontitle が設定されていない場合は節名としても利用されます。

tags

この版に適用する変更タグ。

値 (|もしくは別の文字列で区切る):
minor

この編集に細部の変更の印を付ける

型: 真偽値 (詳細)
notminor

利用者設定で「すべての編集を既定で細部の編集とする」を指定してあっても、細部の編集とマークしないでください。

型: 真偽値 (詳細)
bot

この編集をボットの編集としてマークする。

型: 真偽値 (詳細)
baserevid

ID of the base revision, used to detect edit conflicts. May be obtained through action=query&prop=revisions. Self-conflicts cause the edit to fail unless basetimestamp is set.

型: 整数
basetimestamp

編集前の版のタイムスタンプ。編集競合を検出するために使用されます。 action=query&prop=revisions&rvprop=timestamp で取得できます。

Type: timestamp (allowed formats)
starttimestamp

編集作業を開始したときのタイムスタンプ。編集競合を検出するために使用されます。適切な値は curtimestamp を使用して編集作業を開始するとき (たとえば、編集するページの本文を読み込んだとき) に取得できます。

Type: timestamp (allowed formats)
recreate

その間に削除されたページに関するエラーを上書きします。

型: 真偽値 (詳細)
createonly

すでにそのページが存在する場合は編集を行いません。

型: 真偽値 (詳細)
nocreate

そのページが存在しない場合にエラーを返します。

型: 真偽値 (詳細)
watch
廃止予定です。

そのページを現在の利用者のウォッチリストに追加します。

型: 真偽値 (詳細)
unwatch
廃止予定です。

そのページを現在の利用者のウォッチリストから除去します。

型: 真偽値 (詳細)
watchlist

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

値 (次の値のいずれか1つ): nochange、preferences、unwatch、watch
Default: preferences
md5

The MD5 hash of the text parameter, or the prependtext and appendtext parameters concatenated. If set, the edit won't be done unless the hash is correct.

prependtext

このテキストをページの先頭に追加します。text をオーバーライドします。

appendtext

このテキストをページの末尾に追加する。textを上書きします。

新しい節を追加するにはこのパラメーターではなく section=newを使用してください。

undo

この版を取り消します。text, prependtext および appendtext をオーバーライドします。

型: 整数
The value must be no less than 0.
undoafter

undo からこの版までのすべての版を取り消します。設定しない場合、ひとつの版のみ取り消されます。

型: 整数
The value must be no less than 0.
redirect

自動的に転送を解決します。

型: 真偽値 (詳細)
contentformat

Content serialization format used for the input text.

値 (次の値のいずれか1つ): application/json、text/css、text/javascript、text/plain、text/x-wiki
contentmodel

新しいコンテンツのコンテンツモデル。

値 (次の値のいずれか1つ): GadgetDefinition、Scribunto、css、flow-board、javascript、json、smw/schema、text、wikitext
token

action=query&meta=tokens から取得した「csrf」トークン

このトークンは常に最後のパラメーターとして、または少なくとも text パラメーターより後に送信されるべきです。

このパラメーターは必須です。
captchaword

CAPTCHAに答える

captchaid

以前のリクエストのCAPTCHA ID

action=emailuser

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

利用者にメールを送信します。

パラメーター:
target

送信先の利用者名。

このパラメーターは必須です。
subject

題名。

text

メールの本文。

このパラメーターは必須です。
ccme

メールの複製を自分にも送信します。

型: 真偽値 (詳細)
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。
例:
利用者 WikiSysopContent という本文のメールを送信。
api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC [サンドボックスで開く]

action=expandtemplates

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ウィキテキストに含まれるすべてのテンプレートを展開します。

パラメーター:
title

ページの名前です。

text

変換するウィキテキストです。

このパラメーターは必須です。
revid

Revision ID, for {{REVISIONID}} and similar variables.

型: 整数
prop

Which pieces of information to get.

Note that if no values are selected, the result will contain the wikitext, but the output will be in a deprecated format.

wikitext
展開されたウィキテキスト。
categories
Any categories present in the input that are not represented in the wikitext output.
properties
Page properties defined by expanded magic words in the wikitext.
volatile
Whether the output is volatile and should not be reused elsewhere within the page.
ttl
The maximum time after which caches of the result should be invalidated.
modules
Any ResourceLoader modules that parser functions have requested be added to the output. Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules.
jsconfigvars
ページに固有のJavaScriptの設定変数を提供します。
encodedjsconfigvars
JSON文字列としてページに固有のJavaScriptの設定変数を提供します。
parsetree
入力のXML構文解析ツリー。
値 (|もしくは別の文字列で区切る): categories、encodedjsconfigvars、jsconfigvars、modules、parsetree、properties、ttl、volatile、wikitext
includecomments

HTMLコメントを出力に含めるかどうか。

型: 真偽値 (詳細)
generatexml
廃止予定です。

XMLの構文解析ツリーを生成します (replaced by prop=parsetree)

型: 真偽値 (詳細)
例:
ウィキテキスト {{Project:Sandbox}} を展開する。
api.php?action=expandtemplates&text={{Project:Sandbox}} [サンドボックスで開く]

action=feedcontributions

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

利用者の投稿記録フィードを返します。

パラメーター:
feedformat

フィードの形式。

値 (次の値のいずれか1つ): atom、rss
Default: rss
user

投稿記録を取得する利用者。

このパラメーターは必須です。
型: 利用者名、IP、IP範囲、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
namespace

この名前空間への投稿記録に絞り込む。

値 (次の値のいずれか1つ): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
year

この年以前。

型: 整数
month

この月以前。

型: 整数
tagfilter

このタグが付与された投稿記録に絞り込む。

値 (|もしくは別の文字列で区切る): abusefilter-condition-limit、advanced mobile edit、mobile edit、mobile web edit、mw-blank、mw-changed-redirect-target、mw-contentmodelchange、mw-new-redirect、mw-removed-redirect、mw-replace、mw-rollback、mw-undo、visualeditor、visualeditor-needcheck、visualeditor-switched、visualeditor-wikitext
既定値: (空)
deletedonly

削除された投稿記録のみ表示します。

型: 真偽値 (詳細)
toponly

最新版の編集のみ表示します。

型: 真偽値 (詳細)
newonly

ページ作成を伴う編集のみを表示します。

型: 真偽値 (詳細)
hideminor

細部の編集を非表示

型: 真偽値 (詳細)
showsizediff

版間のサイズの増減を表示する。

型: 真偽値 (詳細)
例:
利用者 Example の投稿記録を取得する。
api.php?action=feedcontributions&user=Example [サンドボックスで開く]

action=feedrecentchanges

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

最近の更新フィードを返します。

パラメーター:
feedformat

フィードの形式。

値 (次の値のいずれか1つ): atom、rss
Default: rss
namespace

この名前空間の結果のみに絞り込む。

値 (次の値のいずれか1つ): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
invert

選択されたものを除く、すべての名前空間。

型: 真偽値 (詳細)
associated

関連する(トークまたは標準)名前空間を含めます。

型: 真偽値 (詳細)
days

結果を絞り込む日数。

型: 整数
The value must be no less than 1.
Default: 7
limit

返す結果の最大数。

型: 整数
The value must be between 1 and 50.
Default: 50
from

これ以降の編集を表示する。

Type: timestamp (allowed formats)
hideminor

細部の変更を隠す。

型: 真偽値 (詳細)
hidebots

ボットによる変更を隠す。

型: 真偽値 (詳細)
hideanons

未登録利用者による変更を隠す。

型: 真偽値 (詳細)
hideliu

登録利用者による変更を隠す。

型: 真偽値 (詳細)
hidepatrolled

巡回済みの変更を隠す。

型: 真偽値 (詳細)
hidemyself

現在の利用者による編集を非表示にする。

型: 真偽値 (詳細)
hidecategorization

カテゴリのメンバーの変更を非表示にする。

型: 真偽値 (詳細)
tagfilter

タグにより絞り込む。

target

このページからリンクされているページの変更のみを表示する。

showlinkedto

選択したページへのリンク元での変更の表示に切り替え

型: 真偽値 (詳細)

action=feedwatchlist

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ウォッチリストのフィードを返します。

パラメーター:
feedformat

フィードの形式。

値 (次の値のいずれか1つ): atom、rss
Default: rss
hours

List pages modified within this many hours from now.

型: 整数
The value must be between 1 and 72.
Default: 24
linktosections

可能であれば、変更された節に直接リンクする。

型: 真偽値 (詳細)
allrev

Include multiple revisions of the same page within given timeframe.

型: 真偽値 (詳細)
wlowner

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

型: 利用者名を使った利用者
wltoken

A security token (available in the user's preferences) to allow access to another user's watchlist.

wlshow

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

値 (|もしくは別の文字列で区切る): !anon、!autopatrolled、!bot、!minor、!patrolled、!unread、anon、autopatrolled、bot、minor、patrolled、unread
wltype

Which types of changes to show:

edit
Regular page edits.
new
Page creations.
log
Log entries.
external
External changes.
categorize
Category membership changes.
値 (|もしくは別の文字列で区切る): categorize、edit、external、log、new
Default: edit|new|log|categorize
wlexcludeuser

この利用者による変更を一覧表示しない。

型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
例:
ウォッチリストのフィードを表示する。
api.php?action=feedwatchlist [サンドボックスで開く]
ウォッチ中のページに対する過去6時間の更新をすべて表示する。
api.php?action=feedwatchlist&allrev=&hours=6 [サンドボックスで開く]

action=filerevert

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ファイルを古い版に差し戻します。

パラメーター:
filename

対象のファイル名 (File: 接頭辞を含めない)。

このパラメーターは必須です。
comment

アップロードのコメント。

既定値: (空)
archivename

Archive name of the revision to revert to.

このパラメーターは必須です。
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=flow

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Allows actions to be taken on Structured Discussions pages.

パラメーター:
submodule

実行する Flow サブモジュールです。

edit-header
Edits a board description.
edit-post
Edits a post's content.
edit-title
Edits a topic's title.
edit-topic-summary
Edits a topic summary's content.
lock-topic
Lock or unlock a Structured Discussions topic.
moderate-post
Moderates a Structured Discussions post.
moderate-topic
Moderates a Structured Discussions topic.
new-topic
Creates a new Structured Discussions topic on the given workflow.
reply
Replies to a post.
undo-edit-header
Retrieve information necessary to undo description edits.
undo-edit-post
Retrieve information necessary to undo post edit.
undo-edit-topic-summary
Retrieve information necessary to undo topic summary edits.
view-header
View a board description.
view-post
View a post.
view-post-history
View the revision history of a post.
view-topic
View a topic.
view-topic-history
View the revision history of a topic.
view-topic-summary
View a topic summary.
view-topiclist
View a list of topics.
close-open-topic
廃止予定です。 Deprecated in favor of action=flow&submodule=lock-topic.
このパラメーターは必須です。
値 (次の値のいずれか1つ): edit-headeredit-postedit-titleedit-topic-summarylock-topicmoderate-postmoderate-topicnew-topicreplyundo-edit-headerundo-edit-postundo-edit-topic-summaryview-headerview-post-historyview-postview-topic-historyview-topic-summaryview-topicview-topiclistclose-open-topic
page

操作を行うページです。

Default: Topic:Flow-enabled_page
token

A token retrieved from action=query&meta=tokens

既定値: (空)

submodule=close-open-topic (cot)

  • このモジュールは廃止予定です。
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Deprecated in favor of action=flow&submodule=lock-topic.

パラメーター:
cotmoderationState

変更後の話題の状態であり、"lock" または "unlock" です。

このパラメーターは必須です。
値 (次の値のいずれか1つ): close、lock、reopen、unlock
cotreason

話題をロックまたはロック解除する理由です。

このパラメーターは必須です。
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

submodule=edit-header (eh)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Edits a board description.

パラメーター:
ehprev_revision

現在の説明の版 ID であり、編集競合を確認するためのものです。

ehcontent

説明の内容です。

このパラメーターは必須です。
ehformat

Format of the description (wikitext|html)

値 (次の値のいずれか1つ): html、wikitext
Default: wikitext
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

submodule=edit-post (ep)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Edits a post's content.

パラメーター:
eppostId

投稿 ID です。

このパラメーターは必須です。
epprev_revision

現在の投稿の版 ID であり、編集競合を確認するためのものです。

このパラメーターは必須です。
epcontent

投稿の本文です。

このパラメーターは必須です。
epformat

Format of the post content (wikitext|html)

値 (次の値のいずれか1つ): html、wikitext
Default: wikitext
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

submodule=edit-title (et)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Edits a topic's title.

パラメーター:
etprev_revision

編集競合を確認するための、現在のページの版ID。

このパラメーターは必須です。
etcontent

題名の内容です。

このパラメーターは必須です。
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

submodule=edit-topic-summary (ets)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Edits a topic summary's content.

パラメーター:
etsprev_revision

現在の話題の要約の版 ID がある場合は指定します。編集競合を確認するためのものです。

etssummary

要約の内容です。

このパラメーターは必須です。
etsformat

Format of the summary (wikitext|html)

値 (次の値のいずれか1つ): html、wikitext
Default: wikitext
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

submodule=lock-topic (cot)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Lock or unlock a Structured Discussions topic.

パラメーター:
cotmoderationState

変更後の話題の状態であり、lock または unlock です。

このパラメーターは必須です。
値 (次の値のいずれか1つ): close、lock、reopen、unlock
cotreason

話題をロックまたはロック解除する理由です。ただしオンウィキの議論のスレッド表示(旧称フロー)ではこの場合「解決済み」を使用し、編集要約欄にオプションで補足の情報を追加します。

このパラメーターは必須です。
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

submodule=moderate-post (mp)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Moderates a Structured Discussions post.

パラメーター:
mpmoderationState

What level to moderate at.

このパラメーターは必須です。
値 (次の値のいずれか1つ): Can be empty, or delete、hide、restore、suppress、undelete、unhide、unsuppress
mpreason

Reason for moderation.

このパラメーターは必須です。
mppostId

ID of the post to moderate.

このパラメーターは必須です。
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

submodule=moderate-topic (mt)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Moderates a Structured Discussions topic.

パラメーター:
mtmoderationState

What level to moderate at.

このパラメーターは必須です。
値 (次の値のいずれか1つ): Can be empty, or delete、hide、restore、suppress、undelete、unhide、unsuppress
mtreason

Reason for moderation.

このパラメーターは必須です。
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

submodule=new-topic (nt)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Creates a new Structured Discussions topic on the given workflow.

パラメーター:
nttopic

新しい話題の題名です。

このパラメーターは必須です。
ntcontent

初めのリプライの話題の本文です。

このパラメーターは必須です。
ntformat

Format of the new topic's initial reply (wikitext|html)

値 (次の値のいずれか1つ): html、wikitext
Default: wikitext
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

submodule=reply (rep)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Replies to a post.

パラメーター:
repreplyTo

返信先の投稿の ID です。

このパラメーターは必須です。
repcontent

新しい投稿の本文です。

このパラメーターは必須です。
repformat

Format of the new post (wikitext|html)

値 (次の値のいずれか1つ): html、wikitext
Default: wikitext
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

submodule=undo-edit-header (ueh)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Retrieve information necessary to undo description edits.

パラメーター:
uehstartId

Revision ID to start undo at.

このパラメーターは必須です。
uehendId

Revision ID to end undo at.

このパラメーターは必須です。

submodule=undo-edit-post (uep)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Retrieve information necessary to undo post edit.

パラメーター:
uepstartId

Revision ID to start undo at.

このパラメーターは必須です。
uependId

Revision ID to end undo at.

このパラメーターは必須です。

submodule=undo-edit-topic-summary (uets)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Retrieve information necessary to undo topic summary edits.

パラメーター:
uetsstartId

Revision ID to start undo at.

このパラメーターは必須です。
uetsendId

Revision ID to end undo at.

このパラメーターは必須です。

submodule=view-header (vh)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

View a board description.

パラメーター:
vhformat

返す本文の形式です。

値 (次の値のいずれか1つ): fixed-html、html、wikitext
Default: fixed-html
vhrevId

最新版の代わりに、この版を読み込みます。

submodule=view-post (vp)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

View a post.

パラメーター:
vppostId

閲覧する投稿の ID です。

このパラメーターは必須です。
vpformat

返す本文の形式です。

値 (次の値のいずれか1つ): fixed-html、html、wikitext
Default: fixed-html

submodule=view-post-history (vph)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

View the revision history of a post.

パラメーター:
vphpostId

ID of the post for which to view revision history.

このパラメーターは必須です。
vphformat

Format to return the content in.

値 (次の値のいずれか1つ): fixed-html、html、wikitext
Default: fixed-html

submodule=view-topic (vt)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

View a topic.

パラメーター:
vtformat

Format to return the content in.

値 (次の値のいずれか1つ): fixed-html、html、wikitext
Default: fixed-html

submodule=view-topic-history (vth)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

View the revision history of a topic.

パラメーター:
vthformat

Format to return the content in.

値 (次の値のいずれか1つ): fixed-html、html、wikitext
Default: fixed-html

submodule=view-topic-summary (vts)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

View a topic summary.

パラメーター:
vtsformat

返す本文の形式です。

値 (次の値のいずれか1つ): fixed-html、html、wikitext
Default: fixed-html
vtsrevId

最新版の代わりに、この版を読み込みます。

submodule=view-topiclist (vtl)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

View a list of topics.

パラメーター:
vtloffset-dir

話題の並び順指定です。

値 (次の値のいずれか1つ): fwd、rev
Default: fwd
vtlsortby

話題の並べ替えのオプションです。either updated (ordered by topic update time), or newest (ordered by topic creation time).

値 (次の値のいずれか1つ): newest、updated、user
Default: user
vtlsavesortby

設定すると、ユーザー好みに並べ替えのオプションを保存します。

型: 真偽値 (詳細)
vtloffset-id

話題の取得を開始するオフセット値 (UUID 形式) です; 最新の オーダリングとだけで使われます。

vtloffset

話題の取得を開始するオフセット値(話題の更新のタイムスタンプ、 TS_MW 形式 (YYYYMMDDHHMMSS))です。; used only with updated ordering

vtlinclude-offset

Includes the offset item in the results as well.

型: 真偽値 (詳細)
vtllimit

取得する話題の件数です。

型: 整数または max
The value must be between 0 and 100.
Default: 10
vtltoconly

Whether to respond with only the information required for the TOC.

型: 真偽値 (詳細)
vtlformat

Format to return the content in.

値 (次の値のいずれか1つ): fixed-html、html、wikitext
Default: fixed-html

action=flow-parsoid-utils

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Convert text between wikitext and HTML.

パラメーター:
from

変換元の形式です。

このパラメーターは必須です。
値 (次の値のいずれか1つ): html、wikitext
to

変換先の形式です。

このパラメーターは必須です。
値 (次の値のいずれか1つ): html、wikitext
content

変換する内容です。

このパラメーターは必須です。
title

ページ名です。pageid とは同時に使用できません。

pageid

ページの ID です。title とは同時に使用できません。

型: 整数

action=flowthank

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Thanks
  • ライセンス: MIT

コメントに対して感謝の通知を送信する。

パラメーター:
postid

The UUID of the post to thank for.

このパラメーターは必須です。
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=help

指定したモジュールのヘルプを表示します。

パラメーター:
modules

ヘルプを表示するモジュールです (action パラメーターおよび format パラメーターの値、または main)。+ を使用して下位モジュールを指定できます。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
Default: main
submodules

指定したモジュールの下位モジュールのヘルプを含めます。

型: 真偽値 (詳細)
recursivesubmodules

下位モジュールのヘルプを再帰的に含めます。

型: 真偽値 (詳細)
wrap

Wrap the output in a standard API response structure.

型: 真偽値 (詳細)
toc

HTML 出力に目次を含めます。

型: 真偽値 (詳細)
例:
メイン モジュールのヘルプ
api.php?action=help [サンドボックスで開く]
action=query とそのすべての下位モジュールに関するヘルプ。
api.php?action=help&modules=query&submodules=1 [サンドボックスで開く]
すべてのヘルプを1つのページに
api.php?action=help&recursivesubmodules=1 [サンドボックスで開く]
ヘルプ モジュール自身のヘルプ
api.php?action=help&modules=help [サンドボックスで開く]
2つの下位モジュールのヘルプ
api.php?action=help&modules=query+info|query+categorymembers [サンドボックスで開く]

action=imagerotate

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

1つ以上の画像を回転させます。

パラメーター:
rotation

画像を回転させる時計回りの角度。

このパラメーターは必須です。
値 (次の値のいずれか1つ): 90、180、270
continue

When more results are available, use this to continue.

tags

アップロード記録の項目に適用するタグ。

値 (|もしくは別の文字列で区切る):
titles

対象のページ名のリスト。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
pageids

対象のページIDのリスト。

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
revids

対象の版IDのリスト。

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
generator

クエリモジュールを実行することにより対象のページの一覧を取得する。

注意 Generator パラメーターの名前は "g" で始まります。例を参照してください。

allcategories
すべてのカテゴリを一覧表示します。
alldeletedrevisions
利用者によって削除された、または名前空間内の削除されたすべての版を一覧表示する。
allfileusages
存在しないものを含め、すべてのファイルの使用状況を一覧表示する。
allimages
順次すべての画像を列挙します。
alllinks
与えられた名前空間へのすべてのリンクを一覧表示します。
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
ある名前空間へのすべての転送を一覧表示する。
allrevisions
すべての版を一覧表示する。
alltransclusions
存在しないものも含めて、すべての参照読み込み ({{x}} で埋め込まれたページ) を一覧表示します。
backlinks
与えられたページにリンクしているすべてのページを検索します。
categories
ページが属するすべてのカテゴリを一覧表示します。
categorymembers
与えられたカテゴリ内のすべてのページを一覧表示します。
deletedrevisions
削除された版の情報を取得します。
duplicatefiles
ハッシュ値に基づいて与えられたファイルの全ての重複ファイルを返します。
embeddedin
Find all pages that embed (transclude) the given title.
exturlusage
与えられたURLを含むページを一覧表示します。
fileusage
与えられたファイルを利用しているすべてのページを返します。
images
与えられたページに含まれるすべてのファイルを返します。
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
与えられた言語間リンクにリンクしているすべてのページを返します。
links
ページからのすべてのリンクを返します。
linkshere
与えられたページにリンクしているすべてのページを返します。
pageswithprop
与えられたページプロパティが使用されているすべてのページを一覧表示します。
prefixsearch
ページ名の先頭一致検索を行います。
protectedtitles
作成保護が掛けられているページを一覧表示します。
querypage
Get a list provided by a QueryPage-based special page.
random
ランダムなページのセットを取得します。
recentchanges
最近の更新を一覧表示します。
redirects
ページへのすべての転送を返します。
revisions
版の情報を取得します。
search
全文検索を行います。
templates
与えられたページで参照読み込みされているすべてのページを返します。
transcludedin
与えられたページを参照読み込みしているすべてのページを検索します。
watchlist
現在の利用者のウォッチリストにあるページへの最近の更新を取得します。
watchlistraw
現在の利用者のウォッチリストにあるすべてのページを取得します。
値 (次の値のいずれか1つ): allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

titles, pageids, および revids, および generator によって返されたページの転送を自動的に解決する。

型: 真偽値 (詳細)
converttitles

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

型: 真偽値 (詳細)
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=import

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

他のWikiまたはXMLファイルからページを取り込む。

xml パラメーターでファイルを送信する場合、ファイルのアップロードとしてHTTP POSTされなければならない (例えば、multipart/form-dataを使用する) 点に注意してください。

パラメーター:
summary

記録されるページ取り込みの要約。

xml

XMLファイルをアップロード

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

For uploaded imports: interwiki prefix to apply to unknown user names (and known users if assignknownusers is set).

interwikisource

ウィキ間の取り込みの場合: 取り込み元のウィキ。

値 (次の値のいずれか1つ):
interwikipage

ウィキ間の取り込みの場合: 取り込むページ。

fullhistory

ウィキ間の取り込みの場合: 現在の版のみではなく完全な履歴を取り込む。

型: 真偽値 (詳細)
templates

ウィキ間の取り込みの場合: 読み込まれているテンプレートも取り込む。

型: 真偽値 (詳細)
namespace

この名前空間に取り込む。rootpageパラメーターとは同時に使用できません。

値 (次の値のいずれか1つ): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
assignknownusers

指定された利用者がこのウィキに存在する場合その利用者に編集を割り当てる。

型: 真偽値 (詳細)
rootpage

このページの下位ページとして取り込む。namespace パラメーターとは同時に使用できません。

tags

Change tags to apply to the entry in the import log and to the null revision on the imported pages.

値 (|もしくは別の文字列で区切る):
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=linkaccount (link)

  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

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

The general procedure to use this module is:

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

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

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
linkmessageformat

Format to use for returning messages.

値 (次の値のいずれか1つ): html、none、raw、wikitext
Default: wikitext
linkmergerequestfields

Merge field information for all authentication requests into one array.

型: 真偽値 (詳細)
linkreturnurl

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

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

linkcontinue

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

型: 真偽値 (詳細)
linktoken

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。
*
This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=link (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.

action=login (lg)

  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ログインして認証クッキーを取得します。

このアクションは、Special:BotPasswordsと組み合わせて使用する必要があります。メインアカウントのログインに使用することは推奨されなくなり、警告なく失敗する可能性があります。メインアカウントに安全にログインするには、action=clientloginを使用します。

パラメーター:
lgname

利用者名。

lgpassword

パスワード。

lgdomain

ドメイン (省略可能)

lgtoken

action=query&meta=tokens から取得した「login」トークン

action=logout

  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ログアウトしてセッションデータを消去します。

パラメーター:
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。
例:
現在の利用者をログアウトする。
api.php?action=logout&token=123ABC [サンドボックスで開く]

action=managetags

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Perform management tasks relating to change tags.

パラメーター:
operation

実行する操作:

create
手動適用のための新たな変更タグを作成します。
delete
変更タグをデータベースから削除し、そのタグが使用されているすべての版、最近の更新項目、記録項目からそれを除去します。
activate
変更タグを有効化し、利用者がそのタグを手動で適用できるようにします。
deactivate
変更タグを無効化し、利用者がそのタグを手動で適用することができないようにします。
このパラメーターは必須です。
値 (次の値のいずれか1つ): activate、create、deactivate、delete
tag

作成、削除、有効化、または無効化するタグ。タグの作成の場合、そのタグは存在しないものでなければなりません。タグの削除の場合、そのタグが存在しなければなりません。タグの有効化の場合、そのタグが存在し、かつ拡張機能によって使用されていないものでなければなりません。タグの無効化の場合、そのタグが現在有効であって手動で定義されたものでなければなりません。

このパラメーターは必須です。
reason

タグを作成、削除、有効化、または無効化する追加の理由。

ignorewarnings

操作中に発生したすべての警告を無視するかどうか。

型: 真偽値 (詳細)
tags

タグを変更し、タグ管理記録の項目に適用します。

値 (|もしくは別の文字列で区切る):
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=mergehistory

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページの履歴を統合する。

パラメーター:
from

履歴統合元のページ名。fromid とは同時に使用できません。

fromid

履歴統合元のページ。from とは同時に使用できません。

型: 整数
to

履歴統合先のページ名。toid とは同時に使用できません。

toid

履歴統合先のページID。to とは同時に使用できません。

型: 整数
timestamp

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

Type: timestamp (allowed formats)
reason

履歴の統合の理由。

既定値: (空)
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=mobileview

  • このモジュールは廃止予定です。
  • このモジュールは読み取りの権限を必要とします。
  • ソース: MobileFrontend
  • ライセンス: GPL-2.0-or-later

Returns data needed for mobile views.

パラメーター:
page

処理対象のページ名。

このパラメーターは必須です。
redirect

Whether redirects should be followed.

値 (次の値のいずれか1つ): no、yes
Default: yes
sections

Pipe-separated list of section numbers for which to return text. "all" can be used to return for all. Ranges in format "1-4" mean get sections 1,2,3,4. Ranges without second number, e.g. "1-" means get all until the end. "references" can be used to specify that all sections containing references should be returned.

prop

Which information to get:

text
HTML of selected sections.
sections
Information about all sections on the page.
normalizedtitle
Normalized page title.
lastmodified
ISO 8601 timestamp for when the page was last modified, e.g. "2014-04-13T22:42:14Z".
lastmodifiedby
Information about the user who modified the page last.
revision
Return the current revision ID of the page.
protection
Information about protection level.
editable
Whether the current user can edit this page. This includes all factors for logged-in users but not blocked status for anons.
languagecount
Number of languages that the page is available in.
hasvariants
Whether or not the page is available in other language variants.
displaytitle
The rendered title of the page, with {{DISPLAYTITLE}} and such applied.
pageprops
Page properties.
値 (|もしくは別の文字列で区切る): contentmodel、description、displaytitle、editable、hasvariants、id、image、languagecount、lastmodified、lastmodifiedby、namespace、normalizedtitle、pageprops、protection、revision、sections、text、thumb
Default: text|sections|normalizedtitle
sectionprop

What information about sections to get.

値 (|もしくは別の文字列で区切る): anchor、fromtitle、index、level、line、number、toclevel
Default: toclevel|line
pageprops

What page properties to return, a pipe ("|") separated list or "*" for all properties.

Default: notoc|noeditsection|wikibase_item
variant

Convert content into this language variant.

既定値: (空)
noimages

Return HTML without images.

型: 真偽値 (詳細)
noheadings

Don't include headings in output.

型: 真偽値 (詳細)
notransform

Don't transform HTML into mobile-specific version.

型: 真偽値 (詳細)
onlyrequestedsections

Return only requested sections even with prop=sections.

型: 真偽値 (詳細)
offset

Pretend all text result is one string, and return the substring starting at this point.

型: 整数
The value must be no less than 0.
Default: 0
maxlen

Pretend all text result is one string, and limit result to this length.

型: 整数
The value must be no less than 0.
Default: 0
revision

Request a specific revision.

型: 整数
The value must be no less than 0.
Default: 0
thumbheight

最大サムネイル高さ。

型: 整数
The value must be no less than 0.
thumbwidth

最大サムネイル幅。

型: 整数
The value must be no less than 0.
thumbsize

Maximum thumbnail dimensions.

型: 整数
The value must be no less than 0.

action=move

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページを移動します。

パラメーター:
from

移動するページのページ名です。fromid とは同時に使用できません。

fromid

移動するページのページIDです。from とは同時に使用できません。

型: 整数
to

移動後のページ名。

このパラメーターは必須です。
reason

改名の理由。

既定値: (空)
movetalk

存在する場合、トークページも名前を変更します。

型: 真偽値 (詳細)
movesubpages

可能であれば、下位ページも名前を変更します。

型: 真偽値 (詳細)
noredirect

転送ページを作成しません。

型: 真偽値 (詳細)
watchlist

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

値 (次の値のいずれか1つ): nochange、preferences、unwatch、watch
Default: preferences
ignorewarnings

あらゆる警告を無視

型: 真偽値 (詳細)
tags

Change tags to apply to the entry in the move log and to the null revision on the destination page.

値 (|もしくは別の文字列で区切る):
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=oathvalidate

  • このモジュールは内部的または不安定です。動作が予告なく変更される場合があります。
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: OATHAuth
  • ライセンス: GPL-2.0-or-later AND GPL-3.0-or-later

Validate a two-factor authentication (OATH) token.

パラメーター:
user

User to validate token for. Defaults to the current user.

型: 利用者名、IP、IP範囲 および インターウィキの名前(例: "prefix>ExampleName")のいずれかを使った利用者
totp
廃止予定です。

Two-factor authentication (OATH) token. Legacy, use "data" param instead

data

JSON encoded data expected by the module currently activated for the user being authenticated

token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=opensearch

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

OpenSearch プロトコルを使用してWiki内を検索します。

パラメーター:
search

検索文字列。

このパラメーターは必須です。
namespace

検索する名前空間。searchが有効な名前空間接頭辞で始まる場合は無視されます。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
Default: 0
limit

返す結果の最大数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
suggest
廃止予定です。

$wgEnableOpenSearchSuggest が false の場合、何もしません。

型: 真偽値 (詳細)
redirects

転送を処理する方法:

return
転送ページそのものを返します。
resolve
転送先のページを返します。limit より返される結果が少なくなるかもしれません。

歴史的な理由により、format=json では "return" が、他の形式では "resolve" が既定です。

値 (次の値のいずれか1つ): resolve、return
format

出力する形式。

値 (次の値のいずれか1つ): json、jsonfm、xml、xmlfm
Default: json
warningsaserror

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

型: 真偽値 (詳細)
例:
Te から始まるページを検索する。
api.php?action=opensearch&search=Te [サンドボックスで開く]

action=options

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

現在の利用者の設定を変更します。

Only options which are registered in core or in one of installed extensions, or options with keys prefixed with userjs- (intended to be used by user scripts), can be set.

パラメーター:
reset

個人設定をサイトの既定値にリセットする。

型: 真偽値 (詳細)
resetkinds

reset が設定されている場合、リセットする設定項目の種類のリスト。

値 (|もしくは別の文字列で区切る): all、registered、registered-checkmatrix、registered-multiselect、special、unused、userjs
Default: all
change

名前=値 の形式 (例えば skin=vector) で整形された変更のリスト。optionname|otheroption|... のように値が与えられなかった (イコール記号すら無い) 場合、設定は既定値にリセットされます。与えられた値がパイプ(|)を含む場合、ほかのセパレーターをお使いください。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
optionname

The name of the option that should be set to the value given by optionvalue.

optionvalue

The value for the option specified by optionname.

token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=paraminfo

API モジュールに関する情報を取得します。

パラメーター:
modules

モジュール名のリスト (action および format パラメーターまたは mainの値)。特定の下位モジュールの指定は+ 、全下位モジュールの指定は+*を使い、あるいは+**ですべての下位モジュールを再帰的に指定します。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
helpformat

ヘルプ文字列の形式。

値 (次の値のいずれか1つ): html、none、raw、wikitext
Default: none
querymodules
廃止予定です。

クエリモジュール名のリスト (prop, meta or list パラメーターの値)。querymodules=foo の代わりに modules=query+foo を使用してください。

値 (|もしくは別の文字列で区切る): abusefilters、abuselog、allcategories、alldeletedrevisions、allfileusages、allimages、alllinks、allmessages、allpages、allredirects、allrevisions、alltransclusions、allusers、authmanagerinfo、backlinks、blocks、categories、categoryinfo、categorymembers、checkuser、checkuserlog、cirrusbuilddoc、cirruscompsuggestbuilddoc、cirrusdoc、contributors、deletedrevisions、deletedrevs、duplicatefiles、embeddedin、extlinks、extracts、exturlusage、filearchive、filerepoinfo、fileusage、flowinfo、gadgetcategories、gadgets、imageinfo、images、imageusage、info、iwbacklinks、iwlinks、langbacklinks、langlinks、languageinfo、links、linkshere、logevents、mystashedfiles、notifications、oath、pageimages、pagepropnames、pageprops、pageswithprop、prefixsearch、protectedtitles、querypage、random、recentchanges、redirects、revisions、search、siteinfo、stashimageinfo、tags、templates、tokens、transcludedin、unreadnotificationpages、usercontribs、userinfo、users、watchlist、watchlistraw
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
mainmodule
廃止予定です。

Get information about the main (top-level) module as well. Use modules=main instead.

pagesetmodule
廃止予定です。

Get information about the pageset module (providing titles= and friends) as well.

formatmodules
廃止予定です。

List of format module names (value of format parameter). Use modules instead.

値 (|もしくは別の文字列で区切る): json、jsonfm、none、php、phpfm、rawfm、xml、xmlfm

action=parse

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Parses content and returns parser output.

See the various prop-modules of action=query to get information from the current version of a page.

There are several ways to specify the text to parse:

  1. Specify a page or revision, using page, pageid, or oldid.
  2. Specify content explicitly, using text, title, revid, and contentmodel.
  3. Specify only a summary to parse. prop should be given an empty value.
パラメーター:
title

文字列が属するページのページ名。これを省略する場合、必ず contentmodel を指定しなければなりません。また、その場合 API がページ名として使用されます。

text

構文解析する文字列。コンテンツモデルを制御するためにはtitle または contentmodel を使用してください。

revid

Revision ID, for {{REVISIONID}} and similar variables.

型: 整数
summary

構文解析する要約

page

このページの内容を構文解析します。text および title とは同時に使用できません。

pageid

このページの内容を構文解析する。page をオーバーライドします。

型: 整数
redirects

もし pagepageid に転送ページが指定された場合、それを解決する。

型: 真偽値 (詳細)
oldid

この版の内容を構文解析する。page および pageid をオーバーライドします。

型: 整数
prop

どの情報を取得するか:

text
ウィキテキストの解析されたテキストを提供します。
langlinks
解析されたウィキテキストにおける言語リンクを提供します。
categories
構文解析されたウィキテキストのカテゴリを提供します。
categorieshtml
カテゴリのHTMLバージョンを提供します。
links
構文解析されたウィキテキスト内で内部リンクを提供します。
templates
構文解析されたウィキテキストでテンプレートを提供します。
images
構文解析されたウィキテキストの画像を提供します。
externallinks
構文解析されたウィキテキスト内で外部リンクを提供します。
sections
構文解析されたウィキテキスト内のセクションを提供します。
revid
構文解析されたページの版IDを追加します。
displaytitle
構文解析されたウィキテキストのタイトルを追加します。
headhtml
ページの<html><head>の要素を開いて<body>を開示し、Doctype を解析する。
modules
Gives the ResourceLoader modules used on the page. To load, use mw.loader.using(). Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules.
jsconfigvars
ページに固有のJavaScriptの設定変数を提供します。適用するには、mw.config.set()を使用します。
encodedjsconfigvars
JSON文字列としてページに固有のJavaScriptの設定変数を提供します。
indicators
ページ上で使用されるページのステータスインジケータのHTMLを提供します。
iwlinks
構文解析されたウィキテキスト内でウィキ間リンクを提供します。
wikitext
構文解析されたオリジナルのwikiテキストを提供します。
properties
構文解析されたウィキテキスト内で定義されたさまざまなプロパティを提供します。
limitreportdata
Gives the limit report in a structured way. Gives no data, when disablelimitreport is set.
limitreporthtml
Gives the HTML version of the limit report. Gives no data, when disablelimitreport is set.
parsetree
版内容のXML構文解析ツリー (requires content model wikitext)
parsewarnings
Gives the warnings that occurred while parsing content.
headitems
廃止予定です。 ページの <head> の中に入れてアイテムを提供します。
値 (|もしくは別の文字列で区切る): categories、categorieshtml、displaytitle、encodedjsconfigvars、externallinks、headhtml、images、indicators、iwlinks、jsconfigvars、langlinks、limitreportdata、limitreporthtml、links、modules、parsetree、parsewarnings、properties、revid、sections、templates、text、wikitext、headitems
Default: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
wrapoutputclass

CSS class to use to wrap the parser output.

Default: mw-parser-output
pst

それを構文解析する前に、入力の上で事前保存の変換を実行してください。テキストで使用した場合のみ有効です。

型: 真偽値 (詳細)
onlypst

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

型: 真偽値 (詳細)
effectivelanglinks
廃止予定です。

エクステンションによって供給された言語リンクが含まれています (for use with prop=langlinks).

型: 真偽値 (詳細)
section

この節番号の内容のみを構文解析します。

new のとき、ページに新しい節を追加するかのように textsectiontitle を解析します。

newtext を指定したときのみ許可されます。

sectiontitle

sectionnew のときの、新しい節の節名。

ページ編集とは異なり、これは summary が省略または空のときにはフォールバックしません。

disablepp
廃止予定です。

disablelimitreport を代わりに使用してください。

型: 真偽値 (詳細)
disablelimitreport

構文解析の出力で制限レポート (New PP limit report) を省略する。

型: 真偽値 (詳細)
disableeditsection

構文解析の出力で節リンクを省略する。

型: 真偽値 (詳細)
disablestylededuplication

Do not deduplicate inline stylesheets in the parser output.

型: 真偽値 (詳細)
generatexml
廃止予定です。

Generate XML parse tree (requires content model wikitext; replaced by prop=parsetree).

型: 真偽値 (詳細)
preview

プレビューモードでのパース

型: 真偽値 (詳細)
sectionpreview

Parse in section preview mode (enables preview mode too).

型: 真偽値 (詳細)
disabletoc

Omit table of contents in output.

型: 真偽値 (詳細)
useskin

Apply the selected skin to the parser output. May affect the following properties: langlinks, headitems, modules, jsconfigvars, indicators.

値 (次の値のいずれか1つ): minerva、monobook、timeless、vector
contentformat

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

値 (次の値のいずれか1つ): application/json、text/css、text/javascript、text/plain、text/x-wiki
contentmodel

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

値 (次の値のいずれか1つ): GadgetDefinition、Scribunto、css、flow-board、javascript、json、smw/schema、text、wikitext
mobileformat

Return parse output in a format suitable for mobile devices.

型: 真偽値 (詳細)
noimages

Disable images in mobile output.

型: 真偽値 (詳細)
mainpage

Apply mobile main page transformations.

型: 真偽値 (詳細)

action=patrol

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページまたは版を巡回済みにする。

パラメーター:
rcid

巡回済みにする最近の更新ID。

型: 整数
revid

巡回済みにする版ID。

型: 整数
tags

巡回記録の項目に適用する変更タグ。

値 (|もしくは別の文字列で区切る):
token

action=query&meta=tokens から取得した「patrol」トークン

このパラメーターは必須です。

action=protect

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページの保護レベルを変更します。

パラメーター:
title

保護(解除)するページ名です。pageid とは同時に使用できません。

pageid

保護(解除)するページIDです。title とは同時に使用できません。

型: 整数
protections

action=level の形式 (例えば、edit=sysop) で整形された、保護レベルの一覧。レベル all は誰もが操作できる、言い換えると制限が掛かっていないことを意味します。

注意: ここに列挙されなかった操作の制限は解除されます。

このパラメーターは必須です。
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
expiry

有効期限です。タイムスタンプがひとつだけ指定された場合は、それがすべての保護に適用されます。無期限の保護を行う場合はinfinite, indefinite, infinity, または never を指定します。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
Default: infinite
reason

保護(解除)の理由。

既定値: (空)
tags

保護記録の項目に適用する変更タグ。

値 (|もしくは別の文字列で区切る):
cascade

カスケード保護(すなわち、そのページが読み込んでいるテンプレートと使用されている画像も保護する)を有効にする。カスケード保護に対応しない保護レベルが与えられた場合は無視する。

型: 真偽値 (詳細)
watch
廃止予定です。

指定されると、保護(解除)するページが現在の利用者のウォッチリストに追加されます。

型: 真偽値 (詳細)
watchlist

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

値 (次の値のいずれか1つ): nochange、preferences、unwatch、watch
Default: preferences
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=purge

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

指定されたページのキャッシュを破棄します。

パラメーター:
forcelinkupdate

リンクテーブルを更新します。

型: 真偽値 (詳細)
forcerecursivelinkupdate

Same as forcelinkupdate, and update the links tables for any page that uses this page as a template.

型: 真偽値 (詳細)
continue

When more results are available, use this to continue.

titles

対象のページ名のリスト。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
pageids

対象のページIDのリスト。

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
revids

対象の版IDのリスト。

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
generator

クエリモジュールを実行することにより対象のページの一覧を取得する。

注意 Generator パラメーターの名前は "g" で始まります。例を参照してください。

allcategories
すべてのカテゴリを一覧表示します。
alldeletedrevisions
利用者によって削除された、または名前空間内の削除されたすべての版を一覧表示する。
allfileusages
存在しないものを含め、すべてのファイルの使用状況を一覧表示する。
allimages
順次すべての画像を列挙します。
alllinks
与えられた名前空間へのすべてのリンクを一覧表示します。
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
ある名前空間へのすべての転送を一覧表示する。
allrevisions
すべての版を一覧表示する。
alltransclusions
存在しないものも含めて、すべての参照読み込み ({{x}} で埋め込まれたページ) を一覧表示します。
backlinks
与えられたページにリンクしているすべてのページを検索します。
categories
ページが属するすべてのカテゴリを一覧表示します。
categorymembers
与えられたカテゴリ内のすべてのページを一覧表示します。
deletedrevisions
削除された版の情報を取得します。
duplicatefiles
ハッシュ値に基づいて与えられたファイルの全ての重複ファイルを返します。
embeddedin
Find all pages that embed (transclude) the given title.
exturlusage
与えられたURLを含むページを一覧表示します。
fileusage
与えられたファイルを利用しているすべてのページを返します。
images
与えられたページに含まれるすべてのファイルを返します。
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
与えられた言語間リンクにリンクしているすべてのページを返します。
links
ページからのすべてのリンクを返します。
linkshere
与えられたページにリンクしているすべてのページを返します。
pageswithprop
与えられたページプロパティが使用されているすべてのページを一覧表示します。
prefixsearch
ページ名の先頭一致検索を行います。
protectedtitles
作成保護が掛けられているページを一覧表示します。
querypage
Get a list provided by a QueryPage-based special page.
random
ランダムなページのセットを取得します。
recentchanges
最近の更新を一覧表示します。
redirects
ページへのすべての転送を返します。
revisions
版の情報を取得します。
search
全文検索を行います。
templates
与えられたページで参照読み込みされているすべてのページを返します。
transcludedin
与えられたページを参照読み込みしているすべてのページを検索します。
watchlist
現在の利用者のウォッチリストにあるページへの最近の更新を取得します。
watchlistraw
現在の利用者のウォッチリストにあるすべてのページを取得します。
値 (次の値のいずれか1つ): allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

titles, pageids, および revids, および generator によって返されたページの転送を自動的に解決する。

型: 真偽値 (詳細)
converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include 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

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

MediaWikiからデータを取得します。

All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites.

パラメーター:
prop

照会ページ用に、どのプロパティを取得するか。

categories
ページが属するすべてのカテゴリを一覧表示します。
categoryinfo
与えられたカテゴリに関する情報を返します。
cirrusbuilddoc
データベースサーバにある単一の CirrusSearch 記事の説明文書のダンプ
cirruscompsuggestbuilddoc
Dump of the document used by the completion suggester
cirrusdoc
データベースサーバにある単一の CirrusSearch 記事の説明文書のダンプ
contributors
ページへのログインした投稿者の一覧と匿名投稿者の数を取得します。
deletedrevisions
削除された版の情報を取得します。
duplicatefiles
ハッシュ値に基づいて与えられたファイルの全ての重複ファイルを返します。
extlinks
与えられたページにあるすべての外部URL (インターウィキを除く) を返します。
extracts
指定されたページのプレーンテキストまたは制限付きHTMLを返します。
fileusage
与えられたファイルを利用しているすべてのページを返します。
imageinfo
ファイルの情報とアップロード履歴を返します。
images
与えられたページに含まれるすべてのファイルを返します。
info
ページの基本的な情報を取得します。
iwlinks
ページからのすべてのウィキ間リンクを返します。
langlinks
ページからのすべての言語間リンクを返します。
links
ページからのすべてのリンクを返します。
linkshere
与えられたページにリンクしているすべてのページを返します。
pageimages
Returns information about images on the page, such as thumbnail and presence of photos.
pageprops
ページコンテンツで定義されている様々なページのプロパティを取得。
redirects
ページへのすべての転送を返します。
revisions
版の情報を取得します。
stashimageinfo
Returns file information for stashed files.
templates
与えられたページで参照読み込みされているすべてのページを返します。
transcludedin
与えられたページを参照読み込みしているすべてのページを検索します。
flowinfo
廃止予定です。 Get basic Structured Discussions information about a page.
値 (|もしくは別の文字列で区切る): categoriescategoryinfocirrusbuilddoccirruscompsuggestbuilddoccirrusdoccontributorsdeletedrevisionsduplicatefilesextlinksextractsfileusageimageinfoimagesinfoiwlinkslanglinkslinkslinksherepageimagespagepropsredirectsrevisionsstashimageinfotemplatestranscludedinflowinfo
list

どの一覧を取得するか。

abusefilters
不正利用フィルターの詳細を表示する。
abuselog
不正利用フィルターによって検知された操作を表示します。
allcategories
すべてのカテゴリを一覧表示します。
alldeletedrevisions
利用者によって削除された、または名前空間内の削除されたすべての版を一覧表示する。
allfileusages
存在しないものを含め、すべてのファイルの使用状況を一覧表示する。
allimages
順次すべての画像を列挙します。
alllinks
与えられた名前空間へのすべてのリンクを一覧表示します。
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
ある名前空間へのすべての転送を一覧表示する。
allrevisions
すべての版を一覧表示する。
alltransclusions
存在しないものも含めて、すべての参照読み込み ({{x}} で埋め込まれたページ) を一覧表示します。
allusers
すべての登録利用者を一覧表示します。
backlinks
与えられたページにリンクしているすべてのページを検索します。
blocks
ブロックされた利用者とIPアドレスを一覧表示します。
categorymembers
与えられたカテゴリ内のすべてのページを一覧表示します。
checkuser
指定した利用者名の利用者が使用した IPアドレス や、指定した IPアドレス を使用した利用者名を調査します。
checkuserlog
利用者調査の記録から項目を取得します。
embeddedin
Find all pages that embed (transclude) the given title.
exturlusage
与えられたURLを含むページを一覧表示します。
filearchive
削除されたファイルをすべて順に列挙します。
gadgetcategories
ガジェットのカテゴリの一覧を返します。
gadgets
このウィキで使用されているガジェットの一覧を返します。
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
与えられた言語間リンクにリンクしているすべてのページを返します。
logevents
Get events from logs.
mystashedfiles
Get a list of files in the current user's upload stash.
pagepropnames
Wiki内で使用されているすべてのページプロパティ名を一覧表示します。
pageswithprop
与えられたページプロパティが使用されているすべてのページを一覧表示します。
prefixsearch
ページ名の先頭一致検索を行います。
protectedtitles
作成保護が掛けられているページを一覧表示します。
querypage
Get a list provided by a QueryPage-based special page.
random
ランダムなページのセットを取得します。
recentchanges
最近の更新を一覧表示します。
search
全文検索を行います。
tags
変更タグを一覧表示します。
usercontribs
利用者によるすべての編集を取得します。
users
利用者のリストについての情報を取得します。
watchlist
現在の利用者のウォッチリストにあるページへの最近の更新を取得します。
watchlistraw
現在の利用者のウォッチリストにあるすべてのページを取得します。
deletedrevs
廃止予定です。 削除された版を一覧表示します。
値 (|もしくは別の文字列で区切る): abusefiltersabuselogallcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsallusersbacklinksblockscategorymemberscheckusercheckuserlogembeddedinexturlusagefilearchivegadgetcategoriesgadgetsimageusageiwbacklinkslangbacklinkslogeventsmystashedfilespagepropnamespageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangessearchtagsusercontribsuserswatchlistwatchlistrawdeletedrevs
meta

どのメタデータを取得するか。

allmessages
Return messages from this site.
authmanagerinfo
Retrieve information about the current authentication status.
filerepoinfo
Return meta information about image repositories configured on the wiki.
languageinfo
Return information about available languages.
notifications
Get notifications waiting for the current user.
siteinfo
Return general information about the site.
tokens
データ変更操作用のトークンを取得します。
unreadnotificationpages
Get pages for which there are unread notifications for the current user.
userinfo
現在の利用者に関する情報を取得します。
oath
内部で使用。 Check to see if two-factor authentication (OATH) is enabled for a user.
値 (|もしくは別の文字列で区切る): allmessagesauthmanagerinfofilerepoinfolanguageinfonotificationssiteinfotokensunreadnotificationpagesuserinfooath
indexpageids

Include an additional pageids section listing all returned page IDs.

型: 真偽値 (詳細)
export

指定されたまたは生成されたすべてのページの、現在の版を書き出します。

型: 真偽値 (詳細)
exportnowrap

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

型: 真偽値 (詳細)
exportschema

Target the given version of the XML dump format when exporting. Can only be used with query+export.

値 (次の値のいずれか1つ): 0.10、0.11
Default: 0.11
iwurl

タイトルがウィキ間リンクである場合に、完全なURLを取得するかどうか。

型: 真偽値 (詳細)
continue

When more results are available, use this to continue.

rawcontinue

Return raw query-continue data for continuation.

型: 真偽値 (詳細)
titles

対象のページ名のリスト。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
pageids

対象のページIDのリスト。

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
revids

対象の版IDのリスト。

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
generator

クエリモジュールを実行することにより対象のページの一覧を取得する。

注意 Generator パラメーターの名前は "g" で始まります。例を参照してください。

allcategories
すべてのカテゴリを一覧表示します。
alldeletedrevisions
利用者によって削除された、または名前空間内の削除されたすべての版を一覧表示する。
allfileusages
存在しないものを含め、すべてのファイルの使用状況を一覧表示する。
allimages
順次すべての画像を列挙します。
alllinks
与えられた名前空間へのすべてのリンクを一覧表示します。
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
ある名前空間へのすべての転送を一覧表示する。
allrevisions
すべての版を一覧表示する。
alltransclusions
存在しないものも含めて、すべての参照読み込み ({{x}} で埋め込まれたページ) を一覧表示します。
backlinks
与えられたページにリンクしているすべてのページを検索します。
categories
ページが属するすべてのカテゴリを一覧表示します。
categorymembers
与えられたカテゴリ内のすべてのページを一覧表示します。
deletedrevisions
削除された版の情報を取得します。
duplicatefiles
ハッシュ値に基づいて与えられたファイルの全ての重複ファイルを返します。
embeddedin
Find all pages that embed (transclude) the given title.
exturlusage
与えられたURLを含むページを一覧表示します。
fileusage
与えられたファイルを利用しているすべてのページを返します。
images
与えられたページに含まれるすべてのファイルを返します。
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
与えられた言語間リンクにリンクしているすべてのページを返します。
links
ページからのすべてのリンクを返します。
linkshere
与えられたページにリンクしているすべてのページを返します。
pageswithprop
与えられたページプロパティが使用されているすべてのページを一覧表示します。
prefixsearch
ページ名の先頭一致検索を行います。
protectedtitles
作成保護が掛けられているページを一覧表示します。
querypage
Get a list provided by a QueryPage-based special page.
random
ランダムなページのセットを取得します。
recentchanges
最近の更新を一覧表示します。
redirects
ページへのすべての転送を返します。
revisions
版の情報を取得します。
search
全文検索を行います。
templates
与えられたページで参照読み込みされているすべてのページを返します。
transcludedin
与えられたページを参照読み込みしているすべてのページを検索します。
watchlist
現在の利用者のウォッチリストにあるページへの最近の更新を取得します。
watchlistraw
現在の利用者のウォッチリストにあるすべてのページを取得します。
値 (次の値のいずれか1つ): allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

query+titles, query+pageids, および query+revids, および query+generator によって返されたページの転送を自動的に解決する。

型: 真偽値 (詳細)
converttitles

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

型: 真偽値 (詳細)

prop=categories (cl)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページが属するすべてのカテゴリを一覧表示します。

パラメーター:
clprop

各カテゴリについて取得する追加のプロパティ:

sortkey
返されるカテゴリのソートキー(sortkey、UTF-8による表示)と人間可読のソートキー (sortkeyprefix) を追加します。
timestamp
カテゴリが追加されたときのタイムスタンプを追加します。
hidden
__HIDDENCAT__で隠されているカテゴリに印を付ける。
値 (|もしくは別の文字列で区切る): hidden、sortkey、timestamp
clshow

どの種類のカテゴリを表示するか。

値 (|もしくは別の文字列で区切る): !hidden、hidden
cllimit

返すカテゴリの数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
clcontinue

When more results are available, use this to continue.

clcategories

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

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
cldir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: 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)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

与えられたカテゴリに関する情報を返します。

パラメーター:
cicontinue

When more results are available, use this to continue.

例:
Category:Foo および Category:Bar に関する情報を取得する。
api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar [サンドボックスで開く]

prop=cirrusbuilddoc (cb)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: CirrusSearch
  • ライセンス: GPL-2.0-or-later

データベースサーバにある単一の CirrusSearch 記事の説明文書のダンプ

例:
データベースから生成された単一の CirrusSearch アーティクルのダンプを取得
api.php?action=query&prop=cirrusbuilddoc&titles=Main_Page [サンドボックスで開く]

prop=cirruscompsuggestbuilddoc (csb)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: CirrusSearch
  • ライセンス: GPL-2.0-or-later

Dump of the document used by the completion suggester

パラメーター:
csbmethod

The scoring method to use

Default: quality

prop=cirrusdoc (cd)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: CirrusSearch
  • ライセンス: GPL-2.0-or-later

データベースサーバにある単一の CirrusSearch 記事の説明文書のダンプ

例:
現在の検索に索引付け済みの単一の CirrusSearch 記事のダンプを取得します。
api.php?action=query&prop=cirrusdoc&titles=Main_Page [サンドボックスで開く]

prop=contributors (pc)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページへのログインした投稿者の一覧と匿名投稿者の数を取得します。

パラメーター:
pcgroup

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

値 (|もしくは別の文字列で区切る): bot、bureaucrat、checkuser、flow-bot、interface-admin、semiop、smwadministrator、smwcurator、smweditor、suppress、sysop
pcexcludegroup

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

値 (|もしくは別の文字列で区切る): bot、bureaucrat、checkuser、flow-bot、interface-admin、semiop、smwadministrator、smwcurator、smweditor、suppress、sysop
pcrights

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

値 (|もしくは別の文字列で区切る): abusefilter-hidden-log、abusefilter-hide-log、abusefilter-log、abusefilter-log-detail、abusefilter-log-private、abusefilter-modify、abusefilter-modify-global、abusefilter-modify-restricted、abusefilter-privatedetails、abusefilter-privatedetails-log、abusefilter-revert、abusefilter-view、abusefilter-view-private、apihighlimits、applychangetags、autoconfirmed、autocreateaccount、autopatrol、bigdelete、block、blockemail、bot、browsearchive、changetags、checkuser、checkuser-log、createaccount、createpage、createtalk、delete、deletechangetags、deletedhistory、deletedtext、deletelogentry、deleterevision、edit、editcontentmodel、editinterface、editmyoptions、editmyprivateinfo、editmyusercss、editmyuserjs、editmyuserjson、editmyuserjsredirect、editmywatchlist、editprotected、editsemiprotected、editsitecss、editsitejs、editsitejson、editusercss、edituserjs、edituserjson、flow-create-board、flow-delete、flow-edit-post、flow-hide、flow-lock、flow-suppress、gadgets-definition-edit、gadgets-edit、hideuser、import、importupload、interwiki、ipblock-exempt、managechangetags、markbotedits、mergehistory、minoredit、move、move-categorypages、move-rootuserpages、move-subpages、movefile、nominornewtalk、noratelimit、nuke、oathauth-api-all、oathauth-disable-for-user、oathauth-enable、oathauth-verify-user、oathauth-view-log、override-export-depth、pagelang、patrol、patrolmarks、protect、purge、read、renameuser、replacetext、reupload、reupload-own、reupload-shared、rollback、sendemail、siteadmin、skipcaptcha、spamblacklistlog、suppressionlog、suppressredirect、suppressrevision、tboverride、tboverride-account、titleblacklistlog、unblockself、undelete、unwatchedpages、upload、upload_by_url、usermerge、userrights、userrights-interwiki、viewmyprivateinfo、viewmywatchlist、viewsuppressed、writeapi
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
pcexcluderights

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

値 (|もしくは別の文字列で区切る): abusefilter-hidden-log、abusefilter-hide-log、abusefilter-log、abusefilter-log-detail、abusefilter-log-private、abusefilter-modify、abusefilter-modify-global、abusefilter-modify-restricted、abusefilter-privatedetails、abusefilter-privatedetails-log、abusefilter-revert、abusefilter-view、abusefilter-view-private、apihighlimits、applychangetags、autoconfirmed、autocreateaccount、autopatrol、bigdelete、block、blockemail、bot、browsearchive、changetags、checkuser、checkuser-log、createaccount、createpage、createtalk、delete、deletechangetags、deletedhistory、deletedtext、deletelogentry、deleterevision、edit、editcontentmodel、editinterface、editmyoptions、editmyprivateinfo、editmyusercss、editmyuserjs、editmyuserjson、editmyuserjsredirect、editmywatchlist、editprotected、editsemiprotected、editsitecss、editsitejs、editsitejson、editusercss、edituserjs、edituserjson、flow-create-board、flow-delete、flow-edit-post、flow-hide、flow-lock、flow-suppress、gadgets-definition-edit、gadgets-edit、hideuser、import、importupload、interwiki、ipblock-exempt、managechangetags、markbotedits、mergehistory、minoredit、move、move-categorypages、move-rootuserpages、move-subpages、movefile、nominornewtalk、noratelimit、nuke、oathauth-api-all、oathauth-disable-for-user、oathauth-enable、oathauth-verify-user、oathauth-view-log、override-export-depth、pagelang、patrol、patrolmarks、protect、purge、read、renameuser、replacetext、reupload、reupload-own、reupload-shared、rollback、sendemail、siteadmin、skipcaptcha、spamblacklistlog、suppressionlog、suppressredirect、suppressrevision、tboverride、tboverride-account、titleblacklistlog、unblockself、undelete、unwatchedpages、upload、upload_by_url、usermerge、userrights、userrights-interwiki、viewmyprivateinfo、viewmywatchlist、viewsuppressed、writeapi
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
pclimit

返す投稿者の数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
pccontinue

When more results are available, use this to continue.

prop=deletedrevisions (drv)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

削除された版の情報を取得します。

May be used in several ways:

  1. Get deleted revisions for a set of pages, by setting titles or pageids. Ordered by title and timestamp.
  2. Get data about a set of deleted revisions by setting their IDs with revids. Ordered by revision ID.
パラメーター:
drvprop

Which properties to get for each revision:

ids
版のID。
flags
Revision flags (minor).
timestamp
版のタイムスタンプ。
user
その版を作成した利用者。
userid
その版の作成者の利用者ID。
size
その版の長さ (バイト) 。
slotsize
Length (bytes) of each revision slot.
sha1
SHA-1 (base 16) of the revision. If the content has been revision deleted, a sha1hidden property will be returned.
slotsha1
SHA-1 (base 16) of each revision slot. If the content has been revision deleted, a sha1hidden property will be returned.
contentmodel
Content model ID of each revision slot.
comment
その版の利用者によるコメント。
parsedcomment
その版の利用者による、構文解析されたコメント。
content
各リビジョンスロットの内容。
tags
その版のタグ。
roles
List content slot roles that exist in the revision.
parsetree
廃止予定です。 Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model wikitext).
値 (|もしくは別の文字列で区切る): comment、content、contentmodel、flags、ids、parsedcomment、roles、sha1、size、slotsha1、slotsize、tags、timestamp、user、userid、parsetree
Default: ids|timestamp|flags|comment|user
drvslots

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

値 (|もしくは別の文字列で区切る): main
すべての値を指定するには、*を用いてください。
drvlimit

返す版の数を制限する。

型: 整数または max
The value must be between 1 and 500.
drvexpandtemplates
廃止予定です。

Use action=expandtemplates instead. Expand templates in revision content (requires drvprop=content).

型: 真偽値 (詳細)
drvgeneratexml
廃止予定です。

Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires drvprop=content).

型: 真偽値 (詳細)
drvparse
廃止予定です。

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

型: 真偽値 (詳細)
drvsection

Only retrieve the content of this section number.

drvdiffto
廃止予定です。

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

drvdifftotext
廃止予定です。

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

drvdifftotextpst
廃止予定です。

Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with drvdifftotext.

型: 真偽値 (詳細)
drvcontentformat
廃止予定です。

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

値 (次の値のいずれか1つ): application/json、text/css、text/javascript、text/plain、text/x-wiki
drvstart

列挙の始点となるタイムスタンプ。版IDの一覧を処理するときには無視されます。

Type: timestamp (allowed formats)
drvend

列挙の終点となるタイムスタンプ。版IDの一覧を処理するときには無視されます。

Type: timestamp (allowed formats)
drvdir

列挙の方向:

newer
古いものを先に表示します。注意: drvstart は drvend 以前でなければなりません。
older
新しいものを先に表示します (既定)。注意: drvstart は drvend 以降でなければなりません。
値 (次の値のいずれか1つ): newer、older
Default: older
drvtag

このタグが付与された版のみ表示します。

drvuser

この利用者による版のみを一覧表示。

型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
drvexcludeuser

この利用者による版を一覧表示しない。

型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
drvcontinue

When more results are available, use this to continue.

例:
ページ 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)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ハッシュ値に基づいて与えられたファイルの全ての重複ファイルを返します。

パラメーター:
dflimit

返す重複ファイルの件数

型: 整数または max
The value must be between 1 and 500.
Default: 10
dfcontinue

When more results are available, use this to continue.

dfdir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
dflocalonly

ローカルに保存されたファイルのみを調べる。

型: 真偽値 (詳細)
  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

与えられたページにあるすべての外部URL (インターウィキを除く) を返します。

パラメーター:
ellimit

返すリンクの数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
elcontinue

When more results are available, use this to continue.

elprotocol

URLのプロトコル。このパラメーターが空であり、かつelquery が設定されている場合, protocol は http となります。すべての外部リンクを一覧表示するためにはこのパラメーターと elquery の両方を空にしてください。

値 (次の値のいずれか1つ): Can be empty, or bitcoin、ftp、ftps、geo、git、gopher、http、https、irc、ircs、magnet、mailto、mms、news、nntp、redis、sftp、sip、sips、sms、ssh、svn、tel、telnet、urn、worldwind、xmpp
既定値: (空)
elquery

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

elexpandurl

Expand protocol-relative URLs with the canonical protocol.

型: 真偽値 (詳細)
例:
Main Page の外部リンクの一覧を取得する。
api.php?action=query&prop=extlinks&titles=Main%20Page [サンドボックスで開く]

prop=extracts (ex)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: TextExtracts
  • ライセンス: GPL-2.0-or-later

指定されたページのプレーンテキストまたは制限付きHTMLを返します。

パラメーター:
exchars

返す文字数。返される実際の本文はわずかに長くなる場合があります。

型: 整数
The value must be between 1 and 1,200.
exsentences

返す文の数。

型: 整数
The value must be between 1 and 10.
exlimit

How many extracts to return. (Multiple extracts can only be returned if exintro is set to true.)

型: 整数または max
The value must be between 1 and 20.
Default: 20
exintro

最初の節の前の内容のみ返す。

型: 真偽値 (詳細)
explaintext

Return extracts as plain text instead of limited HTML.

型: 真偽値 (詳細)
exsectionformat

How to format sections in plaintext mode:

plain
No formatting.
wiki
Wikitext-style formatting (== like this ==).
raw
This module's internal representation (section titles prefixed with <ASCII 1><ASCII 2><section level><ASCII 2><ASCII 1>).
値 (次の値のいずれか1つ): plain、raw、wiki
Default: wiki
excontinue

When more results are available, use this to continue.

型: 整数

prop=fileusage (fu)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

与えられたファイルを利用しているすべてのページを返します。

パラメーター:
fuprop

取得するプロパティ:

pageid
各ページのページID。
title
各ページのページ名。
redirect
ページがリダイレクトである場合マークします。
値 (|もしくは別の文字列で区切る): pageid、redirect、title
Default: pageid|title|redirect
funamespace

この名前空間に含まれるページのみを一覧表示します。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
fushow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
値 (|もしくは別の文字列で区切る): !redirect、redirect
fulimit

How many to return.

型: 整数または max
The value must be between 1 and 500.
Default: 10
fucontinue

When more results are available, use this to continue.

prop=flowinfo (fli)

  • このモジュールは廃止予定です。
  • このモジュールは読み取りの権限を必要とします。
  • ソース: Flow
  • ライセンス: GPL-2.0-or-later

Get basic Structured Discussions information about a page.

prop=imageinfo (ii)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ファイルの情報とアップロード履歴を返します。

パラメーター:
iiprop

取得するファイル情報:

timestamp
Adds timestamp for the uploaded version.
user
Adds the user who uploaded each file version. If the user has been revision deleted, a userhidden property will be returned.
userid
Add the ID of the user that uploaded each file version. If the user has been revision deleted, a userhidden property will be returned.
comment
Comment on the version. If the comment has been revision deleted, a commenthidden property will be returned.
parsedcomment
Parse the comment on the version. If the comment has been revision deleted, a commenthidden property will be returned.
canonicaltitle
Adds the canonical title of the file. If the file has been revision deleted, a filehidden property will be returned.
url
ファイルと説明ページへのURLを提供します。
size
バイト単位でファイルや高さ、幅、ページ数のサイズを追加します(該当する場合)。
dimensions
Alias for size.
sha1
Adds SHA-1 hash for the file. If the file has been revision deleted, a filehidden property will be returned.
mime
ファイルのMIMEタイプを追加します。
thumbmime
画像サムネイルのMIMEタイプを追加します(url と iiurlwidth パラメータが必須です)。
mediatype
ファイルのメディアタイプを追加します。
metadata
ファイルのバージョンの Exif メタデータを一覧表示します。
commonmetadata
Lists file format generic metadata for the version of the file. If the file has been revision deleted, a filehidden property will be returned.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted. If the file has been revision deleted, a filehidden property will be returned.
archivename
非最新バージョンのアーカイブバージョンのファイル名を追加します。
bitdepth
バージョンのビット深度を追加します。
uploadwarning
Used by the Special:Upload page to get information about an existing file. Not intended for use outside MediaWiki core.
badfile
Adds whether the file is on the MediaWiki:Bad image list
値 (|もしくは別の文字列で区切る): archivename、badfile、bitdepth、canonicaltitle、comment、commonmetadata、dimensions、extmetadata、mediatype、metadata、mime、parsedcomment、sha1、size、thumbmime、timestamp、uploadwarning、url、user、userid
Default: timestamp|user
iilimit

How many file revisions to return per file.

型: 整数または max
The value must be between 1 and 500.
Default: 1
iistart

一覧表示の始点となるタイムスタンプ。

Type: timestamp (allowed formats)
iiend

一覧表示の終点となるタイムスタンプ。

Type: timestamp (allowed formats)
iiurlwidth

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

型: 整数
Default: -1
iiurlheight

Similar to iiurlwidth.

型: 整数
Default: -1
iimetadataversion

Version of metadata to use. If latest is specified, use latest version. Defaults to 1 for backwards compatibility.

Default: 1
iiextmetadatalanguage

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

Default: ja
iiextmetadatamultilang

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

型: 真偽値 (詳細)
iiextmetadatafilter

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

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
iiurlparam

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

既定値: (空)
iibadfilecontexttitle

If badfilecontexttitleprop=badfile is set, this is the page title used when evaluating the MediaWiki:Bad image list

iicontinue

When more results are available, use this to continue.

iilocalonly

Look only for files in the local repository.

型: 真偽値 (詳細)

prop=images (im)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

与えられたページに含まれるすべてのファイルを返します。

パラメーター:
imlimit

返す画像の数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
imcontinue

When more results are available, use this to continue.

imimages

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

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
imdir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: 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)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページの基本的な情報を取得します。

パラメーター:
inprop

追加で取得するプロパティ:

protection
それぞれのページの保護レベルを一覧表示する。
talkid
The page ID of the talk page for each non-talk page.
watched
List the watched status of each page.
watchers
The number of watchers, if allowed.
visitingwatchers
The number of watchers of each page who have visited recent edits to that page, if allowed.
notificationtimestamp
The watchlist notification timestamp of each page.
subjectid
The page ID of the parent page for each talk page.
url
Gives a full URL, an edit URL, and the canonical URL for each page.
readable
廃止予定です。 Whether the user can read this page. Use intestactions=read instead.
preload
Gives the text returned by EditFormPreloadText.
displaytitle
Gives the manner in which the page title is actually displayed.
varianttitles
Gives the display title in all variants of the site content language.
値 (|もしくは別の文字列で区切る): displaytitle、notificationtimestamp、preload、protection、subjectid、talkid、url、varianttitles、visitingwatchers、watched、watchers、readable
intestactions

Test whether the current user can perform certain actions on the page.

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
intestactionsdetail

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

boolean
Return a boolean value for each action.
full
Return messages describing why the action is disallowed, or an empty array if it is allowed.
quick
Like full but skipping expensive checks.
値 (次の値のいずれか1つ): boolean、full、quick
Default: boolean
intoken
廃止予定です。

代わりに action=query&meta=tokens を使用してください。

値 (|もしくは別の文字列で区切る): block、delete、edit、email、import、move、protect、unblock、watch
incontinue

When more results are available, use this to continue.

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページからのすべてのウィキ間リンクを返します。

パラメーター:
iwprop

各言語間リンクについて取得する追加のプロパティ:

url
完全なURLを追加します。
値 (|もしくは別の文字列で区切る): url
iwprefix

この接頭辞のウィキ間リンクのみを返す。

iwtitle

検索するウィキ間リンク。iw と同時に使用しなければなりません。

iwdir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
iwlimit

返すウィキ間リンクの数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
iwcontinue

When more results are available, use this to continue.

iwurl
廃止予定です。

完全なURLを取得するかどうか (iwpropとは同時に使用できません).

型: 真偽値 (詳細)
例:
Main Page にあるウィキ間リンクを取得する。
api.php?action=query&prop=iwlinks&titles=Main%20Page [サンドボックスで開く]
  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページからのすべての言語間リンクを返します。

パラメーター:
llprop

各言語間リンクについて取得する追加のプロパティ:

url
完全なURLを追加します。
langname
Adds the localised language name (best effort). Use llinlanguagecode to control the language.
autonym
ネイティブ言語名を追加します。
値 (|もしくは別の文字列で区切る): autonym、langname、url
lllang

この言語コードの言語間リンクのみを返す。

lltitle

検索するリンク。lllangと同時に使用しなければなりません。

lldir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
llinlanguagecode

Language code for localised language names.

Default: ja
lllimit

返す言語間リンクの数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
llcontinue

When more results are available, use this to continue.

llurl
廃止予定です。

完全なURLを取得するかどうか (llpropとは同時に使用できません).

型: 真偽値 (詳細)
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページからのすべてのリンクを返します。

パラメーター:
plnamespace

この名前空間へのリンクのみ表示する。

値 (|もしくは別の文字列で区切る): -1、-2、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
pllimit

返すリンクの数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
plcontinue

When more results are available, use this to continue.

pltitles

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

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
pldir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: 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)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

与えられたページにリンクしているすべてのページを返します。

パラメーター:
lhprop

取得するプロパティ:

pageid
各ページのページID。
title
各ページのページ名。
redirect
Flag if the page is a redirect.
値 (|もしくは別の文字列で区切る): pageid、redirect、title
Default: pageid|title|redirect
lhnamespace

Only include pages in these namespaces.

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
lhshow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
値 (|もしくは別の文字列で区切る): !redirect、redirect
lhlimit

How many to return.

型: 整数または max
The value must be between 1 and 500.
Default: 10
lhcontinue

When more results are available, use this to continue.

prop=pageimages (pi)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: PageImages
  • ライセンス: WTFPL

Returns information about images on the page, such as thumbnail and presence of photos.

パラメーター:
piprop

どの情報を返すか:

サムネイル
ページに関連付けられたサムネイル画像のURLとサイズ(存在する場合)。
オリジナル
ページに関連付けられたイメージのURLと元のサイズ(存在する場合)。
名前
画像のタイトル。
値 (|もしくは別の文字列で区切る): name、original、thumbnail
Default: thumbnail|name
pithumbsize

サムネイル画像の最大幅(ピクセル単位)。

型: 整数
Default: 50
pilimit

返すページの件数です。

型: 整数または max
The value must be between 1 and 50.
Default: 50
pilicense

ページイメージを特定のライセンスタイプに制限する

値 (次の値のいずれか1つ): any、free
Default: free
picontinue

When more results are available, use this to continue.

型: 整数
例:
ページ Albert Einstein 上の画像の名前と 100 ピクセルのサムネイルを取得する。
api.php?action=query&prop=pageimages&titles=Albert%20Einstein&pithumbsize=100 [サンドボックスで開く]

prop=pageprops (pp)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページコンテンツで定義されている様々なページのプロパティを取得。

パラメーター:
ppcontinue

When more results are available, use this to continue.

ppprop

Only list these page properties (action=query&list=pagepropnames returns page property names in use). Useful for checking whether pages use a certain page property.

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
例:
ページ Main Page および MeiaWiki のプロパティを取得する。
api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki [サンドボックスで開く]

prop=redirects (rd)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページへのすべての転送を返します。

パラメーター:
rdprop

取得するプロパティ:

pageid
各リダイレクトのページID。
title
各リダイレクトのページ名。
fragment
Fragment of each redirect, if any.
値 (|もしくは別の文字列で区切る): fragment、pageid、title
Default: pageid|title
rdnamespace

Only include pages in these namespaces.

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
rdshow

Show only items that meet these criteria:

fragment
Only show redirects with a fragment.
!fragment
Only show redirects without a fragment.
値 (|もしくは別の文字列で区切る): !fragment、fragment
rdlimit

返す転送の数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
rdcontinue

When more results are available, use this to continue.

prop=revisions (rv)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

版の情報を取得します。

May be used in several ways:

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

Which properties to get for each revision:

ids
版のID。
flags
Revision flags (minor).
timestamp
版のタイムスタンプ。
user
その版を作成した利用者。
userid
その版の作成者の利用者ID。
size
その版の長さ (バイト) 。
slotsize
Length (bytes) of each revision slot.
sha1
SHA-1 (base 16) of the revision. If the content has been revision deleted, a sha1hidden property will be returned.
slotsha1
SHA-1 (base 16) of each revision slot. If the content has been revision deleted, a sha1hidden property will be returned.
contentmodel
Content model ID of each revision slot.
comment
その版の利用者によるコメント。
parsedcomment
その版の利用者による、構文解析されたコメント。
content
各リビジョンスロットの内容。
tags
その版のタグ。
roles
List content slot roles that exist in the revision.
parsetree
廃止予定です。 Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model wikitext).
値 (|もしくは別の文字列で区切る): comment、content、contentmodel、flags、ids、parsedcomment、roles、sha1、size、slotsha1、slotsize、tags、timestamp、user、userid、parsetree
Default: ids|timestamp|flags|comment|user
rvslots

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

値 (|もしくは別の文字列で区切る): main
すべての値を指定するには、*を用いてください。
rvlimit

返す版の数を制限する。

May only be used with a single page (mode #2).
型: 整数または max
The value must be between 1 and 500.
rvexpandtemplates
廃止予定です。

Use action=expandtemplates instead. Expand templates in revision content (requires rvprop=content).

型: 真偽値 (詳細)
rvgeneratexml
廃止予定です。

Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires rvprop=content).

型: 真偽値 (詳細)
rvparse
廃止予定です。

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

型: 真偽値 (詳細)
rvsection

Only retrieve the content of this section number.

rvdiffto
廃止予定です。

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

rvdifftotext
廃止予定です。

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

rvdifftotextpst
廃止予定です。

Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with rvdifftotext.

型: 真偽値 (詳細)
rvcontentformat
廃止予定です。

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

値 (次の値のいずれか1つ): application/json、text/css、text/javascript、text/plain、text/x-wiki
rvstartid

Start enumeration from this revision's timestamp. The revision must exist, but need not belong to this page.

May only be used with a single page (mode #2).
型: 整数
rvendid

Stop enumeration at this revision's timestamp. The revision must exist, but need not belong to this page.

May only be used with a single page (mode #2).
型: 整数
rvstart

From which revision timestamp to start enumeration.

May only be used with a single page (mode #2).
Type: timestamp (allowed formats)
rvend

列挙の終点となるタイムスタンプ。

May only be used with a single page (mode #2).
Type: timestamp (allowed formats)
rvdir

列挙の方向:

newer
古いものを先に表示します。注意: rvstart は rvend 以前でなければなりません。
older
新しいものを先に表示します (既定)。注意: rvstart は rvend 以降でなければなりません。
May only be used with a single page (mode #2).
値 (次の値のいずれか1つ): newer、older
Default: older
rvuser

この利用者による版のみを結果に含める。

May only be used with a single page (mode #2).
型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
rvexcludeuser

この利用者による版を結果に含めない。

May only be used with a single page (mode #2).
型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
rvtag

このタグが付与された版のみを一覧表示する。

rvtoken
廃止予定です。

Which tokens to obtain for each revision.

値 (|もしくは別の文字列で区切る): rollback
rvcontinue

When more results are available, use this to continue.

prop=stashimageinfo (sii)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Returns file information for stashed files.

パラメーター:
siifilekey

Key that identifies a previous upload that was stashed temporarily.

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
siisessionkey
廃止予定です。

Alias for siifilekey, for backward compatibility.

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
siiprop

取得するファイル情報:

timestamp
Adds timestamp for the uploaded version.
canonicaltitle
Adds the canonical title of the file. If the file has been revision deleted, a filehidden property will be returned.
url
ファイルと説明ページへのURLを提供します。
size
バイト単位でファイルや高さ、幅、ページ数のサイズを追加します(該当する場合)。
dimensions
Alias for size.
sha1
Adds SHA-1 hash for the file. If the file has been revision deleted, a filehidden property will be returned.
mime
ファイルのMIMEタイプを追加します。
thumbmime
画像サムネイルのMIMEタイプを追加します(url と siiurlwidth パラメータが必須です)。
metadata
ファイルのバージョンの Exif メタデータを一覧表示します。
commonmetadata
Lists file format generic metadata for the version of the file. If the file has been revision deleted, a filehidden property will be returned.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted. If the file has been revision deleted, a filehidden property will be returned.
bitdepth
バージョンのビット深度を追加します。
badfile
Adds whether the file is on the MediaWiki:Bad image list
値 (|もしくは別の文字列で区切る): badfile、bitdepth、canonicaltitle、commonmetadata、dimensions、extmetadata、metadata、mime、sha1、size、thumbmime、timestamp、url
Default: timestamp|url
siiurlwidth

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

型: 整数
Default: -1
siiurlheight

Similar to siiurlwidth.

型: 整数
Default: -1
siiurlparam

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

既定値: (空)

prop=templates (tl)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

与えられたページで参照読み込みされているすべてのページを返します。

パラメーター:
tlnamespace

この名前空間のテンプレートのみ表示する。

値 (|もしくは別の文字列で区切る): -1、-2、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
tllimit

返すテンプレートの数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
tlcontinue

When more results are available, use this to continue.

tltemplates

Only list these templates. Useful for checking whether a certain page uses a certain template.

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
tldir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
例:
Main Page で使用されているテンプレートを取得する。
api.php?action=query&prop=templates&titles=Main%20Page [サンドボックスで開く]
Main Page で使用されているテンプレートに関する情報を取得する。
api.php?action=query&generator=templates&titles=Main%20Page&prop=info [サンドボックスで開く]
Main Page で参照読み込みされている 利用者 および テンプレート 名前空間のページを取得する。
api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10 [サンドボックスで開く]

prop=transcludedin (ti)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

与えられたページを参照読み込みしているすべてのページを検索します。

パラメーター:
tiprop

取得するプロパティ:

pageid
各ページのページID。
title
各ページのページ名。
redirect
ページがリダイレクトである場合マークします。
値 (|もしくは別の文字列で区切る): pageid、redirect、title
Default: pageid|title|redirect
tinamespace

この名前空間に含まれるページのみを一覧表示します。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
tishow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
値 (|もしくは別の文字列で区切る): !redirect、redirect
tilimit

返す数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
ticontinue

When more results are available, use this to continue.

例:
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=abusefilters (abf)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Abuse Filter
  • ライセンス: GPL-2.0-or-later

不正利用フィルターの詳細を表示する。

パラメーター:
abfstartid

列挙の始点となるフィルターID。

型: 整数
abfendid

列挙の終点となるフィルターID。

型: 整数
abfdir

列挙の方向:

newer
古いものを先に表示します。注意: abfstart は abfend 以前でなければなりません。
older
新しいものを先に表示します (既定)。注意: abfstart は abfend 以降でなければなりません。
値 (次の値のいずれか1つ): newer、older
Default: newer
abfshow

これらの条件を満たすフィルターのみを表示します。

値 (|もしくは別の文字列で区切る): !deleted、!enabled、!private、deleted、enabled、private
abflimit

表示するフィルターの最大数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
abfprop

取得するプロパティ。

値 (|もしくは別の文字列で区切る): actions、comments、description、hits、id、lasteditor、lastedittime、pattern、private、status
Default: id|description|actions|status
例:
有効化されている公開フィルターを一覧表示する
api.php?action=query&list=abusefilters&abfshow=enabled|!private [サンドボックスで開く]
フィルターに関する詳細の一部を表示します
api.php?action=query&list=abusefilters&abfprop=id|description|pattern [サンドボックスで開く]

list=abuselog (afl)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Abuse Filter
  • ライセンス: GPL-2.0-or-later

不正利用フィルターによって検知された操作を表示します。

パラメーター:
afllogid

指定されたログIDを持つエントリを表示します。

型: 整数
aflstart

列挙の始点となるタイムスタンプ。

Type: timestamp (allowed formats)
aflend

列挙の終点となるタイムスタンプ。

Type: timestamp (allowed formats)
afldir

列挙の方向:

newer
古いものを先に表示します。注意: aflstart は aflend 以前でなければなりません。
older
新しいものを先に表示します (既定)。注意: aflstart は aflend 以降でなければなりません。
値 (次の値のいずれか1つ): newer、older
Default: older
afluser

与えられた利用者またはIPアドレスによる項目のみを表示する。

afltitle

与えられたページに関する項目のみを表示する。

aflfilter

Show only entries that were caught by the given filter IDs. Separate with pipes, prefix with "global-" for global filters.

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
afllimit

一覧表示する項目の最大量。

型: 整数または max
The value must be between 1 and 500.
Default: 10
aflprop

取得するプロパティ。

値 (|もしくは別の文字列で区切る): action、details、filter、hidden、ids、result、revid、timestamp、title、user
Default: ids|user|title|action|result|timestamp|hidden|revid

list=allcategories (ac)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

すべてのカテゴリを一覧表示します。

パラメーター:
acfrom

列挙を開始するカテゴリ。

accontinue

When more results are available, use this to continue.

acto

列挙を終了するカテゴリ。

acprefix

この値で始まるページ名のカテゴリを検索します。

acdir

並べ替えの方向。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
acmin

Only return categories with at least this many members.

型: 整数
acmax

Only return categories with at most this many members.

型: 整数
aclimit

返すカテゴリの数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
acprop

取得するプロパティ:

size
カテゴリ内のページ数を追加します。
hidden
__HIDDENCAT__に隠されているタグカテゴリ。
値 (|もしくは別の文字列で区切る): hidden、size
既定値: (空)
例:
カテゴリを、内包するページ数の情報と共に、一覧表示する。
api.php?action=query&list=allcategories&acprop=size [サンドボックスで開く]
List で始まるカテゴリページに関する情報を取得する。
api.php?action=query&generator=allcategories&gacprefix=List&prop=info [サンドボックスで開く]

list=alldeletedrevisions (adr)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

利用者によって削除された、または名前空間内の削除されたすべての版を一覧表示する。

パラメーター:
adrprop

Which properties to get for each revision:

ids
版のID。
flags
Revision flags (minor).
timestamp
版のタイムスタンプ。
user
その版を作成した利用者。
userid
その版の作成者の利用者ID。
size
その版の長さ (バイト) 。
slotsize
Length (bytes) of each revision slot.
sha1
SHA-1 (base 16) of the revision. If the content has been revision deleted, a sha1hidden property will be returned.
slotsha1
SHA-1 (base 16) of each revision slot. If the content has been revision deleted, a sha1hidden property will be returned.
contentmodel
Content model ID of each revision slot.
comment
その版の利用者によるコメント。
parsedcomment
その版の利用者による、構文解析されたコメント。
content
各リビジョンスロットの内容。
tags
その版のタグ。
roles
List content slot roles that exist in the revision.
parsetree
廃止予定です。 Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model wikitext).
値 (|もしくは別の文字列で区切る): comment、content、contentmodel、flags、ids、parsedcomment、roles、sha1、size、slotsha1、slotsize、tags、timestamp、user、userid、parsetree
Default: ids|timestamp|flags|comment|user
adrslots

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

値 (|もしくは別の文字列で区切る): main
すべての値を指定するには、*を用いてください。
adrlimit

返す版の数を制限する。

型: 整数または max
The value must be between 1 and 500.
adrexpandtemplates
廃止予定です。

Use action=expandtemplates instead. Expand templates in revision content (requires adrprop=content).

型: 真偽値 (詳細)
adrgeneratexml
廃止予定です。

Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires adrprop=content).

型: 真偽値 (詳細)
adrparse
廃止予定です。

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

型: 真偽値 (詳細)
adrsection

Only retrieve the content of this section number.

adrdiffto
廃止予定です。

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

adrdifftotext
廃止予定です。

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

adrdifftotextpst
廃止予定です。

Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with adrdifftotext.

型: 真偽値 (詳細)
adrcontentformat
廃止予定です。

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

値 (次の値のいずれか1つ): application/json、text/css、text/javascript、text/plain、text/x-wiki
adruser

この利用者による版のみを一覧表示する。

型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
adrnamespace

この名前空間に含まれるページのみを一覧表示します。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
adrstart

列挙の始点となるタイムスタンプ。

adruser と同時に使用します。
Type: timestamp (allowed formats)
adrend

列挙の終点となるタイムスタンプ。

adruser と同時に使用します。
Type: timestamp (allowed formats)
adrdir

列挙の方向:

newer
古いものを先に表示します。注意: adrstart は adrend 以前でなければなりません。
older
新しいものを先に表示します (既定)。注意: adrstart は adrend 以降でなければなりません。
値 (次の値のいずれか1つ): newer、older
Default: older
adrfrom

列挙の始点となるページ名。

adruser と同時に使用できません。
adrto

列挙の終点となるページ名。

adruser と同時に使用できません。
adrprefix

この値で始まるすべてのページ名を検索する。

adruser と同時に使用できません。
adrexcludeuser

この利用者による版を一覧表示しない。

adruser と同時に使用できません。
型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
adrtag

このタグが付与された版のみを一覧表示する。

adrcontinue

When more results are available, use this to continue.

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)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

存在しないものを含め、すべてのファイルの使用状況を一覧表示する。

パラメーター:
afcontinue

When more results are available, use this to continue.

affrom

列挙を開始するファイルのページ名。

afto

列挙を終了するファイルのページ名。

afprefix

この値で始まるページ名のすべてのファイルを検索する。

afunique

ファイル名を一度だけ表示します。afprop=ids とは同時に使用できません。ジェネレーターとして使用される場合、リンク元ではなくリンク先のページを生成します。

型: 真偽値 (詳細)
afprop

どの情報を結果に含めるか:

ids
使用しているページのページIDを追加します (afunique とは同時に使用できません)。
title
ファイルのページ名を追加します。
値 (|もしくは別の文字列で区切る): ids、title
Default: title
aflimit

返す項目の総数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
afdir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
例:
List file titles, including missing ones, with page IDs they are from, starting at B.
api.php?action=query&list=allfileusages&affrom=B&afprop=ids|title [サンドボックスで開く]
ユニークなファイルを一覧表示する。
api.php?action=query&list=allfileusages&afunique=&affrom=B [サンドボックスで開く]
ファイル名を、存在しないものに印をつけて、すべて取得する。
api.php?action=query&generator=allfileusages&gafunique=&gaffrom=B [サンドボックスで開く]
ファイルを含むページを取得します。
api.php?action=query&generator=allfileusages&gaffrom=B [サンドボックスで開く]

list=allimages (ai)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

順次すべての画像を列挙します。

パラメーター:
aisort

並べ替えに使用するプロパティ。

値 (次の値のいずれか1つ): name、timestamp
Default: name
aidir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending、newer、older
Default: ascending
aifrom

列挙の始点となる画像タイトル。aisort=name を指定した場合のみ使用できます。

aito

列挙の終点となる画像のページ名。aisort=name を指定した場合のみ使用できます。

aicontinue

When more results are available, use this to continue.

aistart

列挙の始点となるタイムスタンプ。aisort=timestamp を指定した場合のみ使用できます。

Type: timestamp (allowed formats)
aiend

列挙の終点となるタイムスタンプ。aisort=timestamp を指定した場合のみ使用できます。

Type: timestamp (allowed formats)
aiprop

取得するファイル情報:

timestamp
Adds timestamp for the uploaded version.
user
Adds the user who uploaded each file version. If the user has been revision deleted, a userhidden property will be returned.
userid
Add the ID of the user that uploaded each file version. If the user has been revision deleted, a userhidden property will be returned.
comment
Comment on the version. If the comment has been revision deleted, a commenthidden property will be returned.
parsedcomment
Parse the comment on the version. If the comment has been revision deleted, a commenthidden property will be returned.
canonicaltitle
Adds the canonical title of the file. If the file has been revision deleted, a filehidden property will be returned.
url
ファイルと説明ページへのURLを提供します。
size
バイト単位でファイルや高さ、幅、ページ数のサイズを追加します(該当する場合)。
dimensions
Alias for size.
sha1
Adds SHA-1 hash for the file. If the file has been revision deleted, a filehidden property will be returned.
mime
ファイルのMIMEタイプを追加します。
mediatype
ファイルのメディアタイプを追加します。
metadata
ファイルのバージョンの Exif メタデータを一覧表示します。
commonmetadata
Lists file format generic metadata for the version of the file. If the file has been revision deleted, a filehidden property will be returned.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted. If the file has been revision deleted, a filehidden property will be returned.
bitdepth
バージョンのビット深度を追加します。
badfile
Adds whether the file is on the MediaWiki:Bad image list
値 (|もしくは別の文字列で区切る): badfile、bitdepth、canonicaltitle、comment、commonmetadata、dimensions、extmetadata、mediatype、metadata、mime、parsedcomment、sha1、size、timestamp、url、user、userid
Default: timestamp|url
aiprefix

この値で始まるすべての画像タイトルを検索する。aisort=name を指定した場合のみ使用できます。

aiminsize

画像の最小バイト数を制限する。

型: 整数
aimaxsize

画像の最大バイト数を制限する。

型: 整数
aisha1

画像の SHA1 ハッシュ値。aisha1base36 をオーバーライドします。

aisha1base36

SHA1 hash of image in base 36 (used in MediaWiki).

aiuser

この利用者によりアップロードされたファイルのみを返す。aisort=timestamp を指定した場合のみ使用できます。 aifilterbots とは同時に使用できません。

型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
aifilterbots

ボットによりアップロードされたファイルを絞り込む方法。aisort=timestamp を指定した場合のみ使用できます。aiuser とは同時に使用できません。

値 (次の値のいずれか1つ): all、bots、nobots
Default: all
aimime

検索対象のMIMEタイプ、たとえば image/jpeg

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
ailimit

返す画像の総数。

型: 整数または max
The value must be between 1 and 500.
Default: 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 [サンドボックスで開く]
T で始まる4つのファイルに関する情報を表示する。
api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo [サンドボックスで開く]
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

与えられた名前空間へのすべてのリンクを一覧表示します。

パラメーター:
alcontinue

When more results are available, use this to continue.

alfrom

列挙を開始するリンクのページ名。

alto

列挙を終了するリンクのページ名。

alprefix

この値で始まるすべてのリンクされたページを検索する。

alunique

リンクされたページ名を一度だけ表示します。alprop=ids とは同時に使用できません。ジェネレーターとして使用される場合、リンク元ではなくリンク先のページを生成します。

型: 真偽値 (詳細)
alprop

どの情報を結果に含めるか:

ids
リンクしているページのページIDを追加します (alunique とは同時に使用できません)。
title
リンクのページ名を追加します。
値 (|もしくは別の文字列で区切る): ids、title
Default: title
alnamespace

列挙する名前空間。

値 (次の値のいずれか1つ): -1、-2、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
Default: 0
allimit

返す項目の総数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
aldir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
例:
B で始まるリンクされたページ (存在しないページも含む)を、リンク元のページIDとともに表示する。
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)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Enumerate all pages sequentially in a given namespace.

パラメーター:
apfrom

列挙を開始するページ名。

apcontinue

When more results are available, use this to continue.

apto

列挙を終了するページ名。

apprefix

この値で始まるすべてのページ名を検索します。

apnamespace

列挙する名前空間。

値 (次の値のいずれか1つ): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
Default: 0
apfilterredir

リストするページ

値 (次の値のいずれか1つ): all、nonredirects、redirects
Default: all
apminsize

ページの最低バイト数を制限する。

型: 整数
apmaxsize

ページの最大バイト数を制限する。

型: 整数
apprtype

保護されているページに絞り込む。

値 (|もしくは別の文字列で区切る): edit、move、upload
apprlevel

保護レベルで絞り込む (aptype= パラメーターと同時に使用しなければなりません)。

値 (|もしくは別の文字列で区切る): Can be empty, or autoconfirmed、sysop
apprfiltercascade

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

値 (次の値のいずれか1つ): all、cascading、noncascading
Default: all
aplimit

返すページの総数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
apdir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
apfilterlanglinks

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

値 (次の値のいずれか1つ): all、withlanglinks、withoutlanglinks
Default: all
apprexpiry

Which protection expiry to filter the page on:

indefinite
Get only pages with indefinite protection expiry.
definite
Get only pages with a definite (specific) protection expiry.
all
Get pages with any protections expiry.
値 (次の値のいずれか1つ): all、definite、indefinite
Default: all

list=allredirects (ar)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ある名前空間へのすべての転送を一覧表示する。

パラメーター:
arcontinue

When more results are available, use this to continue.

arfrom

列挙を開始するリダイレクトのページ名。

arto

列挙を終了するリダイレクトのページ名。

arprefix

この値で始まるすべてのページを検索する。

arunique

転送先ページ名を一度だけ表示します。arprop=ids|fragment|interwiki とは同時に使用できません。ジェネレーターとして使用される場合、転送元ではなく転送先のページを生成します。

型: 真偽値 (詳細)
arprop

どの情報を結果に含めるか:

ids
転送ページのページIDを追加します (arunique とは同時に使用できません)。
title
転送ページのページ名を追加します。
fragment
Adds the fragment from the redirect, if any (cannot be used with arunique).
interwiki
Adds the interwiki prefix from the redirect, if any (cannot be used with arunique).
値 (|もしくは別の文字列で区切る): fragment、ids、interwiki、title
Default: title
arnamespace

列挙する名前空間。

値 (次の値のいずれか1つ): -1、-2、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
Default: 0
arlimit

返す項目の総数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
ardir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
例:
B で始まる転送先ページ (存在しないページも含む)を、転送元のページIDとともに表示する。
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)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

すべての版を一覧表示する。

パラメーター:
arvprop

Which properties to get for each revision:

ids
版のID。
flags
Revision flags (minor).
timestamp
版のタイムスタンプ。
user
その版を作成した利用者。
userid
その版の作成者の利用者ID。
size
その版の長さ (バイト) 。
slotsize
Length (bytes) of each revision slot.
sha1
SHA-1 (base 16) of the revision. If the content has been revision deleted, a sha1hidden property will be returned.
slotsha1
SHA-1 (base 16) of each revision slot. If the content has been revision deleted, a sha1hidden property will be returned.
contentmodel
Content model ID of each revision slot.
comment
その版の利用者によるコメント。
parsedcomment
その版の利用者による、構文解析されたコメント。
content
各リビジョンスロットの内容。
tags
その版のタグ。
roles
List content slot roles that exist in the revision.
parsetree
廃止予定です。 Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model wikitext).
値 (|もしくは別の文字列で区切る): comment、content、contentmodel、flags、ids、parsedcomment、roles、sha1、size、slotsha1、slotsize、tags、timestamp、user、userid、parsetree
Default: ids|timestamp|flags|comment|user
arvslots

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

値 (|もしくは別の文字列で区切る): main
すべての値を指定するには、*を用いてください。
arvlimit

返す版の数を制限する。

型: 整数または max
The value must be between 1 and 500.
arvexpandtemplates
廃止予定です。

Use action=expandtemplates instead. Expand templates in revision content (requires arvprop=content).

型: 真偽値 (詳細)
arvgeneratexml
廃止予定です。

Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires arvprop=content).

型: 真偽値 (詳細)
arvparse
廃止予定です。

Use action=parse instead. Parse revision content (requires arvprop=content). For performance reasons, if this option is used, arvlimit is enforced to 1.

型: 真偽値 (詳細)
arvsection

Only retrieve the content of this section number.

arvdiffto
廃止予定です。

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

arvdifftotext
廃止予定です。

Use action=compare instead. Text to diff each revision to. Only diffs a limited number of revisions. Overrides arvdiffto. If arvsection is set, only that section will be diffed against this text.

arvdifftotextpst
廃止予定です。

Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with arvdifftotext.

型: 真偽値 (詳細)
arvcontentformat
廃止予定です。

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

値 (次の値のいずれか1つ): application/json、text/css、text/javascript、text/plain、text/x-wiki
arvuser

この利用者による版のみを一覧表示する。

型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
arvnamespace

この名前空間に含まれるページのみを一覧表示します。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
arvstart

列挙の始点となるタイムスタンプ。

Type: timestamp (allowed formats)
arvend

列挙の終点となるタイムスタンプ。

Type: timestamp (allowed formats)
arvdir

列挙の方向:

newer
古いものを先に表示します。注意: arvstart は arvend 以前でなければなりません。
older
新しいものを先に表示します (既定)。注意: arvstart は arvend 以降でなければなりません。
値 (次の値のいずれか1つ): newer、older
Default: older
arvexcludeuser

この利用者による版を一覧表示しない。

型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
arvcontinue

When more results are available, use this to continue.

arvgeneratetitles

ジェネレーターとして使用する場合、版IDではなくページ名を生成します。

型: 真偽値 (詳細)

list=alltransclusions (at)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

存在しないものも含めて、すべての参照読み込み ({{x}} で埋め込まれたページ) を一覧表示します。

パラメーター:
atcontinue

When more results are available, use this to continue.

atfrom

列挙を開始する参照読み込みのページ名。

atto

列挙を終了する参照読み込みのページ名。

atprefix

この値で始まるすべての参照読み込みされているページを検索する。

atunique

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

型: 真偽値 (詳細)
atprop

どの情報を結果に含めるか:

ids
参照元のページIDを追加します (atunique とは同時に使用できません)。
title
参照読み込みのページ名を追加します。
値 (|もしくは別の文字列で区切る): ids、title
Default: title
atnamespace

列挙する名前空間。

値 (次の値のいずれか1つ): -1、-2、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
Default: 10
atlimit

返す項目の総数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
atdir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
例:
参照読み込みされているページ (存在しないページも含む) を、参照元のページIDとともに、B で始まるものから一覧表示する。
api.php?action=query&list=alltransclusions&atfrom=B&atprop=ids|title [サンドボックスで開く]
List unique transcluded titles.
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)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

すべての登録利用者を一覧表示します。

パラメーター:
aufrom

列挙を開始する利用者名。

auto

列挙を終了する利用者名。

auprefix

この値で始まるすべての利用者を検索する。

audir

並べ替えの方向。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
augroup

このグループに所属する利用者のみを結果に含める。

値 (|もしくは別の文字列で区切る): bot、bureaucrat、checkuser、flow-bot、interface-admin、semiop、smwadministrator、smwcurator、smweditor、suppress、sysop
auexcludegroup

このグループに所属する利用者を結果から除外する。

値 (|もしくは別の文字列で区切る): bot、bureaucrat、checkuser、flow-bot、interface-admin、semiop、smwadministrator、smwcurator、smweditor、suppress、sysop
aurights

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

値 (|もしくは別の文字列で区切る): abusefilter-hidden-log、abusefilter-hide-log、abusefilter-log、abusefilter-log-detail、abusefilter-log-private、abusefilter-modify、abusefilter-modify-global、abusefilter-modify-restricted、abusefilter-privatedetails、abusefilter-privatedetails-log、abusefilter-revert、abusefilter-view、abusefilter-view-private、apihighlimits、applychangetags、autoconfirmed、autocreateaccount、autopatrol、bigdelete、block、blockemail、bot、browsearchive、changetags、checkuser、checkuser-log、createaccount、createpage、createtalk、delete、deletechangetags、deletedhistory、deletedtext、deletelogentry、deleterevision、edit、editcontentmodel、editinterface、editmyoptions、editmyprivateinfo、editmyusercss、editmyuserjs、editmyuserjson、editmyuserjsredirect、editmywatchlist、editprotected、editsemiprotected、editsitecss、editsitejs、editsitejson、editusercss、edituserjs、edituserjson、flow-create-board、flow-delete、flow-edit-post、flow-hide、flow-lock、flow-suppress、gadgets-definition-edit、gadgets-edit、hideuser、import、importupload、interwiki、ipblock-exempt、managechangetags、markbotedits、mergehistory、minoredit、move、move-categorypages、move-rootuserpages、move-subpages、movefile、nominornewtalk、noratelimit、nuke、oathauth-api-all、oathauth-disable-for-user、oathauth-enable、oathauth-verify-user、oathauth-view-log、override-export-depth、pagelang、patrol、patrolmarks、protect、purge、read、renameuser、replacetext、reupload、reupload-own、reupload-shared、rollback、sendemail、siteadmin、skipcaptcha、spamblacklistlog、suppressionlog、suppressredirect、suppressrevision、tboverride、tboverride-account、titleblacklistlog、unblockself、undelete、unwatchedpages、upload、upload_by_url、usermerge、userrights、userrights-interwiki、viewmyprivateinfo、viewmywatchlist、viewsuppressed、writeapi
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
auprop

どの情報を結果に含めるか:

blockinfo
利用者に対する現在のブロックに関する情報を追加します。
groups
利用者が所属する利用者グループを一覧表示します。これはサーバー資源を多めに使用するので、返る結果が制限値より少なくなります。
implicitgroups
Lists all the groups the user is automatically in.
rights
利用者が持っている権限を一覧表示します。
editcount
利用者の編集回数を追加します。
registration
可能な場合、利用者の登録日時のタイムスタンプを追加します (空白になるかもしれません)。
centralids
Adds the central IDs and attachment status for the user.
値 (|もしくは別の文字列で区切る): blockinfo、centralids、editcount、groups、implicitgroups、registration、rights
aulimit

返す利用者名の総数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
auwitheditsonly

編集履歴のある利用者のみ一覧表示する。

型: 真偽値 (詳細)
auactiveusers

最近 30 日間のアクティブな利用者のみを一覧表示する。

型: 真偽値 (詳細)
auattachedwiki

With auprop=centralids, also indicate whether the user is attached with the wiki identified by this ID.

例:
Y で始まる利用者を一覧表示する。
api.php?action=query&list=allusers&aufrom=Y [サンドボックスで開く]
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

与えられたページにリンクしているすべてのページを検索します。

パラメーター:
bltitle

検索するページ名。blpageid とは同時に使用できません。

blpageid

検索するページID。bltitleとは同時に使用できません。

型: 整数
blcontinue

When more results are available, use this to continue.

blnamespace

列挙する名前空間。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
bldir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
blfilterredir

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

値 (次の値のいずれか1つ): all、nonredirects、redirects
Default: all
bllimit

返すページの総数。blredirect を有効化した場合は、各レベルに対し個別にlimitが適用されます (つまり、最大で 2 * bllimit 件の結果が返されます)。

型: 整数または max
The value must be between 1 and 500.
Default: 10
blredirect

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

型: 真偽値 (詳細)

list=blocks (bk)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ブロックされた利用者とIPアドレスを一覧表示します。

パラメーター:
bkstart

列挙の始点となるタイムスタンプ。

Type: timestamp (allowed formats)
bkend

列挙の終点となるタイムスタンプ。

Type: timestamp (allowed formats)
bkdir

列挙の方向:

newer
古いものを先に表示します。注意: bkstart は bkend 以前でなければなりません。
older
新しいものを先に表示します (既定)。注意: bkstart は bkend 以降でなければなりません。
値 (次の値のいずれか1つ): newer、older
Default: older
bkids

一覧表示するブロックIDのリスト (任意)。

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
bkusers

検索対象の利用者のリスト (任意)。

型: 利用者名、IP および IP範囲のいずれかを使った利用者のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
bkip

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

bklimit

一覧表示するブロックの最大数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
bkprop

取得するプロパティ:

id
ブロックのIDを追加します。
user
ブロックされた利用者の利用者名を追加します。
userid
ブロックされた利用者の利用者IDを追加します。
by
ブロック実行者の利用者名を追加します。
byid
ブロック実行者の利用者IDを追加します。
timestamp
ブロックが与えられたときのタイムスタンプを追加します。
expiry
ブロックの有効期限が切れたときのタイムスタンプを追加します。
reason
ブロックに指定された理由を追加します。
range
ブロックの影響を受けたIPアドレスの範囲を追加します。
flags
(autoblock, anononly, などとの) ban をタグ付けします。
restrictions
Adds the partial block restrictions if the block is not sitewide.
値 (|もしくは別の文字列で区切る): by、byid、expiry、flags、id、range、reason、restrictions、timestamp、user、userid
Default: id|user|by|timestamp|expiry|reason|flags
bkshow

これらの基準を満たす項目のみを表示します。 たとえば、IPアドレスの無期限ブロックのみを表示するには、bkshow=ip|!temp を設定します。

値 (|もしくは別の文字列で区切る): !account、!ip、!range、!temp、account、ip、range、temp
bkcontinue

When more results are available, use this to continue.

例:
ブロックを一覧表示する。
api.php?action=query&list=blocks [サンドボックスで開く]
利用者Alice および Bob のブロックを一覧表示する。
api.php?action=query&list=blocks&bkusers=Alice|Bob [サンドボックスで開く]

list=categorymembers (cm)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

与えられたカテゴリ内のすべてのページを一覧表示します。

パラメーター:
cmtitle

一覧表示するカテゴリ (必須)。カテゴリ: 接頭辞を含まなければなりません。cmpageid とは同時に使用できません。

cmpageid

一覧表示するカテゴリのページID. cmtitle とは同時に使用できません。

型: 整数
cmprop

どの情報を結果に含めるか:

ids
ページIDを追加します。
title
ページ名と名前空間IDを追加します。
sortkey
カテゴリでの並べ替えに使用するソートキーを追加します (16進数文字列)。
sortkeyprefix
Adds the sortkey prefix used for sorting in the category (human-readable part of the sortkey).
type
Adds the type that the page has been categorised as (page, subcat or file).
timestamp
ページが含まれていたときのタイムスタンプを追加します。
値 (|もしくは別の文字列で区切る): ids、sortkey、sortkeyprefix、timestamp、title、type
Default: ids|title
cmnamespace

Only include pages in these namespaces. Note that cmtype=subcat or cmtype=file may be used instead of cmnamespace=14 or 6.

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
cmtype

Which type of category members to include. Ignored when cmsort=timestamp is set.

値 (|もしくは別の文字列で区切る): file、page、subcat
Default: page|subcat|file
cmcontinue

When more results are available, use this to continue.

cmlimit

返すページの最大数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
cmsort

並べ替えに使用するプロパティ。

値 (次の値のいずれか1つ): sortkey、timestamp
Default: sortkey
cmdir

In which direction to sort.

値 (次の値のいずれか1つ): asc、ascending、desc、descending、newer、older
Default: ascending
cmstart

列挙の始点となるタイムスタンプ。cmsort=timestampを指定した場合のみ使用できます。

Type: timestamp (allowed formats)
cmend

列挙の終点となるタイムスタンプ。cmsort=timestampを指定した場合のみ使用できます。

Type: timestamp (allowed formats)
cmstarthexsortkey

Sortkey to start listing from, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.

cmendhexsortkey

Sortkey to end listing at, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.

cmstartsortkeyprefix

列挙の始点となるソートキーの接頭辞。cmsort=sortkeyを指定した場合のみ使用できます。cmstarthexsortkeyをオーバーライドします。

cmendsortkeyprefix

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

cmstartsortkey
廃止予定です。

代わりに cmstarthexsortkey を使用してください。

cmendsortkey
廃止予定です。

代わりに cmendhexsortkey を使用してください。

例:
Category:Physics に含まれる最初の10ページを取得する。
api.php?action=query&list=categorymembers&cmtitle=Category:Physics [サンドボックスで開く]
Category:Physics に含まれる最初の10ページのページ情報を取得する。
api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info [サンドボックスで開く]

list=checkuser (cu)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: CheckUser
  • ライセンス: GPL-2.0-or-later

指定した利用者名の利用者が使用した IPアドレス や、指定した IPアドレス を使用した利用者名を調査します。

パラメーター:
curequest

利用者調査リクエストの種類です:

userips
対象利用者の IPアドレス を取得します。
edits
対象 IPアドレス または IPアドレス 範囲による編集を取得します。
ipusers
対象 IPアドレス または IPアドレス 範囲を使用した利用者を取得します。
このパラメーターは必須です。
値 (次の値のいずれか1つ): edits、ipusers、userips
cutarget

調査する利用者名、IP アドレス、CIDR 範囲のいずれかです。

このパラメーターは必須です。
cureason

調査の理由です。

culimit

行数の上限です。

型: 整数または max
The value must be between 1 and 500.
Default: 500
cutimecond

利用者データの期間の上限です (例: "-2 weeks" または "2 weeks ago")。

Default: -2 weeks
cuxff

IPアドレス の代わりに XFF データを使用します。

cutoken

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

list=checkuserlog (cul)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: CheckUser
  • ライセンス: GPL-2.0-or-later

利用者調査の記録から項目を取得します。

パラメーター:
culuser

利用者調査の実行者の利用者名です。

cultarget

調査する対象の利用者、IP アドレス、CIDR範囲のいずれかです。

cullimit

行数の上限です。

型: 整数または max
The value must be between 1 and 500.
Default: 10
culdir

列挙の方向:

newer
古いものを先に表示します。注意: culstart は culend 以前でなければなりません。
older
新しいものを先に表示します (既定)。注意: culstart は culend 以降でなければなりません。
値 (次の値のいずれか1つ): newer、older
Default: older
culfrom

一覧の開始点となる日時

Type: timestamp (allowed formats)
culto

一覧の終了点となる日時

Type: timestamp (allowed formats)
culcontinue

When more results are available, use this to continue.

list=deletedrevs (dr)

  • このモジュールは廃止予定です。
  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

削除された版を一覧表示します。

Operates in three modes:

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

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

パラメーター:
drstart

列挙の始点となるタイムスタンプ。

モード: 1、2
Type: timestamp (allowed formats)
drend

列挙の終点となるタイムスタンプ。

モード: 1、2
Type: timestamp (allowed formats)
drdir

列挙の方向:

newer
古いものを先に表示します。注意: drstart は drend 以前でなければなりません。
older
新しいものを先に表示します (既定)。注意: drstart は drend 以降でなければなりません。
モード: 1、3
値 (次の値のいずれか1つ): newer、older
Default: older
drfrom

列挙の始点となるページ名。

モード: 3
drto

列挙の終点となるページ名。

モード: 3
drprefix

Search for all page titles that begin with this value.

モード: 3
drunique

List only one revision for each page.

モード: 3
型: 真偽値 (詳細)
drnamespace

この名前空間に含まれるページのみを一覧表示します。

モード: 3
値 (次の値のいずれか1つ): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
Default: 0
drtag

このタグが付与された版のみを一覧表示する。

druser

この利用者による版のみを一覧表示する。

型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
drexcludeuser

この利用者による版を一覧表示しない。

型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
drprop

どの情報を取得するか:

revid
削除された版の版IDを追加します。
parentid
ページの前の版の版IDを追加します。
user
版を作成した利用者を追加します。
userid
版を作成した利用者のIDを追加します。
comment
版のコメントを追加します。
parsedcomment
版のコメントを構文解析して追加します。
minor
版が細部の編集かどうか印をつけます。
len
版の長さ (バイト) を追加します。
sha1
版のSHA-1 (base 16) を追加します。
content
版の内容を追加します。
token
廃止予定です。編集トークンを返します。
tags
版のタグです。
値 (|もしくは別の文字列で区切る): comment、content、len、minor、parentid、parsedcomment、revid、sha1、tags、token、user、userid
Default: user|comment
drlimit

一覧表示する版の最大量。

型: 整数または max
The value must be between 1 and 500.
Default: 10
drcontinue

When more results are available, use this to continue.

例:
ページ Main Page および Talk:Main Page の最後に削除された版を内容と共に一覧表示する(モード 1)。
api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content [サンドボックスで開く]
Bob による、削除された最後の50投稿を一覧表示する(モード 2)。
api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50 [サンドボックスで開く]
標準名前空間にある削除された最初の50版を一覧表示する(モード 3)。
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50 [サンドボックスで開く]
トーク名前空間にある削除された最初の50版を一覧表示する(モード 3)。
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique= [サンドボックスで開く]

list=embeddedin (ei)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

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

パラメーター:
eititle

検索するページ名。eipageid とは同時に使用できません。

eipageid

検索するページID. eititleとは同時に使用できません。

型: 整数
eicontinue

When more results are available, use this to continue.

einamespace

列挙する名前空間。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
eidir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
eifilterredir

転送ページを絞り込む方法。

値 (次の値のいずれか1つ): all、nonredirects、redirects
Default: all
eilimit

返すページの総数。

型: 整数または max
The value must be between 1 and 500.
Default: 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)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

与えられたURLを含むページを一覧表示します。

パラメーター:
euprop

どの情報を結果に含めるか:

ids
ページのIDを追加します。
title
ページ名と名前空間IDを追加します。
url
ページ内で使用されているURLを追加します。
値 (|もしくは別の文字列で区切る): ids、title、url
Default: ids|title|url
eucontinue

When more results are available, use this to continue.

euprotocol

URLのプロトコル。このパラメーターが空であり、かつeuquery が設定されている場合, protocol は http となります。すべての外部リンクを一覧表示するためにはこのパラメーターと euquery の両方を空にしてください。

値 (次の値のいずれか1つ): Can be empty, or bitcoin、ftp、ftps、geo、git、gopher、http、https、irc、ircs、magnet、mailto、mms、news、nntp、redis、sftp、sip、sips、sms、ssh、svn、tel、telnet、urn、worldwind、xmpp
既定値: (空)
euquery

プロトコルを除いた検索文字列。Special:LinkSearch も参照してください。すべての外部リンクを一覧表示するには空欄にしてください。

eunamespace

列挙するページ名前空間。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
eulimit

返すページの数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
euexpandurl

Expand protocol-relative URLs with the canonical protocol.

型: 真偽値 (詳細)

list=filearchive (fa)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

削除されたファイルをすべて順に列挙します。

パラメーター:
fafrom

列挙の始点となる画像のページ名。

fato

列挙の終点となる画像のページ名。

faprefix

Search for all image titles that begin with this value.

fadir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
fasha1

画像の SHA1 ハッシュ値。fasha1base36 をオーバーライドします。

fasha1base36

SHA1 hash of image in base 36 (used in MediaWiki).

faprop

どの画像情報を取得するか:

sha1
Adds SHA-1 hash for the image.
timestamp
バージョンがアップロードされたタイムスタンプを追加します。
user
画像のバージョンをアップロードした利用者を追加します。
size
バイト単位での画像や高さ、幅、ページ数のサイズを追加します(該当する場合)。
dimensions
Alias for size.
description
Adds description of the image version.
parseddescription
Parse the description of the version.
mime
画像の MIME を追加します。
mediatype
画像のメディア・タイプを追加します。
metadata
画像のバージョンの Exif メタデータを一覧表示します。
bitdepth
バージョンのビット深度を追加します。
archivename
非最新バージョンのアーカイブバージョンのファイル名を追加します。
値 (|もしくは別の文字列で区切る): archivename、bitdepth、description、dimensions、mediatype、metadata、mime、parseddescription、sha1、size、timestamp、user
Default: timestamp
falimit

How many images to return in total.

型: 整数または max
The value must be between 1 and 500.
Default: 10
facontinue

When more results are available, use this to continue.

例:
削除されたファイルの一覧を表示する。
api.php?action=query&list=filearchive [サンドボックスで開く]

list=gadgetcategories (gc)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Gadgets
  • ライセンス: GPL-2.0-or-later

ガジェットのカテゴリの一覧を返します。

パラメーター:
gcprop

ガジェットのカテゴリのどの情報を取得するかです:

name
内部カテゴリ名です。
title
カテゴリ名です。
members
カテゴリ内のガジェット数です。
値 (|もしくは別の文字列で区切る): members、name、title
Default: name
gcnames

取得するカテゴリの名前です。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
例:
既存のガジェットのカテゴリの一覧を取得
api.php?action=query&list=gadgetcategories [サンドボックスで開く]
「foo」および「bar」という名前のカテゴリについてすべての情報を取得
api.php?action=query&list=gadgetcategories&gcnames=foo|bar&gcprop=name|title|members [サンドボックスで開く]

list=gadgets (ga)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Gadgets
  • ライセンス: GPL-2.0-or-later

このウィキで使用されているガジェットの一覧を返します。

パラメーター:
gaprop

ガジェットのどの情報を取得するかです:

id
内部ガジェット ID です。
metadata
ガジェットのメタデータです。
desc
ガジェットの説明を HTML 形式に変換したものです (時間がかかる場合があるため、本当に必要な場合のみ使用してください)。
値 (|もしくは別の文字列で区切る): desc、id、metadata
Default: id|metadata
gacategories

どのカテゴリからガジェットを取得するかです。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
gaids

取得するガジェットの ID です。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
gaallowedonly

現在の利用者が使用できるガジェットのみを列挙します。

型: 真偽値 (詳細)
gaenabledonly

現在の利用者が有効にしているガジェットのみを列挙します。

型: 真偽値 (詳細)
例:
ガジェットの一覧を、各ガジェットの説明も含めて取得
api.php?action=query&list=gadgets&gaprop=id|desc [サンドボックスで開く]
ガジェットの一覧を、すべてのプロパティを含めて取得
api.php?action=query&list=gadgets&gaprop=id|metadata|desc [サンドボックスで開く]
カテゴリ「foo」に属するガジェットの一覧を取得
api.php?action=query&list=gadgets&gacategories=foo [サンドボックスで開く]
ガジェット「foo」および「bar」についての情報を取得
api.php?action=query&list=gadgets&gaids=foo|bar&gaprop=id|desc|metadata [サンドボックスで開く]
現在の利用者が有効にしているガジェットの一覧を取得
api.php?action=query&list=gadgets&gaenabledonly [サンドボックスで開く]

list=imageusage (iu)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Find all pages that use the given image title.

パラメーター:
iutitle

検索するページ名。iupageid とは同時に使用できません。

iupageid

検索するページID. iutitleとは同時に使用できません。

型: 整数
iucontinue

When more results are available, use this to continue.

iunamespace

列挙する名前空間。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
iudir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
iufilterredir

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

値 (次の値のいずれか1つ): all、nonredirects、redirects
Default: all
iulimit

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

型: 整数または max
The value must be between 1 and 500.
Default: 10
iuredirect

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

型: 真偽値 (詳細)
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Find all pages that link to the given interwiki link.

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

パラメーター:
iwblprefix

インターウィキ接頭辞。

iwbltitle

検索するウィキ間リンク。iwblblprefixと同時に使用しなければなりません。

iwblcontinue

When more results are available, use this to continue.

iwbllimit

返すページの総数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
iwblprop

取得するプロパティ:

iwprefix
インターウィキ接頭辞を追加します。
iwtitle
ウィキ間リンクのページ名を追加します。
値 (|もしくは別の文字列で区切る): iwprefix、iwtitle
既定値: (空)
iwbldir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

与えられた言語間リンクにリンクしているすべてのページを返します。

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

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

パラメーター:
lbllang

言語間リンクの言語。

lbltitle

検索する言語間リンク。lbllang と同時に使用しなければなりません。

lblcontinue

When more results are available, use this to continue.

lbllimit

返すページの総数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
lblprop

取得するプロパティ:

lllang
言語間リンクの言語コードを追加します。
lltitle
言語間リンクのページ名を追加します。
値 (|もしくは別の文字列で区切る): lllang、lltitle
既定値: (空)
lbldir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending

list=logevents (le)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Get events from logs.

パラメーター:
leprop

取得するプロパティ:

ids
記録イベントのIDを追加します。
title
記録イベントにページ名を追加します。
type
記録イベントのタイプを追加します。
user
Adds the user responsible for the log event.
userid
Adds the user ID who was responsible for the log event.
timestamp
Adds the timestamp for the log event.
comment
記録イベントのコメントを追加します。
parsedcomment
記録イベントの構文解析されたコメントを追加します。
details
記録イベントに関する追加の詳細を一覧表示します。
tags
記録イベントのタグを一覧表示します。
値 (|もしくは別の文字列で区切る): comment、details、ids、parsedcomment、tags、timestamp、title、type、user、userid
Default: ids|title|type|user|timestamp|comment|details
letype

このタイプの記録項目のみに絞り込む。

値 (次の値のいずれか1つ): Can be empty, or abusefilter、abusefilterprivatedetails、block、contentmodel、create、delete、import、interwiki、managetags、merge、move、newusers、oath、patrol、protect、renameuser、rights、smw、spamblacklist、suppress、tag、thanks、titleblacklist、upload、usermerge
leaction

Filter log actions to only this action. Overrides letype. In the list of possible values, values with the asterisk wildcard such as action/* can have different strings after the slash (/).

値 (次の値のいずれか1つ): abusefilter/create、abusefilter/hit、abusefilter/modify、abusefilterprivatedetails/access、block/block、block/reblock、block/unblock、contentmodel/change、contentmodel/new、create/create、delete/delete、delete/delete_redir、delete/event、delete/flow-delete-post、delete/flow-delete-topic、delete/flow-restore-post、delete/flow-restore-topic、delete/restore、delete/revision、import/interwiki、import/lqt-to-flow-topic、import/upload、interwiki/*、lock/flow-lock-topic、lock/flow-restore-topic、managetags/activate、managetags/create、managetags/deactivate、managetags/delete、merge/merge、move/move、move/move_redir、newusers/autocreate、newusers/byemail、newusers/create、newusers/create2、newusers/newusers、oath/*、patrol/autopatrol、patrol/patrol、protect/modify、protect/move_prot、protect/protect、protect/unprotect、renameuser/renameuser、rights/autopromote、rights/blockautopromote、rights/restoreautopromote、rights/rights、spamblacklist/*、suppress/block、suppress/delete、suppress/event、suppress/flow-restore-post、suppress/flow-restore-topic、suppress/flow-suppress-post、suppress/flow-suppress-topic、suppress/hide-afl、suppress/reblock、suppress/revision、suppress/unhide-afl、tag/update、thanks/*、titleblacklist/*、upload/overwrite、upload/revert、upload/upload、usermerge/*
lestart

列挙の始点となるタイムスタンプ。

Type: timestamp (allowed formats)
leend

列挙の終点となるタイムスタンプ。

Type: timestamp (allowed formats)
ledir

列挙の方向:

newer
古いものを先に表示します。注意: lestart は leend 以前でなければなりません。
older
新しいものを先に表示します (既定)。注意: lestart は leend 以降でなければなりません。
値 (次の値のいずれか1つ): newer、older
Default: older
leuser

与えられた利用者による記録項目に絞り込む。

型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
letitle

そのページに関連する記録項目に絞り込む。

lenamespace

与えられた名前空間内の記録項目に絞り込む。

値 (次の値のいずれか1つ): -1、-2、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
leprefix

この接頭辞ではじまる記録項目に絞り込む。

letag

このタグが付与された記録項目のみ表示する。

lelimit

返す記録項目の総数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
lecontinue

When more results are available, use this to continue.

例:
最近の記録項目を一覧表示する。
api.php?action=query&list=logevents [サンドボックスで開く]

list=mystashedfiles (msf)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Get a list of files in the current user's upload stash.

パラメーター:
msfprop

ファイルのどのプロパティを取得するか。

size
ファイルサイズと画像の大きさを取得します。
type
ファイルの MIME タイプとメディアタイプを取得します。
値 (|もしくは別の文字列で区切る): size、type
既定値: (空)
msflimit

取得するファイルの数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
msfcontinue

When more results are available, use this to continue.

例:
Get the filekey, file size, and pixel size of files in the current user's upload stash.
api.php?action=query&list=mystashedfiles&msfprop=size [サンドボックスで開く]

list=pagepropnames (ppn)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Wiki内で使用されているすべてのページプロパティ名を一覧表示します。

パラメーター:
ppncontinue

When more results are available, use this to continue.

ppnlimit

返す名前の最大数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
例:
最初の10個のプロパティ名を取得する。
api.php?action=query&list=pagepropnames [サンドボックスで開く]

list=pageswithprop (pwp)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

与えられたページプロパティが使用されているすべてのページを一覧表示します。

パラメーター:
pwppropname

Page property for which to enumerate pages (action=query&list=pagepropnames returns page property names in use).

このパラメーターは必須です。
pwpprop

どの情報を結果に含めるか:

ids
ページIDを追加します。
title
ページ名と名前空間IDを追加します。
value
ページプロパティの値を追加。
値 (|もしくは別の文字列で区切る): ids、title、value
Default: ids|title
pwpcontinue

When more results are available, use this to continue.

pwplimit

返すページの最大数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
pwpdir

In which direction to sort.

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
例:
{{DISPLAYTITLE:}} を使用している最初の10ページを一覧表示する。
api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value [サンドボックスで開く]
__NOTOC__ を使用している最初の10ページについての追加情報を取得する。
api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info [サンドボックスで開く]

list=prefixsearch (ps)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページ名の先頭一致検索を行います。

名前が似ていますが、このモジュールはSpecial:PrefixIndexと等価であることを意図しません。そのような目的ではaction=query&list=allpagesapprefix パラメーターと共に使用してください。このモジュールの目的は action=opensearch と似ています: 利用者から入力を受け取り、最も適合するページ名を提供するというものです。検索エンジンのバックエンドによっては、誤入力の訂正や、転送の回避、その他のヒューリスティクスが適用されることがあります。

パラメーター:
pssearch

検索文字列。

このパラメーターは必須です。
psnamespace

検索する名前空間。pssearchが有効な名前空間接頭辞で始まる場合は無視されます。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
Default: 0
pslimit

返す結果の最大数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
psoffset

When more results are available, use this to continue.

型: 整数
Default: 0

list=protectedtitles (pt)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

作成保護が掛けられているページを一覧表示します。

パラメーター:
ptnamespace

この名前空間に含まれるページのみを一覧表示します。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
ptlevel

この保護レベルのページのみを一覧表示します。

値 (|もしくは別の文字列で区切る): autoconfirmed、sysop
ptlimit

返すページの総数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
ptdir

列挙の方向:

newer
古いものを先に表示します。注意: ptstart は ptend 以前でなければなりません。
older
新しいものを先に表示します (既定)。注意: ptstart は ptend 以降でなければなりません。
値 (次の値のいずれか1つ): newer、older
Default: older
ptstart

一覧表示の始点となる保護タイムスタンプ。

Type: timestamp (allowed formats)
ptend

一覧表示の終点となる保護タイムスタンプ。

Type: timestamp (allowed formats)
ptprop

取得するプロパティ:

timestamp
Adds the timestamp of when protection was added.
user
Adds the user that added the protection.
userid
Adds the user ID that added the protection.
comment
Adds the comment for the protection.
parsedcomment
Adds the parsed comment for the protection.
expiry
Adds the timestamp of when the protection will be lifted.
level
保護レベルを追加します。
値 (|もしくは別の文字列で区切る): comment、expiry、level、parsedcomment、timestamp、user、userid
Default: timestamp|level
ptcontinue

When more results are available, use this to continue.

例:
保護されているページを一覧表示する。
api.php?action=query&list=protectedtitles [サンドボックスで開く]
標準名前空間にある保護されたページへのリンクを検索する。
api.php?action=query&generator=protectedtitles&gptnamespace=0&prop=linkshere [サンドボックスで開く]

list=querypage (qp)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

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

パラメーター:
qppage

特別ページの名前です。これは大文字小文字を区別することに注意。

このパラメーターは必須です。
値 (次の値のいずれか1つ): Ancientpages、BrokenRedirects、Deadendpages、DoubleRedirects、Fewestrevisions、GadgetUsage、ListDuplicatedFiles、Listredirects、Lonelypages、Longpages、MediaStatistics、Mostcategories、Mostimages、Mostinterwikis、Mostlinked、Mostlinkedcategories、Mostlinkedtemplates、Mostrevisions、Shortpages、Uncategorizedcategories、Uncategorizedimages、Uncategorizedpages、Uncategorizedtemplates、Unusedcategories、Unusedimages、Unusedtemplates、Unwatchedpages、Wantedcategories、Wantedfiles、Wantedpages、Wantedtemplates、Withoutinterwiki
qpoffset

When more results are available, use this to continue.

型: 整数
Default: 0
qplimit

返す結果の数。

型: 整数または max
The value must be between 1 and 500.
Default: 10

list=random (rn)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ランダムなページのセットを取得します。

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

パラメーター:
rnnamespace

この名前空間にあるページのみを返します。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
rnfilterredir

転送ページを絞り込む方法。

値 (次の値のいずれか1つ): all、nonredirects、redirects
Default: nonredirects
rnredirect
廃止予定です。

代わりに rnfilterredir=redirects を使用してください。

型: 真偽値 (詳細)
rnlimit

返す無作為なページの数を制限する。

型: 整数または max
The value must be between 1 and 500.
Default: 1
rncontinue

When more results are available, use this to continue.

例:
標準名前空間から2つのページを無作為に返す。
api.php?action=query&list=random&rnnamespace=0&rnlimit=2 [サンドボックスで開く]
標準名前空間から無作為に選ばれた2つのページのページ情報を返す。
api.php?action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info [サンドボックスで開く]

list=recentchanges (rc)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

最近の更新を一覧表示します。

パラメーター:
rcstart

列挙の始点となるタイムスタンプ。

Type: timestamp (allowed formats)
rcend

列挙の終点となるタイムスタンプ。

Type: timestamp (allowed formats)
rcdir

列挙の方向:

newer
古いものを先に表示します。注意: rcstart は rcend 以前でなければなりません。
older
新しいものを先に表示します (既定)。注意: rcstart は rcend 以降でなければなりません。
値 (次の値のいずれか1つ): newer、older
Default: older
rcnamespace

この名前空間の変更のみに絞り込む。

値 (|もしくは別の文字列で区切る): -1、-2、0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
rcuser

この利用者による変更のみを一覧表示する。

型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
rcexcludeuser

この利用者による変更を一覧表示しない。

型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
rctag

このタグが付与された版のみ一覧表示する。

rcprop

Include additional pieces of information:

user
Adds the user responsible for the edit and tags if they are an IP. If the user has been revision deleted, a userhidden property will be returned.
userid
Adds the user ID responsible for the edit. If the user has been revision deleted, a userhidden property will be returned.
comment
Adds the comment for the edit. If the comment has been revision deleted, a commenthidden property will be returned.
parsedcomment
構文解析された編集コメントを追加します。
flags
編集のフラグを追加します。
timestamp
編集のタイムスタンプを追加します。
title
編集のページ名を追加します。
ids
ページID、最近の更新IDと新旧の版IDを追加します。
sizes
バイト単位の新旧のページの長さを追加します。
redirect
編集されたページが転送ページである場合、印を付けます。
patrolled
巡回可能な編集について、巡回済みかどうか印を付けます。
loginfo
記録項目に記録の情報 (記録ID, 記録タイプなど) を追加します。
tags
エントリのタグを一覧表示します。
sha1
Adds the content checksum for entries associated with a revision. If the content has been revision deleted, a sha1hidden property will be returned.
値 (|もしくは別の文字列で区切る): comment、flags、ids、loginfo、parsedcomment、patrolled、redirect、sha1、sizes、tags、timestamp、title、user、userid
Default: title|timestamp|ids
rctoken
廃止予定です。

代わりに action=query&meta=tokens を使用してください。

値 (|もしくは別の文字列で区切る): patrol
rcshow

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

値 (|もしくは別の文字列で区切る): !anon、!autopatrolled、!bot、!minor、!patrolled、!redirect、anon、autopatrolled、bot、minor、patrolled、redirect、unpatrolled
rclimit

返す変更の総数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
rctype

Which types of changes to show.

値 (|もしくは別の文字列で区切る): categorize、edit、external、log、new
Default: edit|new|log|categorize
rctoponly

最新の版である変更のみを一覧表示する。

型: 真偽値 (詳細)
rctitle

Filter entries to those related to a page.

rccontinue

When more results are available, use this to continue.

rcgeneraterevisions

ジェネレータとして使用される場合、版IDではなくページ名を生成します。関連する版IDのない最近の変更の項目 (例えば、ほとんどの記録項目) は何も生成しません。

型: 真偽値 (詳細)
rcslot

Only list changes that touch the named slot.

値 (次の値のいずれか1つ): main

list=search (sr)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

全文検索を行います。

パラメーター:
srsearch

この値を含むページ名または本文を検索します。Wikiの検索バックエンド実装に応じて、あなたは特別な検索機能を呼び出すための文字列を検索することができます。

このパラメーターは必須です。
srnamespace

この名前空間内のみを検索します。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
Default: 0
srlimit

返すページの総数です。

型: 整数または max
The value must be between 1 and 500.
Default: 10
sroffset

When more results are available, use this to continue.

型: 整数
Default: 0
srwhat

実行する検索の種類です。

値 (次の値のいずれか1つ): nearmatch、text、title
srinfo

どのメタデータを返すか。

値 (|もしくは別の文字列で区切る): rewrittenquery、suggestion、totalhits
Default: totalhits|suggestion|rewrittenquery
srprop

返すプロパティ:

size
バイト単位のページのサイズを追加します。
wordcount
ページのワード数を追加します。
timestamp
ページが最後に編集されたときのタイムスタンプを追加します。
snippet
Adds a parsed snippet of the page.
titlesnippet
Adds a parsed snippet of the page title.
redirecttitle
Adds the title of the matching redirect.
redirectsnippet
Adds a parsed snippet of the redirect title.
sectiontitle
合致するタイトルを追加します。
sectionsnippet
Adds a parsed snippet of the matching section title.
isfilematch
Adds a boolean indicating if the search matched file content.
categorysnippet
Adds a parsed snippet of the matching category.
score
廃止予定です。 Ignored.
hasrelated
廃止予定です。 Ignored.
extensiondata
Adds extra data generated by extensions.
値 (|もしくは別の文字列で区切る): categorysnippet、extensiondata、isfilematch、redirectsnippet、redirecttitle、sectionsnippet、sectiontitle、size、snippet、timestamp、titlesnippet、wordcount、hasrelated、score
Default: size|wordcount|timestamp|snippet
srinterwiki

Include interwiki results in the search, if available.

型: 真偽値 (詳細)
srenablerewrites

Enable internal query rewriting. Some search backends can rewrite the query into another which is thought to provide better results, for instance by correcting spelling errors.

型: 真偽値 (詳細)
srsort

Set the sort order of returned results.

値 (次の値のいずれか1つ): relevance
Default: relevance

list=tags (tg)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

変更タグを一覧表示します。

パラメーター:
tgcontinue

When more results are available, use this to continue.

tglimit

一覧表示するタグの最大数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
tgprop

取得するプロパティ:

displayname
タグのためのシステムメッセージを追加します。
description
タグの説明を追加します。
hitcount
版の記録項目の数と、このタグを持っている記録項目の数を、追加します。
defined
Indicate whether the tag is defined.
source
Gets the sources of the tag, which may include extension for extension-defined tags and manual for tags that may be applied manually by users.
active
Whether the tag is still being applied.
値 (|もしくは別の文字列で区切る): active、defined、description、displayname、hitcount、source
既定値: (空)

list=usercontribs (uc)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

利用者によるすべての編集を取得します。

パラメーター:
uclimit

返す投稿記録の最大数。

型: 整数または max
The value must be between 1 and 500.
Default: 10
ucstart

The start timestamp to return from.

Type: timestamp (allowed formats)
ucend

The end timestamp to return to.

Type: timestamp (allowed formats)
uccontinue

When more results are available, use this to continue.

ucuser

投稿記録を取得する利用者。ucuserids または ucuserprefix とは同時に使用できません。

型: 利用者名、IP および インターウィキの名前(例: "prefix>ExampleName")のいずれかを使った利用者のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
ucuserids

投稿記録を取得する利用者のID。ucuser または ucuserprefix とは同時に使用できません。

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
ucuserprefix

この値で始まる名前のすべての利用者の投稿記録を取得します。ucuser または ucuserids とは同時に使用できません。

ucdir

列挙の方向:

newer
古いものを先に表示します。注意: ucstart は ucend 以前でなければなりません。
older
新しいものを先に表示します (既定)。注意: ucstart は ucend 以降でなければなりません。
値 (次の値のいずれか1つ): newer、older
Default: older
ucnamespace

この名前空間への投稿記録のみを一覧表示する。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
ucprop

Include additional pieces of information:

ids
ページIDと版IDを追加します。
title
ページ名と名前空間IDを追加します。
timestamp
編集のタイムスタンプを追加します。
comment
編集のコメントを追加します。
parsedcomment
構文解析された編集コメントを追加します。
size
編集の新しいサイズを追加します。
sizediff
Adds the size delta of the edit against its parent.
flags
Adds flags of the edit.
patrolled
Tags patrolled edits.
tags
Lists tags for the edit.
値 (|もしくは別の文字列で区切る): comment、flags、ids、parsedcomment、patrolled、size、sizediff、tags、timestamp、title
Default: ids|title|timestamp|comment|size|flags
ucshow

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

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

値 (|もしくは別の文字列で区切る): !autopatrolled、!minor、!new、!patrolled、!top、autopatrolled、minor、new、patrolled、top
uctag

このタグが付与された版のみを一覧表示する。

uctoponly
廃止予定です。

最新の版である変更のみを一覧表示する。

型: 真偽値 (詳細)
例:
利用者 Example の投稿記録を表示する。
api.php?action=query&list=usercontribs&ucuser=Example [サンドボックスで開く]
192.0.2. から始まるすべてのIPアドレスからの投稿記録を表示する。
api.php?action=query&list=usercontribs&ucuserprefix=192.0.2. [サンドボックスで開く]

list=users (us)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

利用者のリストについての情報を取得します。

パラメーター:
usprop

どの情報を結果に含めるか:

blockinfo
Tags if the user is blocked, by whom, and for what reason.
groups
Lists all the groups each user belongs to.
groupmemberships
Lists groups that each user has been explicitly assigned to, including the expiry date of each group membership.
implicitgroups
Lists all the groups a user is automatically a member of.
rights
Lists all the rights each user has.
editcount
Adds the user's edit count.
registration
Adds the user's registration timestamp.
emailable
Tags if the user can and wants to receive email through Special:Emailuser.
gender
Tags the gender of the user. Returns "male", "female", or "unknown".
centralids
Adds the central IDs and attachment status for the user.
cancreate
Indicates whether an account for valid but unregistered usernames can be created.
値 (|もしくは別の文字列で区切る): blockinfo、cancreate、centralids、editcount、emailable、gender、groupmemberships、groups、implicitgroups、registration、rights
usattachedwiki

With usprop=centralids, indicate whether the user is attached with the wiki identified by this ID.

ususers

A list of users to obtain information for.

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
ususerids

A list of user IDs to obtain information for.

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
ustoken
廃止予定です。

代わりに action=query&meta=tokens を使用してください。

値 (|もしくは別の文字列で区切る): userrights

list=watchlist (wl)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

現在の利用者のウォッチリストにあるページへの最近の更新を取得します。

パラメーター:
wlallrev

Include multiple revisions of the same page within given timeframe.

型: 真偽値 (詳細)
wlstart

列挙の始点となるタイムスタンプ。

Type: timestamp (allowed formats)
wlend

列挙の終点となるタイムスタンプ。

Type: timestamp (allowed formats)
wlnamespace

この名前空間の変更のみに絞り込む。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
wluser

この利用者による変更のみを一覧表示する。

型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
wlexcludeuser

この利用者による変更を一覧表示しない。

型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
wldir

列挙の方向:

newer
古いものを先に表示します。注意: wlstart は wlend 以前でなければなりません。
older
新しいものを先に表示します (既定)。注意: wlstart は wlend 以降でなければなりません。
値 (次の値のいずれか1つ): newer、older
Default: older
wllimit

How many total results to return per request.

型: 整数または max
The value must be between 1 and 500.
Default: 10
wlprop

追加で取得するプロパティ:

ids
版IDとページIDを追加します。
title
ページ名を追加します。
flags
編集のフラグを追加します。
user
Adds the user who made the edit. If the user has been revision deleted, a userhidden property will be returned.
userid
Adds user ID of whoever made the edit. If the user has been revision deleted, a userhidden property will be returned.
comment
編集のコメントを追加します。
parsedcomment
編集の構文解析されたコメントを追加します。
timestamp
編集のタイムスタンプを追加します。
patrol
Tags edits that are patrolled.
sizes
Adds the old and new lengths of the page.
notificationtimestamp
Adds timestamp of when the user was last notified about the edit.
loginfo
適切な場合にログ情報を追加します。
tags
Lists tags for the entry.
値 (|もしくは別の文字列で区切る): comment、flags、ids、loginfo、notificationtimestamp、parsedcomment、patrol、sizes、tags、timestamp、title、user、userid
Default: ids|title|flags
wlshow

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

値 (|もしくは別の文字列で区切る): !anon、!autopatrolled、!bot、!minor、!patrolled、!unread、anon、autopatrolled、bot、minor、patrolled、unread
wltype

Which types of changes to show:

edit
Regular page edits.
new
Page creations.
log
Log entries.
external
External changes.
categorize
Category membership changes.
値 (|もしくは別の文字列で区切る): categorize、edit、external、log、new
Default: edit|new|log|categorize
wlowner

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

型: 利用者名を使った利用者
wltoken

A security token (available in the user's preferences) to allow access to another user's watchlist.

wlcontinue

When more results are available, use this to continue.

例:
現在の利用者のウォッチリストにある最近変更されたページの最新版を一覧表示します。
api.php?action=query&list=watchlist [サンドボックスで開く]
Fetch additional information about the top revision for recently changed pages on the current user's watchlist.
api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment [サンドボックスで開く]
Fetch information about all recent changes to pages on the current user's watchlist.
api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment [サンドボックスで開く]
現在の利用者のウォッチリスト上の最近更新されたページに関する情報を取得する。
api.php?action=query&generator=watchlist&prop=info [サンドボックスで開く]
Fetch revision info for recent changes to pages on the current user's watchlist.
api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user [サンドボックスで開く]
List the top revision for recently changed pages on the watchlist of user Example.
api.php?action=query&list=watchlist&wlowner=Example&wltoken=123ABC [サンドボックスで開く]

list=watchlistraw (wr)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

現在の利用者のウォッチリストにあるすべてのページを取得します。

パラメーター:
wrcontinue

When more results are available, use this to continue.

wrnamespace

この名前空間に含まれるページのみを一覧表示します。

値 (|もしくは別の文字列で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、102、103、108、109、112、113、114、115、828、829、2300、2301、2302、2303、2600、3000、3001、3010、3011、3012、3013
すべての値を指定するには、*を用いてください。
wrlimit

How many total results to return per request.

型: 整数または max
The value must be between 1 and 500.
Default: 10
wrprop

追加で取得するプロパティ:

changed
Adds timestamp of when the user was last notified about the edit.
値 (|もしくは別の文字列で区切る): changed
wrshow

Only list items that meet these criteria.

値 (|もしくは別の文字列で区切る): !changed、changed
wrowner

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

型: 利用者名を使った利用者
wrtoken

A security token (available in the user's preferences) to allow access to another user's watchlist.

wrdir

昇順・降順の別。

値 (次の値のいずれか1つ): ascending、descending
Default: ascending
wrfromtitle

Title (with namespace prefix) to begin enumerating from.

wrtotitle

Title (with namespace prefix) to stop enumerating at.

例:
List pages on the current user's watchlist.
api.php?action=query&list=watchlistraw [サンドボックスで開く]
現在の利用者のウォッチリスト上のページに関する情報を取得する。
api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=info [サンドボックスで開く]

meta=allmessages (am)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Return messages from this site.

パラメーター:
ammessages

出力するメッセージ。 * (既定値) は、すべてのメッセージを意味します。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
Default: *
amprop

取得するプロパティ:

値 (|もしくは別の文字列で区切る): default
amenableparser

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

型: 真偽値 (詳細)
amnocontent

設定した場合、出力内のメッセージの内容が含まれていません。

型: 真偽値 (詳細)
amincludelocal

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

型: 真偽値 (詳細)
amargs

メッセージ中に展開される引数。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
amfilter

この文字列を含んだ名前のメッセージのみを返す。

amcustomised

変更された状態のメッセージのみを返す。

値 (次の値のいずれか1つ): all、modified、unmodified
Default: all
amlang

返すメッセージの言語。

amfrom

Return messages starting at this message.

amto

Return messages ending at this message.

amtitle

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

amprefix

この接頭辞を持つメッセージを返す。

例:
ipb- で始まるメッセージを表示する。
api.php?action=query&meta=allmessages&amprefix=ipb- [サンドボックスで開く]
ドイツ語のメッセージ august および mainpage を表示する。
api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de [サンドボックスで開く]

meta=authmanagerinfo (ami)

Retrieve information about the current authentication status.

パラメーター:
amisecuritysensitiveoperation

Test whether the user's current authentication status is sufficient for the specified security-sensitive operation.

amirequestsfor

Fetch information about the authentication requests needed for the specified authentication action.

値 (次の値のいずれか1つ): change、create、create-continue、link、link-continue、login、login-continue、remove、unlink
amimergerequestfields

Merge field information for all authentication requests into one array.

型: 真偽値 (詳細)
amimessageformat

Format to use for returning messages.

値 (次の値のいずれか1つ): html、none、raw、wikitext
Default: wikitext

meta=filerepoinfo (fri)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Return meta information about image repositories configured on the wiki.

パラメーター:
friprop

Which repository properties to get (properties available may vary on other wikis).

apiurl
URL to the repository API - helpful for getting image info from the host.
articlepath
Repository wiki's $wgArticlePath or equivalent.
canUpload
Whether files can be uploaded to this repository, e.g. via CORS and shared authentication.
descriptionCacheExpiry
(説明なし)
displayname
The human-readable name of the repository wiki.
favicon
Repository wiki's favicon URL, from $wgFavicon.
fetchDescription
Whether file description pages are fetched from this repository when viewing local file description pages.
initialCapital
Whether file names implicitly start with a capital letter.
local
Whether that repository is the local one or not.
name
The key of the repository - used in e.g. $wgForeignFileRepos and imageinfo return values.
rootUrl
Root URL path for image paths.
scriptDirUrl
Root URL path for the repository wiki's MediaWiki installation.
server
Repository wiki's $wgServer or equivalent.
thumbUrl
Root URL path for thumbnail paths.
url
Public zone URL path.
値 (|もしくは別の文字列で区切る): apiurl、articlepath、canUpload、descriptionCacheExpiry、displayname、favicon、fetchDescription、initialCapital、local、name、rootUrl、scriptDirUrl、server、thumbUrl、url
Default: apiurl|articlepath|canUpload|descriptionCacheExpiry|displayname|favicon|fetchDescription|initialCapital|local|name|rootUrl|scriptDirUrl|server|thumbUrl|url
例:
ファイルリポジトリについての情報を取得します。
api.php?action=query&meta=filerepoinfo&friprop=apiurl|name|displayname [サンドボックスで開く]

meta=languageinfo (li)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Return information about available languages.

Continuation may be applied if retrieving the information takes too long for one request.

パラメーター:
liprop

Which information to get for each language.

code
The language code. (This code is MediaWiki-specific, though there are overlaps with other standards.)
bcp47
The BCP-47 language code.
dir
The writing direction of the language (either ltr or rtl).
autonym
The autonym of the language, that is, the name in that language.
name
The name of the language in the language specified by the uselang parameter, with language fallbacks applied if necessary.
fallbacks
The language codes of the fallback languages configured for this language. The implicit final fallback to 'en' is not included (but some languages may fall back to 'en' explicitly).
variants
The language codes of the variants supported by this language.
値 (|もしくは別の文字列で区切る): autonym、bcp47、code、dir、fallbacks、name、variants
Default: code
licode

Language codes of the languages that should be returned, or * for all languages.

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
Default: *
licontinue

When more results are available, use this to continue.

meta=notifications (not)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Echo
  • ライセンス: MIT

Get notifications waiting for the current user.

パラメーター:
notfilter

Filter notifications returned.

値 (|もしくは別の文字列で区切る): !read、read
Default: read|!read
notprop

Details to request.

値 (|もしくは別の文字列で区切る): count、list、seenTime
Default: list
notsections

The notification sections to query (i.e. some combination of 'alert' and 'message').

値 (|もしくは別の文字列で区切る): alert、message
Default: alert|message
notgroupbysection

Whether to group the result by section. Each section is fetched separately if set.

型: 真偽値 (詳細)
notformat

If specified, notifications will be returned formatted this way.

model
Raw notification data
special
Formatted for Special:Notifications page (and only that!) Do not rely on the HTML as it may change at any given time.
flyout
Deprecated. Use notformat=model for raw data
html
Deprecated. Use notformat=model for raw data
値 (次の値のいずれか1つ): flyout、html、model、special
notlimit

返す通知の最大数。

型: 整数または max
The value must be between 1 and 50.
Default: 20
notcontinue

When more results are available, use this to continue.

notunreadfirst

Whether to show unread notifications first (only used if groupbysection is not set).

型: 真偽値 (詳細)
nottitles

Only return notifications for these pages. To get notifications not associated with any page, use [] as a title.

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
notbundle

Whether to show bundle compatible unread notifications according to notification types bundling rules.

型: 真偽値 (詳細)
notalertcontinue

When more alert results are available, use this to continue.

notalertunreadfirst

Whether to show unread message notifications first (only used if groupbysection is set).

型: 真偽値 (詳細)
notmessagecontinue

When more message results are available, use this to continue.

notmessageunreadfirst

Whether to show unread alert notifications first (only used if groupbysection is set).

型: 真偽値 (詳細)

meta=oath (oath)

  • このモジュールは内部的または不安定です。動作が予告なく変更される場合があります。
  • このモジュールは読み取りの権限を必要とします。
  • ソース: OATHAuth
  • ライセンス: GPL-2.0-or-later AND GPL-3.0-or-later

Check to see if two-factor authentication (OATH) is enabled for a user.

パラメーター:
oathuser

User to get information about. Defaults to the current user.

型: 利用者名、IP、IP範囲 および インターウィキの名前(例: "prefix>ExampleName")のいずれかを使った利用者

meta=siteinfo (si)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Return general information about the site.

パラメーター:
siprop

どの情報を取得するか:

general
システム全体の情報。
namespaces
List of registered namespaces and their canonical names.
namespacealiases
List of registered namespace aliases.
specialpagealiases
特別ページの別名の一覧。
magicwords
マジックワードとこれらの別名の一覧。
interwikimap
Returns interwiki map (optionally filtered, optionally localised by using siinlanguagecode).
dbrepllag
Returns database server with the highest replication lag.
statistics
Returns site statistics.
usergroups
Returns user groups and the associated permissions.
libraries
Returns libraries installed on the wiki.
extensions
Returns extensions installed on the wiki.
fileextensions
アップロードが許可されているファイル拡張子の一覧を返します。
rightsinfo
Returns wiki rights (license) information if available.
restrictions
Returns information on available restriction (protection) types.
languages
Returns a list of languages MediaWiki supports (optionally localised by using siinlanguagecode).
languagevariants
Returns a list of language codes for which LanguageConverter is enabled, and the variants supported for each.
skins
Returns a list of all enabled skins (optionally localised by using siinlanguagecode, otherwise in the content language).
extensiontags
Returns a list of parser extension tags.
functionhooks
Returns a list of parser function hooks.
showhooks
Returns a list of all subscribed hooks (contents of $wgHooks).
variables
Returns a list of variable IDs.
protocols
Returns a list of protocols that are allowed in external links.
defaultoptions
Returns the default values for user preferences.
uploaddialog
Returns the upload dialog configuration.
値 (|もしくは別の文字列で区切る): dbrepllag、defaultoptions、extensions、extensiontags、fileextensions、functionhooks、general、interwikimap、languages、languagevariants、libraries、magicwords、namespacealiases、namespaces、protocols、restrictions、rightsinfo、showhooks、skins、specialpagealiases、statistics、uploaddialog、usergroups、variables
Default: general
sifilteriw

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

値 (次の値のいずれか1つ): !local、local
sishowalldb

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

型: 真偽値 (詳細)
sinumberingroup

利用者グループに属する利用者の数を一覧表示します。

型: 真偽値 (詳細)
siinlanguagecode

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

meta=tokens

データ変更操作用のトークンを取得します。

パラメーター:
type

リクエストするトークンの種類。

値 (|もしくは別の文字列で区切る): createaccount、csrf、login、patrol、rollback、userrights、watch
Default: csrf
例:
csrfトークンを取得する (既定)。
api.php?action=query&meta=tokens [サンドボックスで開く]
ウォッチトークンおよび巡回トークンを取得する。
api.php?action=query&meta=tokens&type=watch|patrol [サンドボックスで開く]

meta=unreadnotificationpages (unp)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Echo
  • ライセンス: MIT

Get pages for which there are unread notifications for the current user.

パラメーター:
unpgrouppages

Group talk pages together with their subject page, and group notifications not associated with a page together with the current user's user page.

型: 真偽値 (詳細)
unplimit

返すページの最大数。

型: 整数または max
The value must be between 1 and 2,000.
Default: 10
例:
List pages with (their amount of) unread notifications
api.php?action=query&meta=unreadnotificationpages [サンドボックスで開く]

meta=userinfo (ui)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

現在の利用者に関する情報を取得します。

パラメーター:
uiprop

どの情報を結果に含めるか:

blockinfo
Tags if the current user is blocked, by whom, and for what reason.
hasmsg
Adds a tag messages if the current user has pending messages.
groups
Lists all the groups the current user belongs to.
groupmemberships
Lists groups that the current user has been explicitly assigned to, including the expiry date of each group membership.
implicitgroups
Lists all the groups the current user is automatically a member of.
rights
Lists all the rights the current user has.
changeablegroups
Lists the groups the current user can add to and remove from.
options
Lists all preferences the current user has set.
editcount
Adds the current user's edit count.
ratelimits
Lists all rate limits applying to the current user.
email
Adds the user's email address and email authentication date.
realname
利用者の本名を追加します。
acceptlang
Echoes the Accept-Language header sent by the client in a structured format.
registrationdate
Adds the user's registration date.
unreadcount
Adds the count of unread pages on the user's watchlist (maximum 999; returns 1000+ if more).
centralids
Adds the central IDs and attachment status for the user.
preferencestoken
廃止予定です。 Get a token to change current user's preferences.
latestcontrib
Adds the date of user's latest contribution.
値 (|もしくは別の文字列で区切る): acceptlang、blockinfo、centralids、changeablegroups、editcount、email、groupmemberships、groups、hasmsg、implicitgroups、latestcontrib、options、ratelimits、realname、registrationdate、rights、unreadcount、preferencestoken
uiattachedwiki

With uiprop=centralids, indicate whether the user is attached with the wiki identified by this ID.

例:
現在の利用者に関する情報を取得します。
api.php?action=query&meta=userinfo [サンドボックスで開く]
現在の利用者に関する追加情報を取得します。
api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg [サンドボックスで開く]

action=removeauthenticationdata

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Remove authentication data for the current user.

パラメーター:
request

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

このパラメーターは必須です。
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=resetpassword

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Send a password reset email to a user.

パラメーター:
user

User being reset.

型: 利用者名を使った利用者
email

Email address of the user being reset.

token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。
例:
利用者 Example にパスワード再設定のメールを送信する。
api.php?action=resetpassword&user=Example&token=123ABC [サンドボックスで開く]
Send a password reset email for all users with email address user@example.com.
api.php?action=resetpassword&user=user@example.com&token=123ABC [サンドボックスで開く]

action=revisiondelete

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

版の削除および復元を行います。

パラメーター:
type

Type of revision deletion being performed.

このパラメーターは必須です。
値 (次の値のいずれか1つ): archive、filearchive、logging、oldimage、revision
target

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

ids

Identifiers for the revisions to be deleted.

このパラメーターは必須です。
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
hide

What to hide for each revision.

値 (|もしくは別の文字列で区切る): comment、content、user
show

What to unhide for each revision.

値 (|もしくは別の文字列で区切る): comment、content、user
suppress

Whether to suppress data from administrators as well as others.

値 (次の値のいずれか1つ): no、nochange、yes
Default: nochange
reason

削除または復元の理由。

tags

Tags to apply to the entry in the deletion log.

値 (|もしくは別の文字列で区切る):
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=rollback

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページの最後の編集を取り消す。

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

パラメーター:
title

巻き戻すページ名です。pageid とは同時に使用できません。

pageid

巻き戻すページのページIDです。title とは同時に使用できません。

型: 整数
tags

巻き戻しに適用するタグ。

値 (|もしくは別の文字列で区切る):
user

巻き戻し対象の編集を行った利用者名。

このパラメーターは必須です。
型: 利用者名、IP、インターウィキの名前(例: "prefix>ExampleName") および 利用者ID(例: #12345)のいずれかを使った利用者
summary

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

既定値: (空)
markbot

巻き戻された編集と巻き戻しをボットの編集としてマークする。

型: 真偽値 (詳細)
watchlist

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

値 (次の値のいずれか1つ): nochange、preferences、unwatch、watch
Default: preferences
token

action=query&meta=tokens から取得した「rollback」トークン

互換性のために、ウェブUIで使用されるトークンも受理されます。

このパラメーターは必須です。
例:
利用者 Example による Main Page への最後の一連の編集を巻き戻す。
api.php?action=rollback&title=Main%20Page&user=Example&token=123ABC [サンドボックスで開く]
IP利用者 192.0.2.5 による Main Page への最後の一連の編集を Reverting vandalism という理由で、それらの編集とその差し戻しをボットの編集としてマークして差し戻す。
api.php?action=rollback&title=Main%20Page&user=192.0.2.5&token=123ABC&summary=Reverting%20vandalism&markbot=1 [サンドボックスで開く]

action=rsd

(main | rsd)

Export an RSD (Really Simple Discovery) schema.

action=scribunto-console

  • このモジュールは内部的または不安定です。動作が予告なく変更される場合があります。
  • このモジュールは読み取りの権限を必要とします。
  • ソース: Scribunto
  • ライセンス: GPL-2.0-or-later AND MIT

Internal module for servicing XHR requests from the Scribunto console.

パラメーター:
title

The title of the module to test.

content

The new content of the module.

session

Session token.

型: 整数
question

The next line to evaluate as a script.

このパラメーターは必須です。
clear

Set to clear the current session state.

型: 真偽値 (詳細)

action=setnotificationtimestamp

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Update the notification timestamp for watched pages.

This affects the highlighting of changed pages in the watchlist and history, and the sending of email when the "ウォッチリストにあるページやファイルが更新されたら、メールを受け取る" preference is enabled.

パラメーター:
entirewatchlist

Work on all watched pages.

型: 真偽値 (詳細)
timestamp

Timestamp to which to set the notification timestamp.

Type: timestamp (allowed formats)
torevid

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

型: 整数
newerthanrevid

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

型: 整数
continue

When more results are available, use this to continue.

titles

対象のページ名のリスト。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
pageids

対象のページIDのリスト。

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
revids

対象の版IDのリスト。

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
generator

クエリモジュールを実行することにより対象のページの一覧を取得する。

注意 Generator パラメーターの名前は "g" で始まります。例を参照してください。

allcategories
すべてのカテゴリを一覧表示します。
alldeletedrevisions
利用者によって削除された、または名前空間内の削除されたすべての版を一覧表示する。
allfileusages
存在しないものを含め、すべてのファイルの使用状況を一覧表示する。
allimages
順次すべての画像を列挙します。
alllinks
与えられた名前空間へのすべてのリンクを一覧表示します。
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
ある名前空間へのすべての転送を一覧表示する。
allrevisions
すべての版を一覧表示する。
alltransclusions
存在しないものも含めて、すべての参照読み込み ({{x}} で埋め込まれたページ) を一覧表示します。
backlinks
与えられたページにリンクしているすべてのページを検索します。
categories
ページが属するすべてのカテゴリを一覧表示します。
categorymembers
与えられたカテゴリ内のすべてのページを一覧表示します。
deletedrevisions
削除された版の情報を取得します。
duplicatefiles
ハッシュ値に基づいて与えられたファイルの全ての重複ファイルを返します。
embeddedin
Find all pages that embed (transclude) the given title.
exturlusage
与えられたURLを含むページを一覧表示します。
fileusage
与えられたファイルを利用しているすべてのページを返します。
images
与えられたページに含まれるすべてのファイルを返します。
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
与えられた言語間リンクにリンクしているすべてのページを返します。
links
ページからのすべてのリンクを返します。
linkshere
与えられたページにリンクしているすべてのページを返します。
pageswithprop
与えられたページプロパティが使用されているすべてのページを一覧表示します。
prefixsearch
ページ名の先頭一致検索を行います。
protectedtitles
作成保護が掛けられているページを一覧表示します。
querypage
Get a list provided by a QueryPage-based special page.
random
ランダムなページのセットを取得します。
recentchanges
最近の更新を一覧表示します。
redirects
ページへのすべての転送を返します。
revisions
版の情報を取得します。
search
全文検索を行います。
templates
与えられたページで参照読み込みされているすべてのページを返します。
transcludedin
与えられたページを参照読み込みしているすべてのページを検索します。
watchlist
現在の利用者のウォッチリストにあるページへの最近の更新を取得します。
watchlistraw
現在の利用者のウォッチリストにあるすべてのページを取得します。
値 (次の値のいずれか1つ): allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

titles, pageids, および revids, および generator によって返されたページの転送を自動的に解決する。

型: 真偽値 (詳細)
converttitles

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

型: 真偽値 (詳細)
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=setpagelanguage

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

ページの言語を変更します。

ページ言語の変更はこのwikiでは許可されていません。

この操作を利用するには、$wgPageLanguageUseDB を設定してください。

パラメーター:
title

言語を変更したいページのページ名。pageid とは同時に使用できません。

pageid

言語を変更したいページのページID。title とは同時に使用できません。

型: 整数
lang

Language code of the language to change the page to. Use default to reset the page to the wiki's default content language.

このパラメーターは必須です。
値 (次の値のいずれか1つ): ab、abs、ace、ady、ady-cyrl、aeb、aeb-arab、aeb-latn、af、ak、aln、alt、am、ami、an、ang、anp、ar、arc、arn、arq、ary、arz、as、ase、ast、atj、av、avk、awa、ay、az、azb、ba、ban、bar、bbc、bbc-latn、bcc、bcl、be、be-tarask、bg、bgn、bh、bho、bi、bjn、bm、bn、bo、bpy、bqi、br、brh、bs、btm、bto、bug、bxr、ca、cbk-zam、cdo、ce、ceb、ch、chr、chy、ckb、co、cps、cr、crh、crh-cyrl、crh-latn、cs、csb、cu、cv、cy、da、de、de-at、de-ch、de-formal、default、din、diq、dsb、dtp、dty、dv、dz、ee、egl、el、eml、en、en-ca、en-gb、eo、es、es-formal、et、eu、ext、fa、ff、fi、fit、fj、fo、fr、frc、frp、frr、fur、fy、ga、gag、gan、gan-hans、gan-hant、gcr、gd、gl、glk、gn、gom、gom-deva、gom-latn、gor、got、grc、gsw、gu、gv、ha、hak、haw、he、hi、hif、hif-latn、hil、hr、hrx、hsb、ht、hu、hu-formal、hy、hyw、ia、id、ie、ig、ii、ik、ike-cans、ike-latn、ilo、inh、io、is、it、iu、ja、jam、jbo、jut、jv、ka、kaa、kab、kbd、kbd-cyrl、kbp、kg、khw、ki、kiu、kjp、kk、kk-arab、kk-cn、kk-cyrl、kk-kz、kk-latn、kk-tr、kl、km、kn、ko、ko-kp、koi、krc、kri、krj、krl、ks、ks-arab、ks-deva、ksh、ku、ku-arab、ku-latn、kum、kv、kw、ky、la、lad、lb、lbe、lez、lfn、lg、li、lij、liv、lki、lld、lmo、ln、lo、loz、lrc、lt、ltg、lus、luz、lv、lzh、lzz、mai、map-bms、mdf、mg、mhr、mi、min、mk、ml、mn、mni、mnw、mo、mr、mrj、ms、mt、mwl、my、myv、mzn、na、nah、nan、nap、nb、nds、nds-nl、ne、new、niu、nl、nl-informal、nn、nov、nqo、nrm、nso、nv、ny、nys、oc、olo、om、or、os、pa、pag、pam、pap、pcd、pdc、pdt、pfl、pi、pih、pl、pms、pnb、pnt、prg、ps、pt、pt-br、qu、qug、rgn、rif、rm、rmy、ro、roa-tara、ru、rue、rup、ruq、ruq-cyrl、ruq-latn、rw、sa、sah、sat、sc、scn、sco、sd、sdc、sdh、se、sei、ses、sg、sgs、sh、shi、shn、shy-latn、si、sk、skr、skr-arab、sl、sli、sm、sma、smn、sn、so、sq、sr、sr-ec、sr-el、srn、ss、st、stq、sty、su、sv、sw、szl、szy、ta、tay、tcy、te、tet、tg、tg-cyrl、tg-latn、th、ti、tk、tl、tly、tn、to、tpi、tr、tru、trv、ts、tt、tt-cyrl、tt-latn、tw、ty、tyv、tzm、udm、ug、ug-arab、ug-latn、uk、ur、uz、ve、vec、vep、vi、vls、vmf、vo、vot、vro、wa、war、wo、wuu、xal、xh、xmf、xsy、yi、yo、yue、za、zea、zgh、zh、zh-cn、zh-hans、zh-hant、zh-hk、zh-mo、zh-my、zh-sg、zh-tw、zu
reason

変更の理由。

tags

Change tags to apply to the log entry resulting from this action.

値 (|もしくは別の文字列で区切る):
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=smwbrowse

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Semantic MediaWiki
  • ライセンス: GPL-2.0-or-later

API module to support browse activities for different entity types in Semantic MediaWiki.

パラメーター:
browse
⧼apihelp-smwbrowse-param-browse⧽
このパラメーターは必須です。
値 (次の値のいずれか1つ): category、concept、page、property、psubject、pvalue、subject
params
⧼apihelp-smwbrowse-param-params⧽
このパラメーターは必須です。

action=smwinfo

  • このモジュールは読み取りの権限を必要とします。
  • ソース: Semantic MediaWiki
  • ライセンス: GPL-2.0-or-later

API module to retrieve information about Semantic MediaWiki statistics and other meta information.

パラメーター:
info
⧼apihelp-smwinfo-param-info⧽
値 (|もしくは別の文字列で区切る): conceptcount、declaredpropcount、deletecount、errorcount、formatcount、jobcount、propcount、proppagecount、querycount、querysize、subobjectcount、totalpropcount、usedpropcount
Default: propcount|usedpropcount|declaredpropcount

action=smwtask

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Semantic MediaWiki
  • ライセンス: GPL-2.0-or-later

API module to execute Semantic MediaWiki related tasks (for internal use only, not for public use).

パラメーター:
task

Defines the task type

このパラメーターは必須です。
値 (次の値のいずれか1つ): check-query、duplicate-lookup、insert-job、run-entity-examiner、run-joblist、table-statistics、update
params

JSON encoded parameters that match the selected task type requirement

token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。
例:
Example of running a update task for a particular subject:
api.php?action=smwtask&task=update&params={ "subject": "Foo" } [サンドボックスで開く]

action=spamblacklist

  • このモジュールは読み取りの権限を必要とします。
  • ソース: SpamBlacklist
  • ライセンス: GPL-2.0-or-later

1件以上の URL についてスパムブラックリストに登録されているか検証します。

パラメーター:
url

ブラックリストに登録されているか検証する URL です。

このパラメーターは必須です。
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
例:
2 件の URL についてブラックリストに登録されているか検証
api.php?action=spamblacklist&url=http://www.example.com/|http://www.example.org/ [サンドボックスで開く]

action=stashedit

  • このモジュールは内部的または不安定です。動作が予告なく変更される場合があります。
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Prepare an edit in shared cache.

This is intended to be used via AJAX from the edit form to improve the performance of the page save.

パラメーター:
title

編集されているページのページ名。

このパラメーターは必須です。
section

節番号です。先頭の節の場合は 0、新しい節の場合は newを指定します。

sectiontitle

新しい節の名前です。

text

ページの本文。

stashedtexthash

Page content hash from a prior stash to use instead.

summary

Change summary.

既定値: (空)
contentmodel

新しいコンテンツのコンテンツモデル。

このパラメーターは必須です。
値 (次の値のいずれか1つ): GadgetDefinition、Scribunto、css、flow-board、javascript、json、smw/schema、text、wikitext
contentformat

Content serialization format used for the input text.

このパラメーターは必須です。
値 (次の値のいずれか1つ): application/json、text/css、text/javascript、text/plain、text/x-wiki
baserevid

Revision ID of the base revision.

このパラメーターは必須です。
型: 整数
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=tag

(main | tag)
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

個々の版または記録項目に対しタグの追加または削除を行います。

パラメーター:
rcid

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

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
revid

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

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
logid

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

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
add

追加するタグ。手動で定義されたタグのみ追加可能です。

値 (|もしくは別の文字列で区切る):
remove

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

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
reason

変更の理由。

既定値: (空)
tags

Tags to apply to the log entry that will be created as a result of this action.

値 (|もしくは別の文字列で区切る):
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。
例:
版ID 123に vandalism タグを理由を指定せずに追加する
api.php?action=tag&revid=123&add=vandalism&token=123ABC [サンドボックスで開く]
Wrongly applied という理由で spam タグを 記録項目ID 123 から取り除く
api.php?action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC [サンドボックスで開く]

action=templatedata

  • このモジュールは読み取りの権限を必要とします。
  • ソース: TemplateData
  • ライセンス: GPL-2.0-or-later

Fetch data stored by the TemplateData extension.

パラメーター:
includeMissingTitles

Return data about titles even if they are missing or lack TemplateData. By default titles are only returned if they exist and have TemplateData.

型: 真偽値 (詳細)
doNotIgnoreMissingTitles
廃止予定です。

Return data about titles even if they are missing or lack TemplateData. By default (for backwards compatibility) titles are only returned if they exist and have TemplateData.

型: 真偽値 (詳細)
lang

この言語に地域化された値を返します。既定では、すべてのサポートされている翻訳が返されます。

titles

対象のページ名のリスト。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
pageids

対象のページIDのリスト。

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
revids

対象の版IDのリスト。

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
generator

クエリモジュールを実行することにより対象のページの一覧を取得する。

注意 Generator パラメーターの名前は "g" で始まります。例を参照してください。

allcategories
すべてのカテゴリを一覧表示します。
alldeletedrevisions
利用者によって削除された、または名前空間内の削除されたすべての版を一覧表示する。
allfileusages
存在しないものを含め、すべてのファイルの使用状況を一覧表示する。
allimages
順次すべての画像を列挙します。
alllinks
与えられた名前空間へのすべてのリンクを一覧表示します。
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
ある名前空間へのすべての転送を一覧表示する。
allrevisions
すべての版を一覧表示する。
alltransclusions
存在しないものも含めて、すべての参照読み込み ({{x}} で埋め込まれたページ) を一覧表示します。
backlinks
与えられたページにリンクしているすべてのページを検索します。
categories
ページが属するすべてのカテゴリを一覧表示します。
categorymembers
与えられたカテゴリ内のすべてのページを一覧表示します。
deletedrevisions
削除された版の情報を取得します。
duplicatefiles
ハッシュ値に基づいて与えられたファイルの全ての重複ファイルを返します。
embeddedin
Find all pages that embed (transclude) the given title.
exturlusage
与えられたURLを含むページを一覧表示します。
fileusage
与えられたファイルを利用しているすべてのページを返します。
images
与えられたページに含まれるすべてのファイルを返します。
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
与えられた言語間リンクにリンクしているすべてのページを返します。
links
ページからのすべてのリンクを返します。
linkshere
与えられたページにリンクしているすべてのページを返します。
pageswithprop
与えられたページプロパティが使用されているすべてのページを一覧表示します。
prefixsearch
ページ名の先頭一致検索を行います。
protectedtitles
作成保護が掛けられているページを一覧表示します。
querypage
Get a list provided by a QueryPage-based special page.
random
ランダムなページのセットを取得します。
recentchanges
最近の更新を一覧表示します。
redirects
ページへのすべての転送を返します。
revisions
版の情報を取得します。
search
全文検索を行います。
templates
与えられたページで参照読み込みされているすべてのページを返します。
transcludedin
与えられたページを参照読み込みしているすべてのページを検索します。
watchlist
現在の利用者のウォッチリストにあるページへの最近の更新を取得します。
watchlistraw
現在の利用者のウォッチリストにあるすべてのページを取得します。
値 (次の値のいずれか1つ): allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

titles, pageids, および revids, および generator によって返されたページの転送を自動的に解決する。

型: 真偽値 (詳細)
converttitles

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

型: 真偽値 (詳細)
例:
Template:StubTemplate:ExampleのTemplateDataを返します。テンプレートが存在しないか存在してもTemplateDataがない場合は結果が返されます。
api.php?action=templatedata&titles=Template:Stub|Template:Example&includeMissingTitles=1 [サンドボックスで開く]
Return TemplateData for Template:Stub and Template:Example, with no results if the templates do not exist or do exist but have no TemplateData
api.php?action=templatedata&titles=Template:Stub|Template:Example [サンドボックスで開く]

action=thank

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: Thanks
  • ライセンス: MIT

編集者に感謝の通知を送信する。

パラメーター:
rev

感謝する版のID。これか、または「log」を指定する必要があります。

型: 整数
The value must be no less than 1.
log

Log ID to thank someone for. This or 'rev' must be provided.

型: 整数
The value must be no less than 1.
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。
source

A short string describing the source of the request, for example diff or history.

例:
Send thanks for revision ID 456, with the source being a diff page
api.php?action=thank&revid=456&source=diff&token=123ABC [サンドボックスで開く]

action=titleblacklist (tb)

  • このモジュールは読み取りの権限を必要とします。
  • ソース: TitleBlacklist
  • ライセンス: GPL-2.0-or-later

Validate a page title, filename, or username against the TitleBlacklist.

パラメーター:
tbtitle

The string to validate against the blacklist.

このパラメーターは必須です。
tbaction

確認対象の操作

値 (次の値のいずれか1つ): create、createpage、createtalk、edit、move、new-account、upload
Default: edit
tbnooverride

titleblacklistを上書きしようとしないでください。

型: 真偽値 (詳細)
例:
Fooがブラックリストに載っているかどうかを確認する
api.php?action=titleblacklist&tbtitle=Foo [サンドボックスで開く]
Check whether Bar is blacklisted for editing
api.php?action=titleblacklist&tbtitle=Bar&tbaction=edit [サンドボックスで開く]

action=tokens

  • このモジュールは廃止予定です。
  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Get tokens for data-modifying actions.

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

パラメーター:
type

リクエストするトークンの種類。

値 (|もしくは別の文字列で区切る): block、createaccount、csrf、delete、edit、email、import、login、move、options、patrol、protect、rollback、unblock、userrights、watch
Default: edit
例:
編集トークンを取得する (既定)。
api.php?action=tokens [サンドボックスで開く]
Retrieve an email token and a move token.
api.php?action=tokens&type=email|move [サンドボックスで開く]

action=unblock

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

利用者のブロックを解除します。

パラメーター:
id

解除するブロックのID (list=blocksで取得できます)。user とは同時に使用できません。

型: 整数
user

ブロックを解除する利用者。idとは同時に使用できません。

型: 利用者名、IP、IP範囲 および 利用者ID(例: #12345)のいずれかを使った利用者
userid
廃止予定です。

Specify user=#ID instead.

型: 整数
reason

ブロック解除の理由。

既定値: (空)
tags

ブロック記録の項目に適用する変更タグ。

値 (|もしくは別の文字列で区切る):
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。
例:
ブロックID #105 を解除する。
api.php?action=unblock&id=105 [サンドボックスで開く]
Sorry Bob という理由で利用者 Bob のブロックを解除する。
api.php?action=unblock&user=Bob&reason=Sorry%20Bob [サンドボックスで開く]

action=undelete

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

削除されたページの版を復元します。

削除された版の一覧 (タイムスタンプを含む) はprop=deletedrevisionsに、また削除されたファイルのID一覧はlist=filearchiveで見つけることができます。

パラメーター:
title

復元するページ名。

このパラメーターは必須です。
reason

復元の理由。

既定値: (空)
tags

削除記録の項目に適用する変更タグ。

値 (|もしくは別の文字列で区切る):
timestamps

復元する版のタイムスタンプ。timestampsfileids の両方が空の場合、すべての版が復元されます。

Type: list of timestamps (allowed formats)
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
fileids

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

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
watchlist

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

値 (次の値のいずれか1つ): nochange、preferences、unwatch、watch
Default: preferences
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=unlinkaccount

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Remove a linked third-party account from the current user.

パラメーター:
request

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

このパラメーターは必須です。
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。
例:
Attempt to remove the current user's link for the provider associated with FooAuthenticationRequest.
api.php?action=unlinkaccount&request=FooAuthenticationRequest&token=123ABC [サンドボックスで開く]

action=upload

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

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

Several methods are available:

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

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

パラメーター:
filename

対象のファイル名。

comment

アップロードのコメント。新規ファイルのアップロードで text が指定されていない場合、初期ページテキストとしても使用されます。

既定値: (空)
tags

Change tags to apply to the upload log entry and file page revision.

値 (|もしくは別の文字列で区切る):
text

新しいファイルの初期ページテキスト。

watch
廃止予定です。

このページをウォッチする。

型: 真偽値 (詳細)
watchlist

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

値 (次の値のいずれか1つ): nochange、preferences、watch
Default: preferences
ignorewarnings

あらゆる警告を無視する。

型: 真偽値 (詳細)
file

File contents.

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

ファイル取得元のURL.

filekey

Key that identifies a previous upload that was stashed temporarily.

sessionkey
廃止予定です。

Same as filekey, maintained for backward compatibility.

stash

If set, the server will stash the file temporarily instead of adding it to the repository.

型: 真偽値 (詳細)
filesize

Filesize of entire upload.

型: 整数
The value must be between 0 and 8,388,608.
offset

Offset of chunk in bytes.

型: 整数
The value must be no less than 0.
chunk

Chunk contents.

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

Make potentially large file operations asynchronous when possible.

型: 真偽値 (詳細)
checkstatus

Only fetch the upload status for the given file key.

型: 真偽値 (詳細)
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。

action=userrights

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

利用者の所属グループを変更します。

パラメーター:
user

利用者。

型: 利用者名 および 利用者ID(例: #12345)のいずれかを使った利用者
userid
廃止予定です。

代わりに user=#ID を指定してください。

型: 整数
add

利用者をこのグループに追加するか、既にメンバーの場合は、そのグループのメンバーシップの有効期限を更新します。

値 (|もしくは別の文字列で区切る): bot、bureaucrat、checkuser、flow-bot、interface-admin、semiop、smwadministrator、smwcurator、smweditor、suppress、sysop
expiry

Expiry timestamps. May be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). If only one timestamp is set, it will be used for all groups passed to the add parameter. Use infinite, indefinite, infinity, or never for a never-expiring user group.

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
Default: infinite
remove

Remove the user from these groups.

値 (|もしくは別の文字列で区切る): bot、bureaucrat、checkuser、flow-bot、interface-admin、semiop、smwadministrator、smwcurator、smweditor、suppress、sysop
reason

変更の理由。

既定値: (空)
token

action=query&meta=tokens から取得した「userrights」トークン

互換性のために、ウェブUIで使用されるトークンも受理されます。

このパラメーターは必須です。
tags

Change tags to apply to the entry in the user rights log.

値 (|もしくは別の文字列で区切る):
例:
Add user FooBot to group bot, and remove from groups sysop and bureaucrat.
api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC [サンドボックスで開く]
Add the user with ID 123 to group bot, and remove from groups sysop and bureaucrat.
api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC [サンドボックスで開く]
利用者 SometimeSysop を 1ヶ月間 sysop グループに追加する。
api.php?action=userrights&user=SometimeSysop&add=sysop&expiry=1%20month&token=123ABC [サンドボックスで開く]

action=validatepassword

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

Validate a password against the wiki's password policies.

Validity is reported as Good if the password is acceptable, Change if the password may be used for login but must be changed, or Invalid if the password is not usable.

パラメーター:
password

Password to validate.

このパラメーターは必須です。
user

User name, for use when testing account creation. The named user must not exist.

型: 利用者名 および 利用者ID(例: #12345)のいずれかを使った利用者
email

Email address, for use when testing account creation.

realname

Real name, for use when testing account creation.

action=visualeditor

  • このモジュールは内部的または不安定です。動作が予告なく変更される場合があります。
  • このモジュールは読み取りの権限を必要とします。
  • ソース: VisualEditor
  • ライセンス: MIT

Returns HTML5 for a page from the Parsoid service.

パラメーター:
page

操作を実行したいページ

このパラメーターは必須です。
badetag

If RESTBase query returned a seemingly invalid ETag, pass it here for logging purposes.

format

The format of the output.

値 (次の値のいずれか1つ): json、jsonfm
Default: jsonfm
paction

実行したい操作

このパラメーターは必須です。
値 (次の値のいずれか1つ): metadata、parse、parsedoc、parsefragment、templatesused、wikitext
wikitext

HTMLに変換するため、Parsoidに送るウィキテキスト (paction=parsefragment)

section

The section on which to act.

stash

When saving, set this true if you want to use the stashing API.

oldid

使用する版番号 (既定では最新版)

editintro

Edit intro to add to notices.

pst

Parsoid に送る前にwikitextをあらかじめ変換して保存する (paction=parsefragment)

型: 真偽値 (詳細)
preload

The page to use content from if the fetched page has no content yet.

preloadparams

Parameters to substitute into the preload page, if present.

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。

action=visualeditoredit

  • このモジュールは内部的または不安定です。動作が予告なく変更される場合があります。
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: VisualEditor
  • ライセンス: MIT

HTML5ページを MediaWiki として保存する (Parsoidサービスを利用してウィキテキストに変換されます)

パラメーター:
paction

Action to perform.

このパラメーターは必須です。
値 (次の値のいずれか1つ): diff、save、serialize、serializeforcache
page

操作を実行したいページ

このパラメーターは必須です。
token

action=query&meta=tokens から取得した「csrf」トークン

このパラメーターは必須です。
wikitext

動作を適用するウィキテキストです。

section

The section on which to act.

sectiontitle

新しい節の名前です。

basetimestamp

保存する際に、編集した版のタイムスタンプとしてこれがセットされます。編集競合を検出するのに利用されます。

starttimestamp

保存する際に、ページが読み込まれた時のタイムスタンプとしてこれがセットされます。編集競合を検出するのに利用されます。

oldid

使用する版番号。既定では最新版です。新しいページには 0 を使用します。

minor

細部の編集のしるし。

watchlist

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

html

ウィキテキストを出力として得るために、Parsoidに送るHTML

etag

ETag to send.

summary

編集の要約

captchaid

Captcha ID (captcha response で保存する場合)。

captchaword

(captchaで保存するときの) captchaに対する回答

cachekey

以前にこのキーで serializeforcache リクエストを送った結果を利用する。html を上書きします。

tags

Change tags to apply to the edit.

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。

action=watch

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

現在の利用者のウォッチリストにページを追加/除去します。

パラメーター:
title
廃止予定です。

The page to (un)watch. Use titles instead.

unwatch

If set the page will be unwatched rather than watched.

型: 真偽値 (詳細)
continue

When more results are available, use this to continue.

titles

対象のページ名のリスト。

複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
pageids

対象のページIDのリスト。

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
revids

対象の版IDのリスト。

型: 整数のリスト
複数の値は | もしくは代わりの文字で区切ってください。
値の最大値は 50(緩い制限が適用されるクライアントでは500)です。
generator

クエリモジュールを実行することにより対象のページの一覧を取得する。

注意 Generator パラメーターの名前は "g" で始まります。例を参照してください。

allcategories
すべてのカテゴリを一覧表示します。
alldeletedrevisions
利用者によって削除された、または名前空間内の削除されたすべての版を一覧表示する。
allfileusages
存在しないものを含め、すべてのファイルの使用状況を一覧表示する。
allimages
順次すべての画像を列挙します。
alllinks
与えられた名前空間へのすべてのリンクを一覧表示します。
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
ある名前空間へのすべての転送を一覧表示する。
allrevisions
すべての版を一覧表示する。
alltransclusions
存在しないものも含めて、すべての参照読み込み ({{x}} で埋め込まれたページ) を一覧表示します。
backlinks
与えられたページにリンクしているすべてのページを検索します。
categories
ページが属するすべてのカテゴリを一覧表示します。
categorymembers
与えられたカテゴリ内のすべてのページを一覧表示します。
deletedrevisions
削除された版の情報を取得します。
duplicatefiles
ハッシュ値に基づいて与えられたファイルの全ての重複ファイルを返します。
embeddedin
Find all pages that embed (transclude) the given title.
exturlusage
与えられたURLを含むページを一覧表示します。
fileusage
与えられたファイルを利用しているすべてのページを返します。
images
与えられたページに含まれるすべてのファイルを返します。
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
与えられた言語間リンクにリンクしているすべてのページを返します。
links
ページからのすべてのリンクを返します。
linkshere
与えられたページにリンクしているすべてのページを返します。
pageswithprop
与えられたページプロパティが使用されているすべてのページを一覧表示します。
prefixsearch
ページ名の先頭一致検索を行います。
protectedtitles
作成保護が掛けられているページを一覧表示します。
querypage
Get a list provided by a QueryPage-based special page.
random
ランダムなページのセットを取得します。
recentchanges
最近の更新を一覧表示します。
redirects
ページへのすべての転送を返します。
revisions
版の情報を取得します。
search
全文検索を行います。
templates
与えられたページで参照読み込みされているすべてのページを返します。
transcludedin
与えられたページを参照読み込みしているすべてのページを検索します。
watchlist
現在の利用者のウォッチリストにあるページへの最近の更新を取得します。
watchlistraw
現在の利用者のウォッチリストにあるすべてのページを取得します。
値 (次の値のいずれか1つ): allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsallrevisionsalltransclusionsbacklinkscategoriescategorymembersdeletedrevisionsduplicatefilesembeddedinexturlusagefileusageimagesimageusageiwbacklinkslangbacklinkslinkslinksherepageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangesredirectsrevisionssearchtemplatestranscludedinwatchlistwatchlistraw
redirects

titles, pageids, および revids, および generator によって返されたページの転送を自動的に解決する。

型: 真偽値 (詳細)
converttitles

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

型: 真偽値 (詳細)
token

action=query&meta=tokens から取得した「watch」トークン

このパラメーターは必須です。

action=webapp-manifest

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MobileFrontend
  • ライセンス: GPL-2.0-or-later

Returns a webapp manifest.

format=json

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

データを JSON 形式で出力します。

パラメーター:
callback

指定すると、指定した関数呼び出しで出力をラップします。安全のため、利用者固有のデータはすべて制限されます。

utf8

指定すると、大部分の非 ASCII 文字 (すべてではありません) を、16 進のエスケープ シーケンスに置換する代わりに UTF-8 として符号化します。formatversion1 でない場合は既定です。

型: 真偽値 (詳細)
ascii

指定すると、すべての非ASCII文字を16進エスケープにエンコードします。formatversion1 の場合既定です。

型: 真偽値 (詳細)
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Modern format.
latest
Use the latest format (currently 2), may change without warning.
値 (次の値のいずれか1つ): 1、2、latest
Default: 1

format=jsonfm

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

データを JSON 形式 (HTML に埋め込んだ形式) で出力します。

パラメーター:
wrappedhtml

Return the pretty-printed HTML and associated ResourceLoader modules as a JSON object.

型: 真偽値 (詳細)
callback

指定すると、指定した関数呼び出しで出力をラップします。安全のため、利用者固有のデータはすべて制限されます。

utf8

指定すると、大部分の非 ASCII 文字 (すべてではありません) を、16 進のエスケープ シーケンスに置換する代わりに UTF-8 として符号化します。formatversion1 でない場合は既定です。

型: 真偽値 (詳細)
ascii

指定すると、すべての非ASCII文字を16進エスケープにエンコードします。formatversion1 の場合既定です。

型: 真偽値 (詳細)
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Modern format.
latest
Use the latest format (currently 2), may change without warning.
値 (次の値のいずれか1つ): 1、2、latest
Default: 1

format=none

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

何も出力しません。

format=php

(main | php)
  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

データを PHP のシリアル化した形式で出力します。

パラメーター:
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Modern format.
latest
Use the latest format (currently 2), may change without warning.
値 (次の値のいずれか1つ): 1、2、latest
Default: 1

format=phpfm

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

データを PHP のシリアル化した形式 (HTML に埋め込んだ形式) で出力します。

パラメーター:
wrappedhtml

Return the pretty-printed HTML and associated ResourceLoader modules as a JSON object.

型: 真偽値 (詳細)
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Modern format.
latest
Use the latest format (currently 2), may change without warning.
値 (次の値のいずれか1つ): 1、2、latest
Default: 1

format=rawfm

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

データをデバッグ要素付きで JSON 形式 (HTML に埋め込んだ形式) で出力します。

パラメーター:
wrappedhtml

Return the pretty-printed HTML and associated ResourceLoader modules as a JSON object.

型: 真偽値 (詳細)

format=xml

(main | xml)
  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

データを XML 形式で出力します。

パラメーター:
xslt

指定すると、XSLスタイルシートとして名付けられたページを追加します。値は、必ず、MediaWiki 名前空間の、ページ名の末尾が .xsl でのタイトルである必要があります。

includexmlnamespace

指定すると、XML 名前空間を追加します。

型: 真偽値 (詳細)

format=xmlfm

  • このモジュールは読み取りの権限を必要とします。
  • ソース: MediaWiki
  • ライセンス: GPL-2.0-or-later

データを XML 形式 (HTML に埋め込んだ形式) で出力します。

パラメーター:
wrappedhtml

Return the pretty-printed HTML and associated ResourceLoader modules as a JSON object.

型: 真偽値 (詳細)
xslt

指定すると、XSLスタイルシートとして名付けられたページを追加します。値は、必ず、MediaWiki 名前空間の、ページ名の末尾が .xsl でのタイトルである必要があります。

includexmlnamespace

指定すると、XML 名前空間を追加します。

型: 真偽値 (詳細)

データ型

Input to MediaWiki should be NFC-normalized UTF-8. MediaWiki may attempt to convert other input, but this may cause some operations (such as edits with MD5 checks) to fail.

Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g. param=value1|value2 or param=value1%7Cvalue2. If a value must contain the pipe character, use U+001F (Unit Separator) as the separator and prefix the value with U+001F, e.g. param=%1Fvalue1%1Fvalue2.

Some parameter types in API requests need further explanation:

boolean

真偽値のパラメーターはHTMLのチェックボックスのように機能します: パラメーターが指定されていれば、値に関わらず、真であると推定します。偽の値については、パタメーター自体を省略してください。

expiry

期間は、相対値(例えば、5 months2 weeks)または絶対値(例えば、2014-09-18T12:34:56Z)のどちらかで指定します。期間を定めない場合は、infinite, indefinite, infinity または never を用います。

timestamp

Timestamps may be specified in several formats, see the Timestamp library input formats documented on mediawiki.org for details. ISO 8601 date and time is recommended: 2001-01-15T14:56:00Z. Additionally, the string now may be used to specify the current timestamp.

Templated parameters

Templated parameters support cases where an API module needs a value for each value of some other parameter. For example, if there were an API module to request fruit, it might have a parameter fruits to specify which fruits are being requested and a templated parameter {fruit}-quantity to specify how many of each fruit to request. An API client that wants 1 apple, 5 bananas, and 20 strawberries could then make a request like fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.

クレジット

API の開発者:

  • Roan Kattouw (2007年9月-2009年の主任開発者)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (作成者、2006年9月-2007年9月の主任開発者)
  • Brad Jorsch (2013年-現在の主任開発者)

コメント、提案、質問は mediawiki-api@lists.wikimedia.org にお送りください。 バグはこちらへご報告ください: https://phabricator.wikimedia.org/