MediaWiki API ヘルプ

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

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

メイン モジュール

Status: All features shown on this page should be working, but the API is still in active development, and may change at any time. Subscribe to the mediawiki-api-announce mailing list for notice of updates.

Erroneous requests: When erroneous requests are sent to the API, an HTTP header will be sent with the key "MediaWiki-API-Error" and then both the value of the header and the error code sent back will be set to the same value. For more information see API: Errors and warnings.

パラメーター:
action

実行する操作です。

値 (次の値のいずれか1つ): blockchecktokenclearhasmsgcomparecreateaccountdeleteeditemailuserexpandtemplatesfeedcontributionsfeedrecentchangesfeedwatchlistfilereverthelpimagerotateimportloginlogoutmanagetagsmoveopensearchoptionsparaminfoparsepatrolprotectpurgequeryrevisiondeleterollbackrsdsetnotificationtimestampspamblackliststashedittagtitleblacklisttokensunblockundeleteuploaduserrightswatch
既定値: help
format

出力する形式です。

値 (次の値のいずれか1つ): dbgdbgfmjsonjsonfmnonephpphpfmrawfmtxttxtfmxmlxmlfmyamlyamlfm
既定値: 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.

Type: integer
smaxage

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

Type: integer
既定値: 0
maxage

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

Type: integer
既定値: 0
assert

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

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

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

servedby

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

Type: boolean (details)
curtimestamp

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

Type: boolean (details)
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). 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, an Access-Control-Allow-Origin header will be set.

uselang

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

既定値: user
例:
メイン モジュールのヘルプ
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=block

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

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

パラメーター:
user

ブロックする利用者名、IPアドレスまたはIPレンジ。

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

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

既定値: never
reason

ブロックの理由。

既定値: (空)
anononly

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

Type: boolean (details)
nocreate

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

Type: boolean (details)
autoblock

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

Type: boolean (details)
noemail

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

Type: boolean (details)
hidename

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

Type: boolean (details)
allowusertalk

Allow the user to edit their own talk page (depends on $wgBlockAllowsUTEdit).

Type: boolean (details)
reblock

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

Type: boolean (details)
watchuser

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

Type: boolean (details)
token

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

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

action=checktoken

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
type

調べるトークンの種類。

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

調べるトークン。

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

Maximum allowed age of the token, in seconds.

Type: integer
例:
csrf トークンの妥当性を調べる。
api.php?action=checktoken&type=csrf&token=123ABC

action=clearhasmsg

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

Clears the hasmsg flag for the current user.

例:
Clear the hasmsg flag for the current user.
api.php?action=clearhasmsg

action=compare

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

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

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

パラメーター:
fromtitle

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

fromid

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

Type: integer
fromrev

比較する1つ目の版。

Type: integer
totitle

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

toid

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

Type: integer
torev

比較する2つ目の版。

Type: integer
例:
版1と2の差分を生成する。
api.php?action=compare&fromrev=1&torev=2

action=createaccount

  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
name

利用者名。

このパラメーターは必須です。
Type: user name
password

パスワード (mailpassword が設定されると無視されます)。

domain

外部認証のドメイン (省略可能)。

token

最初のリクエストで得られたアカウント作成用トークンです。

email

利用者の電子メールアドレス (任意)。

realname

利用者の本名 (省略可能)。

mailpassword

設定されると (その値を問わず)、ランダムなパスワードがその利用者に電子メールで送られます。

Type: boolean (details)
reason

ログに記録されるアカウント作成の理由 (任意)。

language

Language code to set as default for the user (optional, defaults to content language).

captchaword

Answer to the CAPTCHA

captchaid

CAPTCHA ID from previous request

例:
利用者 testuser をパスワード test123 として作成する。
api.php?action=createaccount&name=testuser&password=test123
利用者 testuserを作成し、ランダムに生成されたパスワードをメールで送る
api.php?action=createaccount&name=testmailuser&mailpassword=true&reason=MyReason

action=delete

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

ページを削除します。

パラメーター:
title

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

pageid

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

Type: integer
reason

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

watch
廃止予定です。

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

Type: boolean (details)
watchlist

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

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

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

Type: boolean (details)
oldimage

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

token

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

このパラメーターは必須です。
例:
Main Page を削除する
api.php?action=delete&title=Main%20Page&token=123ABC
Preparing for move という理由で Main Page を削除する
api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move

action=edit

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

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

パラメーター:
title

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

pageid

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

Type: integer
section

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

sectiontitle

新しい節の名前です。

text

ページの本文。

summary

Edit summary. Also section title when section=new and sectiontitle is not set.

tags

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

値 (|で区切る):
minor

細部の編集

Type: boolean (details)
notminor

細部の編集ではない。

Type: boolean (details)
bot

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

Type: boolean (details)
basetimestamp

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

Type: timestamp (allowed formats)
starttimestamp

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

Type: timestamp (allowed formats)
recreate

Override any errors about the page having been deleted in the meantime.

Type: boolean (details)
createonly

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

Type: boolean (details)
nocreate

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

Type: boolean (details)
watch
廃止予定です。

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

Type: boolean (details)
unwatch
廃止予定です。

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

Type: boolean (details)
watchlist

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

値 (次の値のいずれか1つ): watch、unwatch、preferences、nochange
既定値: 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 をオーバーライドします。

Type: integer
undoafter

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

Type: integer
redirect

自動的にリダイレクトを解決します。

Type: boolean (details)
contentformat

Content serialization format used for the input text.

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

Content model of the new content.

値 (次の値のいずれか1つ): wikitext、javascript、json、css、text
token

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

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

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

Answer to the CAPTCHA

captchaid

CAPTCHA ID from previous request

action=emailuser

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

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

パラメーター:
target

送信先の利用者名。

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

題名。

text

電子メールの本文。

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

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

Type: boolean (details)
token

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

このパラメーターは必須です。
例:
利用者 WikiSysopContent という本文の電子メールを送信。
api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC

action=expandtemplates

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
title

ページの名前です。

既定値: API
text

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

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

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

Type: integer
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
Gives the JavaScript configuration variables specific to the page.
encodedjsconfigvars
Gives the JavaScript configuration variables specific to the page as a JSON string.
parsetree
The XML parse tree of the input.
値 (|で区切る): wikitext、categories、properties、volatile、ttl、modules、jsconfigvars、encodedjsconfigvars、parsetree
includecomments

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

Type: boolean (details)
generatexml
廃止予定です。

Generate XML parse tree (replaced by prop=parsetree).

Type: boolean (details)
例:
ウィキテキスト {{Project:Sandbox}} を展開する。
api.php?action=expandtemplates&text={{Project:Sandbox}}

action=feedcontributions

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
feedformat

フィードの形式。

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

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

このパラメーターは必須です。
Type: user name
namespace

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

値 (次の値のいずれか1つ): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
year

この年以前。

Type: integer
month

この月以前。

Type: integer
tagfilter

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

値 (|で区切る):
既定値: (空)
deletedonly

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

Type: boolean (details)
toponly

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

Type: boolean (details)
newonly

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

Type: boolean (details)
showsizediff

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

Type: boolean (details)
例:
利用者 Example の投稿記録を取得する。
api.php?action=feedcontributions&user=Example

action=feedrecentchanges

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
feedformat

フィードの形式。

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

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

値 (次の値のいずれか1つ): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
invert

All namespaces but the selected one.

Type: boolean (details)
associated

Include associated (talk or main) namespace.

Type: boolean (details)
days

Days to limit the results to.

値は 1 以上にしてください。
Type: integer
既定値: 7
limit

返す結果の最大数。

値は 1 以上 50 以下にしてください。
Type: integer
既定値: 50
from

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

Type: timestamp (allowed formats)
hideminor

細部の変更を隠す。

Type: boolean (details)
hidebots

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

Type: boolean (details)
hideanons

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

Type: boolean (details)
hideliu

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

Type: boolean (details)
hidepatrolled

巡回済みの変更を隠す。

Type: boolean (details)
hidemyself

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

Type: boolean (details)
tagfilter

タグにより絞り込む。

target

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

showlinkedto

Show changes on pages linked to the selected page instead.

Type: boolean (details)
例:
最近の更新を表示する。
api.php?action=feedrecentchanges
最近30日間の変更を表示する。
api.php?action=feedrecentchanges&days=30

action=feedwatchlist

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
feedformat

フィードの形式。

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

List pages modified within this many hours from now.

値は 1 以上 72 以下にしてください。
Type: integer
既定値: 24
linktosections

Link directly to changed sections if possible.

Type: boolean (details)
allrev

Include multiple revisions of the same page within given timeframe.

Type: boolean (details)
wlowner

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

Type: user name
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.

値 (|で区切る): minor、!minor、bot、!bot、anon、!anon、patrolled、!patrolled、unread、!unread
wltype

Which types of changes to show:

edit
Regular page edits.
external
External changes.
new
Page creations.
log
Log entries.
値 (|で区切る): edit、external、new、log
既定値: edit|new|log
wlexcludeuser

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

Type: user name
例:
ウォッチリストのフィードを表示する。
api.php?action=feedwatchlist
ウォッチ中のページに対する過去6時間の更新をすべて表示する。
api.php?action=feedwatchlist&allrev=&hours=6

action=filerevert

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

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

パラメーター:
filename

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

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

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

既定値: (空)
archivename

Archive name of the revision to revert to.

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

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

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

action=help

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

パラメーター:
modules

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

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
既定値: main
submodules

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

Type: boolean (details)
recursivesubmodules

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

Type: boolean (details)
wrap

Wrap the output in a standard API response structure.

Type: boolean (details)
toc

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

Type: boolean (details)
例:
メイン モジュールのヘルプ
api.php?action=help
すべてのヘルプを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 リクエストのみを受け付けます。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
rotation

Degrees to rotate image clockwise.

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

When more results are available, use this to continue.

titles

A list of titles to work on.

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
pageids

A list of page IDs to work on.

Type: list of integers
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
revids

A list of revision IDs to work on.

Type: list of integers
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

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

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

Type: boolean (details)
converttitles

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

Type: boolean (details)
token

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

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

action=import

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

Import a page from another wiki, or from an XML file.

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

パラメーター:
summary

ページ取り込みの要約。

xml

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

multipart/form-data 形式でファイルをアップロードしてください。
interwikisource

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

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

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

fullhistory

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

Type: boolean (details)
templates

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

Type: boolean (details)
namespace

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

値 (次の値のいずれか1つ): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
rootpage

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

token

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

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

action=login (lg)

  • このモジュールは POST リクエストのみを受け付けます。
  • Source: MediaWiki
  • License: GPL-2.0+

Log in and get authentication cookies.

In the event of a successful log-in, the needed cookies will be included in the HTTP response headers. In the event of a failed log-in, further attempts may be throttled to limit automated password guessing attacks.

パラメーター:
lgname

利用者名。

lgpassword

パスワード。

lgdomain

ドメイン (省略可能)

lgtoken

最初のリクエストで取得したログイントークンです。

action=logout

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

例:
現在の利用者をログアウトする。
api.php?action=logout

action=managetags

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

Perform management tasks relating to change tags.

パラメーター:
operation

Which operation to perform:

create
Create a new change tag for manual use.
delete
Remove a change tag from the database, including removing the tag from all revisions, recent change entries and log entries on which it is used.
activate
Activate a change tag, allowing users to apply it manually.
deactivate
Deactivate a change tag, preventing users from applying it manually.
このパラメーターは必須です。
値 (次の値のいずれか1つ): create、delete、activate、deactivate
tag

Tag to create, delete, activate or deactivate. For tag creation, the tag must not exist. For tag deletion, the tag must exist. For tag activation, the tag must exist and not be in use by an extension. For tag deactivation, the tag must be currently active and manually defined.

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

An optional reason for creating, deleting, activating or deactivating the tag.

ignorewarnings

Whether to ignore any warnings that are issued during the operation.

Type: boolean (details)
token

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

このパラメーターは必須です。
例:
spam という名前のタグを For use in edit patrolling という理由で作成する
api.php?action=managetags&operation=create&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC
vandlaism タグを Misspelt という理由で削除する
api.php?action=managetags&operation=delete&tag=vandlaism&reason=Misspelt&token=123ABC
spam という名前のタグを For use in edit patrolling という理由で有効化する
api.php?action=managetags&operation=activate&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC
Deactivate a tag named spam with the reason No longer required
api.php?action=managetags&operation=deactivate&tag=spam&reason=No+longer+required&token=123ABC

