From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page API:Lists and the translation is 53% complete.
Other languages:
Deutsch • ‎English • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎polski • ‎português • ‎română • ‎svenska • ‎русский • ‎українська • ‎العربية • ‎ไทย • ‎中文 • ‎文言 • ‎日本語 • ‎한국어

GET request to list items that match select criteria.


Lists generally return aggregations of data, such as pages gathered from across a wiki, or links gathered within a single page. To request a list, pass the list parameter of your query string a valid list submodule, such as allimages or usercontribs.

リストAPIの使用には、URL欄で action=query&list=list1|list2 を指定します。

See individual list API pages for more concrete examples of how to use lists:


  • Most list submodules can be used as generators , unless otherwise noted.
  • リストは properties とは異なります - データを pages の要素に追加する代わりに、それぞれのリストは query 要素で独自の分離したブランチを持ちます。
  • List query limits:
    • 結果の件数の上限は、一般利用者は 500、apihighlimits 権限を持つ利用者 (主にボットと管理者) は 5000 まで引き上げて設定できます。
    • いくつかのモジュールは特定の条件でより厳しい制限を課しています。 See this subpage for more details.
    • どんな制限が自分に適用されているか分からない場合、可能な限りたくさんの結果を得るには制限をmaxに設定します。 In that case, a limits element will be returned, specifying the limits used.
    • The limit parameter for a given module consists of the module prefix followed by limit, so ptlimit is the maximum number of protectedtitles returned, and cmlimit is the maximum number of categorymembers returned.