Ajuda API da MediaWiki

This is an auto-generated MediaWiki API documentation page.

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

Módulo principal

Estado: Todas as funcionalidades mostradas nesta página deveriam estar a funcionar, mas a API ainda está em activo desenvolvimento, e pode ser alterada a qualquer momento. Inscreva-se na lista de discussão mediawiki-api-announce para ser informado acerca das actualizações.

Solicitações erradas: Quando solicitações erradas são enviadas à API, um cabeçalho em HTTP será enviado com a chave "MediaWiki-API-Error" e, em seguida, tanto o valor do cabeçalho quanto o código de erro retornado serão definidos com o mesmo valor. Para mais informação, consulte API: Errors and warnings.

Parâmetros:
action

Qual ação executar.

Um dos seguintes valores: 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
Padrão: help
format

O formato da saída.

Um dos seguintes valores: dbg, dbgfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, xml, xmlfm, yaml, yamlfm
Padrão: 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.

Type: integer
smaxage

Define o cabeçalho s-maxage para esta quantidade de segundos. Os erros não são armazenados em cache.

Type: integer
Padrão: 0
maxage

Define o cabeçalho max-age para esta quantidade de segundos. Os erros não são armazenados em cache.

Type: integer
Padrão: 0
assert

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

Um dos seguintes valores: user, bot
requestid

Qualquer valor dado aqui será incluído na resposta. Pode ser usado para distinguir requisições.

servedby

Include the hostname that served the request in the results.

Type: boolean (details)
curtimestamp

Inclui a data atual no resultado.

Type: boolean (details)
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.

Padrão: user
Exemplos:
Ajuda para o módulo principal.
api.php?action=help
Toda ajuda em uma página.
api.php?action=help&recursivesubmodules=1
Permissiões:
writeapi
Uso da API de escrita
Concedidas a: all, user, bot
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
Concedidas a: bot, sysop

action=block

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Bloquear um usuário

Parâmetros:
user

Nome de usuário, endereço IP ou faixa de IP para bloquear.

Este parâmetro é obrigatório.
expiry

Expiry time. May be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). If set to infinite, indefinite, or never, the block will never expire.

Padrão: never
reason

Razão do bloqueio.

Padrão: (vazio)
anononly

Bloqueia apenas usuários anônimos (ou seja desativa edições anônimas para este endereço IP).

Type: boolean (details)
nocreate

Prevenir a criação de conta.

Type: boolean (details)
autoblock

Bloquear automaticamente o endereço IP usado e quaisquer endereços IPs subseqüentes que tentarem acessar a partir deles.

Type: boolean (details)
noemail

Prevent user from sending email through the wiki. (Requires the blockemail right).

Type: boolean (details)
hidename

Oculta o nome do usuário do log de bloqueio. (Requer o direito hideuser).

Type: boolean (details)
allowusertalk

Allow the user to edit their own talk page (depends on $wgBlockAllowsUTEdit).

Type: boolean (details)
reblock

Se o usuário já estiver bloqueado, sobrescrever o bloqueio existente.

Type: boolean (details)
watchuser

Watch the user's or IP address's user and talk pages.

Type: boolean (details)
token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplos:
Bloquear endereço IP 192.0.2.5 por três dias com razão Primeira medida.
api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC
Bloquear usuário Vândalo indefinidamente com razão Vandalismo e o impede de criar nova conta e envio de emails.
api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC

action=checktoken

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Check the validity of a token from action=query&meta=tokens.

Parâmetros:
type

Type of token being tested.

Este parâmetro é obrigatório.
Um dos seguintes valores: csrf, patrol, rollback, userrights, watch
token

Token to test.

Este parâmetro é obrigatório.
maxtokenage

Maximum allowed age of the token, in seconds.

Type: integer
Exemplo:
Test the validity of a csrf token.
api.php?action=checktoken&type=csrf&token=123ABC

action=clearhasmsg

  • This module requires read rights.
  • This module requires write rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Clears the hasmsg flag for the current user.

Exemplo:
Clear the hasmsg flag for the current user.
api.php?action=clearhasmsg

action=compare

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Get the difference between 2 pages.

A revision number, a page title, or a page ID for both "from" and "to" must be passed.

Parâmetros:
fromtitle

Primeiro título para comparar.

fromid

Primeiro ID de página para comparar.

Type: integer
fromrev

Primeira revisão para comparar.

Type: integer
totitle

Segundo título para comparar.

toid

Segundo ID de página para comparar.

Type: integer
torev

Segunda revisão para comparar.

Type: integer
Exemplo:
Criar um diff entre a revisão 1 e 2.
api.php?action=compare&fromrev=1&torev=2

action=createaccount

  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Criar uma nova conta de usuário.

Parâmetros:
name

Nome de usuário.

Este parâmetro é obrigatório.
Type: user name
password

Senha (ignorada se mailpassword está definida).

domain

Domínio para autenticação externa (opcional).

token

Account creation token obtained in first request.

email

Endereço de email para o usuário (opcional).

realname

Nome real do usuário (opcional).

mailpassword

If set to any value, a random password will be emailed to the user.

Type: boolean (details)
reason

Optional reason for creating the account to be put in the logs.

language

Language code to set as default for the user (optional, defaults to content language).

Exemplos:
Create user testuser with password test123.
api.php?action=createaccount&name=testuser&password=test123
Create user testmailuser and email a randomly-generated password.
api.php?action=createaccount&name=testmailuser&mailpassword=true&reason=MyReason

action=delete

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Excluir uma página.

Parâmetros:
title

Título da página para excluir. Não pode ser usado em conjunto com pageid.

pageid

ID da página para excluir. Não pode ser usada juntamente com title.

Type: integer
reason

Reason for the deletion. If not set, an automatically generated reason will be used.

watch
Obsoleto.

Adiciona a página para a lista de vigiados do usuário atual.

Type: boolean (details)
watchlist

Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.

Um dos seguintes valores: watch, unwatch, preferences, nochange
Padrão: preferences
unwatch
Obsoleto.

Remove a página para a lista de vigiados do usuário atual.

Type: boolean (details)
oldimage

The name of the old image to delete as provided by action=query&prop=imageinfo&iiprop=archivename.

token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.

action=edit

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Criar e editar páginas.

Parâmetros:
title

Título da página para editar. Não pode ser usado em conjunto com pageid.

pageid

ID da página para editar. Não pode ser usada juntamente com title.

Type: integer
section

Section number. 0 for the top section, new for a new section.

sectiontitle

O título para uma nova seção.

text

Conteúdo da página

summary

Edit summary. Also section title when section=new and sectiontitle is not set.

tags

Change tags to apply to the revision.

Valores (separar com |):
minor

Edição menor.

Type: boolean (details)
notminor

Non-minor edit.

Type: boolean (details)
bot

Marcar esta edição como feita por bot.

Type: boolean (details)
basetimestamp

Timestamp of the base revision, used to detect edit conflicts. May be obtained through action=query&prop=revisions&rvprop=timestamp.

Type: timestamp (allowed formats)
starttimestamp

Timestamp when the editing process began, used to detect edit conflicts. An appropriate value may be obtained using curtimestamp when beginning the edit process (e.g. when loading the page content to edit).

Type: timestamp (allowed formats)
recreate

Override any errors about the page having been deleted in the meantime.

Type: boolean (details)
createonly

Não editar a página se já existir.

Type: boolean (details)
nocreate

Mostra um erro se a página não existir.

Type: boolean (details)
watch
Obsoleto.

Adiciona a página para a lista de vigiados do usuário atual.

Type: boolean (details)
unwatch
Obsoleto.

Remove a página para a lista de vigiados do usuário atual.

Type: boolean (details)
watchlist

Incondicionalmente adiciona ou página para a lista de vigiados do usuário atual, usa as preferências ou não modifica.

Um dos seguintes valores: watch, unwatch, preferences, nochange
Padrão: preferences
md5

The MD5 hash of the text parameter, or the prependtext and appendtext parameters concatenated. If set, the edit won't be done unless the hash is correct.

prependtext

Add this text to the beginning of the page. Overrides text.

appendtext

Add this text to the end of the page. Overrides text.

Use section=new to append a new section, rather than this parameter.

undo

Undo this revision. Overrides text, prependtext and appendtext.

Type: integer
undoafter

Undo all revisions from undo to this one. If not set, just undo one revision.

Type: integer
redirect

Automatically resolve redirects.

Type: boolean (details)
contentformat

Formato de serialização de conteúdo usado para o texto de entrada.

Um dos seguintes valores: text/x-wiki, text/javascript, application/json, text/css, text/plain
contentmodel

Modelo de conteúdo do novo conteúdo.

Um dos seguintes valores: wikitext, javascript, json, css, text
token

A "csrf" token retrieved from action=query&meta=tokens

The token should always be sent as the last parameter, or at least after the text parameter.

Este parâmetro é obrigatório.

action=emailuser

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Envia email para o usuário.

Parâmetros:
target

Usuário a se enviar o email.

Este parâmetro é obrigatório.
subject

Cabeçalho do assunto.

text

Corpo do email.

Este parâmetro é obrigatório.
ccme

Envie uma cópia deste email para mim.

Type: boolean (details)
token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplo:
Send an email to user WikiSysop with the text Content.
api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC

action=expandtemplates

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Expande todas a predefinições em wikitexto.

Parâmetros:
title

Título da página.

Padrão: API
text

Wikitexto para converter.

Este parâmetro é obrigatório.
revid

Revision ID, for {{REVISIONID}} and similar variables.

Type: integer
prop

Which pieces of information to get.

Note that if no values are selected, the result will contain the wikitext, but the output will be in a deprecated format.

wikitext
The expanded wikitext.
categories
Any categories present in the input that are not represented in the wikitext output.
properties
Page properties defined by expanded magic words in the wikitext.
volatile
Whether the output is volatile and should not be reused elsewhere within the page.
ttl
The maximum time after which caches of the result should be invalidated.
modules
Any ResourceLoader modules that parser functions have requested be added to the output. Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules.
jsconfigvars
Gives the JavaScript configuration variables specific to the page.
encodedjsconfigvars
Gives the JavaScript configuration variables specific to the page as a JSON string.
parsetree
The XML parse tree of the input.
Valores (separar com |): wikitext, categories, properties, volatile, ttl, modules, jsconfigvars, encodedjsconfigvars, parsetree
includecomments

Whether to include HTML comments in the output.

Type: boolean (details)
generatexml
Obsoleto.

Generate XML parse tree (replaced by prop=parsetree).

Type: boolean (details)
Exemplo:
Expand the wikitext {{Project:Sandbox}}.
api.php?action=expandtemplates&text={{Project:Sandbox}}

action=feedcontributions

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Retorna o feed de contribuições de um usuário.

Parâmetros:
feedformat

O formato do feed.

Um dos seguintes valores: rss, atom
Padrão: rss
user

What users to get the contributions for.

Este parâmetro é obrigatório.
Type: user name
namespace

A partir de qual espaço nominal filtrar contribuições.

Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
year

Ano (inclusive anteriores):

Type: integer
month

Mês (inclusive anteriores).

Type: integer
tagfilter

Filtrar contribuições que têm essas tags.

Valores (separar com |):
Padrão: (vazio)
deletedonly

Mostrar apenas contribuições excluídas.

Type: boolean (details)
toponly

Mostrar somente as edições que sejam a última revisão.

Type: boolean (details)
newonly

Mostrar somente as edições que são criação de páginas.

Type: boolean (details)
showsizediff

Mostrar a diferença de tamanho entre as revisões.

Type: boolean (details)
Exemplo:
Return contributions for user Example.
api.php?action=feedcontributions&user=Example

action=feedrecentchanges

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Retorna um feed de alterações recentes.

Parâmetros:
feedformat

O formato do feed.

Um dos seguintes valores: rss, atom
Padrão: rss
namespace

Espaço nominal a partir do qual limitar resultados.

Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
invert

Todos os espaços nominais, exceto o selecionado.

Type: boolean (details)
associated

Include associated (talk or main) namespace.

Type: boolean (details)
days

Days to limit the results to.

The value must be no less than 1.
Type: integer
Padrão: 7
limit

O número máximo a se retornar.

The value must be between 1 and 50.
Type: integer
Padrão: 50
from

Mostra modificações desde então.

Type: timestamp (allowed formats)
hideminor

Ocultar modificações menores.

Type: boolean (details)
hidebots

Ocultar modificações menores feitas por bots.

Type: boolean (details)
hideanons

Hide changes made by anonymous users.

Type: boolean (details)
hideliu

Hide changes made by registered users.

Type: boolean (details)
hidepatrolled

Ocultar alterações patrulhadas.

Type: boolean (details)
hidemyself

Ocultar alterações feitas pelo usuário atual.

Type: boolean (details)
tagfilter

Filtrar por tag.

target

Mostrar apenas mudanças em páginas afluentes a esta.

showlinkedto

Show changes on pages linked to the selected page instead.

Type: boolean (details)
Exemplos:
Mostrar as mudanças recentes.
api.php?action=feedrecentchanges
Mostrar as alterações recentes por 30 dias.
api.php?action=feedrecentchanges&days=30

action=feedwatchlist

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Retornar um feed da lista de vigiados.

Parâmetros:
feedformat

O formato do feed.

Um dos seguintes valores: rss, atom
Padrão: rss
hours

Lista páginas modificadas dentro dessa quantia de horas a partir de agora.

The value must be between 1 and 72.
Type: integer
Padrão: 24
linktosections

Cria link diretamente para seções alteradas, se possível.

Type: boolean (details)
allrev

Include multiple revisions of the same page within given timeframe.

Type: boolean (details)
wlowner

Used along with token to access a different user's watchlist.

Type: user name
wltoken