action=move

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

ページを移動します。

パラメーター:
from

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

fromid

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

Type: integer
to

移動後のページ名。

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

改名の理由。

既定値: (空)
movetalk

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

Type: boolean (details)
movesubpages

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

Type: boolean (details)
noredirect

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

Type: boolean (details)
watch
廃止予定です。

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

Type: boolean (details)
unwatch
廃止予定です。

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

Type: boolean (details)
watchlist

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

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

あらゆる警告を無視

Type: boolean (details)
token

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

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

action=opensearch

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
search

検索文字列。

limit

返す結果の最大数。

No more than 100 (100 for bots) allowed.
Type: integer or max
既定値: 10
namespace

検索する名前空間。

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
既定値: 0
suggest

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

Type: boolean (details)
redirects

How to handle redirects:

return
Return the redirect itself.
resolve
Return the target page. May return fewer than limit results.

For historical reasons, the default is "return" for format=json and "resolve" for other formats.

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

出力する形式。

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

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

Type: boolean (details)
例:
Te から始まるページを検索する。
api.php?action=opensearch&search=Te

action=options

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

Change preferences of the current user.

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

Resets preferences to the site defaults.

Type: boolean (details)
resetkinds

List of types of options to reset when the reset option is set.

値 (|で区切る): registered、registered-multiselect、registered-checkmatrix、userjs、special、unused、all
既定値: all
change

List of changes, formatted name=value (e.g. skin=vector). Value cannot contain pipe characters. If no value is given (not even an equals sign), e.g., optionname|otheroption|..., the option will be reset to its default value.

複数の値は | で区切ってください。 値の最大値は 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, can contain pipe characters.

token

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

このパラメーターは必須です。
例:
すべて初期設定に戻す。
api.php?action=options&reset=&token=123ABC
skin および hideminor の個人設定を変更する。
api.php?action=options&change=skin=vector|hideminor=1&token=123ABC
すべての個人設定を初期化し、skin および nickname を設定する。
api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC

action=paraminfo

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

パラメーター:
modules

モジュールの名前のリスト (action および format パラメーターの値, または main). + を使用して下位モジュールを指定できます。

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
helpformat

Format of help strings.

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

List of query module names (value of prop, meta or list parameter). Use modules=query+foo instead of querymodules=foo.

値 (|で区切る): allcategories、alldeletedrevisions、allfileusages、allimages、alllinks、allmessages、allpages、allredirects、alltransclusions、allusers、backlinks、blocks、categories、categoryinfo、categorymembers、contributors、deletedrevisions、deletedrevs、duplicatefiles、embeddedin、extlinks、exturlusage、filearchive、filerepoinfo、fileusage、imageinfo、images、imageusage、info、iwbacklinks、iwlinks、langbacklinks、langlinks、links、linkshere、logevents、pagepropnames、pageprops、pageswithprop、prefixsearch、protectedtitles、querypage、random、recentchanges、redirects、revisions、search、siteinfo、stashimageinfo、tags、templates、tokens、transcludedin、usercontribs、userinfo、users、watchlist、watchlistraw
値の最大値は 50 (ボットの場合は 500) です。
mainmodule
廃止予定です。

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.

値 (|で区切る): dbg、dbgfm、json、jsonfm、none、php、phpfm、rawfm、txt、txtfm、xml、xmlfm、yaml、yamlfm

action=parse

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

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, and contentmodel.
  3. Specify only a summary to parse. prop should be given an empty value.
パラメーター:
title

Title of page the text belongs to. If omitted, contentmodel must be specified, and API will be used as the title.

text

Text to parse. Use title or contentmodel to control the content model.

summary

Summary to parse.

page

Parse the content of this page. Cannot be used together with text and title.

pageid

Parse the content of this page. Overrides page.

Type: integer
redirects

If page or pageid is set to a redirect, resolve it.

Type: boolean (details)
oldid

Parse the content of this revision. Overrides page and pageid.

Type: integer
prop

Which pieces of information to get:

text
Gives the parsed text of the wikitext.
langlinks
Gives the language links in the parsed wikitext.
categories
Gives the categories in the parsed wikitext.
categorieshtml
Gives the HTML version of the categories.
links
Gives the internal links in the parsed wikitext.
templates
Gives the templates in the parsed wikitext.
images
Gives the images in the parsed wikitext.
externallinks
Gives the external links in the parsed wikitext.
sections
Gives the sections in the parsed wikitext.
revid
Adds the revision ID of the parsed page.
displaytitle
Adds the title of the parsed wikitext.
headitems
Gives items to put in the <head> of the page.
headhtml
Gives parsed <head> of the page.
modules
Gives the ResourceLoader modules used on the page. Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules.
jsconfigvars
Gives the JavaScript configuration variables specific to the page.
encodedjsconfigvars
Gives the JavaScript configuration variables specific to the page as a JSON string.
indicators
Gives the HTML of page status indicators used on the page.
iwlinks
Gives interwiki links in the parsed wikitext.
wikitext
Gives the original wikitext that was parsed.
properties
Gives various properties defined in the parsed wikitext.
limitreportdata
Gives the limit report in a structured way. Gives no data, when disablelimitreport is set.
limitreporthtml
Gives the HTML version of the limit report. Gives no data, when disablelimitreport is set.
parsetree
The XML parse tree of revision content (requires content model wikitext)
値 (|で区切る): text、langlinks、categories、categorieshtml、links、templates、images、externallinks、sections、revid、displaytitle、headitems、headhtml、modules、jsconfigvars、encodedjsconfigvars、indicators、iwlinks、wikitext、properties、limitreportdata、limitreporthtml、parsetree
既定値: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties
pst

Do a pre-save transform on the input before parsing it. Only valid when used with text.

Type: boolean (details)
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.

Type: boolean (details)
effectivelanglinks

Includes language links supplied by extensions (for use with prop=langlinks).

Type: boolean (details)
section

Only retrieve the content of this section number or when new generate a new section.

new section is only honored when specifying text.

sectiontitle

New section title when section is new.

Unlike page editing, this does not fall back to summary when omitted or empty.

disablepp
廃止予定です。

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

Type: boolean (details)
disablelimitreport

Omit the limit report ("NewPP limit report") from the parser output.

Type: boolean (details)
disableeditsection

Omit edit section links from the parser output.

Type: boolean (details)
disabletidy

Do not run HTML cleanup (e.g. tidy) on the parser output.

Type: boolean (details)
generatexml
廃止予定です。

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

Type: boolean (details)
preview

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

Type: boolean (details)
sectionpreview

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

Type: boolean (details)
disabletoc

Omit table of contents in output.

Type: boolean (details)
contentformat

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

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

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

値 (次の値のいずれか1つ): wikitext、javascript、json、css、text

action=patrol

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

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

パラメーター:
rcid

Recentchanges ID to patrol.

Type: integer
revid

巡回済みにする版ID。

Type: integer
token

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

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

action=protect

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

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

パラメーター:
title

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

pageid

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

Type: integer
protections

List of protection levels, formatted action=level (e.g. edit=sysop).

Note: Any actions not listed will have restrictions removed.

このパラメーターは必須です。
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
expiry

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

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
既定値: infinite
reason

保護(解除)の理由。

既定値: (空)
cascade

Enable cascading protection (i.e. protect transcluded templates and images used in this page). Ignored if none of the given protection levels support cascading.

Type: boolean (details)
watch
廃止予定です。

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

Type: boolean (details)
watchlist

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

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

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

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

action=purge

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

Purge the cache for the given titles.

Requires a POST request if the user is not logged in.

パラメーター:
forcelinkupdate

Update the links tables.

Type: boolean (details)
forcerecursivelinkupdate

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

Type: boolean (details)
continue

When more results are available, use this to continue.

titles

A list of titles to work on.

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
pageids

A list of page IDs to work on.

Type: list of integers
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
revids

A list of revision IDs to work on.

Type: list of integers
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

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

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

Type: boolean (details)
converttitles

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

Type: boolean (details)
例:
ページ Main Page および API をパージする。
api.php?action=purge&titles=Main_Page|API
標準名前空間にある最初の10ページをパージする。
api.php?action=purge&generator=allpages&gapnamespace=0&gaplimit=10

action=query

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

Fetch data from and about MediaWiki.

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

パラメーター:
prop

Which properties to get for the queried pages.

値 (|で区切る): categoriescategoryinfocontributorsdeletedrevisionsduplicatefilesextlinksfileusageimageinfoimagesinfoiwlinkslanglinkslinkslinksherepagepropsredirectsrevisionsstashimageinfotemplatestranscludedin
list

Which lists to get.

値 (|で区切る): allcategoriesalldeletedrevisionsallfileusagesallimagesalllinksallpagesallredirectsalltransclusionsallusersbacklinksblockscategorymembersdeletedrevsembeddedinexturlusagefilearchiveimageusageiwbacklinkslangbacklinkslogeventspagepropnamespageswithpropprefixsearchprotectedtitlesquerypagerandomrecentchangessearchtagsusercontribsuserswatchlistwatchlistraw
meta

Which metadata to get.

値 (|で区切る): allmessagesfilerepoinfositeinfotokensuserinfo
indexpageids

Include an additional pageids section listing all returned page IDs.

Type: boolean (details)
export

Export the current revisions of all given or generated pages.

Type: boolean (details)
exportnowrap

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

Type: boolean (details)
iwurl

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

Type: boolean (details)
continue

When more results are available, use this to continue.

rawcontinue

Return raw query-continue data for continuation.

Type: boolean (details)
titles

A list of titles to work on.

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
pageids

A list of page IDs to work on.

Type: list of integers
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
revids

A list of revision IDs to work on.

Type: list of integers
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

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

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

Type: boolean (details)
converttitles

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

Type: boolean (details)

prop=categories (cl)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

List all categories the pages belong to.

パラメーター:
clprop

Which additional properties to get for each category:

sortkey
Adds the sortkey (hexadecimal string) and sortkey prefix (human-readable part) for the category.
timestamp
Adds timestamp of when the category was added.
hidden
Tags categories that are hidden with __HIDDENCAT__.
値 (|で区切る): sortkey、timestamp、hidden
clshow

Which kind of categories to show.

値 (|で区切る): hidden、!hidden
cllimit

返すカテゴリの数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 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

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
例:
ページ Albert Einstein が属しているカテゴリの一覧を取得する。
api.php?action=query&prop=categories&titles=Albert%20Einstein
ページ Albert Einstein で使われているすべてのカテゴリに関する情報を取得する。
api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info

prop=categoryinfo (ci)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
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=contributors (pc)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
pcgroup

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

値 (|で区切る): bot、sysop、bureaucrat、widgeteditor
pcexcludegroup

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

値 (|で区切る): bot、sysop、bureaucrat、widgeteditor
pcrights

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

値 (|で区切る): apihighlimits、applychangetags、autoconfirmed、autopatrol、bigdelete、block、blockemail、bot、browsearchive、changetags、createaccount、createpage、createtalk、delete、deletedhistory、deletedtext、deletelogentry、deleterevision、edit、editcontentmodel、editinterface、editprotected、editmyoptions、editmyprivateinfo、editmyusercss、editmyuserjs、editmywatchlist、editsemiprotected、editusercssjs、editusercss、edituserjs、hideuser、import、importupload、ipblock-exempt、managechangetags、markbotedits、mergehistory、minoredit、move、movefile、move-categorypages、move-rootuserpages、move-subpages、nominornewtalk、noratelimit、override-export-depth、pagelang、passwordreset、patrol、patrolmarks、protect、proxyunbannable、purge、read、reupload、reupload-own、reupload-shared、rollback、sendemail、siteadmin、suppressionlog、suppressredirect、suppressrevision、unblockself、undelete、unwatchedpages、upload、upload_by_url、userrights、userrights-interwiki、viewmyprivateinfo、viewmywatchlist、viewsuppressed、writeapi、renameuser、spamblacklistlog、tboverride、tboverride-account、titleblacklistlog、skipcaptcha、nuke、editwidgets
値の最大値は 50 (ボットの場合は 500) です。
pcexcluderights

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

