MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/API

Módulo principal

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.

Parámetros:
action

Qué acción se realizará.

Un valor: block, checktoken, clearhasmsg, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, login, logout, managetags, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, revisiondelete, rollback, rsd, setnotificationtimestamp, stashedit, tag, tokens, unblock, undelete, upload, userrights, watch
Predeterminado: help
format

El formato de la salida.

Un valor: dbg, dbgfm, dump, dumpfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, wddx, wddxfm, xml, xmlfm, yaml, yamlfm
Predeterminado: 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.

smaxage

Set the s-maxage header to this many seconds. Errors are never cached.

Predeterminado: 0
maxage

Set the max-age header to this many seconds. Errors are never cached.

Predeterminado: 0
assert

Verify the user is logged in if set to user, or has the bot userright if bot.

Un valor: user, 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

Incluir la marca de tiempo actual en el resultado.

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

Language to use for message translations. A list of codes may be fetched from action=query&meta=siteinfo with siprop=languages, or specify user to use the current user's language preference, or specify content to use this wiki's content language.

Predeterminado: user
Ejemplos:
Ayuda del módulo principal
api.php?action=help
Toda la ayuda en una página
api.php?action=help&recursivesubmodules=1
Permisos:
writeapi
Hacer uso de la API de escritura
Concedidos a: bot, BT_Member
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
Concedidos a: bot, sysop

Créditos

Desarrolladores de la API:

  • Roan Kattouw (desarrollador principal sep 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (creador, desarrollador principal sep 2006–sep 2007)
  • Brad Jorsch (desarrollador principal 2013–actualidad)

Envía comentarios, sugerencias y preguntas a mediawiki-api@lists.wikimedia.org o reporta un error en https://phabricator.wikimedia.org/.