API:Lists

GET Request to list items that match select criteria

API documentation
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   parameter of your query string a valid list submodule, such as   or  .

To use the list API, specify   in the URL.

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



Additional notes

 * Most list submodules can be used as generators, unless otherwise noted.


 * Lists differ from  in that, instead of appending data to the elements in the   element, each list has its own separated branch in the <tvar|query> </> element.
 * List query limits:


 * The results limit can be set as high as <tvar|500>500</> for regular users, or <tvar|5000>5000</> for users with the <tvar|apihighlimits> </> right (typically bots and sysops).


 * Some modules impose stricter limits under certain conditions. See this All>Special:MyLanguage/API:Lists/All</>|subpage for more details.

</ul>
 * If you're not sure which limit applies to you and just want as many results as possible, set the limit to <tvar|max> </>. In that case, a <tvar|limits> </> element will be returned, specifying the limits used.
 * The limit parameter for a given module consists of the module prefix followed by <tvar|limit> </>, so <tvar|ptlimit> </> is the maximum number of <tvar|protectedtitles> </> returned, and <tvar|cmlimit> </> is the maximum number of <tvar|categorymembers> </> returned.