値 (|で区切る): apihighlimits、applychangetags、autoconfirmed、autopatrol、bigdelete、block、blockemail、bot、browsearchive、changetags、createaccount、createpage、createtalk、delete、deletedhistory、deletedtext、deletelogentry、deleterevision、edit、editcontentmodel、editinterface、editprotected、editmyoptions、editmyprivateinfo、editmyusercss、editmyuserjs、editmywatchlist、editsemiprotected、editusercssjs、editusercss、edituserjs、hideuser、import、importupload、ipblock-exempt、managechangetags、markbotedits、mergehistory、minoredit、move、movefile、move-categorypages、move-rootuserpages、move-subpages、nominornewtalk、noratelimit、override-export-depth、pagelang、passwordreset、patrol、patrolmarks、protect、proxyunbannable、purge、read、reupload、reupload-own、reupload-shared、rollback、sendemail、siteadmin、suppressionlog、suppressredirect、suppressrevision、unblockself、undelete、unwatchedpages、upload、upload_by_url、userrights、userrights-interwiki、viewmyprivateinfo、viewmywatchlist、viewsuppressed、writeapi、renameuser、spamblacklistlog、tboverride、tboverride-account、titleblacklistlog、skipcaptcha、nuke、editwidgets
値の最大値は 50 (ボットの場合は 500) です。
pclimit

返す投稿者の数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
pccontinue

When more results are available, use this to continue.

例:
Main Page への投稿者を表示する。
api.php?action=query&prop=contributors&titles=Main_Page

prop=deletedrevisions (drv)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

Get deleted revision information.

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
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision.
userid
User ID of the revision creator.
size
Length (bytes) of the revision.
sha1
SHA-1 (base 16) of the revision.
contentmodel
Content model ID of the revision.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Text of the revision.
tags
Tags for the revision.
parsetree
The XML parse tree of revision content (requires content model wikitext).
値 (|で区切る): ids、flags、timestamp、user、userid、size、sha1、contentmodel、comment、parsedcomment、content、tags、parsetree
既定値: ids|timestamp|flags|comment|user
drvlimit

Limit how many revisions will be returned.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
drvexpandtemplates

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

Type: boolean (details)
drvgeneratexml
廃止予定です。

Generate XML parse tree for revision content (requires drvprop=content; replaced by drvprop=parsetree).

Type: boolean (details)
drvparse

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

Type: boolean (details)
drvsection

Only retrieve the content of this section number.

drvdiffto

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

drvdifftotext

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

drvcontentformat

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

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

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

Type: timestamp (allowed formats)
drvend

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

Type: timestamp (allowed formats)
drvdir

In which direction to enumerate:

newer
List oldest first. Note: drvstart has to be before drvend.
older
List newest first (default). Note: drvstart has to be later than drvend.
値 (次の値のいずれか1つ): newer、older
既定値: older
drvtag

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

drvuser

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

Type: user name
drvexcludeuser

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

Type: user name
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&drvprop=user|comment|content
削除された版 123456 に関する情報を一覧表示する。
api.php?action=query&prop=deletedrevisions&revids=123456

prop=duplicatefiles (df)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
dflimit

How many duplicate files to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
dfcontinue

When more results are available, use this to continue.

dfdir

The direction in which to list.

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

Look only for files in the local repository.

Type: boolean (details)
  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
ellimit

返すリンクの数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
eloffset

When more results are available, use this to continue.

Type: integer
elprotocol

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

値 (次の値のいずれか1つ): 空欄にするか、または 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.

Type: boolean (details)
例:
Main Page の外部リンクの一覧を取得する。
api.php?action=query&prop=extlinks&titles=Main%20Page

prop=fileusage (fu)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

Find all pages that use the given files.

パラメーター:
fuprop

Which properties to get:

pageid
Page ID of each page.
title
Title of each page.
redirect
Flag if the page is a redirect.
値 (|で区切る): pageid、title、redirect
既定値: pageid|title|redirect
funamespace

Only include pages in these namespaces.

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
fushow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
値 (|で区切る): redirect、!redirect
fulimit

How many to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
fucontinue

When more results are available, use this to continue.

例:
File:Example.jpg を使用しているページの一覧を取得する。
api.php?action=query&prop=fileusage&titles=File%3AExample.jpg
File:Example.jpg を使用しているページの情報を取得する。
api.php?action=query&generator=fileusage&titles=File%3AExample.jpg&prop=info

prop=imageinfo (ii)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

Returns file information and upload history.

パラメーター:
iiprop

Which file information to get:

timestamp
Adds timestamp for the uploaded version.
user
Adds the user who uploaded each file version.
userid
Add the ID of the user that uploaded each file version.
comment
Comment on the version.
parsedcomment
Parse the comment on the version.
canonicaltitle
Adds the canonical title of the file.
url
Gives URL to the file and the description page.
size
Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions
Alias for size.
sha1
Adds SHA-1 hash for the file.
mime
Adds MIME type of the file.
thumbmime
Adds MIME type of the image thumbnail (requires url and param iiurlwidth).
mediatype
Adds the media type of the file.
metadata
Lists Exif metadata for the version of the file.
commonmetadata
Lists file format generic metadata for the version of the file.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted.
archivename
Adds the filename of the archive version for non-latest versions.
bitdepth
Adds the bit depth of the version.
uploadwarning
Used by the Special:Upload page to get information about an existing file. Not intended for use outside MediaWiki core.
値 (|で区切る): timestamp、user、userid、comment、parsedcomment、canonicaltitle、url、size、dimensions、sha1、mime、thumbmime、mediatype、metadata、commonmetadata、extmetadata、archivename、bitdepth、uploadwarning
既定値: timestamp|user
iilimit

How many file revisions to return per file.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 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.

Type: integer
既定値: -1
iiurlheight

Similar to iiurlwidth.

Type: integer
既定値: -1
iimetadataversion

Version of metadata to use. If latest is specified, use latest version. Defaults to 1 for backwards compatibility.

既定値: 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.

既定値: ja
iiextmetadatamultilang

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

Type: boolean (details)
iiextmetadatafilter

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

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
iiurlparam

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

既定値: (空)
iicontinue

When more results are available, use this to continue.

iilocalonly

Look only for files in the local repository.

Type: boolean (details)

prop=images (im)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
imlimit

返す画像の数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 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

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
例:
Main Page で使用されているファイルの一覧を取得する。
api.php?action=query&prop=images&titles=Main%20Page
Main Page で使用されているファイルに関する情報を取得する。
api.php?action=query&generator=images&titles=Main%20Page&prop=info

prop=info (in)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

ページの基本的な情報を取得します。

パラメーター:
inprop

Which additional properties to get:

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.
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.
preload
Gives the text returned by EditFormPreloadText.
displaytitle
Gives the manner in which the page title is actually displayed.
値 (|で区切る): protection、talkid、watched、watchers、notificationtimestamp、subjectid、url、readable、preload、displaytitle
intestactions

Test whether the current user can perform certain actions on the page.

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
intoken
廃止予定です。

Use action=query&meta=tokens instead.

値 (|で区切る): edit、delete、protect、move、block、unblock、email、import、watch
incontinue

When more results are available, use this to continue.

例:
Main Page に関する情報を取得する。
api.php?action=query&prop=info&titles=Main%20Page
Get general and protection information about the page Main Page.
api.php?action=query&prop=info&inprop=protection&titles=Main%20Page
  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

Returns all interwiki links from the given pages.

パラメーター:
iwprop

Which additional properties to get for each interlanguage link:

url
Adds the full URL.
値 (|で区切る): url
iwprefix

この接頭辞のウィキ間リンクのみを返す。

iwtitle

検索するウィキ間リンク。iw と同時に使用しなければなりません。

iwdir

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
iwlimit

返すウィキ間リンクの数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
iwcontinue

When more results are available, use this to continue.

iwurl
廃止予定です。

Whether to get the full URL (cannot be used with iwprop).

Type: boolean (details)
例:
Main Page にあるウィキ間リンクを取得する。
api.php?action=query&prop=iwlinks&titles=Main%20Page
  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

Returns all interlanguage links from the given pages.

パラメーター:
llprop

Which additional properties to get for each interlanguage link:

url
Adds the full URL.
langname
Adds the localised language name (best effort). Use llinlanguagecode to control the language.
autonym
Adds the native language name.
値 (|で区切る): url、langname、autonym
lllang

この言語コードの言語間リンクのみを返す。

lltitle

検索するリンク。lllangと同時に使用しなければなりません。

lldir

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
llinlanguagecode

Language code for localised language names.

既定値: ja
lllimit

返す言語間リンクの数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
llcontinue

When more results are available, use this to continue.

llurl
廃止予定です。

完全なURLを取得するかどうか (llpropとは同時に使用できません).

Type: boolean (details)
例:
Main Page にある言語間リンクを取得する。
api.php?action=query&prop=langlinks&titles=Main%20Page&redirects=
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

ページからのすべてのリンクを返します。

パラメーター:
plnamespace

この名前空間へのリンクのみ表示する。

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
pllimit

返すリンクの数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 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

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
例:
Main Page からのリンクを取得する。
api.php?action=query&prop=links&titles=Main%20Page
Main Page からリンクされているページに関する情報を取得する。
api.php?action=query&generator=links&titles=Main%20Page&prop=info
Main Page からの 利用者 および テンプレート 名前空間へのリンクを取得する。
api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10

prop=linkshere (lh)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

Find all pages that link to the given pages.

パラメーター:
lhprop

Which properties to get:

pageid
Page ID of each page.
title
Title of each page.
redirect
Flag if the page is a redirect.
値 (|で区切る): pageid、title、redirect
既定値: pageid|title|redirect
lhnamespace

Only include pages in these namespaces.

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
lhshow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
値 (|で区切る): redirect、!redirect
lhlimit

How many to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
lhcontinue

When more results are available, use this to continue.

例:
Main Page にリンクしているページの一覧を取得する。
api.php?action=query&prop=linkshere&titles=Main%20Page
Main Page にリンクしているページの情報を取得する。
api.php?action=query&generator=linkshere&titles=Main%20Page&prop=info

prop=pageprops (pp)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

Get various properties defined in the page content.

パラメーター:
ppcontinue

When more results are available, use this to continue.

ppprop

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

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
例:
ページ Main Page および MeiaWiki のプロパティを取得する。
api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki

prop=redirects (rd)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

ページへのすべての転送を返します。

パラメーター:
rdprop

Which properties to get:

pageid
Page ID of each redirect.
title
Title of each redirect.
fragment
Fragment of each redirect, if any.
値 (|で区切る): pageid、title、fragment
既定値: pageid|title
rdnamespace

Only include pages in these namespaces.

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
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

返す転送の数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
rdcontinue

When more results are available, use this to continue.

例:
Main Page への転送の一覧を取得する。
api.php?action=query&prop=redirects&titles=Main%20Page
Main Page へのすべての転送ページに関する情報を取得する。
api.php?action=query&generator=redirects&titles=Main%20Page&prop=info

prop=revisions (rv)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

Get revision information.

May be used in several ways:

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

Which properties to get for each revision:

ids
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision.
userid
User ID of the revision creator.
size
Length (bytes) of the revision.
sha1
SHA-1 (base 16) of the revision.
contentmodel
Content model ID of the revision.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Text of the revision.
tags
Tags for the revision.
parsetree
The XML parse tree of revision content (requires content model wikitext).
値 (|で区切る): ids、flags、timestamp、user、userid、size、sha1、contentmodel、comment、parsedcomment、content、tags、parsetree
既定値: ids|timestamp|flags|comment|user
rvlimit

Limit how many revisions will be returned.

