API:Properties

GET request to list properties of selected pages.

API documentation

Properties are data about a page, such as categories, or content on a page, such as images or links. To request a property, you pass the prop parameter of your query a valid property submodule, corresponding to the information that you need.

The page or pages whose data you are requesting are specified either by the titles, pageids, or revids parameters of the query, or via a generator .

Queries for properties are written like so: action=query&titles=title1&prop=property1|property2.

Property queries always have a limit on the number of items returned. To view more items, append the values inside the result's continue element to the original request.

Please see individual property API pages for more concrete examples of how to use properties:

• categories
• categoryinfo
• contributors
• deletedrevisions
• duplicatefiles
• extlinks
• fileusage
• globalusage
• imageinfo
• images
• info
• iwlinks
• langlinks
• links
• linkshere
• pageprops
• redirects
• revisions
• stashimageinfo
• templates
• transcludedin

Additional notes

• Most property submodules can be used as generators , unless otherwise noted.
• Property query limits:
  • Results for property queries always have a limit; the default limit is 10. The results limit can be set as high as 500 for regular users, or 5000 for users with the apihighlimits right (typically bots and sysops). Some modules impose stricter limits under certain conditions.
  • If you are not sure which limit applies to you and just want as many results as possible, set the limit to 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 the word limit. For example, imlimit is the maximum number of images returned.

See also

• Documentation on query module - contains a brief description of all property submodules, their corresponding parameters, and values.
• API:Database field and API property associations - contains a table describing how query properties are associated with the fields in a MediaWiki database .
• API:Lists - a similar API, for accessing lists of information, such as allusers, or recentchanges. Unlike property queries, which append data to the pages element, lists return a separate branch in the query element.

• Maintained by MediaWiki Interfaces Team.
• Live chat (IRC): #mediawiki-core ^connect
• Issue tracker: Phabricator MediaWiki-Action-API (Report an issue)