Wikibase/API

From MediaWiki.org
Jump to: navigation, search

Tools clipart.png This page is part of the MediaWiki API documentation.
MediaWiki API

Quick overview:

v · d · e
MediaWiki version: 1.9

All features shown on this page should be working, but the API is still in active development, and may change at any time.

Parameters

The following list includes the parameters that can be used with the Wikibase API:

  • action:Which action to perform
  • format: The format of the output
  • 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".
  • smaxage: Set the s-maxage header to this many seconds. Errors are never cached.
  • maxage: Set the max-age header to this many seconds. Errors are never cached.
  • assert: Verify the user is logged in if set to "user", or has the bot userright if "bot".
  • requestid: Any value given here will be included in the response. May be used to distinguish requests.
  • servedby: Include the hostname that served the request in the results.
  • curtimestamp: Include the current timestamp in the result.
  • 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 http://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: Language to use for message translations. A list of codes may be fetched from action=query&meta=siteinfo&siprop=languages, or specify "user" to use the current user's language preference.
  • centralauthtoken: When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use action=centralauthtoken on this wiki to retrieve the token, before making the CORS request. Each token may only be used once, and expires after 10 seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body).

Examples

Help for the main module

All help in one page


Note Note: Please see wikidata.org/w/api.php for a perfectly up to date copy.

See also[edit | edit source]