May only be used with a single page (mode #2).
No more than 500 (5,000 for bots) allowed.
Type: integer or max
rvexpandtemplates

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

Type: boolean (details)
rvgeneratexml
廃止予定です。

Generate XML parse tree for revision content (requires rvprop=content; replaced by rvprop=parsetree).

Type: boolean (details)
rvparse

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

Type: boolean (details)
rvsection

Only retrieve the content of this section number.

rvdiffto

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

rvdifftotext

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

rvcontentformat

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

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

From which revision ID to start enumeration.

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

Stop revision enumeration on this revision ID.

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

From which revision timestamp to start enumeration.

May only be used with a single page (mode #2).
Type: timestamp (allowed formats)
rvend

Enumerate up to this timestamp.

May only be used with a single page (mode #2).
Type: timestamp (allowed formats)
rvdir

In which direction to enumerate:

newer
List oldest first. Note: rvstart has to be before rvend.
older
List newest first (default). Note: rvstart has to be later than rvend.
May only be used with a single page (mode #2).
値 (次の値のいずれか1つ): newer、older
既定値: older
rvuser

この利用者による版のみを結果に含める。

May only be used with a single page (mode #2).
Type: user name
rvexcludeuser

この利用者による版を結果に含めない。

May only be used with a single page (mode #2).
Type: user name
rvtag

このタグが付与された版のみを一覧表示する。

rvtoken
廃止予定です。

Which tokens to obtain for each revision.

値 (|で区切る): rollback
rvcontinue

When more results are available, use this to continue.

prop=stashimageinfo (sii)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

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

Which file information to get:

timestamp
Adds timestamp for the uploaded version.
canonicaltitle
Adds the canonical title of the file.
url
Gives URL to the file and the description page.
size
Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions
Alias for size.
sha1
Adds SHA-1 hash for the file.
mime
Adds MIME type of the file.
thumbmime
Adds MIME type of the image thumbnail (requires url and param siiurlwidth).
metadata
Lists Exif metadata for the version of the file.
commonmetadata
Lists file format generic metadata for the version of the file.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted.
bitdepth
Adds the bit depth of the version.
値 (|で区切る): timestamp、canonicaltitle、url、size、dimensions、sha1、mime、thumbmime、metadata、commonmetadata、extmetadata、bitdepth
既定値: timestamp|url
siiurlwidth

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

Type: integer
既定値: -1
siiurlheight

Similar to siiurlwidth.

Type: integer
既定値: -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)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

与えられたページでトランスクルードされているすべてのページを返します。

パラメーター:
tlnamespace

この名前空間のテンプレートのみ表示する。

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
tllimit

返すテンプレートの数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 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

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
例:
Main Page で使用されているテンプレートを取得する。
api.php?action=query&prop=templates&titles=Main%20Page
Main Page で使用されているテンプレートに関する情報を取得する。
api.php?action=query&generator=templates&titles=Main%20Page&prop=info
Main Page でトランスクルードされている 利用者 および テンプレート 名前空間のページを取得する。
api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10

prop=transcludedin (ti)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

与えられたページをトランスクルードしているすべてのページを検索します。

パラメーター:
tiprop

Which properties to get:

pageid
Page ID of each page.
title
Title of each page.
redirect
Flag if the page is a redirect.
値 (|で区切る): pageid、title、redirect
既定値: pageid|title|redirect
tinamespace

Only include pages in these namespaces.

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
tishow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
値 (|で区切る): redirect、!redirect
tilimit

How many to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 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=allcategories (ac)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

すべてのカテゴリを一覧表示します。

パラメーター:
acfrom

列挙を開始するカテゴリ。

accontinue

When more results are available, use this to continue.

acto

列挙を終了するカテゴリ。

acprefix

この値で始まるタイトルのカテゴリを検索します。

acdir

Direction to sort in.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
acmin

Only return categories with at least this many members.

Type: integer
acmax

Only return categories with at most this many members.

Type: integer
aclimit

返すカテゴリの数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
acprop

Which properties to get:

size
Adds number of pages in the category.
hidden
Tags categories that are hidden with __HIDDENCAT__.
値 (|で区切る): size、hidden
既定値: (空)
例:
List categories with information on the number of pages in each.
api.php?action=query&list=allcategories&acprop=size
List で始まるカテゴリページに関する情報を取得する。
api.php?action=query&generator=allcategories&gacprefix=List&prop=info

list=alldeletedrevisions (adr)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
adrprop

Which properties to get for each revision:

ids
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision.
userid
User ID of the revision creator.
size
Length (bytes) of the revision.
sha1
SHA-1 (base 16) of the revision.
contentmodel
Content model ID of the revision.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Text of the revision.
tags
Tags for the revision.
parsetree
The XML parse tree of revision content (requires content model wikitext).
値 (|で区切る): ids、flags、timestamp、user、userid、size、sha1、contentmodel、comment、parsedcomment、content、tags、parsetree
既定値: ids|timestamp|flags|comment|user
adrlimit

Limit how many revisions will be returned.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
adrexpandtemplates

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

Type: boolean (details)
adrgeneratexml
廃止予定です。

Generate XML parse tree for revision content (requires adrprop=content; replaced by adrprop=parsetree).

Type: boolean (details)
adrparse

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

Type: boolean (details)
adrsection

Only retrieve the content of this section number.

adrdiffto

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

adrdifftotext

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

adrcontentformat

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

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

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

Type: user name
adrnamespace

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

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
adrstart

列挙の始点となるタイムスタンプ。

May only be used with adruser.
Type: timestamp (allowed formats)
adrend

列挙の終点となるタイムスタンプ。

May only be used with adruser.
Type: timestamp (allowed formats)
adrdir

In which direction to enumerate:

newer
List oldest first. Note: adrstart has to be before adrend.
older
List newest first (default). Note: adrstart has to be later than adrend.
値 (次の値のいずれか1つ): newer、older
既定値: older
adrfrom

列挙の始点となるページ名。

adruser と同時に使用できません。
adrto

列挙の終点となるページ名。

adruser と同時に使用できません。
adrprefix

この値で始まるすべてのページ名を検索する。

adruser と同時に使用できません。
adrexcludeuser

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

adruser と同時に使用できません。
Type: user name
adrtag

このタグが付与された版のみを一覧表示する。

adrcontinue

When more results are available, use this to continue.

adrgeneratetitles

ジェネレーターとして使用する場合、版IDではなくページ名を生成します。

Type: boolean (details)
例:
利用者 Example による削除された直近の50版を一覧表示する。
api.php?action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50
標準名前空間にある削除された最初の50版を一覧表示する。
api.php?action=query&list=alldeletedrevisions&adrdir=newer&adrlimit=50

list=allfileusages (af)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

List all file usages, including non-existing.

パラメーター:
afcontinue

When more results are available, use this to continue.

affrom

列挙を開始するファイルのタイトル。

afto

列挙を終了するファイルのタイトル。

afprefix

この値で始まるすべてのファイルのタイトルを検索する。

afunique

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

Type: boolean (details)
afprop

Which pieces of information to include:

ids
Adds the page IDs of the using pages (cannot be used with afunique).
title
Adds the title of the file.
値 (|で区切る): ids、title
既定値: title
aflimit

How many total items to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
afdir

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
例:
List file titles, including missing ones, with page IDs they are from, starting at B.
api.php?action=query&list=allfileusages&affrom=B&afprop=ids|title
List unique file titles.
api.php?action=query&list=allfileusages&afunique=&affrom=B
Gets all file titles, marking the missing ones.
api.php?action=query&generator=allfileusages&gafunique=&gaffrom=B
Gets pages containing the files.
api.php?action=query&generator=allfileusages&gaffrom=B

list=allimages (ai)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

Enumerate all images sequentially.

パラメーター:
aisort

Property to sort by.

値 (次の値のいずれか1つ): name、timestamp
既定値: name
aidir

The direction in which to list.

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

Which file information to get:

timestamp
Adds timestamp for the uploaded version.
user
Adds the user who uploaded each file version.
userid
Add the ID of the user that uploaded each file version.
comment
Comment on the version.
parsedcomment
Parse the comment on the version.
canonicaltitle
Adds the canonical title of the file.
url
Gives URL to the file and the description page.
size
Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions
Alias for size.
sha1
Adds SHA-1 hash for the file.
mime
Adds MIME type of the file.
mediatype
Adds the media type of the file.
metadata
Lists Exif metadata for the version of the file.
commonmetadata
Lists file format generic metadata for the version of the file.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted.
bitdepth
Adds the bit depth of the version.
値 (|で区切る): timestamp、user、userid、comment、parsedcomment、canonicaltitle、url、size、dimensions、sha1、mime、mediatype、metadata、commonmetadata、extmetadata、bitdepth
既定値: timestamp|url
aiprefix

この値で始まるすべての画像タイトルを検索する。aisort=name を指定した場合のみ使用できます。

aiminsize

Limit to images with at least this many bytes.

Type: integer
aimaxsize

Limit to images with at most this many bytes.

Type: integer
aisha1

SHA1 hash of image. Overrides aisha1base36.

aisha1base36

SHA1 hash of image in base 36 (used in MediaWiki).

aiuser

この利用者によりアップロードされたファイルのみを返す。aisort=timestamp を指定した場合のみ使用できます。 aifilterbots とは同時に使用できません。

Type: user name
aifilterbots

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

値 (次の値のいずれか1つ): all、bots、nobots
既定値: all
aimime

検索対象のMIMEタイプ、たとえば image/jpeg

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
ailimit

返す画像の総数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
例:
B で始まるファイルの一覧を表示する。
api.php?action=query&list=allimages&aifrom=B
Special:NewFiles のように、最近アップロードされたファイルの一覧を表示する。
api.php?action=query&list=allimages&aiprop=user|timestamp|url&aisort=timestamp&aidir=older
MIMEタイプが image/png または image/gif であるファイルの一覧を表示する
api.php?action=query&list=allimages&aimime=image/png|image/gif
T で始まる4つのファイルに関する情報を表示する。
api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

与えられた名前空間へのすべてのリンクを一覧表示します。

パラメーター:
alcontinue

When more results are available, use this to continue.

alfrom

列挙を開始するリンクのタイトル。

alto

列挙を終了するリンクのページ名。

alprefix

この値で始まるすべてのリンクされたページを検索する。

alunique

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

Type: boolean (details)
alprop

Which pieces of information to include:

ids
Adds the page ID of the linking page (cannot be used with alunique).
title
Adds the title of the link.
値 (|で区切る): ids、title
既定値: title
alnamespace

The namespace to enumerate.

値 (次の値のいずれか1つ): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
既定値: 0
allimit

How many total items to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
aldir

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
例:
B で始まるリンクされたページ (存在しないページも含む)を、リンク元のページIDとともに表示する。
api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title
List unique linked titles.
api.php?action=query&list=alllinks&alunique=&alfrom=B
Gets all linked titles, marking the missing ones.
api.php?action=query&generator=alllinks&galunique=&galfrom=B
Gets pages containing the links.
api.php?action=query&generator=alllinks&galfrom=B

list=allpages (ap)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

Enumerate all pages sequentially in a given namespace.

パラメーター:
apfrom

列挙を開始するページ名。

apcontinue

When more results are available, use this to continue.

apto

列挙を終了するページ名。

apprefix

この値で始まるすべてのページ名を検索します。

apnamespace

The namespace to enumerate.

値 (次の値のいずれか1つ): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
既定値: 0
apfilterredir

Which pages to list.

値 (次の値のいずれか1つ): all、redirects、nonredirects
既定値: all
apminsize

Limit to pages with at least this many bytes.

Type: integer
apmaxsize

Limit to pages with at most this many bytes.

Type: integer
apprtype

保護されているページに絞り込む。

値 (|で区切る): edit、move、upload
apprlevel

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

値 (|で区切る): 空欄にするか、または autoconfirmed、sysop
apprfiltercascade

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

値 (次の値のいずれか1つ): cascading、noncascading、all
既定値: all
aplimit

返すページの総数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
apdir

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
apfilterlanglinks

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

値 (次の値のいずれか1つ): withlanglinks、withoutlanglinks、all
既定値: all
apprexpiry

Which protection expiry to filter the page on:

indefinite
Get only pages with indefinite protection expiry.
definite
Get only pages with a definite (specific) protection expiry.
all
Get pages with any protections expiry.
値 (次の値のいずれか1つ): indefinite、definite、all
既定値: all
例:
B で始まるページの一覧を表示する。
api.php?action=query&list=allpages&apfrom=B
T で始まる4つのページに関する情報を表示する。
api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info
Re で始まる最初の非リダイレクトの2ページの内容を表示する。
api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content

list=allredirects (ar)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

List all redirects to a namespace.

パラメーター:
arcontinue

When more results are available, use this to continue.

arfrom

列挙を開始するリダイレクトのページ名。

arto

列挙を終了するリダイレクトのページ名。

arprefix

Search for all target pages that begin with this value.

arunique

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

Type: boolean (details)
arprop

Which pieces of information to include:

ids
Adds the page ID of the redirecting page (cannot be used with arunique).
title
Adds the title of the redirect.
fragment
Adds the fragment from the redirect, if any (cannot be used with arunique).
interwiki
Adds the interwiki prefix from the redirect, if any (cannot be used with arunique).
値 (|で区切る): ids、title、fragment、interwiki
既定値: title
arnamespace

The namespace to enumerate.

値 (次の値のいずれか1つ): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
既定値: 0
arlimit

How many total items to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
ardir

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
例:
List target pages, including missing ones, with page IDs they are from, starting at B.
api.php?action=query&list=allredirects&arfrom=B&arprop=ids|title
List unique target pages.
api.php?action=query&list=allredirects&arunique=&arfrom=B
Gets all target pages, marking the missing ones.
api.php?action=query&generator=allredirects&garunique=&garfrom=B
Gets pages containing the redirects.
api.php?action=query&generator=allredirects&garfrom=B

list=alltransclusions (at)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

List all transclusions (pages embedded using {{x}}), including non-existing.

パラメーター:
atcontinue

When more results are available, use this to continue.

atfrom

The title of the transclusion to start enumerating from.

atto

The title of the transclusion to stop enumerating at.

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.

Type: boolean (details)
atprop

Which pieces of information to include:

ids
Adds the page ID of the transcluding page (cannot be used with atunique).
title
Adds the title of the transclusion.
値 (|で区切る): ids、title
既定値: title
atnamespace

The namespace to enumerate.

値 (次の値のいずれか1つ): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
既定値: 10
atlimit

How many total items to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
atdir

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
例:
List transcluded titles, including missing ones, with page IDs they are from, starting at B.
api.php?action=query&list=alltransclusions&atfrom=B&atprop=ids|title
List unique transcluded titles.
api.php?action=query&list=alltransclusions&atunique=&atfrom=B
Gets all transcluded titles, marking the missing ones.
api.php?action=query&generator=alltransclusions&gatunique=&gatfrom=B
Gets pages containing the transclusions.
api.php?action=query&generator=alltransclusions&gatfrom=B

list=allusers (au)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

すべての登録利用者を一覧表示します。

パラメーター:
aufrom

列挙を開始する利用者名。

auto

列挙を終了する利用者名。

auprefix

この値で始まるすべての利用者を検索する。

audir

Direction to sort in.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
augroup

このグループに所属する利用者のみを結果に含める。

値 (|で区切る): bot、sysop、bureaucrat、widgeteditor
auexcludegroup

このグループに所属する利用者を結果から除外する。

値 (|で区切る): bot、sysop、bureaucrat、widgeteditor
aurights

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

値 (|で区切る): apihighlimits、applychangetags、autoconfirmed、autopatrol、bigdelete、block、blockemail、bot、browsearchive、changetags、createaccount、createpage、createtalk、delete、deletedhistory、deletedtext、deletelogentry、deleterevision、edit、editcontentmodel、editinterface、editprotected、editmyoptions、editmyprivateinfo、editmyusercss、editmyuserjs、editmywatchlist、editsemiprotected、editusercssjs、editusercss、edituserjs、hideuser、import、importupload、ipblock-exempt、managechangetags、markbotedits、mergehistory、minoredit、move、movefile、move-categorypages、move-rootuserpages、move-subpages、nominornewtalk、noratelimit、override-export-depth、pagelang、passwordreset、patrol、patrolmarks、protect、proxyunbannable、purge、read、reupload、reupload-own、reupload-shared、rollback、sendemail、siteadmin、suppressionlog、suppressredirect、suppressrevision、unblockself、undelete、unwatchedpages、upload、upload_by_url、userrights、userrights-interwiki、viewmyprivateinfo、viewmywatchlist、viewsuppressed、writeapi、renameuser、spamblacklistlog、tboverride、tboverride-account、titleblacklistlog、skipcaptcha、nuke、editwidgets
値の最大値は 50 (ボットの場合は 500) です。
auprop

Which pieces of information to include:

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

返す利用者名の総数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
auwitheditsonly

編集履歴のある利用者のみ一覧表示する。

Type: boolean (details)
auactiveusers

最近 30 日間のアクティブな利用者のみを一覧表示する。

Type: boolean (details)
例:
Y で始まる利用者を一覧表示する。
api.php?action=query&list=allusers&aufrom=Y
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

与えられたページにリンクしているすべてのページを検索します。

パラメーター:
bltitle

検索するページ名。blpageid とは同時に使用できません。

blpageid

検索するページID。bltitleとは同時に使用できません。

Type: integer
blcontinue

When more results are available, use this to continue.

blnamespace

The namespace to enumerate.

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
bldir

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
blfilterredir

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

値 (次の値のいずれか1つ): all、redirects、nonredirects
既定値: all
bllimit

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

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
blredirect

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

Type: boolean (details)
例:
Main page へのリンクを表示する。
api.php?action=query&list=backlinks&bltitle=Main%20Page
Main page にリンクしているページの情報を取得する。
api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info

list=blocks (bk)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

ブロックされた利用者とIPアドレスを一覧表示します。

パラメーター:
bkstart

列挙の始点となるタイムスタンプ。

Type: timestamp (allowed formats)
bkend

列挙の終点となるタイムスタンプ。

Type: timestamp (allowed formats)
bkdir

In which direction to enumerate:

newer
List oldest first. Note: bkstart has to be before bkend.
older
List newest first (default). Note: bkstart has to be later than bkend.
値 (次の値のいずれか1つ): newer、older
既定値: older
bkids

一覧表示するブロックIDのリスト (任意)。

Type: list of integers
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
bkusers

検索対象の利用者のリスト (任意)。

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
bkip

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

bklimit

一覧表示するブロックの最大数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
bkprop

Which properties to get:

id
Adds the ID of the block.
user
Adds the username of the blocked user.
userid
Adds the user ID of the blocked user.
by
Adds the username of the blocking user.
byid
Adds the user ID of the blocking user.
timestamp
Adds the timestamp of when the block was given.
expiry
Adds the timestamp of when the block expires.
reason
Adds the reason given for the block.
range
Adds the range of IP addresses affected by the block.
flags
Tags the ban with (autoblock, anononly, etc.).
値 (|で区切る): id、user、userid、by、byid、timestamp、expiry、reason、range、flags
既定値: id|user|by|timestamp|expiry|reason|flags
bkshow

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

値 (|で区切る): account、!account、temp、!temp、ip、!ip、range、!range
bkcontinue

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)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

与えられたカテゴリ内のすべてのページを一覧表示します。

パラメーター:
cmtitle

一覧表示するカテゴリ (必須)。カテゴリ: 接頭辞を含まなければなりません。cmpageid とは同時に使用できません。

cmpageid

一覧表示するカテゴリのページID. cmtitle とは同時に使用できません。

Type: integer
cmprop

Which pieces of information to include:

ids
Adds the page ID.
title
Adds the title and namespace ID of the page.
sortkey
Adds the sortkey used for sorting in the category (hexadecimal string).
sortkeyprefix
Adds the sortkey prefix used for sorting in the category (human-readable part of the sortkey).
type
Adds the type that the page has been categorised as (page, subcat or file).
timestamp
Adds the timestamp of when the page was included.
値 (|で区切る): ids、title、sortkey、sortkeyprefix、type、timestamp
既定値: ids|title
cmnamespace

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、274、275
cmtype

Which type of category members to include. Ignored when cmsort=timestamp is set.

値 (|で区切る): page、subcat、file
既定値: page|subcat|file
cmcontinue

When more results are available, use this to continue.

cmlimit

返すページの最大数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
cmsort

Property to sort by.

値 (次の値のいずれか1つ): sortkey、timestamp
既定値: sortkey
cmdir

In which direction to sort.

値 (次の値のいずれか1つ): asc、desc、ascending、descending、newer、older
既定値: 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=deletedrevs (dr)

  • このモジュールは廃止予定です。
  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

List deleted revisions.

Operates in three modes:

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

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

パラメーター:
drstart

The timestamp to start enumerating from.

Modes: 1、2
Type: timestamp (allowed formats)
drend

The timestamp to stop enumerating at.

Modes: 1、2
Type: timestamp (allowed formats)
drdir

In which direction to enumerate:

newer
List oldest first. Note: drstart has to be before drend.
older
List newest first (default). Note: drstart has to be later than drend.
Modes: 1、3
値 (次の値のいずれか1つ): newer、older
既定値: older
drfrom

列挙の始点となるページ名。

Mode: 3
drto

列挙の終点となるページ名。

Mode: 3
drprefix

Search for all page titles that begin with this value.

Mode: 3
drunique

List only one revision for each page.

Mode: 3
Type: boolean (details)
drnamespace

Only list pages in this namespace.

Mode: 3
値 (次の値のいずれか1つ): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
既定値: 0
drtag

Only list revisions tagged with this tag.

druser

Only list revisions by this user.

Type: user name
drexcludeuser

Don't list revisions by this user.

Type: user name
drprop

Which properties to get:

revid
Adds the revision ID of the deleted revision.
parentid
Adds the revision ID of the previous revision to the page.
user
Adds the user who made the revision.
userid
Adds the ID of the user who made the revision.
comment
Adds the comment of the revision.
parsedcomment
Adds the parsed comment of the revision.
minor
Tags if the revision is minor.
len
Adds the length (bytes) of the revision.
sha1
Adds the SHA-1 (base 16) of the revision.
content
Adds the content of the revision.
token
Deprecated. Gives the edit token.
tags
Tags for the revision.
値 (|で区切る): revid、parentid、user、userid、comment、parsedcomment、minor、len、sha1、content、token、tags
既定値: user|comment
drlimit

The maximum amount of revisions to list.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
drcontinue

When more results are available, use this to continue.

例:
List the last deleted revisions of the pages Main Page and Talk:Main Page, with content (mode 1).
api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content
List the last 50 deleted contributions by Bob (mode 2).
api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50
List the first 50 deleted revisions in the main namespace (mode 3).
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50
List the first 50 deleted pages in the トーク namespace (mode 3).
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique=

list=embeddedin (ei)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
eititle

検索するページ名。eipageid とは同時に使用できません。

eipageid

検索するページID. eititleとは同時に使用できません。

Type: integer
eicontinue

When more results are available, use this to continue.

einamespace

The namespace to enumerate.

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
eidir

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
eifilterredir

How to filter for redirects.

値 (次の値のいずれか1つ): all、redirects、nonredirects
既定値: all
eilimit

How many total pages to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
例:
Show pages transcluding 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)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

与えられたURLを含むページを一覧表示します。

パラメーター:
euprop

Which pieces of information to include:

ids
Adds the ID of page.
title
Adds the title and namespace ID of the page.
url
Adds the URL used in the page.
値 (|で区切る): ids、title、url
既定値: ids|title|url
euoffset

When more results are available, use this to continue.

Type: integer
euprotocol

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

値 (次の値のいずれか1つ): 空欄にするか、または 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

Search string without protocol. See Special:LinkSearch. Leave empty to list all external links.

eunamespace

The page namespaces to enumerate.

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
eulimit

How many pages to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
euexpandurl

Expand protocol-relative URLs with the canonical protocol.

Type: boolean (details)
例:
http://www.mediawiki.org にリンクしているページを一覧表示する。
api.php?action=query&list=exturlusage&euquery=www.mediawiki.org

list=filearchive (fa)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

Enumerate all deleted files sequentially.

パラメーター:
fafrom

The image title to start enumerating from.

fato

The image title to stop enumerating at.

faprefix

Search for all image titles that begin with this value.

fadir

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
fasha1

SHA1 hash of image. Overrides fasha1base36.

fasha1base36

SHA1 hash of image in base 36 (used in MediaWiki).

faprop

Which image information to get:

sha1
Adds SHA-1 hash for the image.
timestamp
Adds timestamp for the uploaded version.
user
Adds user who uploaded the image version.
size
Adds the size of the image in bytes and the height, width and page count (if applicable).
dimensions
Alias for size.
description
Adds description of the image version.
parseddescription
Parse the description of the version.
mime
Adds MIME of the image.
mediatype
Adds the media type of the image.
metadata
Lists Exif metadata for the version of the image.
bitdepth
Adds the bit depth of the version.
archivename
Adds the filename of the archive version for non-latest versions.
値 (|で区切る): sha1、timestamp、user、size、dimensions、description、parseddescription、mime、mediatype、metadata、bitdepth、archivename
既定値: timestamp
falimit

How many images to return in total.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
facontinue

When more results are available, use this to continue.

例:
削除されたファイルの一覧を表示する。
api.php?action=query&list=filearchive

list=imageusage (iu)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

Find all pages that use the given image title.

パラメーター:
iutitle

検索するページ名。iupageid とは同時に使用できません。

iupageid

検索するページID. iutitleとは同時に使用できません。

Type: integer
iucontinue

When more results are available, use this to continue.

iunamespace

The namespace to enumerate.

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
iudir

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
iufilterredir

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

値 (次の値のいずれか1つ): all、redirects、nonredirects
既定値: all
iulimit

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

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
iuredirect

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

Type: boolean (details)
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

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

Prefix for the interwiki.

iwbltitle

Interwiki link to search for. Must be used with iwblblprefix.

iwblcontinue

When more results are available, use this to continue.

iwbllimit

How many total pages to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
iwblprop

Which properties to get:

iwprefix
Adds the prefix of the interwiki.
iwtitle
Adds the title of the interwiki.
値 (|で区切る): iwprefix、iwtitle
既定値: (空)
iwbldir

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

Find all pages that link to the given language link.

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

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

パラメーター:
lbllang

言語間リンクの言語。

lbltitle

検索する言語間リンク。lbllang と同時に使用しなければなりません。

lblcontinue

When more results are available, use this to continue.

lbllimit

返すページの総数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
lblprop

Which properties to get:

lllang
Adds the language code of the language link.
lltitle
Adds the title of the language link.
値 (|で区切る): lllang、lltitle
既定値: (空)
lbldir

The direction in which to list.

値 (次の値のいずれか1つ): ascending、descending
既定値: ascending
例:
fr:Test へリンクしているページを取得する。
api.php?action=query&list=langbacklinks&lbltitle=Test&lbllang=fr
fr:Test へリンクしているページの情報を取得する。
api.php?action=query&generator=langbacklinks&glbltitle=Test&glbllang=fr&prop=info

list=logevents (le)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

Get events from logs.

パラメーター:
leprop

Which properties to get:

ids
Adds the ID of the log event.
title
Adds the title of the page for the log event.
type
Adds the type of log event.
user
Adds the user responsible for the log event.
userid
Adds the user ID who was responsible for the log event.
timestamp
Adds the timestamp for the log event.
comment
Adds the comment of the log event.
parsedcomment
Adds the parsed comment of the log event.
details
Lists additional details about the log event.
tags
Lists tags for the log event.
値 (|で区切る): ids、title、type、user、userid、timestamp、comment、parsedcomment、details、tags
既定値: ids|title|type|user|timestamp|comment|details
letype

Filter log entries to only this type.

値 (次の値のいずれか1つ): 空欄にするか、または renameuser、spamblacklist、titleblacklist、block、protect、rights、delete、upload、move、import、patrol、merge、suppress、tag、managetags、contentmodel、newusers
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つ): protect/modify、protect/protect、protect/unprotect、renameuser/renameuser、spamblacklist/*、titleblacklist/*、block/block、block/reblock、block/unblock、contentmodel/change、delete/delete、delete/event、delete/restore、delete/revision、import/interwiki、import/upload、managetags/activate、managetags/create、managetags/deactivate、managetags/delete、merge/merge、move/move、move/move_redir、patrol/patrol、protect/move_prot、rights/autopromote、rights/rights、suppress/block、suppress/delete、suppress/event、suppress/reblock、suppress/revision、tag/update、upload/overwrite、upload/revert、upload/upload、newusers/newusers、newusers/create、newusers/create2、newusers/byemail、newusers/autocreate
lestart

列挙の始点となるタイムスタンプ。

Type: timestamp (allowed formats)
leend

列挙の終点となるタイムスタンプ。

Type: timestamp (allowed formats)
ledir

In which direction to enumerate:

newer
List oldest first. Note: lestart has to be before leend.
older
List newest first (default). Note: lestart has to be later than leend.
値 (次の値のいずれか1つ): newer、older
既定値: older
leuser

与えられた利用者による記録項目に絞り込む。

letitle

そのページに関連する記録項目に絞り込む。

lenamespace

与えられた名前空間内の記録項目に絞り込む。

値 (次の値のいずれか1つ): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
leprefix

この接頭辞ではじまる記録項目に絞り込む。

letag

このタグが付与された記録項目のみ表示する。

lelimit

返す記録項目の総数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
lecontinue

When more results are available, use this to continue.

例:
最近の記録項目を一覧表示する。
api.php?action=query&list=logevents

list=pagepropnames (ppn)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

Wiki内で使用されているすべてのページプロパティ名を一覧表示します。

パラメーター:
ppncontinue

When more results are available, use this to continue.

ppnlimit

返す名前の最大数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
例:
最初の10個のプロパティ名を取得する。
api.php?action=query&list=pagepropnames

list=pageswithprop (pwp)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

与えられたページプロパティが使用されているすべてのページを一覧表示します。

パラメーター:
pwppropname

Page prop for which to enumerate pages.

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

Which pieces of information to include:

ids
Adds the page ID.
title
Adds the title and namespace ID of the page.
value
Adds the value of the page prop.
値 (|で区切る): ids、title、value
既定値: ids|title
pwpcontinue

When more results are available, use this to continue.

pwplimit

返すページの最大数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
pwpdir

In which direction to sort.

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

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

ページ名の先頭一致検索を行います。

パラメーター:
pssearch

検索文字列。

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

検索する名前空間。

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
既定値: 0
pslimit

返す結果の最大数。

No more than 100 (200 for bots) allowed.
Type: integer or max
既定値: 10
psoffset

Number of results to skip.

Type: integer
既定値: 0
例:
meaning で始まるページ名を検索する。
api.php?action=query&list=prefixsearch&pssearch=meaning

list=protectedtitles (pt)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

作成保護が掛けられているページを一覧表示します。

パラメーター:
ptnamespace

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

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
ptlevel

この保護レベルのページのみを一覧表示します。

値 (|で区切る): autoconfirmed、sysop
ptlimit

返すページの総数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
ptdir

In which direction to enumerate:

newer
List oldest first. Note: ptstart has to be before ptend.
older
List newest first (default). Note: ptstart has to be later than ptend.
値 (次の値のいずれか1つ): newer、older
既定値: older
ptstart

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

Type: timestamp (allowed formats)
ptend

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

Type: timestamp (allowed formats)
ptprop

Which properties to get:

timestamp
Adds the timestamp of when protection was added.
user
Adds the user that added the protection.
userid
Adds the user ID that added the protection.
comment
Adds the comment for the protection.
parsedcomment
Adds the parsed comment for the protection.
expiry
Adds the timestamp of when the protection will be lifted.
level
Adds the protection level.
値 (|で区切る): timestamp、user、userid、comment、parsedcomment、expiry、level
既定値: timestamp|level
ptcontinue

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)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
qppage

特別ページの名前です。これは大文字小文字を区別することに注意。

このパラメーターは必須です。
値 (次の値のいずれか1つ): Ancientpages、BrokenRedirects、Deadendpages、DoubleRedirects、ListDuplicatedFiles、Listredirects、Lonelypages、Longpages、MediaStatistics、Mostcategories、Mostimages、Mostinterwikis、Mostlinkedcategories、Mostlinkedtemplates、Mostlinked、Mostrevisions、Fewestrevisions、Shortpages、Uncategorizedcategories、Uncategorizedpages、Uncategorizedimages、Uncategorizedtemplates、Unusedcategories、Unusedimages、Wantedcategories、Wantedfiles、Wantedpages、Wantedtemplates、Unwatchedpages、Unusedtemplates、Withoutinterwiki
qpoffset

When more results are available, use this to continue.

Type: integer
既定値: 0
qplimit

返す結果の数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10

list=random (rn)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

Get a set of random pages.

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

パラメーター:
rnnamespace

この名前空間にあるページのみを返します。

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
rnfilterredir

How to filter for redirects.

値 (次の値のいずれか1つ): all、redirects、nonredirects
既定値: nonredirects
rnredirect
廃止予定です。

Use rnfilterredir=redirects instead.

Type: boolean (details)
rnlimit

Limit how many random pages will be returned.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 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)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

最近の更新を一覧表示します。

パラメーター:
rcstart

列挙の始点となるタイムスタンプ。

Type: timestamp (allowed formats)
rcend

列挙の終点となるタイムスタンプ。

Type: timestamp (allowed formats)
rcdir

In which direction to enumerate:

newer
List oldest first. Note: rcstart has to be before rcend.
older
List newest first (default). Note: rcstart has to be later than rcend.
値 (次の値のいずれか1つ): newer、older
既定値: older
rcnamespace

この名前空間の変更のみに絞り込む。

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
rcuser

この利用者による変更のみを一覧表示する。

Type: user name
rcexcludeuser

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

Type: user name
rctag

このタグが付与された版のみ一覧表示する。

rcprop

Include additional pieces of information:

user
Adds the user responsible for the edit and tags if they are an IP.
userid
Adds the user ID responsible for the edit.
comment
Adds the comment for the edit.
parsedcomment
Adds the parsed comment for the edit.
flags
Adds flags for the edit.
timestamp
Adds timestamp of the edit.
title
Adds the page title of the edit.
ids
Adds the page ID, recent changes ID and the new and old revision ID.
sizes
Adds the new and old page length in bytes.
redirect
Tags edit if page is a redirect.
patrolled
Tags patrollable edits as being patrolled or unpatrolled.
loginfo
Adds log information (log ID, log type, etc) to log entries.
tags
Lists tags for the entry.
sha1
Adds the content checksum for entries associated with a revision.
値 (|で区切る): user、userid、comment、parsedcomment、flags、timestamp、title、ids、sizes、redirect、patrolled、loginfo、tags、sha1
既定値: title|timestamp|ids
rctoken
廃止予定です。

Use action=query&meta=tokens instead.

値 (|で区切る): patrol
rcshow

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

値 (|で区切る): minor、!minor、bot、!bot、anon、!anon、redirect、!redirect、patrolled、!patrolled、unpatrolled
rclimit

返す変更の総数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
rctype

Which types of changes to show.

値 (|で区切る): edit、external、new、log
既定値: edit|new|log
rctoponly

最新の版である変更のみを一覧表示する。

Type: boolean (details)
rccontinue

When more results are available, use this to continue.

例:
最近の更新を一覧表示する。
api.php?action=query&list=recentchanges
Get page info about recent unpatrolled changes.
api.php?action=query&generator=recentchanges&grcshow=!patrolled&prop=info

list=search (sr)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

全文検索を行います。

パラメーター:
srsearch

この値を含むページ名または本文を検索します。Wikiの検索バックエンド実装に応じて、あなたは特別な検索機能を呼び出すための文字列を検索することができます。

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

この名前空間内のみを検索します。

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
既定値: 0
srwhat

実行する検索の種類です。

値 (次の値のいずれか1つ): title、text、nearmatch
srinfo

Which metadata to return.

値 (|で区切る): totalhits、suggestion、rewrittenquery
既定値: totalhits|suggestion|rewrittenquery
srprop

Which properties to return:

size
Adds the size of the page in bytes.
wordcount
Adds the word count of the page.
timestamp
Adds the timestamp of when the page was last edited.
snippet
Adds a parsed snippet of the page.
titlesnippet
Adds a parsed snippet of the page title.
redirecttitle
Adds the title of the matching redirect.
redirectsnippet
Adds a parsed snippet of the redirect title.
sectiontitle
Adds the title of the matching section.
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
Deprecated and ignored.
hasrelated
Deprecated and ignored.
値 (|で区切る): size、wordcount、timestamp、snippet、titlesnippet、redirecttitle、redirectsnippet、sectiontitle、sectionsnippet、isfilematch、categorysnippet、score、hasrelated
既定値: size|wordcount|timestamp|snippet
sroffset

When more results are available, use this to continue.

Type: integer
既定値: 0
srlimit

返すページの総数です。

No more than 50 (500 for bots) allowed.
Type: integer or max
既定値: 10
srinterwiki

Include interwiki results in the search, if available.

Type: boolean (details)
srenablerewrites

Enable internal query rewriting. Some search backends can rewrite the query into one its thinks gives better results, such as correcting spelling errors.

Type: boolean (details)
例:
meaning を検索する。
api.php?action=query&list=search&srsearch=meaning
Search texts for meaning.
api.php?action=query&list=search&srwhat=text&srsearch=meaning
meaning の検索で返されたページのページ情報を取得する。
api.php?action=query&generator=search&gsrsearch=meaning&prop=info

list=tags (tg)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

変更タグを一覧表示します。

パラメーター:
tgcontinue

When more results are available, use this to continue.

tglimit

一覧表示するタグの最大数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
tgprop

Which properties to get:

name
Adds name of tag.
displayname
Adds system message for the tag.
description
Adds description of the tag.
hitcount
Adds the number of revisions and log entries that have this tag.
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.
値 (|で区切る): name、displayname、description、hitcount、defined、source、active
既定値: name

list=usercontribs (uc)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

利用者によるすべての編集を取得します。

パラメーター:
uclimit

返す投稿記録の最大数。

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 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

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

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
ucuserprefix

この値で始まる名前のすべての利用者の投稿記録を取得します。ucuser をオーバーライドします。

ucdir

In which direction to enumerate:

newer
List oldest first. Note: ucstart has to be before ucend.
older
List newest first (default). Note: ucstart has to be later than ucend.
値 (次の値のいずれか1つ): newer、older
既定値: older
ucnamespace

この名前空間への投稿記録のみを一覧表示する。

値 (|で区切る): 0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、274、275
ucprop

Include additional pieces of information:

ids
Adds the page ID and revision ID.
title
Adds the title and namespace ID of the page.
timestamp
Adds the timestamp of the edit.
comment
Adds the comment of the edit.
parsedcomment
Adds the parsed comment of the edit.
size
Adds the new size of the edit.
sizediff
Adds the size delta of the edit against its parent.
flags
Adds flags of the edit.
patrolled
Tags patrolled edits.
tags
Lists tags for the edit.
値 (|で区切る): ids、title、timestamp、comment、parsedcomment、size、sizediff、flags、patrolled、tags
既定値: ids|title|timestamp|comment|size|flags
ucshow

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

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

値 (|で区切る): minor、!minor、patrolled、!patrolled、top、!top、new、!new
uctag

このタグが付与された版のみを一覧表示する。

uctoponly
廃止予定です。

最新の版である変更のみを一覧表示する。

Type: boolean (details)
例:
利用者 Example の投稿記録を表示する。
api.php?action=query&list=usercontribs&ucuser=Example
Show contributions from all IP addresses with prefix 192.0.2..
api.php?action=query&list=usercontribs&ucuserprefix=192.0.2.

list=users (us)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

Get information about a list of users.

パラメーター:
usprop

Which pieces of information to include:

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

A list of users to obtain information for.

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
ustoken
廃止予定です。

代わりに action=query&meta=tokens を使用してください。

値 (|で区切る): userrights

list=watchlist (wl)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

現在の利用者のウォッチリストにあるページへの最近の更新を取得します。

パラメーター:
wlallrev

Include multiple revisions of the same page within given timeframe.

Type: boolean (details)
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、274、275
wluser

この利用者による変更のみを一覧表示する。

Type: user name
wlexcludeuser

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

Type: user name
wldir

In which direction to enumerate:

newer
List oldest first. Note: wlstart has to be before wlend.
older
List newest first (default). Note: wlstart has to be later than wlend.
値 (次の値のいずれか1つ): newer、older
既定値: older
wllimit

How many total results to return per request.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
wlprop

Which additional properties to get:

ids
Adds revision IDs and page IDs.
title
Adds title of the page.
flags
Adds flags for the edit.
user
Adds the user who made the edit.
userid
Adds user ID of whoever made the edit.
comment
Adds comment of the edit.
parsedcomment
Adds parsed comment of the edit.
timestamp
Adds timestamp of the edit.
patrol
Tags edits that are patrolled.
sizes
Adds the old and new lengths of the page.
notificationtimestamp
Adds timestamp of when the user was last notified about the edit.
loginfo
Adds log information where appropriate.
値 (|で区切る): ids、title、flags、user、userid、comment、parsedcomment、timestamp、patrol、sizes、notificationtimestamp、loginfo
既定値: ids|title|flags
wlshow

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

値 (|で区切る): minor、!minor、bot、!bot、anon、!anon、patrolled、!patrolled、unread、!unread
wltype

Which types of changes to show:

edit
Regular page edits.
external
External changes.
new
Page creations.
log
Log entries.
値 (|で区切る): edit、external、new、log
既定値: edit|new|log
wlowner

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

Type: user name
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.

例:
List the top revision for recently changed pages on the current user's watchlist.
api.php?action=query&list=watchlist
Fetch additional information about the top revision for recently changed pages on the current user's watchlist.
api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment
Fetch information about all recent changes to pages on the current user's watchlist.
api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment
Fetch page info for recently changed pages on the current user's watchlist.
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)

  • このモジュールは読み取りの権限を必要とします。
  • このモジュールはジェネレーターとして使用できます。
  • Source: MediaWiki
  • License: GPL-2.0+

現在の利用者のウォッチリストにあるすべてのページを取得します。

パラメーター:
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、274、275
wrlimit

How many total results to return per request.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
既定値: 10
wrprop

Which additional properties to get:

changed
Adds timestamp of when the user was last notified about the edit.
値 (|で区切る): changed
wrshow

Only list items that meet these criteria.

値 (|で区切る): changed、!changed
wrowner

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

Type: user name
wrtoken

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

wrdir

In which direction to enumerate:

newer
List oldest first. Note: wrstart has to be before wrend.
older
List newest first (default). Note: wrstart has to be later than wrend.
値 (次の値のいずれか1つ): ascending、descending
既定値: 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
Fetch page info for pages on the current user's watchlist.
api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=info

meta=allmessages (am)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

Return messages from this site.

パラメーター:
ammessages

Which messages to output. * (default) means all messages.

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
既定値: *
amprop

Which properties to get.

値 (|で区切る): default
amenableparser

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

Type: boolean (details)
amnocontent

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

Type: boolean (details)
amincludelocal

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

Type: boolean (details)
amargs

メッセージ中に展開される引数。

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
amfilter

この文字列を含んだ名前のメッセージのみを返す。

amcustomised

変更された状態のメッセージのみを返す。

値 (次の値のいずれか1つ): all、modified、unmodified
既定値: 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=filerepoinfo (fri)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

Return meta information about image repositories configured on the wiki.

パラメーター:
friprop

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

apiurl
URL to the repository API - helpful for getting image info from the host.
name
The key of the repository - used in e.g. $wgForeignFileRepos and imageinfo return values.
displayname
The human-readable name of the repository wiki.
rooturl
Root URL for image paths.
local
Whether that repository is the local one or not.
値 (|で区切る): name、displayname、rootUrl、local、url、thumbUrl、initialCapital、scriptDirUrl、scriptExtension、favicon、canUpload
既定値: name|displayname|rootUrl|local|url|thumbUrl|initialCapital|scriptDirUrl|scriptExtension|favicon|canUpload

meta=siteinfo (si)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

Return general information about the site.

パラメーター:
siprop

Which information to get:

general
Overall system information.
namespaces
List of registered namespaces and their canonical names.
namespacealiases
List of registered namespace aliases.
specialpagealiases
List of special page aliases.
magicwords
List of magic words and their aliases.
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
Returns list of file extensions allowed to be uploaded.
rightsinfo
Returns wiki rights (license) information if available.
restrictions
Returns information on available restriction (protection) types.
languages
Returns a list of languages MediaWiki supports (optionally localised by using siinlanguagecode).
skins
Returns a list of all enabled skins (optionally localised by using siinlanguagecode, otherwise in the content language).
extensiontags
Returns a list of parser extension tags.
functionhooks
Returns a list of parser function hooks.
showhooks
Returns a list of all subscribed hooks (contents of $wgHooks).
variables
Returns a list of variable IDs.
protocols
Returns a list of protocols that are allowed in external links.
defaultoptions
Returns the default values for user preferences.
値 (|で区切る): general、namespaces、namespacealiases、specialpagealiases、magicwords、interwikimap、dbrepllag、statistics、usergroups、libraries、extensions、fileextensions、rightsinfo、restrictions、languages、skins、extensiontags、functionhooks、showhooks、variables、protocols、defaultoptions
既定値: general
sifilteriw

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

値 (次の値のいずれか1つ): local、!local
sishowalldb

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

Type: boolean (details)
sinumberingroup

Lists the number of users in user groups.

Type: boolean (details)
siinlanguagecode

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

meta=tokens

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

データ変更操作用のトークンを取得します。

パラメーター:
type

リクエストするトークンの種類。

値 (|で区切る): csrf、patrol、rollback、userrights、watch
既定値: csrf
例:
csrfトークンを取得する (既定)。
api.php?action=query&meta=tokens
ウォッチトークンおよび巡回トークンを取得する。
api.php?action=query&meta=tokens&type=watch|patrol

meta=userinfo (ui)

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

Get information about the current user.

パラメーター:
uiprop

Which pieces of information to include:

blockinfo
Tags if the current user is blocked, by whom, and for what reason.
hasmsg
Adds a tag messages if the current user has pending messages.
groups
Lists all the groups the current user belongs to.
implicitgroups
Lists all the groups the current user is automatically a member of.
rights
Lists all the rights the current user has.
changeablegroups
Lists the groups the current user can add to and remove from.
options
Lists all preferences the current user has set.
preferencestoken
Deprecated. Get a token to change current user's preferences.
editcount
Adds the current user's edit count.
ratelimits
Lists all rate limits applying to the current user.
email
Adds the user's email address and email authentication date.
realname
Adds the user's real name.
acceptlang
Echoes the Accept-Language header sent by the client in a structured format.
registrationdate
Adds the user's registration date.
unreadcount
Adds the count of unread pages on the user's watchlist (maximum 999; returns 1000+ if more).
値 (|で区切る): blockinfo、hasmsg、groups、implicitgroups、rights、changeablegroups、options、preferencestoken、editcount、ratelimits、email、realname、acceptlang、registrationdate、unreadcount
例:
Get information about the current user.
api.php?action=query&meta=userinfo
Get additional information about the current user.
api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg

action=revisiondelete

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

版の削除および復元を行います。

パラメーター:
type

Type of revision deletion being performed.

このパラメーターは必須です。
値 (次の値のいずれか1つ): revision、archive、oldimage、filearchive、logging
target

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

ids

Identifiers for the revisions to be deleted.

このパラメーターは必須です。
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
hide

What to hide for each revision.

値 (|で区切る): content、comment、user
show

What to unhide for each revision.

値 (|で区切る): content、comment、user
suppress

Whether to suppress data from administrators as well as others.

値 (次の値のいずれか1つ): yes、no、nochange
既定値: nochange
reason

削除または復元の理由。

token

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

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

action=rollback

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

Undo the last edit to the page.

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

パラメーター:
title

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

pageid

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

Type: integer
user

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

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

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

既定値: (空)
markbot

Mark the reverted edits and the revert as bot edits.

Type: boolean (details)
watchlist

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

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

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

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

このパラメーターは必須です。
例:
利用者 Example による Main Page への最後の一連の編集を巻き戻す。
api.php?action=rollback&title=Main%20Page&user=Example&token=123ABC
Roll back the last edits to page Main Page by IP user 192.0.2.5 with summary Reverting vandalism, and mark those edits and the revert as bot edits.
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.

例:
Export the RSD schema.
api.php?action=rsd

action=setnotificationtimestamp

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

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.

Type: boolean (details)
timestamp

Timestamp to which to set the notification timestamp.

Type: timestamp (allowed formats)
torevid

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

Type: integer
newerthanrevid

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

Type: integer
continue

When more results are available, use this to continue.

titles

A list of titles to work on.

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
pageids

A list of page IDs to work on.

Type: list of integers
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
revids

A list of revision IDs to work on.

Type: list of integers
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

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

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

Type: boolean (details)
converttitles

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

Type: boolean (details)
token

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

このパラメーターは必須です。
例:
Reset the notification status for the entire watchlist.
api.php?action=setnotificationtimestamp&entirewatchlist=&token=123ABC
Reset the notification status for Main page.
api.php?action=setnotificationtimestamp&titles=Main_page&token=123ABC
Set the notification timestamp for Main page so all edits since 1 January 2012 are unviewed.
api.php?action=setnotificationtimestamp&titles=Main_page&timestamp=2012-01-01T00:00:00Z&token=123ABC
Reset the notification status for pages in the 利用者 namespace.
api.php?action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC

action=spamblacklist

  • このモジュールは読み取りの権限を必要とします。
  • Source: SpamBlacklist
  • License: unknown

1 件以上の URL についてスパムブラックリストに登録されているか検証します。

パラメーター:
url

ブラックリストに登録されているか検証する URL です。

このパラメーターは必須です。
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
例:
2 件の URL についてブラックリストに登録されているか検証
api.php?action=spamblacklist&url=http://www.example.com/|http://www.example.org/

action=stashedit

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

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

Title of the page being edited.

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

Section number. 0 for the top section, new for a new section.

sectiontitle

The title for a new section.

text

Page content.

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

Content model of the new content.

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

Content serialization format used for the input text.

このパラメーターは必須です。
値 (次の値のいずれか1つ): text/x-wiki、text/javascript、application/json、text/css、text/plain
baserevid

Revision ID of the base revision.

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

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

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

action=tag

(main | tag)
  • このモジュールは読み取りの権限を必要とします。
  • このモジュールは書き込みの権限を必要とします。
  • このモジュールは POST リクエストのみを受け付けます。
  • Source: MediaWiki
  • License: GPL-2.0+

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

パラメーター:
rcid

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

Type: list of integers
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
revid

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

Type: list of integers
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
logid

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

Type: list of integers
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
add

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

値 (|で区切る):
remove

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

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
reason

変更の理由。

既定値: (空)
token

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

このパラメーターは必須です。
例:
Add the vandalism tag to revision ID 123 without specifying a reason
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=titleblacklist (tb)

  • このモジュールは読み取りの権限を必要とします。
  • Source: TitleBlacklist
  • License: GPL-2.0+

TitleBllacklist に対して記事のページ名、ファイル名、利用者名を検証します。

パラメーター:
tbtitle

The string to validate against the blacklist.

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

確認対象の操作

値 (次の値のいずれか1つ): create、edit、upload、createtalk、createpage、move、new-account
既定値: edit
tbnooverride

Don't try to override the titleblacklist.

例:
Check whether Foo is blacklisted
api.php?action=titleblacklist&tbtitle=Foo
Check whether Bar is blacklisted for editing
api.php?action=titleblacklist&tbtitle=Bar&tbaction=edit

action=tokens

  • このモジュールは廃止予定です。
  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

Get tokens for data-modifying actions.

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

パラメーター:
type

リクエストするトークンの種類。

値 (|で区切る): block、delete、edit、email、import、move、options、patrol、protect、unblock、watch
既定値: edit
例:
編集トークンを取得する (既定)。
api.php?action=tokens
Retrieve an email token and a move token.
api.php?action=tokens&type=email|move

action=unblock

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

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

パラメーター:
id

解除するブロックのID (list=blocksで取得できます)。user とは同時に使用できません。

Type: integer
user

ブロックを解除する利用者名、IPアドレスまたはIPレンジ。idとは同時に使用できません。

reason

ブロック解除の理由。

既定値: (空)
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 リクエストのみを受け付けます。
  • Source: MediaWiki
  • License: GPL-2.0+

削除されたページの版を復元します。

削除された版の一覧 (タイムスタンプを含む) はlist=deletedrevsに、また削除されたファイルのID一覧はlist=filearchiveで見つけることができます。

パラメーター:
title

復元するページ名。

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

復元の理由。

既定値: (空)
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.

Type: list of integers
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
watchlist

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

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

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

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

action=upload

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

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

Target filename.

comment

Upload comment. Also used as the initial page text for new files if text is not specified.

既定値: (空)
text

Initial page text for new files.

watch
廃止予定です。

このページをウォッチする。

Type: boolean (details)
watchlist

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

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

あらゆる警告を無視する。

Type: boolean (details)
file

File contents.

multipart/form-data 形式でファイルをアップロードしてください。
url

URL to fetch the file from.

filekey

Key that identifies a previous upload that was stashed temporarily.

sessionkey
廃止予定です。

Same as filekey, maintained for backward compatibility.

stash

If set, the server will stash the file temporarily instead of adding it to the repository.

Type: boolean (details)
filesize

Filesize of entire upload.

値は 0 以上 104,857,600 以下にしてください。
Type: integer
offset

Offset of chunk in bytes.

値は 0 以上にしてください。
Type: integer
chunk

Chunk contents.

multipart/form-data 形式でファイルをアップロードしてください。
async

Make potentially large file operations asynchronous when possible.

Type: boolean (details)
asyncdownload

Make fetching a URL asynchronous.

Type: boolean (details)
leavemessage

If asyncdownload is used, leave a message on the user talk page if finished.

Type: boolean (details)
statuskey

Fetch the upload status for this file key (upload by URL).

checkstatus

Only fetch the upload status for the given file key.

Type: boolean (details)
token

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

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

action=userrights

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

Change a user's group membership.

パラメーター:
user

利用者名。

userid

利用者ID。

Type: integer
add

利用者をこのグループに追加します。

値 (|で区切る): bot、sysop、bureaucrat、widgeteditor
remove

Remove the user from these groups.

値 (|で区切る): bot、sysop、bureaucrat、widgeteditor
reason

変更の理由。

既定値: (空)
token

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

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

このパラメーターは必須です。
例:
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

action=watch

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

Add or remove pages from the current user's watchlist.

パラメーター:
title
廃止予定です。

The page to (un)watch. Use titles instead.

unwatch

If set the page will be unwatched rather than watched.

Type: boolean (details)
continue

When more results are available, use this to continue.

titles

A list of titles to work on.

複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
pageids

A list of page IDs to work on.

Type: list of integers
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
revids

A list of revision IDs to work on.

Type: list of integers
複数の値は | で区切ってください。 値の最大値は 50 (ボットの場合は 500) です。
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

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

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

Type: boolean (details)
converttitles

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

Type: boolean (details)
token

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

このパラメーターは必須です。
例:
Main Page をウォッチする。
api.php?action=watch&titles=Main_Page&token=123ABC
Main Page のウォッチを解除する。
api.php?action=watch&titles=Main_Page&unwatch=&token=123ABC
Watch the first few pages in the main namespace.
api.php?action=watch&generator=allpages&gapnamespace=0&token=123ABC

format=dbg

(main | dbg)
  • このモジュールは廃止予定です。
  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

データを PHP の var_export() 形式で出力します。

例:
クエリの結果を DBG 形式に返します。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbg

format=dbgfm

  • このモジュールは廃止予定です。
  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

データを PHP の var_export() 形式 (HTML に埋め込んだ形式) で出力します。

例:
クエリの結果を DBG 形式に返します。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbgfm

format=json

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

データを JSON 形式で出力します。

パラメーター:
callback

指定すると、指定した関数呼び出しで出力をラップします。安全のため、利用者固有のデータはすべて制限されます。

utf8

指定すると、大部分の非 ASCII 文字 (すべてではありません) を、16 進のエスケープ シーケンスに置換する代わりに UTF-8 として符号化します。formatversion1 でない場合は既定です。

Type: boolean (details)
ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

Type: boolean (details)
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
値 (次の値のいずれか1つ): 1、2、latest
既定値: 1
例:
クエリの結果を JSON 形式に返します。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=json

format=jsonfm

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

データを JSON 形式 (HTML に埋め込んだ形式) で出力します。

パラメーター:
callback

指定すると、指定した関数呼び出しで出力をラップします。安全のため、利用者固有のデータはすべて制限されます。

utf8

指定すると、大部分の非 ASCII 文字 (すべてではありません) を、16 進のエスケープ シーケンスに置換する代わりに UTF-8 として符号化します。formatversion1 でない場合は既定です。

Type: boolean (details)
ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

Type: boolean (details)
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
値 (次の値のいずれか1つ): 1、2、latest
既定値: 1
例:
クエリの結果を JSON 形式に返します。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=jsonfm

format=none

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

何も出力しません。

例:
クエリの結果を NONE 形式に返します。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=none

format=php

(main | php)
  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

データを PHP のシリアル化した形式で出力します。

パラメーター:
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
値 (次の値のいずれか1つ): 1、2、latest
既定値: 1
例:
クエリの結果を PHP 形式に返します。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=php

format=phpfm

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

データを PHP のシリアル化した形式 (HTML に埋め込んだ形式) で出力します。

パラメーター:
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
値 (次の値のいずれか1つ): 1、2、latest
既定値: 1
例:
クエリの結果を PHP 形式に返します。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=phpfm

format=rawfm

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

データをデバッグ要素付きで JSON 形式 (HTML に埋め込んだ形式) で出力します。

例:
クエリの結果を RAW 形式に返します。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=rawfm

format=txt

(main | txt)
  • このモジュールは廃止予定です。
  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

データを PHP の print_r() 形式で出力します。

例:
クエリの結果を TXT 形式に返します。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=txt

format=txtfm

  • このモジュールは廃止予定です。
  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

データを PHP の print_r() 形式 (HTML に埋め込んだ形式) で出力します。

例:
クエリの結果を TXT 形式に返します。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=txtfm

format=xml

(main | xml)
  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

データを XML 形式で出力します。

パラメーター:
xslt

指定すると、XSLスタイルシートとして名付けられたページを追加します。値は、必ず、MediaWiki 名前空間の、ページ名の末尾が .xsl でのタイトルである必要があります。

includexmlnamespace

指定すると、XML 名前空間を追加します。

Type: boolean (details)
例:
クエリの結果を XML 形式に返します。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=xml

format=xmlfm

  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

データを XML 形式 (HTML に埋め込んだ形式) で出力します。

パラメーター:
xslt

指定すると、XSLスタイルシートとして名付けられたページを追加します。値は、必ず、MediaWiki 名前空間の、ページ名の末尾が .xsl でのタイトルである必要があります。

includexmlnamespace

指定すると、XML 名前空間を追加します。

Type: boolean (details)
例:
クエリの結果を XML 形式に返します。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=xmlfm

format=yaml

  • このモジュールは廃止予定です。
  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

データを YAML 形式で出力します。

パラメーター:
callback

指定すると、指定した関数呼び出しで出力をラップします。安全のため、利用者固有のデータはすべて制限されます。

utf8

指定すると、大部分の非 ASCII 文字 (すべてではありません) を、16 進のエスケープ シーケンスに置換する代わりに UTF-8 として符号化します。formatversion1 でない場合は既定です。

Type: boolean (details)
ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

Type: boolean (details)
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
値 (次の値のいずれか1つ): 1、2、latest
既定値: 1
例:
クエリの結果を YAML 形式に返します。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=yaml

format=yamlfm

  • このモジュールは廃止予定です。
  • このモジュールは読み取りの権限を必要とします。
  • Source: MediaWiki
  • License: GPL-2.0+

データを YAML 形式 (HTML に埋め込んだ形式) で出力します。

パラメーター:
callback

指定すると、指定した関数呼び出しで出力をラップします。安全のため、利用者固有のデータはすべて制限されます。

utf8

指定すると、大部分の非 ASCII 文字 (すべてではありません) を、16 進のエスケープ シーケンスに置換する代わりに UTF-8 として符号化します。formatversion1 でない場合は既定です。

Type: boolean (details)
ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

Type: boolean (details)
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
値 (次の値のいずれか1つ): 1、2、latest
既定値: 1
例:
クエリの結果を YAML 形式に返します。
api.php?action=query&meta=siteinfo&siprop=namespaces&format=yamlfm

Data types

Some parameter types in API requests need further explanation:

boolean
Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.
timestamp
Timestamps may be specified in several formats. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.
  • ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)
  • ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)
  • MediaWiki format, 20010115145600
  • Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)
  • EXIF format, 2001:01:15 14:56:00
  • RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00
  • RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00
  • C ctime format, Mon Jan 15 14:56:00 2001
  • Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)
  • The string now

クレジット

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/