A security token (available in the user's preferences) to allow access to another user's watchlist.

wlshow

Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set show=minor|!anon.

Valores (separar com |): minor, !minor, bot, !bot, anon, !anon, patrolled, !patrolled, unread, !unread
wltype

Which types of changes to show:

edit
Regular page edits.
external
External changes.
new
Page creations.
log
Log entries.
Valores (separar com |): edit, external, new, log
Padrão: edit|new|log
wlexcludeuser

Don't list changes by this user.

Type: user name
Exemplos:
Mostra o feed de páginas vigiadas.
api.php?action=feedwatchlist
Show all changes to watched pages in the past 6 hours.
api.php?action=feedwatchlist&allrev=&hours=6

action=filerevert

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Reverte um arquivo para uma versão antiga.

Parâmetros:
filename

Nome do arquivo destino, sem o prefixo File:.

Este parâmetro é obrigatório.
comment

Enviar comentário.

Padrão: (vazio)
archivename

Nome do arquivo da revisão para qual reverter.

Este parâmetro é obrigatório.
token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.

action=help

Mostra a ajuda para os módulos especificados.

Parâmetros:
modules

Modules to display help for (values of the action and format parameters, or main). Can specify submodules with a +.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
Padrão: main
submodules

Inclui a ajuda para submódulos do módulo nomeado.

Type: boolean (details)
recursivesubmodules

Inclui a ajuda para submódulos de forma recursiva.

Type: boolean (details)
wrap

Encapsula a saída em uma estrutura de resposta da API padrão.

Type: boolean (details)
toc

Inclui uma tabela de conteúdo na saída HTML.

Type: boolean (details)
Exemplos:
Ajuda para o módulo principal.
api.php?action=help
Toda ajuda em uma página.
api.php?action=help&recursivesubmodules=1
Ajuda para o próprio módulo de ajuda
api.php?action=help&modules=help
Help for two query submodules.
api.php?action=help&modules=query+info|query+categorymembers

action=imagerotate

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Gira uma ou mais imagens.

Parâmetros:
rotation

Graus para girar imagem no sentido horário.

Este parâmetro é obrigatório.
Um dos seguintes valores: 90, 180, 270
continue

When more results are available, use this to continue.

titles

A list of titles to work on.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
pageids

A list of page IDs to work on.

Type: list of integers
Separe os valores com |. Maximum number of values is 50 (500 for bots).
revids

A list of revision IDs to work on.

Type: list of integers
Separe os valores com |. Maximum number of values is 50 (500 for bots).
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

Um dos seguintes valores: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

Type: boolean (details)
converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan, iu, kk, ku, shi, sr, tg, uz, zh.

Type: boolean (details)
token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.

action=import

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Import a page from another wiki, or from an XML file.

Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when sending a file for the xml parameter.

Parâmetros:
summary

Importar sumário.

xml

Enviar arquivo XML.

Must be posted as a file upload using multipart/form-data.
interwikisource

For interwiki imports: wiki to import from.

Um dos seguintes valores:
interwikipage

For interwiki imports: page to import.

fullhistory

For interwiki imports: import the full history, not just the current version.

Type: boolean (details)
templates

For interwiki imports: import all included templates as well.

Type: boolean (details)
namespace

Importar para este espaço nominal. Não pode ser usado em conjunto com rootpage.

Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
rootpage

Importar como subpágina para esta página. Não pode ser usada juntamente com namespace.

token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.

action=login (lg)

  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Log in and get authentication cookies.

In the event of a successful log-in, the needed cookies will be included in the HTTP response headers. In the event of a failed log-in, further attempts may be throttled to limit automated password guessing attacks.

Parâmetros:
lgname

Nome de usuário.

lgpassword

Senha.

lgdomain

Domínio (opcional).

lgtoken

Login token obtained in first request.

action=logout

Terminar e limpar dados de sessão.

Exemplo:
Log the current user out.
api.php?action=logout

action=managetags

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Executar tarefas de gestão relacionadas com alteração de etiquetas.

Parâmetros:
operation

Which operation to perform:

create
Create a new change tag for manual use.
delete
Remove a change tag from the database, including removing the tag from all revisions, recent change entries and log entries on which it is used.
activate
Activate a change tag, allowing users to apply it manually.
deactivate
Deactivate a change tag, preventing users from applying it manually.
Este parâmetro é obrigatório.
Um dos seguintes valores: create, delete, activate, deactivate
tag

Tag to create, delete, activate or deactivate. For tag creation, the tag must not exist. For tag deletion, the tag must exist. For tag activation, the tag must exist and not be in use by an extension. For tag deactivation, the tag must be currently active and manually defined.

Este parâmetro é obrigatório.
reason

Um motivo, opcional, para a criação, eliminação, ativação ou desativação da etiqueta.

ignorewarnings

Whether to ignore any warnings that are issued during the operation.

Type: boolean (details)
token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplos:
Create a tag named spam with the reason For use in edit patrolling
api.php?action=managetags&operation=create&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC
Delete the vandlaism tag with the reason Misspelt
api.php?action=managetags&operation=delete&tag=vandlaism&reason=Misspelt&token=123ABC
Activate a tag named spam with the reason For use in edit patrolling
api.php?action=managetags&operation=activate&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC
Deactivate a tag named spam with the reason No longer required
api.php?action=managetags&operation=deactivate&tag=spam&reason=No+longer+required&token=123ABC

action=move

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Mover uma página.

Parâmetros:
from

Título da página para renomear. Não pode ser usado em conjunto com fromid.

fromid

ID da página a se renomear. Não pode ser usado em conjunto com from.

Type: integer
to

Title to rename the page to.

Este parâmetro é obrigatório.
reason

Reason for the rename.

Padrão: (vazio)
movetalk

Renomear a página de discussão, se existir.

Type: boolean (details)
movesubpages

Renomeia subpáginas, se aplicável.

Type: boolean (details)
noredirect

Não cria um redirecionamento.

Type: boolean (details)
watch
Obsoleto.

Adiciona a página e o redirecionamento para a lista de vigiados do usuário atual.

Type: boolean (details)
unwatch
Obsoleto.

Remove a página e o redirecionamento para a lista de vigiados do usuário atual.

Type: boolean (details)
watchlist

Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.

Um dos seguintes valores: watch, unwatch, preferences, nochange
Padrão: preferences
ignorewarnings

Ignorar quaisquer avisos.

Type: boolean (details)
token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.

action=opensearch

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Search the wiki using the OpenSearch protocol.

Parâmetros:
search

Search string.

limit

O número máximo a se retornar.

No more than 100 (100 for bots) allowed.
Type: integer or max
Padrão: 10
namespace

Espaço nominal para pesquisar.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
Padrão: 0
suggest

Do nothing if $wgEnableOpenSearchSuggest is false.

Type: boolean (details)
redirects

How to handle redirects:

return
Return the redirect itself.
resolve
Return the target page. May return fewer than limit results.

For historical reasons, the default is "return" for format=json and "resolve" for other formats.

Um dos seguintes valores: return, resolve
format

The format of the output.

Um dos seguintes valores: json, jsonfm, xml, xmlfm
Padrão: json
warningsaserror

If warnings are raised with format=json, return an API error instead of ignoring them.

Type: boolean (details)
Exemplo:
Encontra páginas começando com Te.
api.php?action=opensearch&search=Te

action=options

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Change preferences of the current user.

Only options which are registered in core or in one of installed extensions, or options with keys prefixed with userjs- (intended to be used by user scripts), can be set.

Parâmetros:
reset

Redefinir preferências para os padrões do site.

Type: boolean (details)
resetkinds

List of types of options to reset when the reset option is set.

Valores (separar com |): registered, registered-multiselect, registered-checkmatrix, userjs, special, unused, all
Padrão: all
change

List of changes, formatted name=value (e.g. skin=vector). Value cannot contain pipe characters. If no value is given (not even an equals sign), e.g., optionname|otheroption|..., the option will be reset to its default value.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
optionname

The name of the option that should be set to the value given by optionvalue.

optionvalue

The value for the option specified by optionname, can contain pipe characters.

token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.

action=paraminfo

Obtém informações sobre módulos de API.

Parâmetros:
modules

List of module names (values of the action and format parameters, or main). Can specify submodules with a +.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
helpformat

Format of help strings.

Um dos seguintes valores: html, wikitext, raw, none
Padrão: none
querymodules
Obsoleto.

List of query module names (value of prop, meta or list parameter). Use modules=query+foo instead of querymodules=foo.

Valores (separar com |): allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allmessages, allpages, allredirects, alltransclusions, allusers, backlinks, blocks, categories, categoryinfo, categorymembers, contributors, deletedrevisions, deletedrevs, duplicatefiles, embeddedin, extlinks, exturlusage, filearchive, filerepoinfo, fileusage, imageinfo, images, imageusage, info, iwbacklinks, iwlinks, langbacklinks, langlinks, links, linkshere, logevents, pagepropnames, pageprops, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, siteinfo, stashimageinfo, tags, templates, tokens, transcludedin, usercontribs, userinfo, users, watchlist, watchlistraw
Maximum number of values is 50 (500 for bots).
mainmodule
Obsoleto.

Get information about the main (top-level) module as well. Use modules=main instead.

pagesetmodule
Obsoleto.

Get information about the pageset module (providing titles= and friends) as well.

formatmodules
Obsoleto.

List of format module names (value of format parameter). Use modules instead.

Valores (separar com |): dbg, dbgfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, xml, xmlfm, yaml, yamlfm

action=parse

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Parses content and returns parser output.

See the various prop-modules of action=query to get information from the current version of a page.

There are several ways to specify the text to parse:

  1. Specify a page or revision, using page, pageid, or oldid.
  2. Specify content explicitly, using text, title, and contentmodel.
  3. Specify only a summary to parse. prop should be given an empty value.
Parâmetros:
title

Title of page the text belongs to. If omitted, contentmodel must be specified, and API will be used as the title.

text

Text to parse. Use title or contentmodel to control the content model.

summary

Sumário para analisar.

page

Analisa o conteúdo desta página. Não pode ser usado em conjunto com text e title.

pageid

Analisa o conteúdo desta página. sobrepõe page.

Type: integer
redirects

If page or pageid is set to a redirect, resolve it.

Type: boolean (details)
oldid

Parse the content of this revision. Overrides page and pageid.

Type: integer
prop

Qual pedaço de informação obter:

text
Fornece o texto analisado do wikitexto.
langlinks
Fornece os links de idiomas do wikitexto analisado
categories
Fornece as categorias no wikitexto analisado.
categorieshtml
Fornece a versão HTML das categorias.
links
Fornece os links internos do wikitexto analisado.
templates
Fornece a predefinição no wikitexto analisado.
images
Fornece as imagens no wikitexto analisado.
externallinks
Fornece os links externos no wikitexto analisado.
sections
Fornece as seções no wikitexto analisado.
revid
Adds the revision ID of the parsed page.
displaytitle
Adds the title of the parsed wikitext.
headitems
Fornece itens para colocar no <head> da página.
headhtml
Fornece <head> analisado da página.
modules
Fornece os módulos do ResourceLoader usados na página. Ou jsconfigvars ou encodedjsconfigvars deve ser solicitado conjuntamente com modules.
jsconfigvars
Fornece as variáveis de configuração JavaScript específicas da página.
encodedjsconfigvars
Fornece as variáveis de configuração JavaScript específicas da página como uma string JSON.
indicators
Fornece o HTML de indicadores de status de página utilizados na página.
iwlinks
Fornece links interwiki no wikitexto analisado.
wikitext
Fornece o wikitexto original que foi analisado.
properties
Fornece várias propriedades definidas no wikitexto analisado.
limitreportdata
Fornece o relatório limite de uma forma estruturada. Não informa dado, quandodisablelimitreport se definido.
limitreporthtml
Gives the HTML version of the limit report. Gives no data, when disablelimitreport is set.
parsetree
The XML parse tree of revision content (requires content model wikitext)
Valores (separar com |): text, langlinks, categories, categorieshtml, links, templates, images, externallinks, sections, revid, displaytitle, headitems, headhtml, modules, jsconfigvars, encodedjsconfigvars, indicators, iwlinks, wikitext, properties, limitreportdata, limitreporthtml, parsetree
Padrão: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties
pst

Do a pre-save transform on the input before parsing it. Only valid when used with text.

Type: boolean (details)
onlypst

Do a pre-save transform (PST) on the input, but don't parse it. Returns the same wikitext, after a PST has been applied. Only valid when used with text.

Type: boolean (details)
effectivelanglinks

Includes language links supplied by extensions (for use with prop=langlinks).

Type: boolean (details)
section

Only retrieve the content of this section number or when new generate a new section.

new section is only honored when specifying text.

sectiontitle

New section title when section is new.

Unlike page editing, this does not fall back to summary when omitted or empty.

disablepp
Obsoleto.

Use disablelimitreport instead.

Type: boolean (details)
disablelimitreport

Omit the limit report ("NewPP limit report") from the parser output.

Type: boolean (details)
disableeditsection

Omit edit section links from the parser output.

Type: boolean (details)
disabletidy

Do not run HTML cleanup (e.g. tidy) on the parser output.

Type: boolean (details)
generatexml
Obsoleto.

Generate XML parse tree (requires content model wikitext; replaced by prop=parsetree).

Type: boolean (details)
preview

Parse in preview mode.

Type: boolean (details)
sectionpreview

Parse in section preview mode (enables preview mode too).

Type: boolean (details)
disabletoc

Omit table of contents in output.

Type: boolean (details)
contentformat

Content serialization format used for the input text. Only valid when used with text.

Um dos seguintes valores: text/x-wiki, text/javascript, application/json, text/css, text/plain
contentmodel

Content model of the input text. If omitted, title must be specified, and default will be the model of the specified title. Only valid when used with text.

Um dos seguintes valores: wikitext, javascript, json, css, text

action=patrol

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Patrulha uma página ou revisão.

Parâmetros:
rcid

ID de Mudanças recentes para patrulhar.

Type: integer
revid

ID de revisão para patrulhar.

Type: integer
token

A "patrol" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplos:
Patrulha uma modificação recente.
api.php?action=patrol&token=123ABC&rcid=230672766
Patrulha uma revisão.
api.php?action=patrol&token=123ABC&revid=230672766

action=protect

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Modifica o nível de proteção de uma página.

Parâmetros:
title

Título da página para (des)proteger. Não pode ser usado em conjunto com pageid.

pageid

ID da página a se (des)proteger. Não pode ser usado em conjunto com title.

Type: integer
protections

List of protection levels, formatted action=level (e.g. edit=sysop).

Note: Any actions not listed will have restrictions removed.

Este parâmetro é obrigatório.
Separe os valores com |. Maximum number of values is 50 (500 for bots).
expiry

Expiry timestamps. If only one timestamp is set, it'll be used for all protections. Use infinite, indefinite, infinity, or never, for a never-expiring protection.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
Padrão: infinite
reason

Motivo para (des)proteger.

Padrão: (vazio)
cascade

Enable cascading protection (i.e. protect transcluded templates and images used in this page). Ignored if none of the given protection levels support cascading.

Type: boolean (details)
watch
Obsoleto.

If set, add the page being (un)protected to the current user's watchlist.

Type: boolean (details)
watchlist

Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.

Um dos seguintes valores: watch, unwatch, preferences, nochange
Padrão: preferences
token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.

action=purge

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Purge the cache for the given titles.

Requires a POST request if the user is not logged in.

Parâmetros:
forcelinkupdate

Atualiza as tabelas de links.

Type: boolean (details)
forcerecursivelinkupdate

Atualiza a tabela de links, e atualiza as tabelas de links para qualquer página que usa essa página como um modelo.

Type: boolean (details)
continue

When more results are available, use this to continue.

titles

A list of titles to work on.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
pageids

A list of page IDs to work on.

Type: list of integers
Separe os valores com |. Maximum number of values is 50 (500 for bots).
revids

A list of revision IDs to work on.

Type: list of integers
Separe os valores com |. Maximum number of values is 50 (500 for bots).
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

Um dos seguintes valores: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

Type: boolean (details)
converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan, iu, kk, ku, shi, sr, tg, uz, zh.

Type: boolean (details)
Exemplos:
Purge the Main Page and the API page.
api.php?action=purge&titles=Main_Page|API
Purge the first 10 pages in the main namespace.
api.php?action=purge&generator=allpages&gapnamespace=0&gaplimit=10

action=query

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Fetch data from and about MediaWiki.

All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites.

Parâmetros:
prop

Which properties to get for the queried pages.

Valores (separar com |): categories, categoryinfo, contributors, deletedrevisions, duplicatefiles, extlinks, fileusage, imageinfo, images, info, iwlinks, langlinks, links, linkshere, pageprops, redirects, revisions, stashimageinfo, templates, transcludedin
list

Quais listas obter.

Valores (separar com |): allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, alltransclusions, allusers, backlinks, blocks, categorymembers, deletedrevs, embeddedin, exturlusage, filearchive, imageusage, iwbacklinks, langbacklinks, logevents, pagepropnames, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, search, tags, usercontribs, users, watchlist, watchlistraw
meta

Quais metadados obter.

Valores (separar com |): allmessages, filerepoinfo, siteinfo, tokens, userinfo
indexpageids

Include an additional pageids section listing all returned page IDs.

Type: boolean (details)
export

Export the current revisions of all given or generated pages.

Type: boolean (details)
exportnowrap

Return the export XML without wrapping it in an XML result (same format as Special:Export). Can only be used with export.

Type: boolean (details)
iwurl

Whether to get the full URL if the title is an interwiki link.

Type: boolean (details)
continue

When more results are available, use this to continue.

rawcontinue

Return raw query-continue data for continuation.

Type: boolean (details)
titles

A list of titles to work on.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
pageids

A list of page IDs to work on.

Type: list of integers
Separe os valores com |. Maximum number of values is 50 (500 for bots).
revids

A list of revision IDs to work on.

Type: list of integers
Separe os valores com |. Maximum number of values is 50 (500 for bots).
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

Um dos seguintes valores: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

Type: boolean (details)
converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan, iu, kk, ku, shi, sr, tg, uz, zh.

Type: boolean (details)

prop=categories (cl)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

List all categories the pages belong to.

Parâmetros:
clprop

Which additional properties to get for each category:

sortkey
Adds the sortkey (hexadecimal string) and sortkey prefix (human-readable part) for the category.
timestamp
Adds timestamp of when the category was added.
hidden
Tags categories that are hidden with __HIDDENCAT__.
Valores (separar com |): sortkey, timestamp, hidden
clshow

Which kind of categories to show.

Valores (separar com |): hidden, !hidden
cllimit

Quantas categorias retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
clcontinue

When more results are available, use this to continue.

clcategories

Only list these categories. Useful for checking whether a certain page is in a certain category.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
cldir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
Exemplos:
Get a list of categories the page Albert Einstein belongs to.
api.php?action=query&prop=categories&titles=Albert%20Einstein
Get information about all categories used in the page Albert Einstein.
api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info

prop=categoryinfo (ci)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Returns information about the given categories.

Parâmetro:
cicontinue

When more results are available, use this to continue.

Exemplo:
Get information about Category:Foo and Category:Bar.
api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar

prop=contributors (pc)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Get the list of logged-in contributors and the count of anonymous contributors to a page.

Parâmetros:
pcgroup

Only include users in the given groups. Does not include implicit or auto-promoted groups like *, user, or autoconfirmed.

Valores (separar com |): bot, sysop, bureaucrat
pcexcludegroup

Exclude users in the given groups. Does not include implicit or auto-promoted groups like *, user, or autoconfirmed.

Valores (separar com |): bot, sysop, bureaucrat
pcrights

Only include users having the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.

Valores (separar com |): apihighlimits, applychangetags, autoconfirmed, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmywatchlist, editsemiprotected, editusercssjs, editusercss, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, passwordreset, patrol, patrolmarks, protect, proxyunbannable, purge, read, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi
Maximum number of values is 50 (500 for bots).
pcexcluderights

Exclude users having the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.

Valores (separar com |): apihighlimits, applychangetags, autoconfirmed, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmywatchlist, editsemiprotected, editusercssjs, editusercss, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, passwordreset, patrol, patrolmarks, protect, proxyunbannable, purge, read, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi
Maximum number of values is 50 (500 for bots).
pclimit

Quantas contribuições retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
pccontinue

When more results are available, use this to continue.

Exemplo:
Show contributors to the page Main Page.
api.php?action=query&prop=contributors&titles=Main_Page

prop=deletedrevisions (drv)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Get deleted revision information.

May be used in several ways:

  1. Get deleted revisions for a set of pages, by setting titles or pageids. Ordered by title and timestamp.
  2. Get data about a set of deleted revisions by setting their IDs with revids. Ordered by revision ID.
Parâmetros:
drvprop

Which properties to get for each revision:

ids
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision.
userid
User ID of the revision creator.
size
Length (bytes) of the revision.
sha1
SHA-1 (base 16) of the revision.
contentmodel
Content model ID of the revision.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Text of the revision.
tags
Tags for the revision.
parsetree
The XML parse tree of revision content (requires content model wikitext).
Valores (separar com |): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
Padrão: ids|timestamp|flags|comment|user
drvlimit

Limit how many revisions will be returned.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
drvexpandtemplates

Expand templates in revision content (requires drvprop=content).

Type: boolean (details)
drvgeneratexml
Obsoleto.

Generate XML parse tree for revision content (requires drvprop=content; replaced by drvprop=parsetree).

Type: boolean (details)
drvparse

Parse revision content (requires drvprop=content). For performance reasons, if this option is used, drvlimit is enforced to 1.

Type: boolean (details)
drvsection

Only retrieve the content of this section number.

drvdiffto

Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

drvdifftotext

Text to diff each revision to. Only diffs a limited number of revisions. Overrides drvdiffto. If drvsection is set, only that section will be diffed against this text.

drvcontentformat

Serialization format used for drvdifftotext and expected for output of content.

Um dos seguintes valores: text/x-wiki, text/javascript, application/json, text/css, text/plain
drvstart

The timestamp to start enumerating from. Ignored when processing a list of revision IDs.

Type: timestamp (allowed formats)
drvend

The timestamp to stop enumerating at. Ignored when processing a list of revision IDs.

Type: timestamp (allowed formats)
drvdir

In which direction to enumerate:

newer
List oldest first. Note: drvstart has to be before drvend.
older
List newest first (default). Note: drvstart has to be later than drvend.
Um dos seguintes valores: newer, older
Padrão: older
drvtag

Only list revisions tagged with this tag.

drvuser

Only list revisions by this user.

Type: user name
drvexcludeuser

Don't list revisions by this user.

Type: user name
drvcontinue

When more results are available, use this to continue.

Exemplos:
List the deleted revisions of the pages Main Page and Talk:Main Page, with content.
api.php?action=query&prop=deletedrevisions&titles=Main%20Page|Talk:Main%20Page&drvprop=user|comment|content
List the information for deleted revision 123456.
api.php?action=query&prop=deletedrevisions&revids=123456

prop=duplicatefiles (df)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

List all files that are duplicates of the given files based on hash values.

Parâmetros:
dflimit

Quantos arquivos duplicados retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
dfcontinue

When more results are available, use this to continue.

dfdir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
dflocalonly

Look only for files in the local repository.

Type: boolean (details)
  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Retorna todas as URLs externas (não interwikis) a partir das páginas de dados.

Parâmetros:
ellimit

Quantos links retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
eloffset

When more results are available, use this to continue.

Type: integer
elprotocol

Protocol of the URL. If empty and elquery is set, the protocol is http. Leave both this and elquery empty to list all external links.

Um dos seguintes valores: Can be empty, or bitcoin, ftp, ftps, geo, git, gopher, http, https, irc, ircs, magnet, mailto, mms, news, nntp, redis, sftp, sip, sips, sms, ssh, svn, tel, telnet, urn, worldwind, xmpp
Padrão: (vazio)
elquery

Search string without protocol. Useful for checking whether a certain page contains a certain external url.

elexpandurl

Expand protocol-relative URLs with the canonical protocol.

Type: boolean (details)
Exemplo:
Get a list of external links on Main Page.
api.php?action=query&prop=extlinks&titles=Main%20Page

prop=fileusage (fu)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Find all pages that use the given files.

Parâmetros:
fuprop

Which properties to get:

pageid
Page ID of each page.
title
Title of each page.
redirect
Flag if the page is a redirect.
Valores (separar com |): pageid, title, redirect
Padrão: pageid|title|redirect
funamespace

Only include pages in these namespaces.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
fushow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
Valores (separar com |): redirect, !redirect
fulimit

Quantos retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
fucontinue

When more results are available, use this to continue.

prop=imageinfo (ii)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Returns file information and upload history.

Parâmetros:
iiprop

Which file information to get:

timestamp
Adds timestamp for the uploaded version.
user
Adds the user who uploaded each file version.
userid
Add the ID of the user that uploaded each file version.
comment
Comment on the version.
parsedcomment
Parse the comment on the version.
canonicaltitle
Adds the canonical title of the file.
url
Gives URL to the file and the description page.
size
Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions
Alias for size.
sha1
Adds SHA-1 hash for the file.
mime
Adds MIME type of the file.
thumbmime
Adds MIME type of the image thumbnail (requires url and param iiurlwidth).
mediatype
Adds the media type of the file.
metadata
Lists Exif metadata for the version of the file.
commonmetadata
Lists file format generic metadata for the version of the file.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted.
archivename
Adds the filename of the archive version for non-latest versions.
bitdepth
Adds the bit depth of the version.
uploadwarning
Used by the Special:Upload page to get information about an existing file. Not intended for use outside MediaWiki core.
Valores (separar com |): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, thumbmime, mediatype, metadata, commonmetadata, extmetadata, archivename, bitdepth, uploadwarning
Padrão: timestamp|user
iilimit

Quantas revisões de arquivos retornar por arquivo.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 1
iistart

Timestamp to start listing from.

Type: timestamp (allowed formats)
iiend

Timestamp to stop listing at.

Type: timestamp (allowed formats)
iiurlwidth

If iiprop=url is set, a URL to an image scaled to this width will be returned. For performance reasons if this option is used, no more than 50 scaled images will be returned.

Type: integer
Padrão: -1
iiurlheight

Similar to iiurlwidth.

Type: integer
Padrão: -1
iimetadataversion

Version of metadata to use. If latest is specified, use latest version. Defaults to 1 for backwards compatibility.

Padrão: 1
iiextmetadatalanguage

What language to fetch extmetadata in. This affects both which translation to fetch, if multiple are available, as well as how things like numbers and various values are formatted.

Padrão: pt-br
iiextmetadatamultilang

If translations for extmetadata property are available, fetch all of them.

Type: boolean (details)
iiextmetadatafilter

If specified and non-empty, only these keys will be returned for iiprop=extmetadata.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
iiurlparam

A handler specific parameter string. For example, PDFs might use page15-100px. iiurlwidth must be used and be consistent with iiurlparam.

Padrão: (vazio)
iicontinue

When more results are available, use this to continue.

iilocalonly

Look only for files in the local repository.

Type: boolean (details)

prop=images (im)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Returns all files contained on the given pages.

Parâmetros:
imlimit

Quantos arquivos retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
imcontinue

When more results are available, use this to continue.

imimages

Only list these files. Useful for checking whether a certain page has a certain file.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
imdir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending

prop=info (in)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Obter informação básica da página.

Parâmetros:
inprop

Which additional properties to get:

protection
List the protection level of each page.
talkid
The page ID of the talk page for each non-talk page.
watched
List the watched status of each page.
watchers
The number of watchers, if allowed.
notificationtimestamp
The watchlist notification timestamp of each page.
subjectid
The page ID of the parent page for each talk page.
url
Gives a full URL, an edit URL, and the canonical URL for each page.
readable
Se o usuário pode ler esta página.
preload
Fornece o texto retornado por EditFormPreloadText.
displaytitle
Fornece o modo como o título da página é exibido.
Valores (separar com |): protection, talkid, watched, watchers, notificationtimestamp, subjectid, url, readable, preload, displaytitle
intestactions

Testa se o usuário atual pode executar determinadas ações na página.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
intoken
Obsoleto.

Use action=query&meta=tokens instead.

Valores (separar com |): edit, delete, protect, move, block, unblock, email, import, watch
incontinue

When more results are available, use this to continue.

Exemplos:
Obtém informações sobre a página Página principal.
api.php?action=query&prop=info&titles=Main%20Page
Get general and protection information about the page Main Page.
api.php?action=query&prop=info&inprop=protection&titles=Main%20Page
  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Returns all interwiki links from the given pages.

Parâmetros:
iwprop

Which additional properties to get for each interlanguage link:

url
Adds the full URL.
Valores (separar com |): url
iwprefix

Only return interwiki links with this prefix.

iwtitle

Interwiki link to search for. Must be used with iwprefix.

iwdir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
iwlimit

How many interwiki links to return.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
iwcontinue

When more results are available, use this to continue.

iwurl
Obsoleto.

Whether to get the full URL (cannot be used with iwprop).

Type: boolean (details)
Exemplo:
Get interwiki links from the page Main Page.
api.php?action=query&prop=iwlinks&titles=Main%20Page
  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Returns all interlanguage links from the given pages.

Parâmetros:
llprop

Which additional properties to get for each interlanguage link:

url
Adds the full URL.
langname
Adds the localised language name (best effort). Use llinlanguagecode to control the language.
autonym
Adds the native language name.
Valores (separar com |): url, langname, autonym
lllang

Only return language links with this language code.

lltitle

Link to search for. Must be used with lllang.

lldir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
llinlanguagecode

Language code for localised language names.

Padrão: pt-br
lllimit

Quantos links de idioma retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
llcontinue

When more results are available, use this to continue.

llurl
Obsoleto.

Whether to get the full URL (cannot be used with llprop).

Type: boolean (details)
Exemplo:
Get interlanguage links from the page Main Page.
api.php?action=query&prop=langlinks&titles=Main%20Page&redirects=
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Returns all links from the given pages.

Parâmetros:
plnamespace

Show links in these namespaces only.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
pllimit

Quantos links retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
plcontinue

When more results are available, use this to continue.

pltitles

Only list links to these titles. Useful for checking whether a certain page links to a certain title.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
pldir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
Exemplos:
Get links from the page Main Page
api.php?action=query&prop=links&titles=Main%20Page
Get information about the link pages in the page Main Page.
api.php?action=query&generator=links&titles=Main%20Page&prop=info
Get links from the page Main Page in the Usuário and Predefinição namespaces.
api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10

prop=linkshere (lh)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Find all pages that link to the given pages.

Parâmetros:
lhprop

Which properties to get:

pageid
Page ID of each page.
title
Title of each page.
redirect
Flag if the page is a redirect.
Valores (separar com |): pageid, title, redirect
Padrão: pageid|title|redirect
lhnamespace

Only include pages in these namespaces.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
lhshow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
Valores (separar com |): redirect, !redirect
lhlimit

Quantos retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
lhcontinue

When more results are available, use this to continue.

prop=pageprops (pp)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Get various properties defined in the page content.

Parâmetros:
ppcontinue

When more results are available, use this to continue.

ppprop

Only list these props. Useful for checking whether a certain page uses a certain page prop.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
Exemplo:
Get properties for the pages Main Page and MediaWiki.
api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki

prop=redirects (rd)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Returns all redirects to the given pages.

Parâmetros:
rdprop

Which properties to get:

pageid
Page ID of each redirect.
title
Title of each redirect.
fragment
Fragment of each redirect, if any.
Valores (separar com |): pageid, title, fragment
Padrão: pageid|title
rdnamespace

Only include pages in these namespaces.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
rdshow

Show only items that meet these criteria:

fragment
Only show redirects with a fragment.
!fragment
Only show redirects without a fragment.
Valores (separar com |): fragment, !fragment
rdlimit

How many redirects to return.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
rdcontinue

When more results are available, use this to continue.

prop=revisions (rv)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Get revision information.

May be used in several ways:

  1. Get data about a set of pages (last revision), by setting titles or pageids.
  2. Get revisions for one given page, by using titles or pageids with start, end, or limit.
  3. Get data about a set of revisions by setting their IDs with revids.
Parâmetros:
rvprop

Which properties to get for each revision:

ids
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision.
userid
User ID of the revision creator.
size
Length (bytes) of the revision.
sha1
SHA-1 (base 16) of the revision.
contentmodel
Content model ID of the revision.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Text of the revision.
tags
Tags for the revision.
parsetree
The XML parse tree of revision content (requires content model wikitext).
Valores (separar com |): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
Padrão: ids|timestamp|flags|comment|user
rvlimit

Limit how many revisions will be returned.

May only be used with a single page (mode #2).
No more than 500 (5 000 for bots) allowed.
Type: integer or max
rvexpandtemplates

Expand templates in revision content (requires rvprop=content).

Type: boolean (details)
rvgeneratexml
Obsoleto.

Generate XML parse tree for revision content (requires rvprop=content; replaced by rvprop=parsetree).

Type: boolean (details)
rvparse

Parse revision content (requires rvprop=content). For performance reasons, if this option is used, rvlimit is enforced to 1.

Type: boolean (details)
rvsection

Only retrieve the content of this section number.

rvdiffto

Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

rvdifftotext

Text to diff each revision to. Only diffs a limited number of revisions. Overrides rvdiffto. If rvsection is set, only that section will be diffed against this text.

rvcontentformat

Serialization format used for rvdifftotext and expected for output of content.

Um dos seguintes valores: text/x-wiki, text/javascript, application/json, text/css, text/plain
rvstartid

From which revision ID to start enumeration.

May only be used with a single page (mode #2).
Type: integer
rvendid

Stop revision enumeration on this revision ID.

May only be used with a single page (mode #2).
Type: integer
rvstart

From which revision timestamp to start enumeration.

May only be used with a single page (mode #2).
Type: timestamp (allowed formats)
rvend

Enumerate up to this timestamp.

May only be used with a single page (mode #2).
Type: timestamp (allowed formats)
rvdir

In which direction to enumerate:

newer
List oldest first. Note: rvstart has to be before rvend.
older
List newest first (default). Note: rvstart has to be later than rvend.
May only be used with a single page (mode #2).
Um dos seguintes valores: newer, older
Padrão: older
rvuser

Only include revisions made by user.

May only be used with a single page (mode #2).
Type: user name
rvexcludeuser

Exclude revisions made by user.

May only be used with a single page (mode #2).
Type: user name
rvtag

Only list revisions tagged with this tag.

rvtoken
Obsoleto.

Which tokens to obtain for each revision.

Valores (separar com |): rollback
rvcontinue

When more results are available, use this to continue.

prop=stashimageinfo (sii)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Returns file information for stashed files.

Parâmetros:
siifilekey

Key that identifies a previous upload that was stashed temporarily.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
siisessionkey
Obsoleto.

Alias for siifilekey, for backward compatibility.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
siiprop

Which file information to get:

timestamp
Adds timestamp for the uploaded version.
canonicaltitle
Adds the canonical title of the file.
url
Gives URL to the file and the description page.
size
Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions
Alias for size.
sha1
Adds SHA-1 hash for the file.
mime
Adds MIME type of the file.
thumbmime
Adds MIME type of the image thumbnail (requires url and param siiurlwidth).
metadata
Lists Exif metadata for the version of the file.
commonmetadata
Lists file format generic metadata for the version of the file.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted.
bitdepth
Adds the bit depth of the version.
Valores (separar com |): timestamp, canonicaltitle, url, size, dimensions, sha1, mime, thumbmime, metadata, commonmetadata, extmetadata, bitdepth
Padrão: timestamp|url
siiurlwidth

If siiprop=url is set, a URL to an image scaled to this width will be returned. For performance reasons if this option is used, no more than 50 scaled images will be returned.

Type: integer
Padrão: -1
siiurlheight

Similar to siiurlwidth.

Type: integer
Padrão: -1
siiurlparam

A handler specific parameter string. For example, PDFs might use page15-100px. siiurlwidth must be used and be consistent with siiurlparam.

Padrão: (vazio)

prop=templates (tl)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Returns all pages transcluded on the given pages.

Parâmetros:
tlnamespace

Show templates in this namespaces only.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
tllimit

Quantas predefinições retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
tlcontinue

When more results are available, use this to continue.

tltemplates

Only list these templates. Useful for checking whether a certain page uses a certain template.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
tldir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
Exemplos:
Get the templates used on the page Main Page.
api.php?action=query&prop=templates&titles=Main%20Page
Get information about the template pages used on Main Page.
api.php?action=query&generator=templates&titles=Main%20Page&prop=info
Get pages in the Usuário and Predefinição namespaces that are transcluded on the page Main Page.
api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10

prop=transcludedin (ti)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Find all pages that transclude the given pages.

Parâmetros:
tiprop

Which properties to get:

pageid
Page ID of each page.
title
Title of each page.
redirect
Flag if the page is a redirect.
Valores (separar com |): pageid, title, redirect
Padrão: pageid|title|redirect
tinamespace

Only include pages in these namespaces.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
tishow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
Valores (separar com |): redirect, !redirect
tilimit

Quantos retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
ticontinue

When more results are available, use this to continue.

Exemplos:
Get a list of pages transcluding Main Page.
api.php?action=query&prop=transcludedin&titles=Main%20Page
Get information about pages transcluding Main Page.
api.php?action=query&generator=transcludedin&titles=Main%20Page&prop=info

list=allcategories (ac)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Enumera todas as categorias.

Parâmetros:
acfrom

The category to start enumerating from.

accontinue

When more results are available, use this to continue.

acto

The category to stop enumerating at.

acprefix

Pesquisa por todo os título de categoria que começam com este valor.

acdir

Direção para ordenar.

Um dos seguintes valores: ascending, descending
Padrão: ascending
acmin

Retorna apenas as categorias com pelo menos esta quantidade de membros.

Type: integer
acmax

Retorna apenas as categorias com no máximo esta quantidade de membros.

Type: integer
aclimit

Quantas categorias retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
acprop

Which properties to get:

size
Adds number of pages in the category.
hidden
Tags categories that are hidden with __HIDDENCAT__.
Valores (separar com |): size, hidden
Padrão: (vazio)
Exemplos:
Lista categorias com a informação sobre o número de páginas em cada uma.
api.php?action=query&list=allcategories&acprop=size
Retrieve info about the category page itself for categories beginning List.
api.php?action=query&generator=allcategories&gacprefix=List&prop=info

list=alldeletedrevisions (adr)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Lista todas as revisões excluídas por um usuário ou em um espaço nominal.

Parâmetros:
adrprop

Which properties to get for each revision:

ids
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision.
userid
User ID of the revision creator.
size
Length (bytes) of the revision.
sha1
SHA-1 (base 16) of the revision.
contentmodel
Content model ID of the revision.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Text of the revision.
tags
Tags for the revision.
parsetree
The XML parse tree of revision content (requires content model wikitext).
Valores (separar com |): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
Padrão: ids|timestamp|flags|comment|user
adrlimit

Limit how many revisions will be returned.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
adrexpandtemplates

Expand templates in revision content (requires adrprop=content).

Type: boolean (details)
adrgeneratexml
Obsoleto.

Generate XML parse tree for revision content (requires adrprop=content; replaced by adrprop=parsetree).

Type: boolean (details)
adrparse

Parse revision content (requires adrprop=content). For performance reasons, if this option is used, adrlimit is enforced to 1.

Type: boolean (details)
adrsection

Only retrieve the content of this section number.

adrdiffto

Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

adrdifftotext

Text to diff each revision to. Only diffs a limited number of revisions. Overrides adrdiffto. If adrsection is set, only that section will be diffed against this text.

adrcontentformat

Serialization format used for adrdifftotext and expected for output of content.

Um dos seguintes valores: text/x-wiki, text/javascript, application/json, text/css, text/plain
adruser

Lista apenas revisões desse usuário.

Type: user name
adrnamespace

Lista páginas apenas neste espaço nominal.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
adrstart

A data a partir da qual começar a enumeração.

Só pode ser usada com adruser.
Type: timestamp (allowed formats)
adrend

A data onde parar a enumeração.

Só pode ser usada com adruser.
Type: timestamp (allowed formats)
adrdir

In which direction to enumerate:

newer
List oldest first. Note: adrstart has to be before adrend.
older
List newest first (default). Note: adrstart has to be later than adrend.
Um dos seguintes valores: newer, older
Padrão: older
adrfrom

Começar listando desse título.

Não pode ser usada com adruser.
adrto

Parar a listagem neste título.

Não pode ser usada com adruser.
adrprefix

Pesquisa por todo os título que começam com este valor.

Não pode ser usada com adruser.
adrexcludeuser

Não lista as revisões deste usuário.

Não pode ser usada com adruser.
Type: user name
adrtag

Lista apenas as revisões com esta tag.

adrcontinue

When more results are available, use this to continue.

adrgeneratetitles

When being used as a generator, generate titles rather than revision IDs.

Type: boolean (details)
Exemplos:
Lista as últimas 50 contribuições excluídas pelo usuário Exemplo.
api.php?action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50
Lista as primeiras 50 edições excluídas no espaço nominal principal.
api.php?action=query&list=alldeletedrevisions&adrdir=newer&adrlimit=50

list=allfileusages (af)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Lista todas as utilizações de arquivo, incluindo os não-existentes.

Parâmetros:
afcontinue

When more results are available, use this to continue.

affrom

O título do arquivo a partir do qual começar a enumerar.

afto

O título do arquivo onde parar de enumerar.

afprefix

Search for all file titles that begin with this value.

afunique

Only show distinct file titles. Cannot be used with afprop=ids. When used as a generator, yields target pages instead of source pages.

Type: boolean (details)
afprop

Which pieces of information to include:

ids
Adds the page IDs of the using pages (cannot be used with afunique).
title
Adds the title of the file.
Valores (separar com |): ids, title
Padrão: title
aflimit

Quantos itens retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
afdir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
Exemplos:
List file titles, including missing ones, with page IDs they are from, starting at B.
api.php?action=query&list=allfileusages&affrom=B&afprop=ids|title
List unique file titles.
api.php?action=query&list=allfileusages&afunique=&affrom=B
Gets all file titles, marking the missing ones.
api.php?action=query&generator=allfileusages&gafunique=&gaffrom=B
Gets pages containing the files.
api.php?action=query&generator=allfileusages&gaffrom=B

list=allimages (ai)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Enumerate all images sequentially.

Parâmetros:
aisort

Property to sort by.

Um dos seguintes valores: name, timestamp
Padrão: name
aidir

The direction in which to list.

Um dos seguintes valores: ascending, descending, newer, older
Padrão: ascending
aifrom

The image title to start enumerating from. Can only be used with aisort=name.

aito

The image title to stop enumerating at. Can only be used with aisort=name.

aicontinue

When more results are available, use this to continue.

aistart

The timestamp to start enumerating from. Can only be used with aisort=timestamp.

Type: timestamp (allowed formats)
aiend

The timestamp to end enumerating. Can only be used with aisort=timestamp.

Type: timestamp (allowed formats)
aiprop

Which file information to get:

timestamp
Adds timestamp for the uploaded version.
user
Adds the user who uploaded each file version.
userid
Add the ID of the user that uploaded each file version.
comment
Comment on the version.
parsedcomment
Parse the comment on the version.
canonicaltitle
Adds the canonical title of the file.
url
Gives URL to the file and the description page.
size
Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions
Alias for size.
sha1
Adds SHA-1 hash for the file.
mime
Adds MIME type of the file.
mediatype
Adds the media type of the file.
metadata
Lists Exif metadata for the version of the file.
commonmetadata
Lists file format generic metadata for the version of the file.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted.
bitdepth
Adds the bit depth of the version.
Valores (separar com |): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, mediatype, metadata, commonmetadata, extmetadata, bitdepth
Padrão: timestamp|url
aiprefix

Search for all image titles that begin with this value. Can only be used with aisort=name.

aiminsize

Limit to images with at least this many bytes.

Type: integer
aimaxsize

Limit to images with at most this many bytes.

Type: integer
aisha1

SHA1 hash of image. Overrides aisha1base36.

aisha1base36

SHA1 hash of image in base 36 (used in MediaWiki).

aiuser

Retorna apenas os arquivos enviados por este usuário. Só pode ser usado com aisort=timestamp. Não pode ser usado em conjunto com aifilterbots.

Type: user name
aifilterbots

Como filtrar arquivos enviados por bots. Só pode ser usado com aisort=timestamp. Não pode ser usado em conjunto com aiuser.

Um dos seguintes valores: all, bots, nobots
Padrão: all
aimime

Quais tipos MIME pesquisar, ex.: image/jpeg.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
ailimit

Quantas imagens retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
Exemplos:
Mostra uma lista de arquivos começando com a letra B.
api.php?action=query&list=allimages&aifrom=B
Mostra uma lista de arquivos recentemente enviados, semelhante ao Special:NewFiles.
api.php?action=query&list=allimages&aiprop=user|timestamp|url&aisort=timestamp&aidir=older
Mostra uma lista de arquivos com o tipo MIME image/png ou image/gif
api.php?action=query&list=allimages&aimime=image/png|image/gif
Mostra informações sobre 4 arquivos começando com a letra T.
api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Enumerar todos os links que apontam para um determinado espaço nominal.

Parâmetros:
alcontinue

When more results are available, use this to continue.

alfrom

O título do link a partir do qual começar a enumerar.

alto

O título do link onde parar de enumerar.

alprefix

Pesquisa por todos os títulos com link que começam com este valor.

alunique

Only show distinct linked titles. Cannot be used with alprop=ids. When used as a generator, yields target pages instead of source pages.

Type: boolean (details)
alprop

Which pieces of information to include:

ids
Adds the page ID of the linking page (cannot be used with alunique).
title
Adds the title of the link.
Valores (separar com |): ids, title
Padrão: title
alnamespace

O espaço nominal a se enumerar.

Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
Padrão: 0
allimit

Quantos itens retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
aldir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
Exemplos:
List linked titles, including missing ones, with page IDs they are from, starting at B.
api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title
List unique linked titles.
api.php?action=query&list=alllinks&alunique=&alfrom=B
Gets all linked titles, marking the missing ones.
api.php?action=query&generator=alllinks&galunique=&galfrom=B
Obtém páginas contendo os links.
api.php?action=query&generator=alllinks&galfrom=B

list=allpages (ap)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Enumerate all pages sequentially in a given namespace.

Parâmetros:
apfrom

The page title to start enumerating from.

apcontinue

When more results are available, use this to continue.

apto

The page title to stop enumerating at.

apprefix

Pesquisa para todos os títulos de páginas que comecem com este valor.

apnamespace

O espaço nominal a se enumerar.

Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
Padrão: 0
apfilterredir

Quais páginas listar.

Um dos seguintes valores: all, redirects, nonredirects
Padrão: all
apminsize

Limitar a páginas com pelo menos essa quantidade de bytes.

Type: integer
apmaxsize

Limitar a páginas com no máximo essa quantidade de bytes.

Type: integer
apprtype

Limit to protected pages only.

Valores (separar com |): edit, move, upload
apprlevel

Filter protections based on protection level (must be used with apprtype= parameter).

Valores (separar com |): Can be empty, or autoconfirmed, sysop
apprfiltercascade

Filter protections based on cascadingness (ignored when apprtype isn't set).

Um dos seguintes valores: cascading, noncascading, all
Padrão: all
aplimit

Quantas páginas retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
apdir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
apfilterlanglinks

Filter based on whether a page has langlinks. Note that this may not consider langlinks added by extensions.

Um dos seguintes valores: withlanglinks, withoutlanglinks, all
Padrão: all
apprexpiry

Which protection expiry to filter the page on:

indefinite
Get only pages with indefinite protection expiry.
definite
Get only pages with a definite (specific) protection expiry.
all
Get pages with any protections expiry.
Um dos seguintes valores: indefinite, definite, all
Padrão: all
Exemplos:
Show a list of pages starting at the letter B.
api.php?action=query&list=allpages&apfrom=B
Mostrar informação sobre 4 páginas que comecem com a letra T.
api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info
Show content of first 2 non-redirect pages beginning at Re.
api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content

list=allredirects (ar)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Lista todos os redirecionamentos para um espaço nominal.

Parâmetros:
arcontinue

When more results are available, use this to continue.

arfrom

O título do redirecionamento a partir do qual começar a enumerar.

arto

O título do redirecionamento onde parar de enumerar.

arprefix

Search for all target pages that begin with this value.

arunique

Only show distinct target pages. Cannot be used with arprop=ids|fragment|interwiki. When used as a generator, yields target pages instead of source pages.

Type: boolean (details)
arprop

Which pieces of information to include:

ids
Adds the page ID of the redirecting page (cannot be used with arunique).
title
Adds the title of the redirect.
fragment
Adds the fragment from the redirect, if any (cannot be used with arunique).
interwiki
Adds the interwiki prefix from the redirect, if any (cannot be used with arunique).
Valores (separar com |): ids, title, fragment, interwiki
Padrão: title
arnamespace

O espaço nominal a se enumerar.

Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
Padrão: 0
arlimit

How many total items to return.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
ardir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
Exemplos:
List target pages, including missing ones, with page IDs they are from, starting at B.
api.php?action=query&list=allredirects&arfrom=B&arprop=ids|title
List unique target pages.
api.php?action=query&list=allredirects&arunique=&arfrom=B
Gets all target pages, marking the missing ones.
api.php?action=query&generator=allredirects&garunique=&garfrom=B
Gets pages containing the redirects.
api.php?action=query&generator=allredirects&garfrom=B

list=alltransclusions (at)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

List all transclusions (pages embedded using {{x}}), including non-existing.

Parâmetros:
atcontinue

When more results are available, use this to continue.

atfrom

The title of the transclusion to start enumerating from.

atto

The title of the transclusion to stop enumerating at.

atprefix

Search for all transcluded titles that begin with this value.

atunique

Only show distinct transcluded titles. Cannot be used with atprop=ids. When used as a generator, yields target pages instead of source pages.

Type: boolean (details)
atprop

Which pieces of information to include:

ids
Adds the page ID of the transcluding page (cannot be used with atunique).
title
Adds the title of the transclusion.
Valores (separar com |): ids, title
Padrão: title
atnamespace

O espaço nominal a se enumerar.

Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
Padrão: 10
atlimit

Quantos itens retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
atdir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
Exemplos:
List transcluded titles, including missing ones, with page IDs they are from, starting at B.
api.php?action=query&list=alltransclusions&atfrom=B&atprop=ids|title
List unique transcluded titles.
api.php?action=query&list=alltransclusions&atunique=&atfrom=B
Gets all transcluded titles, marking the missing ones.
api.php?action=query&generator=alltransclusions&gatunique=&gatfrom=B
Gets pages containing the transclusions.
api.php?action=query&generator=alltransclusions&gatfrom=B

list=allusers (au)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Enumerate all registered users.

Parâmetros:
aufrom

The user name to start enumerating from.

auto

The user name to stop enumerating at.

auprefix

Search for all users that begin with this value.

audir

Direction to sort in.

Um dos seguintes valores: ascending, descending
Padrão: ascending
augroup

Only include users in the given groups.

Valores (separar com |): bot, sysop, bureaucrat
auexcludegroup

Exclude users in the given groups.

Valores (separar com |): bot, sysop, bureaucrat
aurights

Only include users with the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.

Valores (separar com |): apihighlimits, applychangetags, autoconfirmed, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmywatchlist, editsemiprotected, editusercssjs, editusercss, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, passwordreset, patrol, patrolmarks, protect, proxyunbannable, purge, read, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi
Maximum number of values is 50 (500 for bots).
auprop

Which pieces of information to include:

blockinfo
Adds the information about a current block on the user.
groups
Lists groups that the user is in. This uses more server resources and may return fewer results than the limit.
implicitgroups
Lists all the groups the user is automatically in.
rights
Lists rights that the user has.
editcount
Adds the edit count of the user.
registration
Adds the timestamp of when the user registered if available (may be blank).
Valores (separar com |): blockinfo, groups, implicitgroups, rights, editcount, registration
aulimit

How many total user names to return.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
auwitheditsonly

Only list users who have made edits.

Type: boolean (details)
auactiveusers

Only list users active in the last 30 days.

Type: boolean (details)
Exemplo:
Lista de utilizadores que comecem com Y.
api.php?action=query&list=allusers&aufrom=Y
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Find all pages that link to the given page.

Parâmetros:
bltitle

Título a se pesquisar. Não pode ser usado em conjunto com blpageid.

blpageid

ID da página a se pesquisar. Não pode ser usado em conjunto com bltitle.

Type: integer
blcontinue

When more results are available, use this to continue.

blnamespace

O espaço nominal a se enumerar.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
bldir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
blfilterredir

How to filter for redirects. If set to nonredirects when blredirect is enabled, this is only applied to the second level.

Um dos seguintes valores: all, redirects, nonredirects
Padrão: all
bllimit

How many total pages to return. If blredirect is enabled, the limit applies to each level separately (which means up to 2 * bllimit results may be returned).

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
blredirect

If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.

Type: boolean (details)
Exemplos:
Show links to Main page.
api.php?action=query&list=backlinks&bltitle=Main%20Page
Get information about pages linking to Main page.
api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info

list=blocks (bk)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

List all blocked users and IP addresses.

Parâmetros:
bkstart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)
bkend

The timestamp to stop enumerating at.

Type: timestamp (allowed formats)
bkdir

In which direction to enumerate:

newer
List oldest first. Note: bkstart has to be before bkend.
older
List newest first (default). Note: bkstart has to be later than bkend.
Um dos seguintes valores: newer, older
Padrão: older
bkids

List of block IDs to list (optional).

Type: list of integers
Separe os valores com |. Maximum number of values is 50 (500 for bots).
bkusers

List of users to search for (optional).

Separe os valores com |. Maximum number of values is 50 (500 for bots).
bkip

Obtém todos os blocos aplicando a este IP ou intervalos CIDR, incluindo intervalos de blocos. Não pode ser usado em conjunto com bkusers. Intervalos CIDR mais largos do que IPv4/16 ou IPv6/19 não são aceitos.

bklimit

O número máximo de bloqueios a listar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
bkprop

Which properties to get:

id
Adds the ID of the block.
user
Adds the username of the blocked user.
userid
Adds the user ID of the blocked user.
by
Adds the username of the blocking user.
byid
Adds the user ID of the blocking user.
timestamp
Adds the timestamp of when the block was given.
expiry
Adds the timestamp of when the block expires.
reason
Adds the reason given for the block.
range
Adds the range of IP addresses affected by the block.
flags
Tags the ban with (autoblock, anononly, etc.).
Valores (separar com |): id, user, userid, by, byid, timestamp, expiry, reason, range, flags
Padrão: id|user|by|timestamp|expiry|reason|flags
bkshow

Show only items that meet these criteria. For example, to see only indefinite blocks on IP addresses, set bkshow=ip|!temp.

Valores (separar com |): account, !account, temp, !temp, ip, !ip, range, !range
bkcontinue

When more results are available, use this to continue.

Exemplos:
List blocks.
api.php?action=query&list=blocks
List blocks of users Alice and Bob.
api.php?action=query&list=blocks&bkusers=Alice|Bob

list=categorymembers (cm)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Lista de todas as páginas numa categoria fornecida.

Parâmetros:
cmtitle

Qual categoria enumerar (obrigatório). Deve incluir o prefixo Categoria:. Não pode ser usado em conjunto com cmpageid.

cmpageid

ID da página da categoria para enumerar. Não pode ser usado em conjunto com cmtitle.

Type: integer
cmprop

Which pieces of information to include:

ids
Adds the page ID.
title
Adds the title and namespace ID of the page.
sortkey
Adds the sortkey used for sorting in the category (hexadecimal string).
sortkeyprefix
Adds the sortkey prefix used for sorting in the category (human-readable part of the sortkey).
type
Adds the type that the page has been categorised as (page, subcat or file).
timestamp
Adds the timestamp of when the page was included.
Valores (separar com |): ids, title, sortkey, sortkeyprefix, type, timestamp
Padrão: ids|title
cmnamespace

Only include pages in these namespaces. Note that cmtype=subcat or cmtype=file may be used instead of cmnamespace=14 or 6.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
cmtype

Which type of category members to include. Ignored when cmsort=timestamp is set.

Valores (separar com |): page, subcat, file
Padrão: page|subcat|file
cmcontinue

When more results are available, use this to continue.

cmlimit

The maximum number of pages to return.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
cmsort

Property to sort by.

Um dos seguintes valores: sortkey, timestamp
Padrão: sortkey
cmdir

In which direction to sort.

Um dos seguintes valores: asc, desc, ascending, descending, newer, older
Padrão: ascending
cmstart

Timestamp to start listing from. Can only be used with cmsort=timestamp.

Type: timestamp (allowed formats)
cmend

Timestamp to end listing at. Can only be used with cmsort=timestamp.

Type: timestamp (allowed formats)
cmstarthexsortkey

Sortkey to start listing from, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.

cmendhexsortkey

Sortkey to end listing at, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.

cmstartsortkeyprefix

Sortkey prefix to start listing from. Can only be used with cmsort=sortkey. Overrides cmstarthexsortkey.

cmendsortkeyprefix

Sortkey prefix to end listing before (not at; if this value occurs it will not be included!). Can only be used with cmsort=sortkey. Overrides cmendhexsortkey.

cmstartsortkey
Obsoleto.

Use cmstarthexsortkey instead.

cmendsortkey
Obsoleto.

Use cmendhexsortkey instead.

Exemplos:
Get first 10 pages in Category:Physics.
api.php?action=query&list=categorymembers&cmtitle=Category:Physics
Get page info about first 10 pages in Category:Physics.
api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info

list=deletedrevs (dr)

  • Este módulo está obsoleto.
  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

List deleted revisions.

Operates in three modes:

  1. List deleted revisions for the given titles, sorted by timestamp.
  2. List deleted contributions for the given user, sorted by timestamp (no titles specified).
  3. List all deleted revisions in the given namespace, sorted by title and timestamp (no titles specified, druser not set).

Certain parameters only apply to some modes and are ignored in others.

Parâmetros:
drstart

The timestamp to start enumerating from.

Modos: 1, 2
Type: timestamp (allowed formats)
drend

The timestamp to stop enumerating at.

Modos: 1, 2
Type: timestamp (allowed formats)
drdir

In which direction to enumerate:

newer
List oldest first. Note: drstart has to be before drend.
older
List newest first (default). Note: drstart has to be later than drend.
Modos: 1, 3
Um dos seguintes valores: newer, older
Padrão: older
drfrom

Start listing at this title.

Modo: 3
drto

Stop listing at this title.

Modo: 3
drprefix

Search for all page titles that begin with this value.

Modo: 3
drunique

List only one revision for each page.

Modo: 3
Type: boolean (details)
drnamespace

Listar apenas as páginas neste domínio.

Modo: 3
Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
Padrão: 0
drtag

Only list revisions tagged with this tag.

druser

Only list revisions by this user.

Type: user name
drexcludeuser

Não listar edições deste utilizador.

Type: user name
drprop

Which properties to get:

revid
Adds the revision ID of the deleted revision.
parentid
Adds the revision ID of the previous revision to the page.
user
Adds the user who made the revision.
userid
Adds the ID of the user who made the revision.
comment
Adds the comment of the revision.
parsedcomment
Adds the parsed comment of the revision.
minor
Tags if the revision is minor.
len
Adds the length (bytes) of the revision.
sha1
Adds the SHA-1 (base 16) of the revision.
content
Adds the content of the revision.
token
Deprecated. Gives the edit token.
tags
Tags for the revision.
Valores (separar com |): revid, parentid, user, userid, comment, parsedcomment, minor, len, sha1, content, token, tags
Padrão: user|comment
drlimit

The maximum amount of revisions to list.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
drcontinue

When more results are available, use this to continue.

Exemplos:
List the last deleted revisions of the pages Main Page and Talk:Main Page, with content (mode 1).
api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content
List the last 50 deleted contributions by Bob (mode 2).
api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50
List the first 50 deleted revisions in the main namespace (mode 3).
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50
List the first 50 deleted pages in the Discussão namespace (mode 3).
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique=

list=embeddedin (ei)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Find all pages that embed (transclude) the given title.

Parâmetros:
eititle

Título a se pesquisar. Não pode ser usado em conjunto com eipageid.

eipageid

ID da página a se pesquisar. Não pode ser usado em conjunto com eititle.

Type: integer
eicontinue

When more results are available, use this to continue.

einamespace

O espaço nominal a se enumerar.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
eidir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
eifilterredir

Como filtrar por redirecionamentos.

Um dos seguintes valores: all, redirects, nonredirects
Padrão: all
eilimit

Quantas páginas retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
Exemplos:
Mostrar páginas transcluíndo Template:Stub.
api.php?action=query&list=embeddedin&eititle=Template:Stub
Obtém informação sobre páginas transcluindo Template:Stub.
api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info

list=exturlusage (eu)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Enumerate pages that contain a given URL.

Parâmetros:
euprop

Which pieces of information to include:

ids
Adds the ID of page.
title
Adds the title and namespace ID of the page.
url
Adds the URL used in the page.
Valores (separar com |): ids, title, url
Padrão: ids|title|url
euoffset

When more results are available, use this to continue.

Type: integer
euprotocol

Protocol of the URL. If empty and euquery is set, the protocol is http. Leave both this and euquery empty to list all external links.

Um dos seguintes valores: Can be empty, or bitcoin, ftp, ftps, geo, git, gopher, http, https, irc, ircs, magnet, mailto, mms, news, nntp, redis, sftp, sip, sips, sms, ssh, svn, tel, telnet, urn, worldwind, xmpp
Padrão: (vazio)
euquery

Search string without protocol. See Special:LinkSearch. Leave empty to list all external links.

eunamespace

The page namespaces to enumerate.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
eulimit

Quantas páginas retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
euexpandurl

Expand protocol-relative URLs with the canonical protocol.

Type: boolean (details)

list=filearchive (fa)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Enumerate all deleted files sequentially.

Parâmetros:
fafrom

The image title to start enumerating from.

fato

The image title to stop enumerating at.

faprefix

Search for all image titles that begin with this value.

fadir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
fasha1

SHA1 hash of image. Overrides fasha1base36.

fasha1base36

SHA1 hash of image in base 36 (used in MediaWiki).

faprop

Which image information to get:

sha1
Adds SHA-1 hash for the image.
timestamp
Adds timestamp for the uploaded version.
user
Adds user who uploaded the image version.
size
Adds the size of the image in bytes and the height, width and page count (if applicable).
dimensions
Alias for size.
description
Adds description of the image version.
parseddescription
Parse the description of the version.
mime
Adds MIME of the image.
mediatype
Adds the media type of the image.
metadata
Lists Exif metadata for the version of the image.
bitdepth
Adds the bit depth of the version.
archivename
Adds the filename of the archive version for non-latest versions.
Valores (separar com |): sha1, timestamp, user, size, dimensions, description, parseddescription, mime, mediatype, metadata, bitdepth, archivename
Padrão: timestamp
falimit

Quantas imagens retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
facontinue

When more results are available, use this to continue.

Exemplo:
Mostrar lista de todos os ficheiros eliminados
api.php?action=query&list=filearchive

list=imageusage (iu)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Find all pages that use the given image title.

Parâmetros:
iutitle

Título a se pesquisar. Não pode ser usado em conjunto com iupageid.

iupageid

ID da página para pesquisar. Não pode ser usado em conjunto com iutitle.

Type: integer
iucontinue

When more results are available, use this to continue.

iunamespace

O espaço nominal a se enumerar.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
iudir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
iufilterredir

How to filter for redirects. If set to nonredirects when iuredirect is enabled, this is only applied to the second level.

Um dos seguintes valores: all, redirects, nonredirects
Padrão: all
iulimit

How many total pages to return. If iuredirect is enabled, the limit applies to each level separately (which means up to 2 * iulimit results may be returned).

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
iuredirect

If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.

Type: boolean (details)
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Encontra todas as páginas que apontam para o determinado link interwiki.

Pode ser usado para encontrar todos os links com um prefixo, ou todos os links para um título (com um determinado prefixo). Usar nenhum parâmetro é efetivamente "todos os links interwiki".

Parâmetros:
iwblprefix

Prefixo para o interwiki.

iwbltitle

Interwiki link to search for. Must be used with iwblblprefix.

iwblcontinue

When more results are available, use this to continue.

iwbllimit

Quantas páginas retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
iwblprop

Which properties to get:

iwprefix
Adds the prefix of the interwiki.
iwtitle
Adds the title of the interwiki.
Valores (separar com |): iwprefix, iwtitle
Padrão: (vazio)
iwbldir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Find all pages that link to the given language link.

Can be used to find all links with a language code, or all links to a title (with a given language). Using neither parameter is effectively "all language links".

Note that this may not consider language links added by extensions.

Parâmetros:
lbllang

Language for the language link.

lbltitle

Language link to search for. Must be used with lbllang.

lblcontinue

When more results are available, use this to continue.

lbllimit

Quantas páginas retornar.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
lblprop

Which properties to get:

lllang
Adds the language code of the language link.
lltitle
Adds the title of the language link.
Valores (separar com |): lllang, lltitle
Padrão: (vazio)
lbldir

The direction in which to list.

Um dos seguintes valores: ascending, descending
Padrão: ascending

list=logevents (le)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Get events from logs.

Parâmetros:
leprop

Which properties to get:

ids
Adds the ID of the log event.
title
Adds the title of the page for the log event.
type
Adds the type of log event.
user
Adds the user responsible for the log event.
userid
Adds the user ID who was responsible for the log event.
timestamp
Adds the timestamp for the log event.
comment
Adds the comment of the log event.
parsedcomment
Adds the parsed comment of the log event.
details
Lists additional details about the log event.
tags
Lists tags for the log event.
Valores (separar com |): ids, title, type, user, userid, timestamp, comment, parsedcomment, details, tags
Padrão: ids|title|type|user|timestamp|comment|details
letype

Filter log entries to only this type.

Um dos seguintes valores: Can be empty, or block, protect, rights, delete, upload, move, import, patrol, merge, suppress, tag, managetags, contentmodel, newusers
leaction

Filter log actions to only this action. Overrides letype. In the list of possible values, values with the asterisk wildcard such as action/* can have different strings after the slash (/).

Um dos seguintes valores: protect/modify, protect/protect, protect/unprotect, block/block, block/reblock, block/unblock, contentmodel/change, delete/delete, delete/event, delete/restore, delete/revision, import/interwiki, import/upload, managetags/activate, managetags/create, managetags/deactivate, managetags/delete, merge/merge, move/move, move/move_redir, patrol/patrol, protect/move_prot, rights/autopromote, rights/rights, suppress/block, suppress/delete, suppress/event, suppress/reblock, suppress/revision, tag/update, upload/overwrite, upload/revert, upload/upload, newusers/newusers, newusers/create, newusers/create2, newusers/byemail, newusers/autocreate
lestart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)
leend

The timestamp to end enumerating.

Type: timestamp (allowed formats)
ledir

In which direction to enumerate:

newer
List oldest first. Note: lestart has to be before leend.
older
List newest first (default). Note: lestart has to be later than leend.
Um dos seguintes valores: newer, older
Padrão: older
leuser

Filter entries to those made by the given user.

letitle

Filter entries to those related to a page.

lenamespace

Filter entries to those in the given namespace.

Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
leprefix

Filter entries that start with this prefix.

letag

Only list event entries tagged with this tag.

lelimit

How many total event entries to return.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
lecontinue

When more results are available, use this to continue.

Exemplo:
List recent log events.
api.php?action=query&list=logevents

list=pagepropnames (ppn)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

List all page property names in use on the wiki.

Parâmetros:
ppncontinue

When more results are available, use this to continue.

ppnlimit

The maximum number of names to return.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
Exemplo:
Get first 10 property names.
api.php?action=query&list=pagepropnames

list=pageswithprop (pwp)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

List all pages using a given page property.

Parâmetros:
pwppropname

Page prop for which to enumerate pages.

Este parâmetro é obrigatório.
pwpprop

Which pieces of information to include:

ids
Adds the page ID.
title
Adds the title and namespace ID of the page.
value
Adds the value of the page prop.
Valores (separar com |): ids, title, value
Padrão: ids|title
pwpcontinue

When more results are available, use this to continue.

pwplimit

The maximum number of pages to return.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
pwpdir

In which direction to sort.

Um dos seguintes valores: ascending, descending
Padrão: ascending
Exemplos:
List the first 10 pages using {{DISPLAYTITLE:}}.
api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value
Get additional information about the first 10 pages using __NOTOC__.
api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info

list=prefixsearch (ps)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Perform a prefix search for page titles.

Parâmetros:
pssearch

Search string.

Este parâmetro é obrigatório.
psnamespace

Namespaces to search.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
Padrão: 0
pslimit

O número máximo a se retornar.

No more than 100 (200 for bots) allowed.
Type: integer or max
Padrão: 10
psoffset

Number of results to skip.

Type: integer
Padrão: 0
Exemplo:
Search for page titles beginning with meaning.
api.php?action=query&list=prefixsearch&pssearch=meaning

list=protectedtitles (pt)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

List all titles protected from creation.

Parâmetros:
ptnamespace

Only list titles in these namespaces.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
ptlevel

Only list titles with these protection levels.

Valores (separar com |): autoconfirmed, sysop
ptlimit

How many total pages to return.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
ptdir

In which direction to enumerate:

newer
List oldest first. Note: ptstart has to be before ptend.
older
List newest first (default). Note: ptstart has to be later than ptend.
Um dos seguintes valores: newer, older
Padrão: older
ptstart

Start listing at this protection timestamp.

Type: timestamp (allowed formats)
ptend

Stop listing at this protection timestamp.

Type: timestamp (allowed formats)
ptprop

Which properties to get:

timestamp
Adds the timestamp of when protection was added.
user
Adds the user that added the protection.
userid
Adds the user ID that added the protection.
comment
Adds the comment for the protection.
parsedcomment
Adds the parsed comment for the protection.
expiry
Adds the timestamp of when the protection will be lifted.
level
Adds the protection level.
Valores (separar com |): timestamp, user, userid, comment, parsedcomment, expiry, level
Padrão: timestamp|level
ptcontinue

When more results are available, use this to continue.

Exemplos:
List protected titles.
api.php?action=query&list=protectedtitles
Find links to protected titles in the main namespace.
api.php?action=query&generator=protectedtitles&gptnamespace=0&prop=linkshere

list=querypage (qp)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Get a list provided by a QueryPage-based special page.

Parâmetros:
qppage

The name of the special page. Note, this is case sensitive.

Este parâmetro é obrigatório.
Um dos seguintes valores: Ancientpages, BrokenRedirects, Deadendpages, DoubleRedirects, ListDuplicatedFiles, Listredirects, Lonelypages, Longpages, MediaStatistics, Mostcategories, Mostimages, Mostinterwikis, Mostlinkedcategories, Mostlinkedtemplates, Mostlinked, Mostrevisions, Fewestrevisions, Shortpages, Uncategorizedcategories, Uncategorizedpages, Uncategorizedimages, Uncategorizedtemplates, Unusedcategories, Unusedimages, Wantedcategories, Wantedfiles, Wantedpages, Wantedtemplates, Unwatchedpages, Unusedtemplates, Withoutinterwiki
qpoffset

When more results are available, use this to continue.

Type: integer
Padrão: 0
qplimit

Number of results to return.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10

list=random (rn)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Get a set of random pages.

Pages are listed in a fixed sequence, only the starting point is random. This means that if, for example, Main Page is the first random page in the list, List of fictional monkeys will always be second, List of people on stamps of Vanuatu third, etc.

Parâmetros:
rnnamespace

Return pages in these namespaces only.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
rnfilterredir

How to filter for redirects.

Um dos seguintes valores: all, redirects, nonredirects
Padrão: nonredirects
rnredirect
Obsoleto.

Use rnfilterredir=redirects instead.

Type: boolean (details)
rnlimit

Limit how many random pages will be returned.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 1
rncontinue

When more results are available, use this to continue.

Exemplos:
Return two random pages from the main namespace.
api.php?action=query&list=random&rnnamespace=0&rnlimit=2
Return page info about two random pages from the main namespace.
api.php?action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info

list=recentchanges (rc)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Enumerate recent changes.

Parâmetros:
rcstart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)
rcend

The timestamp to end enumerating.

Type: timestamp (allowed formats)
rcdir

In which direction to enumerate:

newer
List oldest first. Note: rcstart has to be before rcend.
older
List newest first (default). Note: rcstart has to be later than rcend.
Um dos seguintes valores: newer, older
Padrão: older
rcnamespace

Filter changes to only these namespaces.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
rcuser

Only list changes by this user.

Type: user name
rcexcludeuser

Don't list changes by this user.

Type: user name
rctag

Only list changes tagged with this tag.

rcprop

Include additional pieces of information:

user
Adds the user responsible for the edit and tags if they are an IP.
userid
Adds the user ID responsible for the edit.
comment
Adds the comment for the edit.
parsedcomment
Adds the parsed comment for the edit.
flags
Adds flags for the edit.
timestamp
Adds timestamp of the edit.
title
Adds the page title of the edit.
ids
Adds the page ID, recent changes ID and the new and old revision ID.
sizes
Adds the new and old page length in bytes.
redirect
Tags edit if page is a redirect.
patrolled
Tags patrollable edits as being patrolled or unpatrolled.
loginfo
Adds log information (log ID, log type, etc) to log entries.
tags
Lists tags for the entry.
sha1
Adds the content checksum for entries associated with a revision.
Valores (separar com |): user, userid, comment, parsedcomment, flags, timestamp, title, ids, sizes, redirect, patrolled, loginfo, tags, sha1
Padrão: title|timestamp|ids
rctoken
Obsoleto.

Use action=query&meta=tokens instead.

Valores (separar com |): patrol
rcshow

Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set rcshow=minor|!anon.

Valores (separar com |): minor, !minor, bot, !bot, anon, !anon, redirect, !redirect, patrolled, !patrolled, unpatrolled
rclimit

How many total changes to return.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
rctype

Which types of changes to show.

Valores (separar com |): edit, external, new, log
Padrão: edit|new|log
rctoponly

Only list changes which are the latest revision.

Type: boolean (details)
rccontinue

When more results are available, use this to continue.

Exemplos:
Lista de mudanças recentes
api.php?action=query&list=recentchanges
Get page info about recent unpatrolled changes.
api.php?action=query&generator=recentchanges&grcshow=!patrolled&prop=info

list=search (sr)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Perform a full text search.

Parâmetros:
srsearch

Search for page titles or content matching this value. You can use the search string to invoke special search features, depending on what the wiki's search backend implements.

Este parâmetro é obrigatório.
srnamespace

Search only within these namespaces.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
Padrão: 0
srwhat

Which type of search to perform.

Um dos seguintes valores: title, text, nearmatch
srinfo

Which metadata to return.

Valores (separar com |): totalhits, suggestion, rewrittenquery
Padrão: totalhits|suggestion|rewrittenquery
srprop

Which properties to return:

size
Adds the size of the page in bytes.
wordcount
Adds the word count of the page.
timestamp
Adds the timestamp of when the page was last edited.
snippet
Adds a parsed snippet of the page.
titlesnippet
Adds a parsed snippet of the page title.
redirecttitle
Adds the title of the matching redirect.
redirectsnippet
Adds a parsed snippet of the redirect title.
sectiontitle
Adds the title of the matching section.
sectionsnippet
Adds a parsed snippet of the matching section title.
isfilematch
Adds a boolean indicating if the search matched file content.
categorysnippet
Adds a parsed snippet of the matching category.
score
Deprecated and ignored.
hasrelated
Deprecated and ignored.
Valores (separar com |): size, wordcount, timestamp, snippet, titlesnippet, redirecttitle, redirectsnippet, sectiontitle, sectionsnippet, isfilematch, categorysnippet, score, hasrelated
Padrão: size|wordcount|timestamp|snippet
sroffset

When more results are available, use this to continue.

Type: integer
Padrão: 0
srlimit

Quantas páginas retornar.

No more than 50 (500 for bots) allowed.
Type: integer or max
Padrão: 10
srinterwiki

Include interwiki results in the search, if available.

Type: boolean (details)
srenablerewrites

Habilitar rescrever a pesquisa interna. Alguns motores de busca podem rescrever a consulta para outra que acha dará melhores resultados, como a corrigir erros de ortografia.

Type: boolean (details)
Exemplos:
Search for meaning.
api.php?action=query&list=search&srsearch=meaning
Search texts for meaning.
api.php?action=query&list=search&srwhat=text&srsearch=meaning
Get page info about the pages returned for a search for meaning.
api.php?action=query&generator=search&gsrsearch=meaning&prop=info

list=tags (tg)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

List change tags.

Parâmetros:
tgcontinue

When more results are available, use this to continue.

tglimit

The maximum number of tags to list.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
tgprop

Which properties to get:

name
Adds name of tag.
displayname
Adds system message for the tag.
description
Adds description of the tag.
hitcount
Adds the number of revisions and log entries that have this tag.
defined
Indicate whether the tag is defined.
source
Gets the sources of the tag, which may include extension for extension-defined tags and manual for tags that may be applied manually by users.
active
Whether the tag is still being applied.
Valores (separar com |): name, displayname, description, hitcount, defined, source, active
Padrão: name

list=usercontribs (uc)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Get all edits by a user.

Parâmetros:
uclimit

The maximum number of contributions to return.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
ucstart

The start timestamp to return from.

Type: timestamp (allowed formats)
ucend

The end timestamp to return to.

Type: timestamp (allowed formats)
uccontinue

When more results are available, use this to continue.

ucuser

The users to retrieve contributions for.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
ucuserprefix

Retrieve contributions for all users whose names begin with this value. Overrides ucuser.

ucdir

In which direction to enumerate:

newer
List oldest first. Note: ucstart has to be before ucend.
older
List newest first (default). Note: ucstart has to be later than ucend.
Um dos seguintes valores: newer, older
Padrão: older
ucnamespace

Only list contributions in these namespaces.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
ucprop

Include additional pieces of information:

ids
Adds the page ID and revision ID.
title
Adds the title and namespace ID of the page.
timestamp
Adds the timestamp of the edit.
comment
Adds the comment of the edit.
parsedcomment
Adds the parsed comment of the edit.
size
Adds the new size of the edit.
sizediff
Adds the size delta of the edit against its parent.
flags
Adds flags of the edit.
patrolled
Tags patrolled edits.
tags
Lists tags for the edit.
Valores (separar com |): ids, title, timestamp, comment, parsedcomment, size, sizediff, flags, patrolled, tags
Padrão: ids|title|timestamp|comment|size|flags
ucshow

Show only items that meet these criteria, e.g. non minor edits only: ucshow=!minor.

If ucshow=patrolled or ucshow=!patrolled is set, revisions older than $wgRCMaxAge (7776000 seconds) won't be shown.

Valores (separar com |): minor, !minor, patrolled, !patrolled, top, !top, new, !new
uctag

Only list revisions tagged with this tag.

uctoponly
Obsoleto.

Only list changes which are the latest revision.

Type: boolean (details)
Exemplos:
Show contributions of user Example.
api.php?action=query&list=usercontribs&ucuser=Example
Show contributions from all IP addresses with prefix 192.0.2..
api.php?action=query&list=usercontribs&ucuserprefix=192.0.2.

list=users (us)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Get information about a list of users.

Parâmetros:
usprop

Which pieces of information to include:

blockinfo
Tags if the user is blocked, by whom, and for what reason.
groups
Lists all the groups each user belongs to.
implicitgroups
Lists all the groups a user is automatically a member of.
rights
Lists all the rights each user has.
editcount
Adds the user's edit count.
registration
Adds the user's registration timestamp.
emailable
Tags if the user can and wants to receive email through Special:Emailuser.
gender
Tags the gender of the user. Returns "male", "female", or "unknown".
Valores (separar com |): blockinfo, groups, implicitgroups, rights, editcount, registration, emailable, gender
ususers

A list of users to obtain information for.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
ustoken
Obsoleto.

Use action=query&meta=tokens instead.

Valores (separar com |): userrights

list=watchlist (wl)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Get recent changes to pages in the current user's watchlist.

Parâmetros:
wlallrev

Include multiple revisions of the same page within given timeframe.

Type: boolean (details)
wlstart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)
wlend

The timestamp to end enumerating.

Type: timestamp (allowed formats)
wlnamespace

Filter changes to only the given namespaces.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
wluser

Only list changes by this user.

Type: user name
wlexcludeuser

Don't list changes by this user.

Type: user name
wldir

In which direction to enumerate:

newer
List oldest first. Note: wlstart has to be before wlend.
older
List newest first (default). Note: wlstart has to be later than wlend.
Um dos seguintes valores: newer, older
Padrão: older
wllimit

Quantos resultados retornar por solicitação.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
wlprop

Which additional properties to get:

ids
Adds revision IDs and page IDs.
title
Adds title of the page.
flags
Adds flags for the edit.
user
Adds the user who made the edit.
userid
Adds user ID of whoever made the edit.
comment
Adds comment of the edit.
parsedcomment
Adds parsed comment of the edit.
timestamp
Adds timestamp of the edit.
patrol
Tags edits that are patrolled.
sizes
Adds the old and new lengths of the page.
notificationtimestamp
Adds timestamp of when the user was last notified about the edit.
loginfo
Adds log information where appropriate.
Valores (separar com |): ids, title, flags, user, userid, comment, parsedcomment, timestamp, patrol, sizes, notificationtimestamp, loginfo
Padrão: ids|title|flags
wlshow

Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set wlshow=minor|!anon.

Valores (separar com |): minor, !minor, bot, !bot, anon, !anon, patrolled, !patrolled, unread, !unread
wltype

Which types of changes to show:

edit
Regular page edits.
external
External changes.
new
Page creations.
log
Log entries.
Valores (separar com |): edit, external, new, log
Padrão: edit|new|log
wlowner

Used along with wltoken to access a different user's watchlist.

Type: user name
wltoken

A security token (available in the user's preferences) to allow access to another user's watchlist.

wlcontinue

When more results are available, use this to continue.

Exemplos:
List the top revision for recently changed pages on the current user's watchlist.
api.php?action=query&list=watchlist
Fetch additional information about the top revision for recently changed pages on the current user's watchlist.
api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment
Fetch information about all recent changes to pages on the current user's watchlist.
api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment
Fetch page info for recently changed pages on the current user's watchlist.
api.php?action=query&generator=watchlist&prop=info
Fetch revision info for recent changes to pages on the current user's watchlist.
api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user
List the top revision for recently changed pages on the watchlist of user Example.
api.php?action=query&list=watchlist&wlowner=Example&wltoken=123ABC

list=watchlistraw (wr)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Get all pages on the current user's watchlist.

Parâmetros:
wrcontinue

When more results are available, use this to continue.

wrnamespace

Only list pages in the given namespaces.

Valores (separar com |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
wrlimit

Quantos resultados retornar por solicitação.

No more than 500 (5 000 for bots) allowed.
Type: integer or max
Padrão: 10
wrprop

Which additional properties to get:

changed
Adds timestamp of when the user was last notified about the edit.
Valores (separar com |): changed
wrshow

Only list items that meet these criteria.

Valores (separar com |): changed, !changed
wrowner

Used along with wrtoken to access a different user's watchlist.

Type: user name
wrtoken

A security token (available in the user's preferences) to allow access to another user's watchlist.

wrdir

In which direction to enumerate:

newer
List oldest first. Note: wrstart has to be before wrend.
older
List newest first (default). Note: wrstart has to be later than wrend.
Um dos seguintes valores: ascending, descending
Padrão: ascending
wrfromtitle

Title (with namespace prefix) to begin enumerating from.

wrtotitle

Title (with namespace prefix) to stop enumerating at.

Exemplos:
List pages on the current user's watchlist.
api.php?action=query&list=watchlistraw
Fetch page info for pages on the current user's watchlist.
api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=info

meta=allmessages (am)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Return messages from this site.

Parâmetros:
ammessages

Which messages to output. * (default) means all messages.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
Padrão: *
amprop

Quais propriedades obter.

Valores (separar com |): default
amenableparser

Set to enable parser, will preprocess the wikitext of message (substitute magic words, handle templates, etc.).

Type: boolean (details)
amnocontent

If set, do not include the content of the messages in the output.

Type: boolean (details)
amincludelocal

Also include local messages, i.e. messages that don't exist in the software but do exist as a MediaWiki: page. This lists all MediaWiki: pages, so it will also list those that aren't really messages such as Common.js.

Type: boolean (details)
amargs

Arguments to be substituted into message.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
amfilter

Return only messages with names that contain this string.

amcustomised

Retornar apenas mensagens neste estado personalização.

Um dos seguintes valores: all, modified, unmodified
Padrão: all
amlang

Retornar mensagens neste idioma.

amfrom

Retornar mensagens começando com esta mensagem.

amto

Retornar mensagens terminando com esta mensagem.

amtitle

Page name to use as context when parsing message (for amenableparser option).

amprefix

Retornar apenas mensagens com este prefixo.

Exemplos:
Mostrar mensagens começando com ipb-.
api.php?action=query&meta=allmessages&amprefix=ipb-
Show messages august and mainpage in German.
api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de

meta=filerepoinfo (fri)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Return meta information about image repositories configured on the wiki.

Parâmetro:
friprop

Which repository properties to get (there may be more available on some wikis):

apiurl
URL to the repository API - helpful for getting image info from the host.
name
The key of the repository - used in e.g. $wgForeignFileRepos and imageinfo return values.
displayname
The human-readable name of the repository wiki.
rooturl
Root URL for image paths.
local
Whether that repository is the local one or not.
Valores (separar com |): name, displayname, rootUrl, local, url, thumbUrl, initialCapital, scriptDirUrl, scriptExtension, favicon, canUpload
Padrão: name|displayname|rootUrl|local|url|thumbUrl|initialCapital|scriptDirUrl|scriptExtension|favicon|canUpload
Exemplo:
Get information about file repositories.
api.php?action=query&meta=filerepoinfo&friprop=apiurl|name|displayname

meta=siteinfo (si)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Return general information about the site.

Parâmetros:
siprop

Which information to get:

general
Overall system information.
namespaces
List of registered namespaces and their canonical names.
namespacealiases
List of registered namespace aliases.
specialpagealiases
List of special page aliases.
magicwords
List of magic words and their aliases.
interwikimap
Returns interwiki map (optionally filtered, optionally localised by using siinlanguagecode).
dbrepllag
Returns database server with the highest replication lag.
statistics
Returns site statistics.
usergroups
Returns user groups and the associated permissions.
libraries
Returns libraries installed on the wiki.
extensions
Returns extensions installed on the wiki.
fileextensions
Returns list of file extensions allowed to be uploaded.
rightsinfo
Returns wiki rights (license) information if available.
restrictions
Returns information on available restriction (protection) types.
languages
Returns a list of languages MediaWiki supports (optionally localised by using siinlanguagecode).
skins
Returns a list of all enabled skins (optionally localised by using siinlanguagecode, otherwise in the content language).
extensiontags
Returns a list of parser extension tags.
functionhooks
Returns a list of parser function hooks.
showhooks
Returns a list of all subscribed hooks (contents of $wgHooks).
variables
Returns a list of variable IDs.
protocols
Returns a list of protocols that are allowed in external links.
defaultoptions
Returns the default values for user preferences.
Valores (separar com |): general, namespaces, namespacealiases, specialpagealiases, magicwords, interwikimap, dbrepllag, statistics, usergroups, libraries, extensions, fileextensions, rightsinfo, restrictions, languages, skins, extensiontags, functionhooks, showhooks, variables, protocols, defaultoptions
Padrão: general
sifilteriw

Return only local or only nonlocal entries of the interwiki map.

Um dos seguintes valores: local, !local
sishowalldb

List all database servers, not just the one lagging the most.

Type: boolean (details)
sinumberingroup

Lists the number of users in user groups.

Type: boolean (details)
siinlanguagecode

Language code for localised language names (best effort) and skin names.

meta=tokens

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Gets tokens for data-modifying actions.

Parâmetro:
type

Types of token to request.

Valores (separar com |): csrf, patrol, rollback, userrights, watch
Padrão: csrf
Exemplos:
Retrieve a csrf token (the default).
api.php?action=query&meta=tokens
Retrieve a watch token and a patrol token.
api.php?action=query&meta=tokens&type=watch|patrol

meta=userinfo (ui)

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Get information about the current user.

Parâmetro:
uiprop

Which pieces of information to include:

blockinfo
Tags if the current user is blocked, by whom, and for what reason.
hasmsg
Adds a tag messages if the current user has pending messages.
groups
Lists all the groups the current user belongs to.
implicitgroups
Lists all the groups the current user is automatically a member of.
rights
Lists all the rights the current user has.
changeablegroups
Lists the groups the current user can add to and remove from.
options
Lists all preferences the current user has set.
preferencestoken
Deprecated. Get a token to change current user's preferences.
editcount
Adds the current user's edit count.
ratelimits
Lists all rate limits applying to the current user.
email
Adds the user's email address and email authentication date.
realname
Adds the user's real name.
acceptlang
Echoes the Accept-Language header sent by the client in a structured format.
registrationdate
Adds the user's registration date.
unreadcount
Adds the count of unread pages on the user's watchlist (maximum 999; returns 1000+ if more).
Valores (separar com |): blockinfo, hasmsg, groups, implicitgroups, rights, changeablegroups, options, preferencestoken, editcount, ratelimits, email, realname, acceptlang, registrationdate, unreadcount
Exemplos:
Get information about the current user.
api.php?action=query&meta=userinfo
Get additional information about the current user.
api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg

action=revisiondelete

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Delete and undelete revisions.

Parâmetros:
type

Type of revision deletion being performed.

Este parâmetro é obrigatório.
Um dos seguintes valores: revision, archive, oldimage, filearchive, logging
target

Page title for the revision deletion, if required for the type.

ids

Identifiers for the revisions to be deleted.

Este parâmetro é obrigatório.
Separe os valores com |. Maximum number of values is 50 (500 for bots).
hide

What to hide for each revision.

Valores (separar com |): content, comment, user
show

What to unhide for each revision.

Valores (separar com |): content, comment, user
suppress

Whether to suppress data from administrators as well as others.

Um dos seguintes valores: yes, no, nochange
Padrão: nochange
reason

Reason for the deletion or undeletion.

token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.

action=rollback

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Undo the last edit to the page.

If the last user who edited the page made multiple edits in a row, they will all be rolled back.

Parâmetros:
title

Título da página para reverter. Não pode ser usado em conjunto com pageid.

pageid

ID da página para reverter. Não pode ser usado em conjunto com title.

Type: integer
user

Name of the user whose edits are to be rolled back.

Este parâmetro é obrigatório.
summary

Custom edit summary. If empty, default summary will be used.

Padrão: (vazio)
markbot

Mark the reverted edits and the revert as bot edits.

Type: boolean (details)
watchlist

Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.

Um dos seguintes valores: watch, unwatch, preferences, nochange
Padrão: preferences
token

A "rollback" token retrieved from action=query&meta=tokens

For compatibility, the token used in the web UI is also accepted.

Este parâmetro é obrigatório.
Exemplos:
Roll back the last edits to page Main Page by user Example.
api.php?action=rollback&title=Main%20Page&user=Example&token=123ABC
Roll back the last edits to page Main Page by IP user 192.0.2.5 with summary Reverting vandalism, and mark those edits and the revert as bot edits.
api.php?action=rollback&title=Main%20Page&user=192.0.2.5&token=123ABC&summary=Reverting%20vandalism&markbot=1

action=rsd

(main | rsd)

Export an RSD (Really Simple Discovery) schema.

Exemplo:
Export the RSD schema.
api.php?action=rsd

action=setnotificationtimestamp

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Update the notification timestamp for watched pages.

This affects the highlighting of changed pages in the watchlist and history, and the sending of email when the "Notificar-me por email quando uma página ou arquivo vigiado for alterado" preference is enabled.

Parâmetros:
entirewatchlist

Work on all watched pages.

Type: boolean (details)
timestamp

Timestamp to which to set the notification timestamp.

Type: timestamp (allowed formats)
torevid

Revision to set the notification timestamp to (one page only).

Type: integer
newerthanrevid

Revision to set the notification timestamp newer than (one page only).

Type: integer
continue

When more results are available, use this to continue.

titles

A list of titles to work on.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
pageids

A list of page IDs to work on.

Type: list of integers
Separe os valores com |. Maximum number of values is 50 (500 for bots).
revids

A list of revision IDs to work on.

Type: list of integers
Separe os valores com |. Maximum number of values is 50 (500 for bots).
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

Um dos seguintes valores: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

Type: boolean (details)
converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan, iu, kk, ku, shi, sr, tg, uz, zh.

Type: boolean (details)
token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplos:
Reset the notification status for the entire watchlist.
api.php?action=setnotificationtimestamp&entirewatchlist=&token=123ABC
Reset the notification status for Main page.
api.php?action=setnotificationtimestamp&titles=Main_page&token=123ABC
Set the notification timestamp for Main page so all edits since 1 January 2012 are unviewed.
api.php?action=setnotificationtimestamp&titles=Main_page&timestamp=2012-01-01T00:00:00Z&token=123ABC
Reset the notification status for pages in the Usuário namespace.
api.php?action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC

action=stashedit

  • This module is internal or unstable. Its operation may change without notice.
  • This module requires read rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Prepare an edit in shared cache.

This is intended to be used via AJAX from the edit form to improve the performance of the page save.

Parâmetros:
title

Title of the page being edited.

Este parâmetro é obrigatório.
section

Section number. 0 for the top section, new for a new section.

sectiontitle

The title for a new section.

text

Page content.

Este parâmetro é obrigatório.
contentmodel

Content model of the new content.

Este parâmetro é obrigatório.
Um dos seguintes valores: wikitext, javascript, json, css, text
contentformat

Content serialization format used for the input text.

Este parâmetro é obrigatório.
Um dos seguintes valores: text/x-wiki, text/javascript, application/json, text/css, text/plain
baserevid

Revision ID of the base revision.

Este parâmetro é obrigatório.
Type: integer
token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.

action=tag

(main | tag)
  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Add or remove change tags from individual revisions or log entries.

Parâmetros:
rcid

One or more recent changes IDs from which to add or remove the tag.

Type: list of integers
Separe os valores com |. Maximum number of values is 50 (500 for bots).
revid

One or more revision IDs from which to add or remove the tag.

Type: list of integers
Separe os valores com |. Maximum number of values is 50 (500 for bots).
logid

One or more log entry IDs from which to add or remove the tag.

Type: list of integers
Separe os valores com |. Maximum number of values is 50 (500 for bots).
add

Tags to add. Only manually defined tags can be added.

Valores (separar com |):
remove

Tags to remove. Only tags that are either manually defined or completely undefined can be removed.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
reason

Reason for the change.

Padrão: (vazio)
token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplos:
Add the vandalism tag to revision ID 123 without specifying a reason
api.php?action=tag&revid=123&add=vandalism&token=123ABC
Remove the spam tag from log entry ID 123 with the reason Wrongly applied
api.php?action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC

action=tokens

  • Este módulo está obsoleto.
  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Get tokens for data-modifying actions.

This module is deprecated in favor of action=query&meta=tokens.

Parâmetro:
type

Types of token to request.

Valores (separar com |): block, delete, edit, email, import, move, options, patrol, protect, unblock, watch
Padrão: edit
Exemplos:
Retrieve an edit token (the default).
api.php?action=tokens
Retrieve an email token and a move token.
api.php?action=tokens&type=email|move

action=unblock

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Desbloquear um utilizador.

Parâmetros:
id

ID do bloco para desbloquear (obtido através de list=blocks). Não pode ser usado em conjunto com user.

Type: integer
user

Nome de usuário, endereço IP ou intervalo de IP para a se desbloquear. Não pode ser usado em conjunto com id.

reason

Motivo para o desbloqueio.

Padrão: (vazio)
token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplos:
Unblock block ID #105.
api.php?action=unblock&id=105
Unblock user Bob with reason Sorry Bob.
api.php?action=unblock&user=Bob&reason=Sorry%20Bob

action=undelete

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Restore revisions of a deleted page.

A list of deleted revisions (including timestamps) can be retrieved through list=deletedrevs, and a list of deleted file IDs can be retrieved through list=filearchive.

Parâmetros:
title

Título da página a restaurar.

Este parâmetro é obrigatório.
reason

Reason for restoring.

Padrão: (vazio)
timestamps

Timestamps of the revisions to restore. If both timestamps and fileids are empty, all will be restored.

Type: list of timestamps (allowed formats)
Separe os valores com |. Maximum number of values is 50 (500 for bots).
fileids

IDs of the file revisions to restore. If both timestamps and fileids are empty, all will be restored.

Type: list of integers
Separe os valores com |. Maximum number of values is 50 (500 for bots).
watchlist

Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.

Um dos seguintes valores: watch, unwatch, preferences, nochange
Padrão: preferences
token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.

action=upload

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Upload a file, or get the status of pending uploads.

Several methods are available:

  • Upload file contents directly, using the file parameter.
  • Upload the file in pieces, using the filesize, chunk, and offset parameters.
  • Have the MediaWiki server fetch a file from a URL, using the url parameter.
  • Complete an earlier upload that failed due to warnings, using the filekey parameter.

Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when sending the file.

Parâmetros:
filename

Target filename.

comment

Upload comment. Also used as the initial page text for new files if text is not specified.

Padrão: (vazio)
text

Initial page text for new files.

watch
Obsoleto.

Vigiar página.

Type: boolean (details)
watchlist

Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.

Um dos seguintes valores: watch, preferences, nochange
Padrão: preferences
ignorewarnings

Ignorar todos os avisos.

Type: boolean (details)
file

File contents.

Must be posted as a file upload using multipart/form-data.
url

URL to fetch the file from.

filekey

Key that identifies a previous upload that was stashed temporarily.

sessionkey
Obsoleto.

Same as filekey, maintained for backward compatibility.

stash

If set, the server will stash the file temporarily instead of adding it to the repository.

Type: boolean (details)
filesize

Filesize of entire upload.

The value must be between 0 and 104 857 600.
Type: integer
offset

Offset of chunk in bytes.

The value must be no less than 0.
Type: integer
chunk

Chunk contents.

Must be posted as a file upload using multipart/form-data.
async

Make potentially large file operations asynchronous when possible.

Type: boolean (details)
asyncdownload

Make fetching a URL asynchronous.

Type: boolean (details)
leavemessage

If asyncdownload is used, leave a message on the user talk page if finished.

Type: boolean (details)
statuskey

Fetch the upload status for this file key (upload by URL).

checkstatus

Only fetch the upload status for the given file key.

Type: boolean (details)
token

A "csrf" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.

action=userrights

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Change a user's group membership.

Parâmetros:
user

Nome de utilizador(a).

userid

ID de utilizador.

Type: integer
add

Adicionar o utilizador a estes grupos.

Valores (separar com |): bot, sysop, bureaucrat
remove

Remover este utilizador destes grupos.

Valores (separar com |): bot, sysop, bureaucrat
reason

Reason for the change.

Padrão: (vazio)
token

A "userrights" token retrieved from action=query&meta=tokens

For compatibility, the token used in the web UI is also accepted.

Este parâmetro é obrigatório.
Exemplos:
Add user FooBot to group bot, and remove from groups sysop and bureaucrat.
api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC
Add the user with ID 123 to group bot, and remove from groups sysop and bureaucrat.
api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC

action=watch

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Add or remove pages from the current user's watchlist.

Parâmetros:
title
Obsoleto.

The page to (un)watch. Use titles instead.

unwatch

If set the page will be unwatched rather than watched.

Type: boolean (details)
continue

When more results are available, use this to continue.

titles

A list of titles to work on.

Separe os valores com |. Maximum number of values is 50 (500 for bots).
pageids

A list of page IDs to work on.

Type: list of integers
Separe os valores com |. Maximum number of values is 50 (500 for bots).
revids

A list of revision IDs to work on.

Type: list of integers
Separe os valores com |. Maximum number of values is 50 (500 for bots).
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

Um dos seguintes valores: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

Type: boolean (details)
converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan, iu, kk, ku, shi, sr, tg, uz, zh.

Type: boolean (details)
token

A "watch" token retrieved from action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplos:
Watch the page Main Page.
api.php?action=watch&titles=Main_Page&token=123ABC
Deixar de vigiar a página Página Principal.
api.php?action=watch&titles=Main_Page&unwatch=&token=123ABC
Watch the first few pages in the main namespace.
api.php?action=watch&generator=allpages&gapnamespace=0&token=123ABC

format=dbg

(main | dbg)
  • Este módulo está obsoleto.
  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Output data in PHP's var_export() format.

Exemplo:
Return the query result in the DBG format.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbg

format=dbgfm

  • Este módulo está obsoleto.
  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Output data in PHP's var_export() format (pretty-print in HTML).

Exemplo:
Return the query result in the DBG format.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbgfm

format=json

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Dados de saída em formato JSON.

Parâmetros:
callback

If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

utf8

If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.

Type: boolean (details)
ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

Type: boolean (details)
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
Um dos seguintes valores: 1, 2, latest
Padrão: 1
Exemplo:
Return the query result in the JSON format.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=json

format=jsonfm

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Output data in JSON format (pretty-print in HTML).

Parâmetros:
callback

If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

utf8

If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.

Type: boolean (details)
ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

Type: boolean (details)
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
Um dos seguintes valores: 1, 2, latest
Padrão: 1
Exemplo:
Return the query result in the JSON format.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=jsonfm

format=none

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Output nothing.

Exemplo:
Return the query result in the NONE format.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=none

format=php

(main | php)
  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Output data in serialized PHP format.

Parâmetro:
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
Um dos seguintes valores: 1, 2, latest
Padrão: 1
Exemplo:
Return the query result in the PHP format.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=php

format=phpfm

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Output data in serialized PHP format (pretty-print in HTML).

Parâmetro:
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
Um dos seguintes valores: 1, 2, latest
Padrão: 1
Exemplo:
Return the query result in the PHP format.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=phpfm

format=rawfm

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Output data with the debugging elements in JSON format (pretty-print in HTML).

Exemplo:
Return the query result in the RAW format.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=rawfm

format=txt

(main | txt)
  • Este módulo está obsoleto.
  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Output data in PHP's print_r() format.

Exemplo:
Return the query result in the TXT format.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=txt

format=txtfm

  • Este módulo está obsoleto.
  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Output data in PHP's print_r() format (pretty-print in HTML).

Exemplo:
Return the query result in the TXT format.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=txtfm

format=xml

(main | xml)
  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Output data in XML format.

Parâmetros:
xslt

If specified, adds the named page as an XSL stylesheet. The value must be a title in the MediaWiki namespace ending in .xsl.

includexmlnamespace

If specified, adds an XML namespace.

Type: boolean (details)
Exemplo:
Return the query result in the XML format.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=xml

format=xmlfm

  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Output data in XML format (pretty-print in HTML).

Parâmetros:
xslt

If specified, adds the named page as an XSL stylesheet. The value must be a title in the MediaWiki namespace ending in .xsl.

includexmlnamespace

If specified, adds an XML namespace.

Type: boolean (details)
Exemplo:
Return the query result in the XML format.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=xmlfm

format=yaml

  • Este módulo está obsoleto.
  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Output data in YAML format.

Parâmetros:
callback

If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

utf8

If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.

Type: boolean (details)
ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

Type: boolean (details)
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
Um dos seguintes valores: 1, 2, latest
Padrão: 1
Exemplo:
Return the query result in the YAML format.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=yaml

format=yamlfm

  • Este módulo está obsoleto.
  • This module requires read rights.
  • Source: MediaWiki
  • Licença: GPL-2.0+

Output data in YAML format (pretty-print in HTML).

Parâmetros:
callback

If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.

utf8

If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.

Type: boolean (details)
ascii

If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.

Type: boolean (details)
formatversion

Output formatting:

1
Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
2
Experimental modern format. Details may change!
latest
Use the latest format (currently 2), may change without warning.
Um dos seguintes valores: 1, 2, latest
Padrão: 1
Exemplo:
Return the query result in the YAML format.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=yamlfm

Tipo de dados

Some parameter types in API requests need further explanation:

boolean
Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.
timestamp
Timestamps may be specified in several formats. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.
  • ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)
  • ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)
  • MediaWiki format, 20010115145600
  • Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)
  • EXIF format, 2001:01:15 14:56:00
  • RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00
  • RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00
  • C ctime format, Mon Jan 15 14:56:00 2001
  • Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)
  • The string now

Créditos

Programadores API:

  • Roan Kattouw (programador principal Set 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (criador, programador-líder Set 2006–Set 2007)
  • Brad Jorsch (programador-líder 2013–presente)

Por favor, envie os seus comentários, sugestões e perguntas para mediawiki-api@lists.wikimedia.org ou reporte um erro técnico em https://phabricator.wikimedia.org/.