Ajuda da API do MediaWiki

Esta é uma página de documentação da API do MediaWiki gerada automaticamente.

Documentação e exemplos: https://www.mediawiki.org/wiki/API

Módulo principal

Estado: A API do MediaWiki é uma interface consolidada e estável que é constantemente suportada e melhorada. Embora tentemos evitá-lo, podemos ocasionalmente realizar alterações disruptivas. Inscreva-se na lista de distribuição mediawiki-api-announce para receber notificações das atualizações.

Pedidos incorretos: Quando são enviados pedidos incorretos à API, será devolvido um cabeçalho HTTP com a chave "MediaWiki-API-Error" e depois tanto o valor desse cabeçalho como o código de erro devolvido serão definidos com o mesmo valor. Para mais informação, consulte API:Erros e avisos.

Parâmetros:
action

A operação a ser realizada.

abusefiltercheckmatch
Verifique se um filtro de abusos coincide com um conjunto de variáveis, evento do registo de abusos com editor registado.
abusefilterchecksyntax
Verificar a sintaxe de um filtro de abusos.
abusefilterevalexpression
Avalia uma expressão do filtro de abusos.
abusefilterunblockautopromote
Desbloqueia um utilizador de receber autopromoções em consequência do filtro de abusos.
block
Bloquear um utilizador.
categorytree
Módulo interno para a extensão "Árvore de categorias" (CategoryTree).
changeauthenticationdata
Alterar os dados de autenticação do utilizador atual.
checktoken
Verificar a validade de uma chave a partir de action=query&meta=tokens.
clearhasmsg
Limpa a indicação hasmsg do utilizador atual.
clientlogin
Entrar na wiki usando o processo interativo.
compare
Obter a diferença entre duas páginas.
createaccount
Criar uma conta de utilizador nova.
cspreport
Usado por browsers para reportar violações da norma "Content Security Policy". Este módulo nunca deve ser usado, exceto quando utilizado automaticamente por um browser compatível com a CSP.
delete
Eliminar uma página.
echomarkread
Marcar notificações como lidas para o utilizador atual.
echomarkseen
Marcar as notificações como vistas pelo utilizador atual.
edit
Criar e editar páginas.
editmassmessagelist
Editar uma lista de entrega de mensagens em massa.
emailuser
Enviar correio eletrónico a um utilizador.
expandtemplates
Expande todas as predefinições existentes num texto wiki.
feedcontributions
Devolve um feed das contribuições do utilizador.
feedrecentchanges
Devolve um feed das mudanças recentes.
feedwatchlist
Devolve um feed das páginas vigiadas.
filerevert
Reverter um ficheiro para uma versão antiga.
help
Apresentar ajuda para os módulos especificados.
imagerotate
Rodar uma ou mais imagens.
import
Importar uma página de outra wiki ou de um ficheiro XML.
linkaccount
Ligar uma conta de um fornecedor terceiro ao utilizador atual.
login
Iniciar uma sessão e obter cookies de autenticação.
logout
Terminar a sessão e limpar os dados da sessão.
managetags
Executar tarefas de gestão relacionadas com etiquetas de modificação.
massmessage
Enviar uma mensagem para uma lista de páginas.
mergehistory
Fundir o historial de páginas.
mobileview
Devolve os dados necessários para o visionamento em dispositivos móveis.
move
Mover uma página.
multiupload-unpack
Descomprimir um ficheiro ZIP ou tar antes de importar o seu conteúdo.
oathvalidate
Validar uma chave de autenticação de dois fatores (OATH).
opensearch
Pesquisar a wiki usando o protocolo OpenSearch.
options
Alterar as preferências do utilizador atual.
paraminfo
Obter informação sobre os módulos da API.
parse
Faz a análise sintática do conteúdo e devolve o resultado da análise.
patrol
Patrulhar uma página ou revisão.
protect
Alterar o nível de proteção de uma página.
purge
Limpar a cache para os títulos especificados.
query
Obter dados de, e sobre, o MediaWiki.
removeauthenticationdata
Remover os dados de autenticação do utilizador atual.
resetpassword
Enviar a um utilizador uma mensagem eletrónica de reinício da palavra-passe.
revisiondelete
Eliminar e restaurar revisões.
rollback
Desfazer a última edição da página.
rsd
Exportar um esquema (schema) RSD (Really Simple Discovery).
scribunto-console
Módulo anterno pa respunder ls pedidos XHR benidos de la cunsuola Scribunto.
setnotificationtimestamp
Atualizar a data e hora de notificação de alterações às páginas vigiadas.
setpagelanguage
Alterar a língua de uma página.
spamblacklist
Validar um ou mais URL contra a lista negra de spam.
stashedit
Preparar uma edição na cache partilhada.
tag
Adicionar ou remover as etiquetas de modificação aplicadas a revisões individuais ou a entradas do registo.
thank
Enviar uma notificação de agradecimento a um editor.
titleblacklist
Validar um título de página, nome de ficheiro ou nome de utilizador contra a lista negra.
transcodereset
Os utilizadores com o privilégio 'transcode-reset' podem reiniciar e voltar a executar uma tarefa de transcodificação.
unblock
Desbloquear um utilizador.
undelete
Restaurar revisões de uma página eliminada.
unlinkaccount
Remover do utilizador atual uma conta ligada de uma wiki terceira.
upload
Carregar um ficheiro, ou obter o estado dos carregamentos pendentes.
userrights
Alterar os grupos a que um utilizador pertence.
validatepassword
Validar uma palavra-passe face às regras para palavras-passe da wiki.
watch
Adicionar ou remover páginas da lista de páginas vigiadas do utilizador atual.
webapp-manifest
Devolve um manifesto de aplicação web.
tokens
Obsoleto. Obter chaves para operações de modificação de dados.
Um dos seguintes valores: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, block, categorytree, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, cspreport, delete, echomarkread, echomarkseen, edit, editmassmessagelist, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, massmessage, mergehistory, mobileview, move, multiupload-unpack, oathvalidate, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, scribunto-console, setnotificationtimestamp, setpagelanguage, spamblacklist, stashedit, tag, thank, titleblacklist, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, tokens
Valor por omissão: help
format

O formato do resultado.

json
Produzir os dados de saída no formato JSON.
jsonfm
Produzir os dados de saída em formato JSON (realce sintático em HTML).
none
Não produzir nada.
php
Produzir os dados de saída em formato PHP seriado.
phpfm
Produzir os dados de saída em formato PHP seriado (realce sintático em HTML).
rawfm
Produzir os dados de saída, incluindo elementos para despiste de erros, em formato JSON (realce sintático em HTML).
xml
Produzir os dados de saída em formato XML.
xmlfm
Produzir os dados de saída em formato XML (realce sintático em HTML).
Um dos seguintes valores: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Valor por omissão: jsonfm
maxlag

O atraso máximo pode ser usado quando o MediaWiki é instalado num cluster de bases de dados replicadas. Para impedir que as operações causem ainda mais atrasos de replicação do sítio, este parâmetro pode fazer o cliente aguardar até que o atraso de replicação seja inferior ao valor especificado. Caso o atraso atual exceda esse valor, o código de erro maxlag é devolvido com uma mensagem como À espera do servidor $host: $lag segundos de atraso.
Consulte Manual: Parâmetro maxlag para mais informações.

Tipo: inteiro
smaxage

Definir no cabeçalho HTTP s-maxage de controlo da cache este número de segundos. Os erros nunca são armazenados na cache.

Tipo: inteiro
Valor por omissão: 0
maxage

Definir no cabeçalho HTTP max-age de controlo da cache este número de segundos. Os erros nunca são armazenados na cache.

Tipo: inteiro
Valor por omissão: 0
assert

Se definido com o valor user, verificar que o utilizador está autenticado. Se definido com o valor bot, verificar que o utilizador tem o privilégio de conta robô.

Um dos seguintes valores: user, bot
assertuser

Verificar que o utilizador atual é o utilizador nomeado.

Tipo: nome de utilizador
requestid

Qualquer valor fornecido aqui será incluído na resposta. Pode ser usado para distinguir pedidos.

servedby

Incluir nos resultados o nome do servidor que serviu o pedido.

Tipo: booleano (detalhes)
curtimestamp

Incluir a data e hora atuais no resultado.

Tipo: booleano (detalhes)
responselanginfo

Incluir as línguas usadas para uselang e errorlang no resultado.

Tipo: booleano (detalhes)
origin

Ao aceder à API usando um pedido AJAX entre domínios (CORS), coloque aqui o domínio de origem. Isto tem de ser incluído em todas as verificações prévias e, portanto, tem de fazer parte do URI do pedido (e não do conteúdo do POST).

Para pedidos autenticados, este valor tem de corresponder de forma exata a um dos cabeçalhos Origin, portanto, tem de ser algo como https://en.wikipedia.org ou https://meta.wikimedia.org. Se este parâmetro não for igual ao cabeçalho Origin, será devolvida a resposta 403. Se este parâmetro for igual ao cabeçalho Origin e a origem for permitida (white-listed) os cabeçalhos Access-Control-Allow-Origin e Access-Control-Allow-Credentials serão preenchidos.

Para pedidos não autenticados, especifique o valor *. Isto fará com que o cabeçalho Access-Control-Allow-Origin seja preenchido, mas Access-Control-Allow-Credentials terá o valor false e o acesso a todos os dados específicos do utilizador está restringido.

uselang

A língua a ser usada nas traduções de mensagens. action=query&meta=siteinfo com siprop=languages devolve uma lista de códigos de língua, ou especifique user para usar a língua nas preferências do utilizador atual, ou especifique content para usar a língua de conteúdo desta wiki.

Valor por omissão: user
errorformat

O formato a ser usado no texto de avisos e erros.

plaintext
Texto wiki com os elementos HTML removidos e as entidades substituídas.
wikitext
Texto wiki sem análise sintática.
html
HTML.
raw
Chave e parâmetros da mensagem.
none
Sem saída de texto, só os códigos de erro.
bc
Formato usado antes do MediaWiki 1.29. errorlang e errorsuselocal são ignorados.
Um dos seguintes valores: plaintext, wikitext, html, raw, none, bc
Valor por omissão: bc
errorlang

A língua a ser usada para avisos e erros. action=query&meta=siteinfo com siprop=languages devolve uma lista de códigos de língua, ou especifique content para usar a língua de conteúdo desta wiki, ou especifique uselang para usar o mesmo valor que o parâmetro uselang.

Valor por omissão: uselang
errorsuselocal

Se fornecido, os textos de erro utilizarão mensagens personalizadas localmente do espaço nominal Biqui.

Tipo: booleano (detalhes)
Permissões:
writeapi
Outelizar la API de scrita
Concedidas a: all, user i bot
apihighlimits
Usar limites mais altos em consultas da API (consultas lentas: 500; consultas rápidas: 5000). Os limites para consultas lentas também se aplicam a parâmetros com vários valores.
Concedidas a: bot i sysop

action=abusefiltercheckmatch

  • Este módulo requer direitos de leitura.
  • Fonte: Abuse Filter
  • Licença: GPL-2.0-or-later

Verifique se um filtro de abusos coincide com um conjunto de variáveis, evento do registo de abusos com editor registado.

É necessário um dos seguintes: vars, rcid ou logid (só um pode ser usado).

Parâmetros:
filter

O texto completo do filtro para verificar a coincidência.

Este parâmetro é obrigatório.
vars

Matriz codificada JSON de variáveis para o teste.

rcid

Identificador da mudança recente para testar.

Tipo: inteiro
logid

Identificador do registo de abusos para testar.

Tipo: inteiro
Exemplo:
Testar se a mudança recente com o identificador 15 é detetada por um filtro simples
api.php?action=abusefiltercheckmatch&filter=!("autoconfirmed"%20in%20user_groups)&rcid=15 [abrir na página de testes]

action=abusefilterchecksyntax

  • Este módulo requer direitos de leitura.
  • Fonte: Abuse Filter
  • Licença: GPL-2.0-or-later

Verificar a sintaxe de um filtro de abusos.

Parâmetro:
filter

O texto completo do filtro para verificar a sintaxe.

Este parâmetro é obrigatório.

action=abusefilterevalexpression

  • Este módulo requer direitos de leitura.
  • Fonte: Abuse Filter
  • Licença: GPL-2.0-or-later

Avalia uma expressão do filtro de abusos.

Parâmetro:
expression

A expressão para avaliar.

Este parâmetro é obrigatório.

action=abusefilterunblockautopromote

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: Abuse Filter
  • Licença: GPL-2.0-or-later

Desbloqueia um utilizador de receber autopromoções em consequência do filtro de abusos.

Parâmetros:
user

Nome do utilizador que pretende desbloquear.

Este parâmetro é obrigatório.
Tipo: nome de utilizador
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=block

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Bloquear um utilizador.

Parâmetros:
user

O nome de utilizador, endereço IP ou gama de endereços IP a serem bloqueados. Não pode ser usado em conjunto com userid

Tipo: nome de utilizador
userid

O identificador do utilizador a ser bloqueado. Não pode ser usado em conjunto com user.

Tipo: inteiro
expiry

O período de expiração. Pode ser relativo (p. ex. 5 meses ou 2 semanas) ou absoluto (p. ex. 2014-09-18T12:34:56Z). Se definido como infinite, indefinite ou never, o bloqueio nunca expirará.

Valor por omissão: never
reason

O motivo do bloqueio.

Padrão: (vazio)
anononly

Bloquear só utilizadores anónimos (isto é, impedir edições anónimas a partir deste endereço IP)

Tipo: booleano (detalhes)
nocreate

Impedir a criação de contas.

Tipo: booleano (detalhes)
autoblock

Bloquear automaticamente o último endereço IP usado e quaisquer outros endereços IP subsequentes a partir do quais o utilizador tente iniciar uma sessão.

Tipo: booleano (detalhes)
noemail

Impedir o utilizador de enviar correio eletrónico através da wiki. (Requer o privilégio blockemail).

Tipo: booleano (detalhes)
hidename

Ocultar o nome do utilizador do registo de bloqueios. (Requer o privilégio hideuser).

Tipo: booleano (detalhes)
allowusertalk

Permitir que o utilizador edite a sua própria página de discussão (depende de $wgBlockAllowsUTEdit).

Tipo: booleano (detalhes)
reblock

Se o utilizador já está bloqueado, sobrescrever o bloco existente.

Tipo: booleano (detalhes)
watchuser

Vigiar as páginas de utilizador e de discussão, do utilizador ou do endereço IP.

Tipo: booleano (detalhes)
tags

Etiquetas de modificação a aplicar à entrada no registo de bloqueios.

Valores (separados com | ou alternativas):
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplos:
Bloquear o endereço IP 192.0.2.5 por três dias com o motivo First strike.
api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC [abrir na página de testes]
Bloquear o utilizador Vandal indefinidamente com o motivo Vandalism, e impedir a criação de nova conta e o envio de correio eletrónico.
api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC [abrir na página de testes]

action=categorytree

  • Este módulo é interno ou instável. O seu funcionamento pode ser alterado sem aviso prévio.
  • Este módulo requer direitos de leitura.
  • Fonte: CategoryTree
  • Licença: GPL-2.0-or-later

Módulo interno para a extensão "Árvore de categorias" (CategoryTree).

Parâmetros:
category

Título no espaço nominal Categoria, o prefixo será ignorado se for fornecido.

Este parâmetro é obrigatório.
options

Opções para o construtor CategoryTree como objeto JSON. A opção depth tem o valor predefinido 1.

action=changeauthenticationdata (changeauth)

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Alterar os dados de autenticação do utilizador atual.

Parâmetros:
changeauthrequest

Usar este pedido de autenticação, com o id devolvido por action=query&meta=authmanagerinfo com amirequestsfor=change.

Este parâmetro é obrigatório.
changeauthtoken

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.
*
Este módulo aceita parâmetros adicionais, dependendo dos pedidos de autenticação disponíveis. Use action=query&meta=authmanagerinfo com amirequestsfor=change (ou uma resposta anterior deste módulo, se aplicável) para determinar os pedidos disponíveis e os campos que estes utilizam.

action=checktoken

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Verificar a validade de uma chave a partir de action=query&meta=tokens.

Parâmetros:
type

Tipo de chave que está a ser testado.

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

Chave a testar.

Este parâmetro é obrigatório.
maxtokenage

Validade máxima da chave, em segundos.

Tipo: inteiro

action=clearhasmsg

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Limpa a indicação hasmsg do utilizador atual.

Exemplo:
Limpar a indicação hasmsg do utilizador atual.
api.php?action=clearhasmsg [abrir na página de testes]

action=clientlogin (login)

Entrar na wiki usando o processo interativo.

O procedimento geral para usar este módulo é:

  1. Obtenha os campos disponíveis usando action=query&meta=authmanagerinfo com amirequestsfor=login e uma chave login obtida de action=query&meta=tokens.
  2. Apresente os campos ao utilizador e obtenha os dados fornecidos por este.
  3. Publique-os para este módulo, fornecendo loginreturnurl e quaisquer campos relevantes.
  4. Verifique o valor de status na resposta.
    • Se recebeu PASS ou FAIL, terminou. A operação terá tido sucesso ou falhado.
    • Se recebeu UI, apresente os novos campos ao utilizador e obtenha os dados fornecidos por este. Depois publique-os para este módulo com logincontinue e os campos relevantes preenchidos, e repita o passo 4.
    • Se recebeu REDIRECT, encaminhe o utilizador para redirecttarget e aguarde o retorno para o URL loginreturnurl. Depois publique para este módulo com logincontinue quaisquer campos que tenham sido passados ao URL de retorno, e repita o passo 4.
    • Se recebeu RESTART, isto significa que a autenticação funcionou mas não temos uma conta de utilizador associada. Pode dar-lhe o tratamento de UI ou FAIL.
Parâmetros:
loginrequests

Usar só estes pedidos de autenticação, com o id devolvido por action=query&meta=authmanagerinfo com amirequestsfor=login ou por uma resposta anterior deste módulo.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
loginmessageformat

Formato a usar nas mensagens de saída.

Um dos seguintes valores: html, wikitext, raw, none
Valor por omissão: wikitext
loginmergerequestfields

Combinar a informação de todos os pedidos de autenticação numa única matriz.

Tipo: booleano (detalhes)
loginpreservestate

Preservar o estado de uma tentativa de autenticação anterior falhada, se possível.

Tipo: booleano (detalhes)
loginreturnurl

O URL de retorno para processos de autenticação por terceiros tem de ser absoluto. É obrigatório fornecer este URL ou logincontinue.

Tipicamente, após receber uma resposta REDIRECT, abrirá um browser ou uma web view para o URL redirecttarget especificado, para dar lugar ao processo de autenticação por terceiros. Quando esse processo terminar, a terceira entidade encaminhará o browser ou a web view para este URL. Deve extrair do URL quaisquer parâmetros de consulta ou de POST, e passá-los como um pedido logincontinue a este módulo da API.

logincontinue

Este pedido é uma continuação após uma resposta anterior com o valor UI ou REDIRECT. É obrigatório fornecer este parâmetro ou o parâmetro loginreturnurl.

Tipo: booleano (detalhes)
logintoken

Uma chave "login" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.
*
Este módulo aceita parâmetros adicionais, dependendo dos pedidos de autenticação disponíveis. Use action=query&meta=authmanagerinfo com amirequestsfor=login (ou uma resposta anterior deste módulo, se aplicável) para determinar os pedidos disponíveis e os campos que estes utilizam.
Exemplos:
Inicia o processo de entrada na wiki com o utilizador Example e a palavra-passe ExamplePassword.
api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [abrir na página de testes]
Continuar o processo de autenticação após uma resposta UI para autenticação de dois fatores, fornecendo uma OATHToken de 987654.
api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [abrir na página de testes]

action=compare

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter a diferença entre duas páginas.

Tem de ser passado um número de revisão, ou um título de página, ou um identificador de página, ou uma referência relativa para "from" e "to".

Parâmetros:
fromtitle

Primeiro título a comparar.

fromid

Primeiro identificador de página a comparar.

Tipo: inteiro
fromrev

Primeira revisão a comparar.

Tipo: inteiro
fromtext

Usar este texto em vez do conteúdo da revisão especificada por fromtitle, fromid ou fromrev.

fromsection

Utilizar apenas a secção especificada do conteúdo 'from' especificado.

frompst

Fazer uma transformação anterior à gravação, de fromtext.

Tipo: booleano (detalhes)
fromcontentformat

Formato de seriação do conteúdo de fromtext.

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

Modelo de conteúdo de fromtext. Se não for fornecido, ele será deduzido a partir dos outros parâmetros.

Um dos seguintes valores: GadgetDefinition, MassMessageListContent, Scribunto, wikitext, javascript, json, css, text
totitle

Segundo título a comparar.

toid

Segundo identificador de página a comparar.

Tipo: inteiro
torev

Segunda revisão a comparar.

Tipo: inteiro
torelative

Usar uma revisão relativa à revisão determinada a partir de fromtitle, fromid ou fromrev. Todas as outras opções 'to' serão ignoradas.

Um dos seguintes valores: prev, next, cur
totext

Usar este texto em vez do conteúdo da revisão especificada por totitle, toid ou torev.

tosection

Utilizar apenas a secção especificada do conteúdo 'to' especificado.

topst

Fazer uma transformação anterior à gravação, de totext.

Tipo: booleano (detalhes)
tocontentformat

Formato de seriação do conteúdo de totext.

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

Modelo de conteúdo de totext. Se não for fornecido, ele será deduzido a partir dos outros parâmetros.

Um dos seguintes valores: GadgetDefinition, MassMessageListContent, Scribunto, wikitext, javascript, json, css, text
prop

As informações que devem ser obtidas.

diff
O HTML da lista de diferenças.
diffsize
O tamanho do HTML da lista de diferenças, em bytes.
rel
Os identificadores da revisão anterior a 'from' e da posterior a 'to', se existirem.
ids
Os identificadores de página e de revisão das revisões 'from' e 'to'.
title
Os títulos de página das revisões 'from' e 'to'.
user
O nome e o identificador de utilizador das revisões 'from' e 'to'.
comment
O comentário das revisões 'from' e 'to'.
parsedcomment
O comentário após análise sintática, das revisões 'from' e 'to'.
size
O tamanho das revisões 'from' e 'to'.
Valores (separados com | ou alternativas): diff, diffsize, rel, ids, title, user, comment, parsedcomment, size
Valor por omissão: diff|ids|title
Exemplo:
Criar uma lista de diferenças entre as revisões 1 e 2.
api.php?action=compare&fromrev=1&torev=2 [abrir na página de testes]

action=createaccount (create)

  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Criar uma conta de utilizador nova.

O procedimento geral para usar este módulo é:

  1. Obtenha os campos disponíveis usando action=query&meta=authmanagerinfo com amirequestsfor=create e uma chave createaccount obtida de action=query&meta=tokens.
  2. Apresente os campos ao utilizador e obtenha os dados fornecidos por este.
  3. Publique-os para este módulo, fornecendo createreturnurl e quaisquer campos relevantes.
  4. Verifique o valor de status na resposta.
    • Se recebeu PASS ou FAIL, terminou. A operação terá tido sucesso ou falhado.
    • Se recebeu UI, apresente os novos campos ao utilizador e obtenha os dados fornecidos por este. Depois publique-os para este módulo com createcontinue e os campos relevantes preenchidos, e repita o passo 4.
    • Se recebeu REDIRECT, encaminhe o utilizador para redirecttarget e aguarde o retorno para o URL createreturnurl. Depois publique para este módulo com createcontinue quaisquer campos que tenham sido passados ao URL de retorno, e repita o passo 4.
    • Se recebeu RESTART, isto significa que a autenticação funcionou mas não temos uma conta de utilizador associada. Pode dar-lhe o tratamento de UI ou FAIL.
Parâmetros:
createrequests

Usar só estes pedidos de autenticação, com o id devolvido por action=query&meta=authmanagerinfo com amirequestsfor=create ou por uma resposta anterior deste módulo.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
createmessageformat

Formato a usar nas mensagens de saída.

Um dos seguintes valores: html, wikitext, raw, none
Valor por omissão: wikitext
createmergerequestfields

Combinar a informação de todos os pedidos de autenticação numa única matriz.

Tipo: booleano (detalhes)
createpreservestate

Preservar o estado de uma tentativa de autenticação anterior falhada, se possível.

Se action=query&meta=authmanagerinfo devolveu o valor verdadeiro para hasprimarypreservedstate, pedidos marcados como primary-required devem ser omitidos. Se devolveu um valor não vazio em preservedusername, esse nome de utilizador tem de ser usado no parâmetro username.

Tipo: booleano (detalhes)
createreturnurl

O URL de retorno para processos de autenticação por terceiros tem de ser absoluto. É obrigatório fornecer este URL ou createcontinue.

Tipicamente, após receber uma resposta REDIRECT, abrirá um browser ou uma web view para o URL redirecttarget especificado, para dar lugar ao processo de autenticação por terceiros. Quando esse processo terminar, a terceira entidade encaminhará o browser ou a web view para este URL. Deve extrair do URL quaisquer parâmetros de consulta ou de POST, e passá-los como um pedido createcontinue a este módulo da API.

createcontinue

Este pedido é uma continuação após uma resposta anterior com o valor UI ou REDIRECT. É obrigatório fornecer este parâmetro ou o parâmetro createreturnurl.

Tipo: booleano (detalhes)
createtoken

Uma chave "createaccount" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.
*
Este módulo aceita parâmetros adicionais, dependendo dos pedidos de autenticação disponíveis. Use action=query&meta=authmanagerinfo com amirequestsfor=create (ou uma resposta anterior deste módulo, se aplicável) para determinar os pedidos disponíveis e os campos que estes utilizam.

action=cspreport

  • Este módulo é interno ou instável. O seu funcionamento pode ser alterado sem aviso prévio.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Usado por browsers para reportar violações da norma "Content Security Policy". Este módulo nunca deve ser usado, exceto quando utilizado automaticamente por um browser compatível com a CSP.

Parâmetros:
reportonly

Marcar como sendo um relatório vindo de uma norma de monitorização e não de uma norma exigida.

Tipo: booleano (detalhes)
source

Aquilo que gerou o cabeçalho CSP que desencadeou este relatório.

Valor por omissão: internal

action=delete

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Eliminar uma página.

Parâmetros:
title

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

pageid

Identificador da página a eliminar. Não pode ser usado em conjunto com title.

Tipo: inteiro
reason

Motivo para a eliminação. Se não for definido, será usado um motivo gerado automaticamente.

tags

Etiquetas de modificação a aplicar à entrada no registo de eliminações.

Valores (separados com | ou alternativas):
watch
Obsoleto.

Adicionar a página às páginas vigiadas do utilizador atual.

Tipo: booleano (detalhes)
watchlist

Adicionar ou remover incondicionalmente a página da lista de páginas vigiadas do utilizador atual, usar as preferências ou não alterar o estado de vigilância.

Um dos seguintes valores: watch, unwatch, preferences, nochange
Valor por omissão: preferences
unwatch
Obsoleto.

Remover a página das páginas vigiadas do utilizador atual.

Tipo: booleano (detalhes)
oldimage

O nome da imagem antiga a ser eliminada, tal como fornecido por action=query&prop=imageinfo&iiprop=archivename.

token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=echomarkread

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: Echo
  • Licença: MIT

Marcar notificações como lidas para o utilizador atual.

Parâmetros:
list

Uma lista de identificadores de notificações a marcar como lidas.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
unreadlist

Uma lista de identificadores de notificações a marcar como não lidas.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
all

Se definido, marca todas as notificações de um utilizador como lidas.

Tipo: booleano (detalhes)
sections

Uma lista de secções a marcar como lidas.

Valores (separados com | ou alternativas): alert, message
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=echomarkseen

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: Echo
  • Licença: MIT

Marcar as notificações como vistas pelo utilizador atual.

Parâmetros:
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.
type

Tipos de notificações a marcar como vistas: 'alert', 'message' ou 'all'.

Este parâmetro é obrigatório.
Um dos seguintes valores: alert, message, all
timestampFormat

Formato da data e hora a usar no resultado, 'ISO_8601' ou 'MW'. 'MW' é agora obsoleto aqui, por isso todos os clientes devem mudar para 'ISO_8601'. Este parâmetro será removido e 'ISO_8601' passará a ser o único formato de saída.

Um dos seguintes valores: ISO_8601, MW
Valor por omissão: MW
Exemplo:
Marcar as notificações de todos os tipos como vistas
api.php?action=echomarkseen&type=all [abrir na página de testes]

action=edit

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Criar e editar páginas.

Parâmetros:
title

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

pageid

Identificador da página a ser editada. Não pode ser usado em conjunto com title.

Tipo: inteiro
section

Número da secção. 0 para a secção de topo, new para uma secção nova.

sectiontitle

Título para uma nova secção.

text

Conteúdo da página.

summary

Resumo da edição. Também é o título da secção quando section=new e sectiontitle não está definido.

tags

Etiquetas de modificação a aplicar à revisão.

Valores (separados com | ou alternativas):
minor

Edição menor.

Tipo: booleano (detalhes)
notminor

Edição não menor.

Tipo: booleano (detalhes)
bot

Marcar esta edição como edição de robô.

Tipo: booleano (detalhes)
basetimestamp

Data e hora da revisão de base, usada para detetar conflitos de edição. Pode ser obtida usando action=query&prop=revisions&rvprop=timestamp.

Tipo: data e hora (formatos permitidos)
starttimestamp

Data e hora de início do processo de edição, usada para detetar conflitos de edição. Pode-se obter um valor apropriado usando curtimestamp ao iniciar o processo de edição (por exemplo, ao carregar o conteúdo da página para edição).

Tipo: data e hora (formatos permitidos)
recreate

Ignorar todos os erros acerca da página ter sido eliminada entretanto.

Tipo: booleano (detalhes)
createonly

Não editar a página se ela já existe.

Tipo: booleano (detalhes)
nocreate

Gerar um erro se a página não existe.

Tipo: booleano (detalhes)
watch
Obsoleto.

Adicionar a página às páginas vigiadas do utilizador atual.

Tipo: booleano (detalhes)
unwatch
Obsoleto.

Remover a página da lista de páginas vigiadas do utilizador atual.

Tipo: booleano (detalhes)
watchlist

Adicionar ou remover incondicionalmente a página da lista de páginas vigiadas do utilizador atual, usar as preferências ou não alterar o estado de vigilância.

Um dos seguintes valores: watch, unwatch, preferences, nochange
Valor por omissão: preferences
md5

A chave MD5 do parâmetro text, ou os parâmetros prependtext e appendtext concatenados. Se estiver definido, a edição não será realizada a menos que a chave seja correta.

prependtext

Adicionar este texto ao início da página. Tem precedência sobre text.

appendtext

Adicionar este texto ao fim da página. Tem precedência sobre text.

Para acrescentar uma nova secção no fim da página, usar section=new em vez deste parâmetro.

undo

Desfazer esta revisão. Tem precedência sobre text, prependtext e appendtext.

O valor não pode ser inferior a 0.
Tipo: inteiro
undoafter

Desfazer todas as revisões desde undo até esta. Se não for definido, desfazer só uma revisão.

O valor não pode ser inferior a 0.
Tipo: inteiro
redirect

Resolver automaticamente redirecionamentos.

Tipo: booleano (detalhes)
contentformat

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

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

Modelo de conteúdo do novo conteúdo.

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

Uma chave "csrf" obtida de action=query&meta=tokens

A chave deve ser sempre enviada como último parâmetro, ou pelo menos após o parâmetro text.

Este parâmetro é obrigatório.

action=editmassmessagelist

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MassMessage
  • Licença: GPL-2.0-or-later

Editar uma lista de entrega de mensagens em massa.

Parâmetros:
spamlist

Titulo da lista de entregas a ser atualizada.

Este parâmetro é obrigatório.
add

Títulos a adicionar à lista.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
remove

Títulos a remover da lista.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=emailuser

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Enviar correio eletrónico a um utilizador.

Parâmetros:
target

Utilizador a quem enviar correio eletrónico.

Este parâmetro é obrigatório.
subject

Assunto.

text

Texto.

Este parâmetro é obrigatório.
ccme

Enviar-me uma cópia desta mensagem.

Tipo: booleano (detalhes)
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplo:
Enviar uma mensagem de correio ao utilizador WikiSysop com o texto Content.
api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC [abrir na página de testes]

action=expandtemplates

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Expande todas as predefinições existentes num texto wiki.

Parâmetros:
title

Título da página.

text

Texto wiki a converter.

Este parâmetro é obrigatório.
revid

Identificador da revisão, para {{REVISIONID}} e variáveis semelhantes.

Tipo: inteiro
prop

As informações que devem ser obtidas:

Note que, se não for selecionado nenhum valor, o resultado irá conter o texto wiki mas a saída estará num formato obsoleto.

wikitext
O texto wiki expandido.
categories
Quaisquer categorias existentes na entrada que não estão representadas no texto wiki de saída.
properties
Propriedades da página, definidas por palavras mágicas expandidas, no texto wiki.
volatile
Indica se o resultado é volátil e não deve ser reutilizado noutra parte da página.
ttl
O período máximo a partir do qual os armazenamentos do resultado na cache devem ser invalidados.
modules
Quaisquer módulos ResourceLoader que as funções do analisador sintático solicitaram que fossem adicionados ao resultado de saída. Um dos valores jsconfigvars ou encodedjsconfigvars tem de ser solicitado em conjunto com o valor modules.
jsconfigvars
Devolve as variáveis de configuração JavaScript específicas desta página.
encodedjsconfigvars
Devolve as variáveis de configuração JavaScript específicas da página, no formato de uma string JSON.
parsetree
A árvore de análise sintática em XML do texto de entrada.
Valores (separados com | ou alternativas): wikitext, categories, properties, volatile, ttl, modules, jsconfigvars, encodedjsconfigvars, parsetree
includecomments

Indica se devem ser incluídos comentários HTML no resultado.

Tipo: booleano (detalhes)
generatexml
Obsoleto.

Gerar a árvore de análise sintática em XML (substituído por prop=parsetree).

Tipo: booleano (detalhes)
templatesandboxprefix

Prefixo da página de testes para predefinições, como especificado em Special:TemplateSandbox.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
templatesandboxtitle

Analisar a página usando templatesandboxtext em vez do conteúdo da página referida aqui.

templatesandboxtext

Analisar a página usando o conteúdo desta página, em vez da página referida na variável templatesandboxtext.

templatesandboxcontentmodel

Modelo de conteúdo de templatesandboxtext.

Um dos seguintes valores: GadgetDefinition, MassMessageListContent, Scribunto, wikitext, javascript, json, css, text
templatesandboxcontentformat

Formato de conteúdo de templatesandboxtext.

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

action=feedcontributions

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolve um feed das contribuições do utilizador.

Parâmetros:
feedformat

O formato do feed.

Um dos seguintes valores: rss, atom
Valor por omissão: rss
user

Os utilizadores dos quais serão obtidas as contribuições.

Este parâmetro é obrigatório.
Tipo: nome de utilizador
namespace

O espaço nominal pelo qual as contribuições serão filtradas.

Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
year

Desde o ano.

Tipo: inteiro
month

Desde o mês.

Tipo: inteiro
tagfilter

Filtrar as contribuições para produzir as que têm estas etiquetas.

Valores (separados com | ou alternativas): mw-contentmodelchange, mw-new-redirect, mw-removed-redirect, mw-changed-redirect-target, mw-blank, mw-replace, mw-rollback, mw-undo, abusefilter-condition-limit, mobile edit, mobile web edit, massmessage-delivery
Padrão: (vazio)
deletedonly

Mostrar apenas as contribuições eliminadas.

Tipo: booleano (detalhes)
toponly

Mostrar apenas as edições mais recentes.

Tipo: booleano (detalhes)
newonly

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

Tipo: booleano (detalhes)
hideminor

Ocultar edições menores.

Tipo: booleano (detalhes)
showsizediff

Mostrar diferença de tamanho entre edições.

Tipo: booleano (detalhes)
Exemplo:
Devolver as contribuições do utilizador Example.
api.php?action=feedcontributions&user=Example [abrir na página de testes]

action=feedrecentchanges

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolve um feed das mudanças recentes.

Parâmetros:
feedformat

O formato do feed.

Um dos seguintes valores: rss, atom
Valor por omissão: rss
namespace

O espaço nominal ao qual os resultados serão limitados.

Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
invert

Todos os espaços nominais exceto o selecionado.

Tipo: booleano (detalhes)
associated

Incluir o espaço nominal associado (de discussão ou principal).

Tipo: booleano (detalhes)
days

Dias aos quais limitar os resultados.

O valor não pode ser inferior a 1.
Tipo: inteiro
Valor por omissão: 7
limit

O número máximo de resultados a serem devolvidos.

O valor tem de estar compreendido entre 1 e 50.
Tipo: inteiro
Valor por omissão: 50
from

Mostrar alterações desde então.

Tipo: data e hora (formatos permitidos)
hideminor

Ocultar edições menores.

Tipo: booleano (detalhes)
hidebots

Ocultar mudanças feitas por robôs.

Tipo: booleano (detalhes)
hideanons

Ocultar mudanças feitas por utilizadores anónimos.

Tipo: booleano (detalhes)
hideliu

Ocultar mudanças feitas por utilizadores registados.

Tipo: booleano (detalhes)
hidepatrolled

Ocultar mudanças patrulhadas.

Tipo: booleano (detalhes)
hidemyself

Ocultar mudanças feitas pelo utilizador atual.

Tipo: booleano (detalhes)
hidecategorization

Ocultar mudanças de pertença a categorias.

Tipo: booleano (detalhes)
tagfilter

Filtrar por etiqueta.

target

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

showlinkedto

Mostrar mudanças em páginas com hiperligações para a página selecionada.

Tipo: booleano (detalhes)

action=feedwatchlist

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolve um feed das páginas vigiadas.

Parâmetros:
feedformat

O formato do feed.

Um dos seguintes valores: rss, atom
Valor por omissão: rss
hours

Mostrar as mudanças recentes desde há este número de horas.

O valor tem de estar compreendido entre 1 e 72.
Tipo: inteiro
Valor por omissão: 24
linktosections

Ligar diretamente às secções alteradas, se possível.

Tipo: booleano (detalhes)
allrev

Incluir revisões múltiplas da mesma página dentro do intervalo de tempo indicado.

Tipo: booleano (detalhes)
wlowner

Usado com token para aceder à lista de páginas vigiadas de outro utilizador.

Tipo: nome de utilizador
wltoken

Uma chave de segurança (disponível nas preferências do utilizador) para permitir acesso à lista de páginas vigiadas de outro utilizador.

wlshow

Mostrar só as entradas que correspondem a estes critérios. Por exemplo, para ver só as edições menores feitas por utilizadores autenticados, definir show=minor|!anon.

Valores (separados com | ou alternativas): minor, !minor, bot, !bot, anon, !anon, patrolled, !patrolled, autopatrolled, !autopatrolled, unread, !unread
wltype

Os tipos de alterações a serem mostradas:

edit
Edições normais.
new
Criações de páginas.
log
Entradas do registo.
external
Mudanças externas.
categorize
Alterações de pertença a categorias.
Valores (separados com | ou alternativas): edit, new, log, external, categorize
Valor por omissão: edit|new|log|categorize
wlexcludeuser

Não listar as mudanças deste utilizador.

Tipo: nome de utilizador
Exemplos:
Mostrar o feed das páginas vigiadas.
api.php?action=feedwatchlist [abrir na página de testes]
Mostrar todas as mudanças às páginas vigiadas nas últimas 6 horas.
api.php?action=feedwatchlist&allrev=&hours=6 [abrir na página de testes]

action=filerevert

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Reverter um ficheiro para uma versão antiga.

Parâmetros:
filename

Nome do ficheiro de destino, sem o prefixo File:.

Este parâmetro é obrigatório.
comment

Comentário do carregamento.

Padrão: (vazio)
archivename

Nome de arquivo da revisão para a qual o ficheiro será revertido.

Este parâmetro é obrigatório.
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=help

Apresentar ajuda para os módulos especificados.

Parâmetros:
modules

Módulos para os quais apresentar ajuda (valores dos parâmetros action e format, ou main). Pode-se especificar submódulos com um +.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
Valor por omissão: main
submodules

Incluir ajuda para submódulos do módulo nomeado.

Tipo: booleano (detalhes)
recursivesubmodules

Incluir ajuda para os submódulos de forma recursiva.

Tipo: booleano (detalhes)
wrap

Envolver a saída numa estrutura padrão de resposta da API.

Tipo: booleano (detalhes)
toc

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

Tipo: booleano (detalhes)

action=imagerotate

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Rodar uma ou mais imagens.

Parâmetros:
rotation

Graus de rotação da imagem no sentido horário.

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

Quando houver mais resultados disponíveis, usar isto para continuar

tags

Etiquetas a aplicar à entrada no registo de carregamentos.

Valores (separados com | ou alternativas):
titles

Uma lista dos títulos a serem trabalhados.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
pageids

Uma lista dos identificadores de página a serem trabalhados.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
revids

Uma lista dos identificadores de revisões a serem trabalhados.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
generator

Obter a lista de páginas nas quais trabalhar, executando o módulo de consulta especificado.

Nota: Os nomes dos parâmetros de geradores têm de ser prefixados com um "g", veja os exemplos.

allcategories
Enumerar todas as categorias.
alldeletedrevisions
Listar todas as revisões eliminadas por um utilizador ou de um espaço nominal.
allfileusages
Listar todas as utilizações de ficheiros, incluindo ficheiros que não existam.
allimages
Enumerar todas as imagens sequencialmente.
alllinks
Enumerar todas as hiperligações que apontam para um determinado espaço nominal.
allpages
Enumerar sequencialmente todas as páginas de um determinado espaço nominal.
allredirects
Listar todos os redirecionamentos para um espaço nominal.
allrevisions
Listar todas as revisões.
alltransclusions
Listar todas as transclusões (páginas incorporadas utilizando {{x}}), incluindo as que estejam em falta.
backlinks
Encontrar todas as páginas que contêm hiperligações para a página indicada.
categories
Listar todas as categorias às quais as páginas pertencem.
categorymembers
Listar todas as páginas numa categoria específica.
deletedrevisions
Obter informações sobre as revisões eliminadas.
duplicatefiles
Listar todos os ficheiros que são duplicados dos ficheiros indicados com base no seu resumo criptográfico.
embeddedin
Encontrar todas as páginas que incorporam (transcluem) o título indicado.
exturlusage
Enumerar as páginas que contêm um determinado URL.
fileusage
Encontrar todas as páginas que usam os ficheiros indicados.
images
Devolve todos os ficheiros contidos nas páginas indicadas.
imageusage
Encontrar todas as páginas que utilizam o título da imagem indicada.
iwbacklinks
Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
langbacklinks
Encontrar todas as páginas que contêm hiperligações para a hiperligação interlínguas indicada.
links
Devolve todas as hiperligações das páginas indicadas.
linkshere
Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
pageswithprop
Listar todas as páginas que usam uma determinada propriedade.
prefixsearch
Realizar uma procura de prefixo nos títulos de página.
protectedtitles
Listar todos os títulos cuja criação está impedida.
querypage
Obter uma lista fornecida por uma página especial baseada em consultas (QueryPage).
random
Obter um conjunto de páginas aleatórias.
recentchanges
Enumerar as mudanças recentes.
redirects
Devolve todos os redirecionamentos para as páginas indicadas.
revisions
Obter informação da revisão.
search
Efetuar uma pesquisa do texto integral.
templates
Devolve todas as páginas que são transcluídas nas páginas indicadas.
transcludedin
Obter todas as páginas que transcluem as páginas indicadas.
watchlist
Obter mudanças recentes das páginas vigiadas do utilizador atual.
watchlistraw
Obter todas as páginas na lista de páginas vigiadas do utilizador atual.
Um dos seguintes valores: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, 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

Resolver automaticamente os redirecionamentos listados nos parâmetros titles, pageids e revids, e nas páginas devolvidas por generator.

Tipo: booleano (detalhes)
converttitles

Converter os títulos noutras variantes de língua, se necessário. Só funciona se a língua de conteúdo da wiki suporta a conversão entre variantes. As línguas que suportam conversão entre variantes incluem en, crh, gan, iu, kk, ku, shi, sr, tg, uz i zh.

Tipo: booleano (detalhes)
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=import

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Importar uma página de outra wiki ou de um ficheiro XML.

Note que o pedido POST de HTTP tem de ser feito como um carregamento de ficheiro (isto é, usando "multipart/form-data") ao enviar um ficheiro para o parâmetro xml.

Parâmetros:
summary

Resumo da importação para a entrada do registo.

xml

Ficheiro XML carregado.

Tem ser enviado (posted) como um carregamento de ficheiro usando multipart/form-data.
interwikiprefix

Para importações carregadas: o prefixo interwikis a ser aplicado aos nomes de utilizador desconhecidos (e aos conhecidos se assignknownusers estiver definido).

interwikisource

Para importações interwikis: a wiki de onde importar.

Um dos seguintes valores:
interwikipage

Para importações interwikis: a página a importar.

fullhistory

Para importações interwikis: importar o historial completo, não apenas a versão atual.

Tipo: booleano (detalhes)
templates

Para importações interwikis: importar também todas as predefinições incluídas.

Tipo: booleano (detalhes)
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, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
assignknownusers

Atribuir as edições aos utilizadores locais se o utilizador nomeado existir localmente.

Tipo: booleano (detalhes)
rootpage

Importar como subpágina desta página. Não pode ser usado em conjunto com namespace.

tags

Etiquetas de modificação a aplicar à entrada no registo de importações e à revisão nula nas páginas importadas.

Valores (separados com | ou alternativas):
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=linkaccount (link)

  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Ligar uma conta de um fornecedor terceiro ao utilizador atual.

O procedimento geral para usar este módulo é:

  1. Obtenha os campos disponíveis usando action=query&meta=authmanagerinfo com amirequestsfor=link e uma chave csrf obtida de action=query&meta=tokens.
  2. Apresente os campos ao utilizador e obtenha os dados fornecidos por este.
  3. Publique-os para este módulo, fornecendo linkreturnurl e quaisquer campos relevantes.
  4. Verifique o valor de status na resposta.
    • Se recebeu PASS ou FAIL, terminou. A operação terá tido sucesso ou falhado.
    • Se recebeu UI, apresente os novos campos ao utilizador e obtenha os dados fornecidos por este. Depois publique-os para este módulo com linkcontinue e os campos relevantes preenchidos, e repita o passo 4.
    • Se recebeu REDIRECT, encaminhe o utilizador para redirecttarget e aguarde o retorno para o URL linkreturnurl. Depois publique para este módulo com linkcontinue quaisquer campos que tenham sido passados ao URL de retorno, e repita o passo 4.
    • Se recebeu RESTART, isto significa que a autenticação funcionou mas não temos uma conta de utilizador associada. Pode dar-lhe o tratamento de UI ou FAIL.
Parâmetros:
linkrequests

Usar só estes pedidos de autenticação, com o id devolvido por action=query&meta=authmanagerinfo com amirequestsfor=link ou por uma resposta anterior deste módulo.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
linkmessageformat

Formato a usar nas mensagens de saída.

Um dos seguintes valores: html, wikitext, raw, none
Valor por omissão: wikitext
linkmergerequestfields

Combinar a informação de todos os pedidos de autenticação numa única matriz.

Tipo: booleano (detalhes)
linkreturnurl

O URL de retorno para processos de autenticação por terceiros tem de ser absoluto. É obrigatório fornecer este URL ou linkcontinue.

Tipicamente, após receber uma resposta REDIRECT, abrirá um browser ou uma web view para o URL redirecttarget especificado, para dar lugar ao processo de autenticação por terceiros. Quando esse processo terminar, a terceira entidade encaminhará o browser ou a web view para este URL. Deve extrair do URL quaisquer parâmetros de consulta ou de POST, e passá-los como um pedido linkcontinue a este módulo da API.

linkcontinue

Este pedido é uma continuação após uma resposta anterior com o valor UI ou REDIRECT. É obrigatório fornecer este parâmetro ou o parâmetro linkreturnurl.

Tipo: booleano (detalhes)
linktoken

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.
*
Este módulo aceita parâmetros adicionais, dependendo dos pedidos de autenticação disponíveis. Use action=query&meta=authmanagerinfo com amirequestsfor=link (ou uma resposta anterior deste módulo, se aplicável) para determinar os pedidos disponíveis e os campos que estes utilizam.

action=login (lg)

Iniciar uma sessão e obter cookies de autenticação.

Esta operação só deve ser usada em combinação com Special:BotPasswords; a sua utilização para entrar com a conta principal é obsoleta e poderá falhar sem aviso. Para entrar com a conta principal de forma segura, use action=clientlogin.

Parâmetros:
lgname

Nome de utilizador.

lgpassword

Palavra-passe.

lgdomain

Domínio (opcional).

lgtoken

Uma chave "login" obtida de action=query&meta=tokens

action=logout

Terminar a sessão e limpar os dados da sessão.

Exemplo:
Terminar a sessão do utilizador atual.
api.php?action=logout [abrir na página de testes]

action=managetags

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

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

Parâmetros:
operation

A operação que será realizada:

create
Criar uma nova etiqueta de modificação para uso manual.
delete
Remover da base de dados uma etiqueta de modificação, incluindo remover a etiqueta de todas as revisões, entradas nas mudanças recentes e entradas do registo onde ela é utilizada.
activate
Ativar uma etiqueta de modificação, permitindo que os utilizadores a apliquem manualmente.
deactivate
Desativar uma etiqueta de modificação, impedindo que os utilizadores a apliquem manualmente.
Este parâmetro é obrigatório.
Um dos seguintes valores: create, delete, activate, deactivate
tag

Etiqueta a ser criada, eliminada, ativada ou desativada. Para criar uma etiqueta ela não pode existir. Para eliminar uma etiqueta, ela tem de existir. Para ativar uma etiqueta, ela tem de existir e não estar a ser utilizada por nenhuma extensão. Para desativar uma etiqueta, ela tem de estar ativa e definida manualmente.

Este parâmetro é obrigatório.
reason

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

ignorewarnings

Indica se devem ser ignorados todos os avisos gerados durante a operação.

Tipo: booleano (detalhes)
tags

Etiquetas de modificação a aplicar à entrada no registo de gestão de etiquetas.

Valores (separados com | ou alternativas):
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=massmessage

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MassMessage
  • Licença: GPL-2.0-or-later

Enviar uma mensagem para uma lista de páginas.

Parâmetros:
spamlist

Página que contém uma lista de páginas nas quais será deixada uma mensagem.

Este parâmetro é obrigatório.
subject

Linha do assunto da mensagem.

Este parâmetro é obrigatório.
message

Texto do corpo da mensagem.

Este parâmetro é obrigatório.
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=mergehistory

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Fundir o historial de páginas.

Parâmetros:
from

Título da página cujo historial será fundido. Não pode ser usado em conjunto com fromid.

fromid

Identificador da página cujo historial será fundido. Não pode ser usado em conjunto com from.

Tipo: inteiro
to

Título da página à qual o historial será fundido. Não pode ser usado em conjunto com toid.

toid

Identificador da página à qual o historial será fundido. Não pode ser usado em conjunto com to.

Tipo: inteiro
timestamp

Data e hora até a qual as revisões serão movidas do historial da página de origem para o historial das páginas de destino. Se omitido, todo o historial da página de origem será fundido com a página de destino.

Tipo: data e hora (formatos permitidos)
reason

Motivo para fundir o historial.

Padrão: (vazio)
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=mobileview

  • Este módulo requer direitos de leitura.
  • Fonte: MobileFrontend
  • Licença: GPL-2.0-or-later

Devolve os dados necessários para o visionamento em dispositivos móveis.

Parâmetros:
page

Título da página a processar.

Este parâmetro é obrigatório.
redirect

Se os redirecionamentos devem ser seguidos.

Um dos seguintes valores: yes, no
Valor por omissão: yes
sections

Lista dos números de secção, separados por barras verticais, cujo texto será devolvido. Pode usar "all" para o texto de todas as secções. Intervalos, no formato "1-4", significam as secções 1, 2, 3 e 4. Intervalos sem o segundo número, no formato "1-", significam todas as secções a partir da especificada. Pode usar "references" para especificar que devem ser devolvidas todas as secções que contêm referências.

prop

As informações a obter:

text
O HTML das secções selecionadas.
sections
Informação sobre todas as secções da página.
normalizedtitle
O título da página normalizado.
lastmodified
A data e hora em que a página foi modificada pela última vez, no formato ISO 8601, por exemplo "2014-04-13T22:42:14Z".
lastmodifiedby
Informação sobre o último utilizador a modificar a página.
revision
Devolver o identificador da revisão atual da página.
protection
Informação sobre o nível de proteção.
editable
Se o utilizador atual pode ou não editar a página. Isto inclui todos os fatores para os utilizadores autenticados, mas não o estado de bloqueio de utilizadores anónimos.
languagecount
O número de línguas nas quais a página está disponível.
hasvariants
Se a página está ou não disponível noutras variantes da língua.
displaytitle
O título da página como será apresentado, com a aplicação de {{DISPLAYTITLE}} e outros.
pageprops
As propriedades da página.
Valores (separados com | ou alternativas): id, text, sections, normalizedtitle, lastmodified, lastmodifiedby, revision, protection, editable, languagecount, hasvariants, displaytitle, pageprops, description, contentmodel, namespace, image, thumb
Valor por omissão: text|sections|normalizedtitle
sectionprop

Que informação sobre as secções deve ser obtida.

Valores (separados com | ou alternativas): toclevel, level, line, number, index, fromtitle, anchor
Valor por omissão: toclevel|line
pageprops

Que propriedade de página devem ser devolvidas; uma lista separada por barras verticais ("|") ou "*" para todas as propriedades.

Valor por omissão: notoc|noeditsection|wikibase_item
variant

Converter o conteúdo para esta variante da língua.

Padrão: (vazio)
noimages

Devolver o HTML sem imagens.

Tipo: booleano (detalhes)
noheadings

Não incluir cabeçalhos no resultado de saída.

Tipo: booleano (detalhes)
notransform

Não transformar o HTML numa versão específica para dispositivos móveis.

Tipo: booleano (detalhes)
onlyrequestedsections

Devolver só as secções pedidas, mesmo com prop=sections.

Tipo: booleano (detalhes)
offset

Tratar todo o resultado de texto como se fosse uma só linha e devolver a parte a partir deste ponto.

O valor não pode ser inferior a 0.
Tipo: inteiro
Valor por omissão: 0
maxlen

Tratar todo o resultado de texto como se fosse uma só linha e limitar o resultado a este comprimento.

O valor não pode ser inferior a 0.
Tipo: inteiro
Valor por omissão: 0
revision

Solicitar uma revisão específica.

O valor não pode ser inferior a 0.
Tipo: inteiro
Valor por omissão: 0
thumbheight

Altura máxima das miniaturas.

O valor não pode ser inferior a 0.
Tipo: inteiro
thumbwidth

Largura máxima das miniaturas.

O valor não pode ser inferior a 0.
Tipo: inteiro
thumbsize

Dimensões máximas das miniaturas.

O valor não pode ser inferior a 0.
Tipo: inteiro
Exemplos:
Obter informação sobre a secção 0 da página Doom metal
api.php?action=mobileview&page=Doom_metal&sections=0 [abrir na página de testes]
Obter informação sobre a secção 0 e as secções que contêm referências, da página Candlemass
api.php?action=mobileview&page=Candlemass&sections=0|references [abrir na página de testes]
Obter informação sobre a secção 1 e seguintes e sobre as secções que contêm referências, da página Candlemass
api.php?action=mobileview&page=Candlemass&sections=1-|references [abrir na página de testes]

action=move

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Mover uma página.

Parâmetros:
from

Título da página cujo nome será alterado. Não pode ser usado em conjunto com fromid.

fromid

Identificador da página cujo nome será alterado. Não pode ser usado em conjunto com from.

Tipo: inteiro
to

Novo título da página.

Este parâmetro é obrigatório.
reason

Motivo para a alteração do nome.

Padrão: (vazio)
movetalk

Alterar o nome da página de discussão, se esta existir.

Tipo: booleano (detalhes)
movesubpages

Alterar o nome das subpáginas, se estas existirem.

Tipo: booleano (detalhes)
noredirect

Não criar um redirecionamento.

Tipo: booleano (detalhes)
watchlist

Adicionar ou remover incondicionalmente a página da lista de páginas vigiadas do utilizador atual, usar as preferências ou não alterar o estado de vigilância.

Um dos seguintes valores: watch, unwatch, preferences, nochange
Valor por omissão: preferences
ignorewarnings

Ignorar quaisquer avisos.

Tipo: booleano (detalhes)
tags

Etiquetas de modificação a aplicar à entrada no registo de movimentações e à revisão nula na página de destino.

Valores (separados com | ou alternativas):
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=multiupload-unpack

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Fonte: MultiUpload
  • Licença: GPL-2.0-or-later

Descomprimir um ficheiro ZIP ou tar antes de importar o seu conteúdo.

Parâmetros:
key

"filekey" (chave de ficheiro) obtida ao carregar o ficheiro comprimido para a área de ficheiros escondidos

filename

Nome do ficheiro comprimido

action=oathvalidate

  • Este módulo é interno ou instável. O seu funcionamento pode ser alterado sem aviso prévio.
  • Este módulo requer direitos de leitura.
  • Este módulo só aceita pedidos POST.
  • Fonte: OATHAuth
  • Licença: GPL-2.0-or-later AND GPL-3.0-or-later

Validar uma chave de autenticação de dois fatores (OATH).

Parâmetros:
user

O utilizador para o qual a chave será validada. Por omissão, o utilizador atual.

Tipo: nome de utilizador
totp

Chave para autenticação de dois fatores (OATH).

Este parâmetro é obrigatório.
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=opensearch

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Pesquisar a wiki usando o protocolo OpenSearch.

Parâmetros:
search

Texto a pesquisar.

Este parâmetro é obrigatório.
namespace

Espaços nominais a pesquisar. Ignorados se search começar com um prefixo de espaço nominal válido.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
Valor por omissão: 0
limit

O número máximo de resultados a serem devolvidos.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
suggest

Não fazer nada se $wgEnableOpenSearchSuggest for falso.

Tipo: booleano (detalhes)
redirects

Como tratar redirecionamentos:

return
Devolver o próprio redirecionamento.
resolve
Devolver a página de destino. Pode devolver menos de limit resultados.

Por razões históricas, o valor por omissão é "return" para o formato format=json e "resolve" para outros formatos.

Um dos seguintes valores: return, resolve
format

O formato do resultado.

Um dos seguintes valores: json, jsonfm, xml, xmlfm
Valor por omissão: json
warningsaserror

Se forem gerados avisos com format=json, devolver um erro da API em vez de ignorá-los.

Tipo: booleano (detalhes)
Exemplo:
Encontrar as páginas que começam por Te.
api.php?action=opensearch&search=Te [abrir na página de testes]

action=options

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Alterar as preferências do utilizador atual.

Só podem ser definidas as opções que estão registadas no núcleo do MediaWiki ou numa das extensões instaladas, ou opções cuja chave tem o prefixo userjs- (que são supostas ser usadas por scripts de utilizador).

Parâmetros:
reset

Reiniciar preferências para os valores por omissão do sítio.

Tipo: booleano (detalhes)
resetkinds

Lista dos tipos de opções a reiniciar quando a opção reset está definida.

Valores (separados com | ou alternativas): registered, registered-multiselect, registered-checkmatrix, userjs, special, unused, all
Valor por omissão: all
change

Listas das alterações, na forma nome=valor (isto é, skin=vector). Se não for fornecido nenhum valor (nem sequer um sinal de igualdade), por exemplo, nomedaopção|outraopção|..., a opção será reiniciada para o seu valor por omissão. Se qualquer dos valores passados contém uma barra vertical (|), use um separador alternativo para valores múltiplos de forma a obter o comportamento correto.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
optionname

O nome da opção que deve ser configurada com o valor dado por optionvalue.

optionvalue

O valor para a opção especificada por optionname.

token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=paraminfo

Obter informação sobre os módulos da API.

Parâmetros:
modules

Lista dos nomes dos módulos (valores dos parâmetros action e format, ou main). Podem ser especificados submódulos com +, ou todos os submódulos com +*, ou todos os submódulos de forma recursiva com +**.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
helpformat

Formato dos textos de ajuda.

Um dos seguintes valores: html, wikitext, raw, none
Valor por omissão: none
querymodules
Obsoleto.

Lista de nomes dos módulos a consultar (valores dos parâmetros prop, meta ou list). Usar modules=query+foo em vez de querymodules=foo.

Valores (separados com | ou alternativas): abusefilters, abuselog, allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allmessages, allpages, allredirects, allrevisions, alltransclusions, allusers, authmanagerinfo, backlinks, blocks, categories, categoryinfo, categorymembers, checkuser, checkuserlog, contributors, deletedrevisions, deletedrevs, duplicatefiles, embeddedin, extlinks, extracts, exturlusage, filearchive, filerepoinfo, fileusage, gadgetcategories, gadgets, imageinfo, images, imageusage, info, iwbacklinks, iwlinks, langbacklinks, langlinks, links, linkshere, logevents, mmsites, mystashedfiles, notifications, oath, pageimages, pagepropnames, pageprops, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, references, revisions, search, siteinfo, stashimageinfo, tags, templates, tokens, transcludedin, transcodestatus, unreadnotificationpages, usercontribs, userinfo, users, videoinfo, watchlist, watchlistraw
O número máximo de valores é 50 (500 para robôs).
mainmodule
Obsoleto.

Obter também informação sobre o módulo principal (do nível de topo). Em vez de usá-lo, usar modules=main.

pagesetmodule
Obsoleto.

Obter também informação sobre o módulo pageset (fornecendo titles= e restantes).

formatmodules
Obsoleto.

Lista de nomes de módulos de formato (valor do parâmetro format). Em vez de usá-lo, use modules.

Valores (separados com | ou alternativas): json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm

action=parse

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Faz a análise sintática do conteúdo e devolve o resultado da análise.

Consulte os vários módulos disponíveis no parâmetro prop de action=query para obter informação da versão atual de uma página.

Há várias formas de especificar o texto a analisar:

  1. Especificar uma página ou revisão, usando page, pageid ou oldid.
  2. Especificar o conteúdo de forma explícita, usando text, title, revid e contentmodel.
  3. Especificar só um resumo a analisar. prop deve receber o valor vazio.
Parâmetros:
title

Título da página à qual o texto pertence. Se omitido, é preciso especificar contentmodel e deve usar API como título.

text

Texto a analisar. Usar title ou contentmodel para controlar o modelo de conteúdo.

revid

Identificador da revisão, para {{REVISIONID}} e variáveis semelhantes.

Tipo: inteiro
summary

Resumo a analisar.

page

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

pageid

Analisar o conteúdo desta página. Tem precedência sobre page.

Tipo: inteiro
redirects

Se page ou pageid estiverem definidos para um redirecionamento, resolvê-lo.

Tipo: booleano (detalhes)
oldid

Analisar o conteúdo desta revisão. Tem precedência sobre page e pageid.

Tipo: inteiro
prop

As informações que devem ser obtidas:

text
Fornece o texto analisado resultante do texto wiki.
langlinks
Fornece as hiperligações interlínguas do texto wiki analisado.
categories
Fornece as categorias do texto wiki analisado.
categorieshtml
Fornece a versão HTML das categorias.
links
Fornece as hiperligações internas do texto wiki analisado.
templates
Fornece as predefinições do texto wiki analisado.
images
Fornece as imagens do texto wiki analisado.
externallinks
Fornece as hiperligações externas do texto wiki analisado.
sections
Fornece as secções do texto wiki analisado.
revid
Adiciona o identificador de revisão da página analisada.
displaytitle
Adiciona o título do texto wiki analisado.
headhtml
Fornece o <head> analisado da página.
modules
Fornece os módulos ResourceLoader usados na página. Para carregá-los, usar mw.loader.using(). Uma das variáveis jsconfigvars ou encodedjsconfigvars tem de ser pedida em conjunto com modules.
jsconfigvars
Fornece as variáveis de configuração JavaScript específicas da página. Para aplicá-las, usar mw.config.set().
encodedjsconfigvars
Fornece as variáveis de configuração JavaScript específicas da página, no formato de uma string JSON.
indicators
Fornece o HTML dos indicadores de estado de página que são usados na página.
iwlinks
Fornece as hiperligações interwikis do texto wiki analisado.
wikitext
Fornece o texto wiki original que foi analisado.
properties
Fornece várias propriedades definidas no texto analisado.
limitreportdata
Fornece o relatório de limites de forma estruturada. Não fornece dados quando disablelimitreport está definido.
limitreporthtml
Fornece a versão HTML do relatório de limites. Não fornece dados quando disablelimitreport está definido.
parsetree
A árvore de análise XML do conteúdo da revisão (requer o modelo de conteúdo wikitext).
parsewarnings
Fornece os avisos gerados durante a análise sintática do conteúdo.
headitems
Obsoleto. Fornece os elementos a colocar no <head> da página.
Valores (separados com | ou alternativas): text, langlinks, categories, categorieshtml, links, templates, images, externallinks, sections, revid, displaytitle, headhtml, modules, jsconfigvars, encodedjsconfigvars, indicators, iwlinks, wikitext, properties, limitreportdata, limitreporthtml, parsetree, parsewarnings, headitems
Valor por omissão: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
wrapoutputclass

A classe CSS a utilizar para envolver o resultado do analisador sintático.

Valor por omissão: mw-parser-output
pst

Fazer uma transformação anterior à gravação do texto de entrada, antes de analisá-lo. Só é válido quando usado com texto.

Tipo: booleano (detalhes)
onlypst

Fazer uma transformação anterior à gravação (PST, pre-save transform) do texto de entrada, mas não o analisar. Devolve o mesmo texto após aplicação da PST. Só é válido quando usado com text.

Tipo: booleano (detalhes)
effectivelanglinks
Obsoleto.

Inclui hiperligações interlínguas fornecidas por extensões (para ser usado com prop=langlinks).

Tipo: booleano (detalhes)
section

Analisar apenas o conteúdo desta secção.

Quando tiver o valor new, analisar text e sectiontitle como se fosse adicionar uma nova secção à página.

new só é permitido quando se especifica text.

sectiontitle

O novo título da secção quando section tem o valor new.

Ao contrário da edição de páginas, este não toma o valor de summary se for omitido ou estiver vazio.

disablepp
Obsoleto.

Em vez deste, usar disablelimitreport.

Tipo: booleano (detalhes)
disablelimitreport

Omitir o relatório de limites ("NewPP limit report") do resultado de saída do analisador sintático.

Tipo: booleano (detalhes)
disableeditsection

Omitir as hiperligações para edição da secção no resultado da análise sintática.

Tipo: booleano (detalhes)
disabletidy

Não fazer a limpeza do HTML (isto é, o tidy) no resultado da análise sintática.

Tipo: booleano (detalhes)
disablestylededuplication

Não desduplicar as folhas de estilo internas (etiquetas <style>) na saída do analisador sintático.

Tipo: booleano (detalhes)
generatexml
Obsoleto.

Gerar a árvore de análise XML (requer o modelo de conteúdo wikitext; substituído por prop=parsetree).

Tipo: booleano (detalhes)
preview

Executar a análise em modo de antevisão.

Tipo: booleano (detalhes)
sectionpreview

Executar a análise em modo de antevisão (também ativa o modo de antevisão).

Tipo: booleano (detalhes)
disabletoc

Omitir a tabela de conteúdo no resultado.

Tipo: booleano (detalhes)
useskin

Aplicar o tema selecionado ao resultado do analisador sintático. Pode afetar as seguintes propriedades: langlinks, headitems, modules, jsconfigvars, indicators.

Um dos seguintes valores: monobook, timeless, vector, cologneblue, modern, minerva
contentformat

O formato da seriação de conteúdo, usado para o texto de entrada. Só é válido quando usado com text.

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

Modelo de conteúdo do texto de entrada. Se omitido, title tem de ser especificado e o valor por omissão será o modelo do título especificado. Só é válido quando usado com text.

Um dos seguintes valores: GadgetDefinition, MassMessageListContent, Scribunto, wikitext, javascript, json, css, text
mobileformat

Devolver o resultado da análise sintática numa forma adequada para dispositivos móveis.

Tipo: booleano (detalhes)
noimages

Desativar imagens no resultado para dispositivos móveis.

Tipo: booleano (detalhes)
mainpage

Aplicar as transformações da página principal para dispositivos móveis.

Tipo: booleano (detalhes)
templatesandboxprefix

Prefixo da página de testes para predefinições, como especificado em Special:TemplateSandbox.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
templatesandboxtitle

Analisar a página usando templatesandboxtext em vez do conteúdo da página referida aqui.

templatesandboxtext

Analisar a página usando o conteúdo desta página, em vez da página referida na variável templatesandboxtext.

templatesandboxcontentmodel

Modelo de conteúdo de templatesandboxtext.

Um dos seguintes valores: GadgetDefinition, MassMessageListContent, Scribunto, wikitext, javascript, json, css, text
templatesandboxcontentformat

Formato de conteúdo de templatesandboxtext.

Um dos seguintes valores: application/json, text/plain, text/x-wiki, text/javascript, text/css
Exemplos:
Fazer a análise sintática de uma página.
api.php?action=parse&page=Project:Sandbox [abrir na página de testes]
Fazer a análise sintática do texto wiki.
api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext [abrir na página de testes]
Fazer a análise sintática do texto wiki, especificando o título da página.
api.php?action=parse&text={{PAGENAME}}&title=Test [abrir na página de testes]
Fazer a análise sintática de um resumo.
api.php?action=parse&summary=Some+[[link]]&prop= [abrir na página de testes]

action=patrol

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Patrulhar uma página ou revisão.

Parâmetros:
rcid

Identificador da mudança recente a patrulhar.

Tipo: inteiro
revid

Identificador da revisão a patrulhar.

Tipo: inteiro
tags

Etiquetas de modificação a aplicar à entrada no registo de edições patrulhadas.

Valores (separados com | ou alternativas):
token

Uma chave "patrol" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=protect

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

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

Parâmetros:
title

Título da página a proteger ou desproteger. Não pode ser usado em conjunto com pageid.

pageid

Identificador da página a proteger ou desproteger. Não pode ser usado em conjunto com title.

Tipo: inteiro
protections

Lista de níveis de proteção, na forma action=level (por exemplo, edit=sysop). O nível all significada que todos podem executar a operação, isto é, sem restrição.

Nota: Serão removidas as restrições de quaisquer operações não listadas.

Este parâmetro é obrigatório.
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
expiry

Datas e horas de expiração. Se só uma data e hora for definida, será usada para todas as proteções. Use infinite, indefinite, infinity ou never, para proteção sem expiração.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
Valor por omissão: infinite
reason

Motivo da proteção ou desproteção.

Padrão: (vazio)
tags

Etiquetas de modificação a aplicar à entrada no registo de proteções.

Valores (separados com | ou alternativas):
cascade

Ativar a proteção em cascata (isto é, proteger as predefinições transcluídas e as imagens usadas nesta página). Ignorado se nenhum dos níveis de proteção dados suportam a proteção em cascata.

Tipo: booleano (detalhes)
watch
Obsoleto.

Se definido, adicionar a página que está a ser protegida ou desprotegida às páginas vigiadas do utilizador atual.

Tipo: booleano (detalhes)
watchlist

Adicionar ou remover incondicionalmente a página da lista de páginas vigiadas do utilizador atual, usar as preferências ou não alterar o estado de vigilância.

Um dos seguintes valores: watch, unwatch, preferences, nochange
Valor por omissão: preferences
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=purge

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Limpar a cache para os títulos especificados.

Parâmetros:
forcelinkupdate

Atualizar as tabelas de hiperligações.

Tipo: booleano (detalhes)
forcerecursivelinkupdate

Atualizar a tabela de hiperligações, e atualizar as tabelas de hiperligações de qualquer página que usa esta página como modelo.

Tipo: booleano (detalhes)
continue

Quando houver mais resultados disponíveis, usar isto para continuar

titles

Uma lista dos títulos a serem trabalhados.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
pageids

Uma lista dos identificadores de página a serem trabalhados.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
revids

Uma lista dos identificadores de revisões a serem trabalhados.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
generator

Obter a lista de páginas nas quais trabalhar, executando o módulo de consulta especificado.

Nota: Os nomes dos parâmetros de geradores têm de ser prefixados com um "g", veja os exemplos.

allcategories
Enumerar todas as categorias.
alldeletedrevisions
Listar todas as revisões eliminadas por um utilizador ou de um espaço nominal.
allfileusages
Listar todas as utilizações de ficheiros, incluindo ficheiros que não existam.
allimages
Enumerar todas as imagens sequencialmente.
alllinks
Enumerar todas as hiperligações que apontam para um determinado espaço nominal.
allpages
Enumerar sequencialmente todas as páginas de um determinado espaço nominal.
allredirects
Listar todos os redirecionamentos para um espaço nominal.
allrevisions
Listar todas as revisões.
alltransclusions
Listar todas as transclusões (páginas incorporadas utilizando {{x}}), incluindo as que estejam em falta.
backlinks
Encontrar todas as páginas que contêm hiperligações para a página indicada.
categories
Listar todas as categorias às quais as páginas pertencem.
categorymembers
Listar todas as páginas numa categoria específica.
deletedrevisions
Obter informações sobre as revisões eliminadas.
duplicatefiles
Listar todos os ficheiros que são duplicados dos ficheiros indicados com base no seu resumo criptográfico.
embeddedin
Encontrar todas as páginas que incorporam (transcluem) o título indicado.
exturlusage
Enumerar as páginas que contêm um determinado URL.
fileusage
Encontrar todas as páginas que usam os ficheiros indicados.
images
Devolve todos os ficheiros contidos nas páginas indicadas.
imageusage
Encontrar todas as páginas que utilizam o título da imagem indicada.
iwbacklinks
Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
langbacklinks
Encontrar todas as páginas que contêm hiperligações para a hiperligação interlínguas indicada.
links
Devolve todas as hiperligações das páginas indicadas.
linkshere
Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
pageswithprop
Listar todas as páginas que usam uma determinada propriedade.
prefixsearch
Realizar uma procura de prefixo nos títulos de página.
protectedtitles
Listar todos os títulos cuja criação está impedida.
querypage
Obter uma lista fornecida por uma página especial baseada em consultas (QueryPage).
random
Obter um conjunto de páginas aleatórias.
recentchanges
Enumerar as mudanças recentes.
redirects
Devolve todos os redirecionamentos para as páginas indicadas.
revisions
Obter informação da revisão.
search
Efetuar uma pesquisa do texto integral.
templates
Devolve todas as páginas que são transcluídas nas páginas indicadas.
transcludedin
Obter todas as páginas que transcluem as páginas indicadas.
watchlist
Obter mudanças recentes das páginas vigiadas do utilizador atual.
watchlistraw
Obter todas as páginas na lista de páginas vigiadas do utilizador atual.
Um dos seguintes valores: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, 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

Resolver automaticamente os redirecionamentos listados nos parâmetros titles, pageids e revids, e nas páginas devolvidas por generator.

Tipo: booleano (detalhes)
converttitles

Converter os títulos noutras variantes de língua, se necessário. Só funciona se a língua de conteúdo da wiki suporta a conversão entre variantes. As línguas que suportam conversão entre variantes incluem en, crh, gan, iu, kk, ku, shi, sr, tg, uz i zh.

Tipo: booleano (detalhes)

action=query

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter dados de, e sobre, o MediaWiki.

Todas as modificações de dados terão primeiro que usar uma consulta para adquirir uma chave, o que visa impedir abusos de sítios maliciosos.

Parâmetros:
prop

As propriedades a serem obtidas para as páginas consultadas.

categories
Listar todas as categorias às quais as páginas pertencem.
categoryinfo
Devolve informação sobre as categorias indicadas.
contributors
Obter a lista do contribuidores autenticados e a contagem dos contribuidores anónimos de uma página.
deletedrevisions
Obter informações sobre as revisões eliminadas.
duplicatefiles
Listar todos os ficheiros que são duplicados dos ficheiros indicados com base no seu resumo criptográfico.
extlinks
Devolve todos os URL externos (que não sejam interwikis) das páginas especificadas.
extracts
Fornece extratos do conteúdo das páginas indicadas, em texto simples ou HTML limitado.
fileusage
Encontrar todas as páginas que usam os ficheiros indicados.
imageinfo
Devolve informação do ficheiro e o historial de carregamentos.
images
Devolve todos os ficheiros contidos nas páginas indicadas.
info
Obter a informação básica da página.
iwlinks
Devolve todas as hiperligações interwikis das páginas indicadas.
langlinks
Devolve todas as hiperligações interlínguas das páginas indicadas.
links
Devolve todas as hiperligações das páginas indicadas.
linkshere
Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
pageimages
Devolve informação sobre as imagens de uma página, tais como miniaturas e a presença de fotografias.
pageprops
Obter várias propriedades de página definidas no conteúdo da página.
redirects
Devolve todos os redirecionamentos para as páginas indicadas.
references
Devolver uma representação de dados, das referências associadas com as páginas especificadas.
revisions
Obter informação da revisão.
stashimageinfo
Devolve informações dos ficheiros escondidos.
templates
Devolve todas as páginas que são transcluídas nas páginas indicadas.
transcludedin
Obter todas as páginas que transcluem as páginas indicadas.
transcodestatus
Obter o estado da transcodificação de um dado ficheiro.
videoinfo
Expande imageinfo para incluir informações sobre a fonte (e obras derivadas) do vídeo
Valores (separados com | ou alternativas): categories, categoryinfo, contributors, deletedrevisions, duplicatefiles, extlinks, extracts, fileusage, imageinfo, images, info, iwlinks, langlinks, links, linkshere, pageimages, pageprops, redirects, references, revisions, stashimageinfo, templates, transcludedin, transcodestatus, videoinfo
list

As listas a serem obtidas.

abusefilters
Mostrar detalhes dos filtros de abuso.
abuselog
Mostrar os eventos que foram detetados por um dos filtros de abuso.
allcategories
Enumerar todas as categorias.
alldeletedrevisions
Listar todas as revisões eliminadas por um utilizador ou de um espaço nominal.
allfileusages
Listar todas as utilizações de ficheiros, incluindo ficheiros que não existam.
allimages
Enumerar todas as imagens sequencialmente.
alllinks
Enumerar todas as hiperligações que apontam para um determinado espaço nominal.
allpages
Enumerar sequencialmente todas as páginas de um determinado espaço nominal.
allredirects
Listar todos os redirecionamentos para um espaço nominal.
allrevisions
Listar todas as revisões.
alltransclusions
Listar todas as transclusões (páginas incorporadas utilizando {{x}}), incluindo as que estejam em falta.
allusers
Enumerar todos os utilizadores registados.
backlinks
Encontrar todas as páginas que contêm hiperligações para a página indicada.
blocks
Listar todos os utilizadores e endereços IP bloqueados.
categorymembers
Listar todas as páginas numa categoria específica.
checkuser
Verificar que endereços IP são usados por determinado nome de utilizador ou que nomes de utilizador são usados por um determinado endereço IP.
checkuserlog
Obter entradas do registo de verificação de utilizadores.
embeddedin
Encontrar todas as páginas que incorporam (transcluem) o título indicado.
exturlusage
Enumerar as páginas que contêm um determinado URL.
filearchive
Enumerar todos os ficheiros eliminados sequencialmente.
gadgetcategories
Devolve uma lista de categorias de gadgets.
gadgets
Devolve uma lista dos gadgets usados nesta wiki.
imageusage
Encontrar todas as páginas que utilizam o título da imagem indicada.
iwbacklinks
Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
langbacklinks
Encontrar todas as páginas que contêm hiperligações para a hiperligação interlínguas indicada.
logevents
Obter eventos dos registos.
mmsites
Atender os pedidos de preenchimento automático para o campo do sítio em MassMessage.
mystashedfiles
Obter uma lista dos ficheiros que estão na área de ficheiros escondidos do utilizador atual.
pagepropnames
Listar todos os nomes de propriedades de páginas em uso nesta wiki.
pageswithprop
Listar todas as páginas que usam uma determinada propriedade.
prefixsearch
Realizar uma procura de prefixo nos títulos de página.
protectedtitles
Listar todos os títulos cuja criação está impedida.
querypage
Obter uma lista fornecida por uma página especial baseada em consultas (QueryPage).
random
Obter um conjunto de páginas aleatórias.
recentchanges
Enumerar as mudanças recentes.
search
Efetuar uma pesquisa do texto integral.
tags
Listar as etiquetas de modificação.
usercontribs
Obter todas as edições de um utilizador.
users
Obter informações sobre uma lista de utilizadores.
watchlist
Obter mudanças recentes das páginas vigiadas do utilizador atual.
watchlistraw
Obter todas as páginas na lista de páginas vigiadas do utilizador atual.
deletedrevs
Obsoleto. Listar as revisões eliminadas.
Valores (separados com | ou alternativas): abusefilters, abuselog, allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, allusers, backlinks, blocks, categorymembers, checkuser, checkuserlog, embeddedin, exturlusage, filearchive, gadgetcategories, gadgets, imageusage, iwbacklinks, langbacklinks, logevents, mmsites, mystashedfiles, pagepropnames, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, search, tags, usercontribs, users, watchlist, watchlistraw, deletedrevs
meta

Os metadados a serem obtidos.

allmessages
Devolver as mensagens deste sítio.
authmanagerinfo
Obter informação sobre o atual estado de autenticação.
filerepoinfo
Devolver meta informação sobre os repositórios de imagens configurados na wiki.
notifications
Obter notificações à espera do utilizador atual.
oath
Verificar se a autenticação de dois fatores (OATH) está ativa para um utilizador.
siteinfo
Devolver informação geral sobre o sítio.
tokens
Obtém chaves para operações de modificação de dados.
unreadnotificationpages
Obter as páginas que contêm notificações não lidas para o utilizador atual.
userinfo
Obter informações sobre o utilizador atual.
Valores (separados com | ou alternativas): allmessages, authmanagerinfo, filerepoinfo, notifications, oath, siteinfo, tokens, unreadnotificationpages, userinfo
indexpageids

Incluir uma secção adicional de identificadores de página que lista todos os identificadores de página devolvidos.

Tipo: booleano (detalhes)
export

Exportar as revisões atuais de todas as páginas fornecidas ou geradas.

Tipo: booleano (detalhes)
exportnowrap

Devolver o XML de exportação sem envolvê-lo num resultado XML (o mesmo formato que Special:Export). Só pode ser usado com query+export.

Tipo: booleano (detalhes)
iwurl

Indica se deve ser obtido o URL completo quando o título é uma hiperligação interwikis.

Tipo: booleano (detalhes)
continue

Quando houver mais resultados disponíveis, usar isto para continuar

rawcontinue

Devolver os dados em bruto de query-continue para continuar.

Tipo: booleano (detalhes)
titles

Uma lista dos títulos a serem trabalhados.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
pageids

Uma lista dos identificadores de página a serem trabalhados.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
revids

Uma lista dos identificadores de revisões a serem trabalhados.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
generator

Obter a lista de páginas nas quais trabalhar, executando o módulo de consulta especificado.

Nota: Os nomes dos parâmetros de geradores têm de ser prefixados com um "g", veja os exemplos.

allcategories
Enumerar todas as categorias.
alldeletedrevisions
Listar todas as revisões eliminadas por um utilizador ou de um espaço nominal.
allfileusages
Listar todas as utilizações de ficheiros, incluindo ficheiros que não existam.
allimages
Enumerar todas as imagens sequencialmente.
alllinks
Enumerar todas as hiperligações que apontam para um determinado espaço nominal.
allpages
Enumerar sequencialmente todas as páginas de um determinado espaço nominal.
allredirects
Listar todos os redirecionamentos para um espaço nominal.
allrevisions
Listar todas as revisões.
alltransclusions
Listar todas as transclusões (páginas incorporadas utilizando {{x}}), incluindo as que estejam em falta.
backlinks
Encontrar todas as páginas que contêm hiperligações para a página indicada.
categories
Listar todas as categorias às quais as páginas pertencem.
categorymembers
Listar todas as páginas numa categoria específica.
deletedrevisions
Obter informações sobre as revisões eliminadas.
duplicatefiles
Listar todos os ficheiros que são duplicados dos ficheiros indicados com base no seu resumo criptográfico.
embeddedin
Encontrar todas as páginas que incorporam (transcluem) o título indicado.
exturlusage
Enumerar as páginas que contêm um determinado URL.
fileusage
Encontrar todas as páginas que usam os ficheiros indicados.
images
Devolve todos os ficheiros contidos nas páginas indicadas.
imageusage
Encontrar todas as páginas que utilizam o título da imagem indicada.
iwbacklinks
Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
langbacklinks
Encontrar todas as páginas que contêm hiperligações para a hiperligação interlínguas indicada.
links
Devolve todas as hiperligações das páginas indicadas.
linkshere
Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
pageswithprop
Listar todas as páginas que usam uma determinada propriedade.
prefixsearch
Realizar uma procura de prefixo nos títulos de página.
protectedtitles
Listar todos os títulos cuja criação está impedida.
querypage
Obter uma lista fornecida por uma página especial baseada em consultas (QueryPage).
random
Obter um conjunto de páginas aleatórias.
recentchanges
Enumerar as mudanças recentes.
redirects
Devolve todos os redirecionamentos para as páginas indicadas.
revisions
Obter informação da revisão.
search
Efetuar uma pesquisa do texto integral.
templates
Devolve todas as páginas que são transcluídas nas páginas indicadas.
transcludedin
Obter todas as páginas que transcluem as páginas indicadas.
watchlist
Obter mudanças recentes das páginas vigiadas do utilizador atual.
watchlistraw
Obter todas as páginas na lista de páginas vigiadas do utilizador atual.
Um dos seguintes valores: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, 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

Resolver automaticamente os redirecionamentos listados nos parâmetros query+titles, query+pageids e query+revids, e nas páginas devolvidas por query+generator.

Tipo: booleano (detalhes)
converttitles

Converter os títulos noutras variantes de língua, se necessário. Só funciona se a língua de conteúdo da wiki suporta a conversão entre variantes. As línguas que suportam conversão entre variantes incluem en, crh, gan, iu, kk, ku, shi, sr, tg, uz i zh.

Tipo: booleano (detalhes)

prop=categories (cl)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Listar todas as categorias às quais as páginas pertencem.

Parâmetros:
clprop

As propriedades adicionais que devem ser obtidas para cada categoria:

sortkey
Adiciona a chave de ordenação (string hexadecimal) e o prefixo da chave de ordenação (parte legível) da categoria.
timestamp
Adiciona a data e hora a que a categoria foi adicionada.
hidden
Etiqueta as categorias que estão ocultadas com __HIDDENCAT__.
Valores (separados com | ou alternativas): sortkey, timestamp, hidden
clshow

Os tipos de categorias que serão mostrados.

Valores (separados com | ou alternativas): hidden, !hidden
cllimit

O número de categorias a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
clcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

clcategories

Listar só estas categorias. Útil para verificar se uma determinada página está numa determinada categoria.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
cldir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
Exemplos:
Obter uma lista das categorias às quais pertence a página Albert Einstein.
api.php?action=query&prop=categories&titles=Albert%20Einstein [abrir na página de testes]
Obter informação sobre todas as categorias usadas na página Albert Einstein.
api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info [abrir na página de testes]

prop=categoryinfo (ci)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolve informação sobre as categorias indicadas.

Parâmetro:
cicontinue

Quando houver mais resultados disponíveis, usar isto para continuar

prop=contributors (pc)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter a lista do contribuidores autenticados e a contagem dos contribuidores anónimos de uma página.

Parâmetros:
pcgroup

Incluir só os utilizadores nos grupos indicados. Não inclui os grupos implícitos ou de promoção automática como *, utilizador, ou autoconfirmado.

Valores (separados com | ou alternativas): bot, sysop, bureaucrat, emailconfirmed, rollback, checkuser, staff
pcexcludegroup

Excluir os utilizadores nos grupos indicados. Não inclui os grupos implícitos ou de promoção automática como *, utilizador, ou autoconfirmado.

Valores (separados com | ou alternativas): bot, sysop, bureaucrat, emailconfirmed, rollback, checkuser, staff
pcrights

Incluir só os utilizadores com as permissões indicadas. Não inclui as permissões atribuídas por grupos implícitos ou de promoção automática como *, utilizador, ou autoconfirmado.

Valores (separados com | ou alternativas): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjson, editmyuserjs, editmywatchlist, editsemiprotected, editusercss, edituserjson, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, patrol, patrolmarks, protect, 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, gadgets-edit, gadgets-definition-edit, oathauth-enable, oathauth-api-all, spamblacklistlog, tboverride, tboverride-account, titleblacklistlog, abusefilter-modify, abusefilter-log-detail, abusefilter-view, abusefilter-log, abusefilter-private, abusefilter-private-log, abusefilter-modify-restricted, abusefilter-revert, abusefilter-view-private, abusefilter-log-private, abusefilter-hidden-log, abusefilter-hide-log, abusefilter-modify-global, checkuser, checkuser-log, welcomeexempt, massmessage, nuke, replacetext, renameuser, refreshspecial, usermerge, dpl_param_update_rules, dpl_param_delete_rules, skipcaptcha, transcode-reset, transcode-status, poll-admin, poll-create, poll-vote, poll-score, interwiki
O número máximo de valores é 50 (500 para robôs).
pcexcluderights

Excluir os utilizadores com as permissões indicadas. Não inclui as permissões atribuídas por grupos implícitos ou de promoção automática como *, utilizador, ou autoconfirmado.

Valores (separados com | ou alternativas): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjson, editmyuserjs, editmywatchlist, editsemiprotected, editusercss, edituserjson, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, patrol, patrolmarks, protect, 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, gadgets-edit, gadgets-definition-edit, oathauth-enable, oathauth-api-all, spamblacklistlog, tboverride, tboverride-account, titleblacklistlog, abusefilter-modify, abusefilter-log-detail, abusefilter-view, abusefilter-log, abusefilter-private, abusefilter-private-log, abusefilter-modify-restricted, abusefilter-revert, abusefilter-view-private, abusefilter-log-private, abusefilter-hidden-log, abusefilter-hide-log, abusefilter-modify-global, checkuser, checkuser-log, welcomeexempt, massmessage, nuke, replacetext, renameuser, refreshspecial, usermerge, dpl_param_update_rules, dpl_param_delete_rules, skipcaptcha, transcode-reset, transcode-status, poll-admin, poll-create, poll-vote, poll-score, interwiki
O número máximo de valores é 50 (500 para robôs).
pclimit

O número de contribuidores a serem devolvidos.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
pccontinue

Quando houver mais resultados disponíveis, usar isto para continuar

Exemplo:
Mostrar os contribuidores da página Main Page.
api.php?action=query&prop=contributors&titles=Main_Page [abrir na página de testes]

prop=deletedrevisions (drv)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter informações sobre as revisões eliminadas.

Pode ser usado de várias maneiras:

  1. Obter as revisões eliminadas para um conjunto de páginas, definindo títulos ou identificadores de página. Ordenados por título e data e hora.
  2. Obter dados sobre um conjunto de revisões eliminadas definindo os respetivos ids: com identificadores de revisão. Ordenados pelo identificador de revisão.
Parâmetros:
drvprop

As propriedades a serem obtidas para cada revisão:

ids
O identificador da revisão.
flags
As etiquetas da revisão (menor).
timestamp
A data e hora da revisão.
user
O utilizador que fez a revisão.
userid
O identificador de utilizador do criador da revisão.
size
O tamanho (em bytes) da revisão.
sha1
O resumo criptográfico SHA-1 (na base 16) da revisão.
contentmodel
O identificador do modelo de conteúdo da revisão.
comment
O comentário do utilizador para a revisão.
parsedcomment
O comentário do utilizador para a revisão, após a análise sintática.
content
O texto da revisão.
tags
As etiquetas para a revisão.
parsetree
Descontinuado. Em substituição, use action=expandtemplates ou action=parse. A árvore de análise XML do conteúdo da revisão (requer o modelo de conteúdo wikitext).
Valores (separados com | ou alternativas): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
Valor por omissão: ids|timestamp|flags|comment|user
drvlimit

Limitar o número de revisões que serão devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
drvexpandtemplates
Obsoleto.

Em substituição, use action=expandtemplates. Expandir predefinições no conteúdo da revisão (requer drvprop=content).

Tipo: booleano (detalhes)
drvgeneratexml
Obsoleto.

Em substituição, use action=expandtemplates ou action=parse. Gerar a árvore de análise sintática em XML do conteúdo da revisão (requer drvprop=content).

Tipo: booleano (detalhes)
drvparse
Obsoleto.

Em substituição, use action=parse. Fazer a análise sintática do conteúdo da revisão (requer drvprop=content). Por motivos de desempenho, se esta opção for usada drvlimit é forçado a ser 1.

Tipo: booleano (detalhes)
drvsection

Obter apenas o conteúdo da secção que tem este número.

drvdiffto
Obsoleto.

Em substituição, use action=compare. O identificador da revisão contra a qual será tirada uma lista de diferenças de cada revisão. Usar prev (anterior), next (seguinte) e cur (atual).

drvdifftotext
Obsoleto.

Em substituição, use action=compare. O texto contra o qual será tirada uma lista de diferenças de cada revisão. Só produz as diferenças para um número limitado de revisões. Tem precedência sobre drvdiffto. Se drvsection estiver definido, só o conteúdo dessa secção será comparado contra o texto.

drvdifftotextpst
Obsoleto.

Em substituição, use action=compare. Fazer uma transformação anterior à gravação do texto, antes de calcular as diferenças. Só é válido quando usado com drvdifftotext.

Tipo: booleano (detalhes)
drvcontentformat

O formato de seriação usado para drvdifftotext e esperado para o conteúdo produzido.

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

A data e hora da revisão a partir da qual será começada a enumeração. Ignorado ao processar uma lista de identificadores de revisão.

Tipo: data e hora (formatos permitidos)
drvend

A data e hora da revisão na qual será terminada a enumeração. Ignorado ao processar uma lista de identificadores de revisão.

Tipo: data e hora (formatos permitidos)
drvdir

A direção da enumeração:

newer
Listar o mais antigo primeiro. Nota: drvstart tem de estar antes de drvend.
older
Listar o mais recente primeiro (padrão). Nota: drvstart tem de estar depois de drvend.
Um dos seguintes valores: newer, older
Valor por omissão: older
drvtag

Listar só as revisões marcadas com esta etiqueta.

drvuser

Listar só as revisões deste utilizador.

Tipo: nome de utilizador
drvexcludeuser

Não listar as revisões deste utilizador.

Tipo: nome de utilizador
drvcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

Exemplos:
Listar as revisões eliminadas das páginas Main Page e Talk:Main Page, com o conteúdo.
api.php?action=query&prop=deletedrevisions&titles=Main%20Page|Talk:Main%20Page&drvprop=user|comment|content [abrir na página de testes]
Listar a informação da revisão eliminada 123456.
api.php?action=query&prop=deletedrevisions&revids=123456 [abrir na página de testes]

prop=duplicatefiles (df)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Listar todos os ficheiros que são duplicados dos ficheiros indicados com base no seu resumo criptográfico.

Parâmetros:
dflimit

O número de ficheiros duplicados a serem devolvidos.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
dfcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

dfdir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
dflocalonly

Procurar ficheiros só no repositório local.

Tipo: booleano (detalhes)
  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolve todos os URL externos (que não sejam interwikis) das páginas especificadas.

Parâmetros:
ellimit

O número de hiperligações a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
eloffset

Quando houver mais resultados disponíveis, usar isto para continuar

Tipo: inteiro
elprotocol

Protocolo do URL. Se vazio e elquery está definido, o protocolo é http. Deixe este parâmetro e elquery vazios para listar todas as hiperligações externas.

Um dos seguintes valores: Pode estar vazio, ou ser 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

Texto de pesquisa sem protocolo. Útil para verificar se uma determinada página contém um determinado URL externo.

elexpandurl

Expandir os URL relativos a protocolo com o protocolo canónico.

Tipo: booleano (detalhes)
Exemplo:
Obter uma lista das hiperligações externas da Main Page.
api.php?action=query&prop=extlinks&titles=Main%20Page [abrir na página de testes]

prop=extracts (ex)

  • Este módulo requer direitos de leitura.
  • Fonte: TextExtracts
  • Licença: GPL-2.0-or-later

Fornece extratos do conteúdo das páginas indicadas, em texto simples ou HTML limitado.

Parâmetros:
exchars

Quantos caracteres devem ser devolvidos. O texto devolvido pode ser ligeiramente mais longo.

O valor tem de estar compreendido entre 1 e 1 200.
Tipo: inteiro
exsentences

Quantas frases devem ser devolvidas.

O valor tem de estar compreendido entre 1 e 10.
Tipo: inteiro
exlimit

Quantos extratos devem ser devolvidos. (Se pode ser devolvido mais do que um extrato se 'exintro' tiver o valor "true", verdadeiro).

Não são permitidos mais do que 20 (20 para robôs).
Tipo: inteiro ou max
Valor por omissão: 20
exintro

Devolver só o conteúdo antes da primeira secção.

Tipo: booleano (detalhes)
explaintext

Devolver extratos em texto simples em vez de HTML limitado.

Tipo: booleano (detalhes)
exsectionformat

Como formatar as secções no modo de texto simples:

plain
Sem formatação.
wiki
Formatação ao estilo de texto wiki (== assim ==)
raw
A representação interna deste módulo (títulos de secção com os prefixos <ASCII 1><ASCII 2><nível de secção><ASCII 2><ASCII 1>).
Um dos seguintes valores: plain, wiki, raw
Valor por omissão: wiki
excontinue

Quando houver mais resultados disponíveis, usar isto para continuar

Tipo: inteiro

prop=fileusage (fu)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Encontrar todas as páginas que usam os ficheiros indicados.

Parâmetros:
fuprop

As propriedades a serem obtidas:

pageid
O identificador de cada página.
title
O título de cada página.
redirect
Indicar se a página é um redirecionamento.
Valores (separados com | ou alternativas): pageid, title, redirect
Valor por omissão: pageid|title|redirect
funamespace

Incluir só as páginas destes espaços nominais.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
fushow

Mostrar só as páginas que correspondem a estes critérios:

redirect
Mostrar só os redirecionamentos.
!redirect
Mostrar só os não redirecionamentos.
Valores (separados com | ou alternativas): redirect, !redirect
fulimit

O número de elementos a serem devolvidos.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
fucontinue

Quando houver mais resultados disponíveis, usar isto para continuar

prop=imageinfo (ii)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolve informação do ficheiro e o historial de carregamentos.

Parâmetros:
iiprop

As informações do ficheiro que devem ser obtidas:

timestamp
Adiciona a data e hora da versão carregada.
user
Adiciona o utilizador que carregou cada versão de ficheiro.
userid
Adiciona o identificador do utilizador que carregou cada versão de ficheiro.
comment
O comentário da versão.
parsedcomment
Fazer a análise sintática do comentário da versão.
canonicaltitle
Adiciona o título canónico do ficheiro.
url
Devolve URL para o ficheiro e página de descrição.
size
Adiciona o tamanho do ficheiro em bytes e a altura, largura e contagem de páginas (se aplicável).
dimensions
Nome alternativo para size.
sha1
Adiciona o resumo criptográfico SHA-1 do ficheiro.
mime
Adiciona o tipo MIME do ficheiro.
thumbmime
Adiciona o tipo MIME da miniatura (requer URL e o parâmetro iiurlwidth).
mediatype
Adiciona o tipo de multimédia do ficheiro.
metadata
Lista os metadados Exif para a versão do ficheiro.
commonmetadata
Lista os metadados genéricos do formato de ficheiro para a versão do ficheiro.
extmetadata
Lista os metadados formatados, combinados de várias fontes. Os resultados estão no formato HTML.
archivename
Adiciona o nome de ficheiro da versão arquivada das versões anteriores à última.
bitdepth
Adiciona a profundidade em bits da versão.
uploadwarning
Usado pela página Special:Upload para obter informação sobre um ficheiro existente. Não se destina a ser usado fora do núcleo central do MediaWiki.
badfile
Indica se o ficheiro está na lista MediaWiki:Bad image list
Valores (separados com | ou alternativas): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, thumbmime, mediatype, metadata, commonmetadata, extmetadata, archivename, bitdepth, uploadwarning, badfile
Valor por omissão: timestamp|user
iilimit

O número de revisões a serem devolvidas por ficheiro.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 1
iistart

Data e hora a partir da qual será começada a listagem.

Tipo: data e hora (formatos permitidos)
iiend

Data e hora na qual será terminada a listagem.

Tipo: data e hora (formatos permitidos)
iiurlwidth

Se iiprop=url está definido, será devolvido um URL para uma imagem redimensionada com este comprimento. Por razões de desempenho, se esta opção for usada não serão devolvidas mais de 50 imagens redimensionadas.

Tipo: inteiro
Valor por omissão: -1
iiurlheight

Semelhante a iiurlwidth.

Tipo: inteiro
Valor por omissão: -1
iimetadataversion

Versão de metadados a ser usada. Se for especificado o valor latest, usar a versão mais recente. Por omissão tem o valor 1 para compatibilidade com versões anteriores.

Valor por omissão: 1
iiextmetadatalanguage

Em que língua obter extmetadata. Isto afeta tanto a tradução que será obtida, caso existam várias, como a formatação de números e vários outros valores.

Valor por omissão: mwl
iiextmetadatamultilang

Se estiverem disponíveis traduções para a propriedade extmetadata, obtê-las todas.

Tipo: booleano (detalhes)
iiextmetadatafilter

Se for especificado e não estiver vazio, só serão devolvidas estas chaves para iiprop=extmetadata.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
iiurlparam

Um parâmetro de texto específico do objeto. Por exemplo, ficheiros PDF podem usar page15-100px. iiurlwidth tem de ser usado e ser consistente com iiurlparam.

Padrão: (vazio)
iibadfilecontexttitle

Se badfilecontexttitleprop=badfile estiver definido, este é o título da página usado ao calcular a MediaWiki:Bad image list

iicontinue

Quando houver mais resultados disponíveis, usar isto para continuar

iilocalonly

Procurar ficheiros só no repositório local.

Tipo: booleano (detalhes)

prop=images (im)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolve todos os ficheiros contidos nas páginas indicadas.

Parâmetros:
imlimit

O número de ficheiros a serem devolvidos.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
imcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

imimages

Listar só estes ficheiros. Útil para verificar se uma determinada página tem um determinado ficheiro.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
imdir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending

prop=info (in)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

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

Parâmetros:
inprop

As propriedades adicionais que devem ser obtidas:

protection
Listar o nível de proteção de cada página.
talkid
O identificador da página de discussão de cada página que não seja de discussão.
watched
Listar o estado de vigilância de cada página.
watchers
O número de vigilantes, se for permitido.
visitingwatchers
O número de vigilantes de cada página que visitaram edições recentes dessa página, se permitido.
notificationtimestamp
A data e hora das notificações de alterações de cada página vigiada.
subjectid
O identificador da página progenitora de cada página de discussão.
url
Fornece um URL completo, um URL de edição e o URL canónico, para cada página.
readable
Indica se o utilizador pode ler esta página.
preload
Fornece o texto devolvido por EditFormPreloadText.
displaytitle
Fornece a forma como o título da página é apresentado.
varianttitles
Fornece o título de apresentação em todas as variantes da língua de conteúdo da wiki.
Valores (separados com | ou alternativas): protection, talkid, watched, watchers, visitingwatchers, notificationtimestamp, subjectid, url, readable, preload, displaytitle, varianttitles
intestactions

Testar se o utilizador pode realizar certas operações na página.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
intoken
Obsoleto.

Em substituição, usar action=query&meta=tokens.

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

Quando houver mais resultados disponíveis, usar isto para continuar

Exemplos:
Obter informações sobre a página Main Page.
api.php?action=query&prop=info&titles=Main%20Page [abrir na página de testes]
Obter informação geral e de proteção sobre a página Main Page.
api.php?action=query&prop=info&inprop=protection&titles=Main%20Page [abrir na página de testes]
  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolve todas as hiperligações interwikis das páginas indicadas.

Parâmetros:
iwprop

As propriedades adicionais que devem ser obtidas para cada hiperligação interlínguas:

url
Adiciona o URL completo.
Valores (separados com | ou alternativas): url
iwprefix

Devolver só as hiperligações interwikis com este prefixo.

iwtitle

Hiperligação interwikis a ser procurada. Tem de ser usado em conjunto com iwprefix.

iwdir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
iwlimit

O número de hiperligações interwikis a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
iwcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

iwurl
Obsoleto.

Indica se deve ser obtido o URL completo (não pode ser usado com iwprop).

Tipo: booleano (detalhes)
Exemplo:
Obter as hiperligações interwikis da página Main Page.
api.php?action=query&prop=iwlinks&titles=Main%20Page [abrir na página de testes]
  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolve todas as hiperligações interlínguas das páginas indicadas.

Parâmetros:
llprop

As propriedades adicionais que devem ser obtidas para cada hiperligação interlínguas:

url
Adiciona o URL completo.
langname
Adiciona o nome da língua localizado (melhor esforço). Usar llinlanguagecode para controlar a língua.
autonym
Adiciona o nome nativo da língua.
Valores (separados com | ou alternativas): url, langname, autonym
lllang

Devolver só as hiperligações interlínguas com este código de língua.

lltitle

A hiperligação a ser procurada. Tem de ser usado com lllang.

lldir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
llinlanguagecode

O código de língua para os nomes de língua localizados.

Valor por omissão: mwl
lllimit

O número de hiperligações interlínguas a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
llcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

llurl
Obsoleto.

Indica se deve ser obtido o URL completo (não pode ser usado com llprop).

Tipo: booleano (detalhes)
Exemplo:
Obter as hiperligações interlínguas da página Main Page.
api.php?action=query&prop=langlinks&titles=Main%20Page&redirects= [abrir na página de testes]
  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolve todas as hiperligações das páginas indicadas.

Parâmetros:
plnamespace

Mostrar apenas as hiperligações destes espaços nominais.

Valores (separados com | ou alternativas): -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
pllimit

O número de hiperligações a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
plcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

pltitles

Listar só as hiperligações para estes títulos. Útil para verificar se uma determinada página contém hiperligações para um determinado título.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
pldir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
Exemplos:
Obter as hiperligações da página Main Page.
api.php?action=query&prop=links&titles=Main%20Page [abrir na página de testes]
Obter informação sobre as páginas ligadas na página Main Page.
api.php?action=query&generator=links&titles=Main%20Page&prop=info [abrir na página de testes]
Obter as hiperligações da página Main Page nos espaços nominais Outelizador(a) e Modelo.
api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10 [abrir na página de testes]

prop=linkshere (lh)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.

Parâmetros:
lhprop

As propriedades a serem obtidas:

pageid
O identificador de cada página.
title
O título de cada página.
redirect
Indicar se a página é um redirecionamento.
Valores (separados com | ou alternativas): pageid, title, redirect
Valor por omissão: pageid|title|redirect
lhnamespace

Incluir só as páginas nestes espaços nominais.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
lhshow

Mostrar só as páginas que correspondem a estes critérios:

redirect
Mostrar só os redirecionamentos.
!redirect
Mostrar só os não redirecionamentos.
Valores (separados com | ou alternativas): redirect, !redirect
lhlimit

O número de páginas a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
lhcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

Exemplos:
Obter uma lista das páginas com hiperligações para a página Main Page.
api.php?action=query&prop=linkshere&titles=Main%20Page [abrir na página de testes]
Obter informação sobre as páginas com hiperligações para a página Main Page.
api.php?action=query&generator=linkshere&titles=Main%20Page&prop=info [abrir na página de testes]

prop=pageimages (pi)

  • Este módulo requer direitos de leitura.
  • Fonte: PageImages
  • Licença: WTFPL

Devolve informação sobre as imagens de uma página, tais como miniaturas e a presença de fotografias.

Parâmetros:
piprop

A informação a ser devolvida:

thumbnail
O URL e as dimensões da miniatura associada à página, se existir.
original
O URL e as dimensões originais da imagem associada à página, se existir.
name
O título da imagem.
Valores (separados com | ou alternativas): thumbnail, name, original
Valor por omissão: thumbnail|name
pithumbsize

Largura máxima em píxeis das imagens das miniaturas.

Tipo: inteiro
Valor por omissão: 50
pilimit

Devolver as propriedades de quantas imagens.

Não são permitidos mais do que 50 (100 para robôs).
Tipo: inteiro ou max
Valor por omissão: 50
pilicense

Limitar as imagens da página às que tenham um certo tipo de licença

Um dos seguintes valores: free, any
Valor por omissão: free
picontinue

Quando houver mais resultados disponíveis, usar isto para continuar

Tipo: inteiro
Exemplo:
Obter o nome e uma miniatura de 100 píxeis de uma imagem na página Albert Einstein.
api.php?action=query&prop=pageimages&titles=Albert%20Einstein&pithumbsize=100 [abrir na página de testes]

prop=pageprops (pp)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter várias propriedades de página definidas no conteúdo da página.

Parâmetros:
ppcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

ppprop

Listar só estas propriedades de página (action=query&list=pagepropnames devolve os nomes das propriedades de página em uso). Útil para verificar se as páginas usam uma determinada propriedade de página.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
Exemplo:
Obter as propriedades das páginas Main Page e MediaWiki.
api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki [abrir na página de testes]

prop=redirects (rd)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolve todos os redirecionamentos para as páginas indicadas.

Parâmetros:
rdprop

As propriedades a serem obtidas:

pageid
O identificador de página de cada redirecionamento.
title
O título de cada redirecionamento.
fragment
O fragmento de cada redirecionamento, se existir.
Valores (separados com | ou alternativas): pageid, title, fragment
Valor por omissão: pageid|title
rdnamespace

Incluir só as páginas destes espaços nominais.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
rdshow

Mostrar só as páginas que correspondem a estes critérios:

fragment
Mostrar só os redirecionamentos com um fragmento.
!fragment
Mostrar só os redirecionamentos sem um fragmento.
Valores (separados com | ou alternativas): fragment, !fragment
rdlimit

O número de redirecionamentos a serem devolvidos.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
rdcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

Exemplos:
Obter uma lista dos redirecionamentos para a página Main Page.
api.php?action=query&prop=redirects&titles=Main%20Page [abrir na página de testes]
Obter informação sobre todos os redirecionamentos para a página Main Page.
api.php?action=query&generator=redirects&titles=Main%20Page&prop=info [abrir na página de testes]

prop=references (rf)

Devolver uma representação de dados, das referências associadas com as páginas especificadas.

Parâmetro:
rfcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

prop=revisions (rv)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter informação da revisão.

Pode ser usado de várias maneiras:

  1. Obter dados sobre um conjunto de páginas (última revisão), definindo títulos ou identificadores de páginas.
  2. Obter as revisões de uma página indicada, usando títulos ou identificadores de páginas, com start, end ou limit.
  3. Obter dados sobre um conjunto de revisões definindo os respetivos identificadores de revisões.
Parâmetros:
rvprop

As propriedades a serem obtidas para cada revisão:

ids
O identificador da revisão.
flags
As etiquetas da revisão (menor).
timestamp
A data e hora da revisão.
user
O utilizador que fez a revisão.
userid
O identificador de utilizador do criador da revisão.
size
O tamanho (em bytes) da revisão.
sha1
O resumo criptográfico SHA-1 (na base 16) da revisão.
contentmodel
O identificador do modelo de conteúdo da revisão.
comment
O comentário do utilizador para a revisão.
parsedcomment
O comentário do utilizador para a revisão, após a análise sintática.
content
O texto da revisão.
tags
As etiquetas para a revisão.
parsetree
Descontinuado. Em substituição, use action=expandtemplates ou action=parse. A árvore de análise XML do conteúdo da revisão (requer o modelo de conteúdo wikitext).
Valores (separados com | ou alternativas): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
Valor por omissão: ids|timestamp|flags|comment|user
rvlimit

Limitar o número de revisões que serão devolvidas.

Só pode ser usado com uma única página (modo #2)
Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
rvexpandtemplates
Obsoleto.

Em substituição, use action=expandtemplates. Expandir predefinições no conteúdo da revisão (requer rvprop=content).

Tipo: booleano (detalhes)
rvgeneratexml
Obsoleto.

Em substituição, use action=expandtemplates ou action=parse. Gerar a árvore de análise sintática em XML do conteúdo da revisão (requer rvprop=content).

Tipo: booleano (detalhes)
rvparse
Obsoleto.

Em substituição, use action=parse. Fazer a análise sintática do conteúdo da revisão (requer rvprop=content). Por motivos de desempenho, se esta opção for usada rvlimit é forçado a ser 1.

Tipo: booleano (detalhes)
rvsection

Obter apenas o conteúdo da secção que tem este número.

rvdiffto
Obsoleto.

Em substituição, use action=compare. O identificador da revisão contra a qual será tirada uma lista de diferenças de cada revisão. Usar prev (anterior), next (seguinte) e cur (atual).

rvdifftotext
Obsoleto.

Em substituição, use action=compare. O texto contra o qual será tirada uma lista de diferenças de cada revisão. Só produz as diferenças para um número limitado de revisões. Tem precedência sobre rvdiffto. Se rvsection estiver definido, só o conteúdo dessa secção será comparado contra o texto.

rvdifftotextpst
Obsoleto.

Em substituição, use action=compare. Fazer uma transformação anterior à gravação do texto, antes de calcular as diferenças. Só é válido quando usado com rvdifftotext.

Tipo: booleano (detalhes)
rvcontentformat

O formato de seriação usado para rvdifftotext e esperado para o conteúdo produzido.

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

Iniciar a enumeração a partir da data e hora desta revisão. A revisão tem de existir, mas não precisa de pertencer a esta página.

Só pode ser usado com uma única página (modo #2)
Tipo: inteiro
rvendid

Terminar a enumeração na data e hora desta revisão. A revisão tem de existir, mas não precisa de pertencer a esta página.

Só pode ser usado com uma única página (modo #2)
Tipo: inteiro
rvstart

A data e hora da revisão a partir da qual será começada a enumeração.

Só pode ser usado com uma única página (modo #2)
Tipo: data e hora (formatos permitidos)
rvend

A data e hora da revisão na qual será terminada a enumeração.

Só pode ser usado com uma única página (modo #2)
Tipo: data e hora (formatos permitidos)
rvdir

A direção da enumeração:

newer
Listar o mais antigo primeiro. Nota: rvstart tem de estar antes de rvend.
older
Listar o mais recente primeiro (padrão). Nota: rvstart tem de estar depois de rvend.
Só pode ser usado com uma única página (modo #2)
Um dos seguintes valores: newer, older
Valor por omissão: older
rvuser

Incluir só as revisões deste utilizador.

Só pode ser usado com uma única página (modo #2)
Tipo: nome de utilizador
rvexcludeuser

Excluir as revisões deste utilizador.

Só pode ser usado com uma única página (modo #2)
Tipo: nome de utilizador
rvtag

Listar só as revisões marcadas com esta etiqueta.

rvtoken
Obsoleto.

Que chaves obter para cada revisão.

Valores (separados com | ou alternativas): rollback
rvcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

prop=stashimageinfo (sii)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolve informações dos ficheiros escondidos.

Parâmetros:
siifilekey

Chave que identifica um carregamento anterior que foi escondido temporariamente.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
siisessionkey
Obsoleto.

Nome alternativo de siifilekey, para compatibilidade com versões anteriores.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
siiprop

As informações do ficheiro que devem ser obtidas:

timestamp
Adiciona a data e hora da versão carregada.
canonicaltitle
Adiciona o título canónico do ficheiro.
url
Devolve URL para o ficheiro e página de descrição.
size
Adiciona o tamanho do ficheiro em bytes e a altura, largura e contagem de páginas (se aplicável).
dimensions
Nome alternativo para size.
sha1
Adiciona o resumo criptográfico SHA-1 do ficheiro.
mime
Adiciona o tipo MIME do ficheiro.
thumbmime
Adiciona o tipo MIME da miniatura (requer URL e o parâmetro siiurlwidth).
metadata
Lista os metadados Exif para a versão do ficheiro.
commonmetadata
Lista os metadados genéricos do formato de ficheiro para a versão do ficheiro.
extmetadata
Lista os metadados formatados, combinados de várias fontes. Os resultados estão no formato HTML.
bitdepth
Adiciona a profundidade em bits da versão.
badfile
Indica se o ficheiro está na lista MediaWiki:Bad image list
Valores (separados com | ou alternativas): timestamp, canonicaltitle, url, size, dimensions, sha1, mime, thumbmime, metadata, commonmetadata, extmetadata, bitdepth, badfile
Valor por omissão: timestamp|url
siiurlwidth

Se siiprop=url está definido, será devolvido um URL para uma imagem redimensionada com este comprimento. Por razões de desempenho, se esta opção for usada não serão devolvidas mais de 50 imagens redimensionadas.

Tipo: inteiro
Valor por omissão: -1
siiurlheight

Semelhante a siiurlwidth.

Tipo: inteiro
Valor por omissão: -1
siiurlparam

Um parâmetro de texto específico do objeto. Por exemplo, ficheiros PDF podem usar page15-100px. siiurlwidth tem de ser usado e ser consistente com siiurlparam.

Padrão: (vazio)

prop=templates (tl)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolve todas as páginas que são transcluídas nas páginas indicadas.

Parâmetros:
tlnamespace

Mostrar só as predefinições nestes espaços nominais.

Valores (separados com | ou alternativas): -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
tllimit

O número de predefinições a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
tlcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

tltemplates

Listar só estas predefinições. Útil para verificar se uma determinada página contém uma determinada predefinição.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
tldir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
Exemplos:
Obter as predefinições usadas na página Main Page.
api.php?action=query&prop=templates&titles=Main%20Page [abrir na página de testes]
Obter informação sobre as páginas das predefinições usadas na página Main Page.
api.php?action=query&generator=templates&titles=Main%20Page&prop=info [abrir na página de testes]
Obter as páginas dos espaços nominais Outelizador(a) e Modelo que são transcluídas na página Main Page.
api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10 [abrir na página de testes]

prop=transcludedin (ti)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter todas as páginas que transcluem as páginas indicadas.

Parâmetros:
tiprop

As propriedades a serem obtidas:

pageid
O identificador de cada página.
title
O título de cada página.
redirect
Indicar se a página é um redirecionamento.
Valores (separados com | ou alternativas): pageid, title, redirect
Valor por omissão: pageid|title|redirect
tinamespace

Incluir só as páginas nestes espaços nominais.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
tishow

Mostrar só as entradas que correspondem a estes critérios:

redirect
Mostrar só os redirecionamentos.
!redirect
Mostrar só as que não são redirecionamentos.
Valores (separados com | ou alternativas): redirect, !redirect
tilimit

O número de entradas a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
ticontinue

Quando houver mais resultados disponíveis, usar isto para continuar

Exemplos:
Obter uma lista das páginas que transcluem Main Page.
api.php?action=query&prop=transcludedin&titles=Main%20Page [abrir na página de testes]
Obter informação sobre as páginas que transcluem Main Page.
api.php?action=query&generator=transcludedin&titles=Main%20Page&prop=info [abrir na página de testes]

prop=transcodestatus

  • Este módulo requer direitos de leitura.
  • Fonte: TimedMediaHandler
  • Licença: GPL-2.0-or-later

Obter o estado da transcodificação de um dado ficheiro.

prop=videoinfo (vi)

  • Este módulo requer direitos de leitura.
  • Fonte: TimedMediaHandler
  • Licença: GPL-2.0-or-later

Expande imageinfo para incluir informações sobre a fonte (e obras derivadas) do vídeo

Parâmetros:
viprop

As informações do ficheiro que devem ser obtidas:

timestamp
Adiciona a data e hora da versão carregada.
user
Adiciona o utilizador que carregou cada versão de ficheiro.
userid
Adiciona o identificador do utilizador que carregou cada versão de ficheiro.
comment
O comentário da versão.
parsedcomment
Fazer a análise sintática do comentário da versão.
canonicaltitle
Adiciona o título canónico do ficheiro.
url
Devolve URL para o ficheiro e página de descrição.
size
Adiciona o tamanho do ficheiro em bytes e a altura, largura e contagem de páginas (se aplicável).
dimensions
Nome alternativo para size.
sha1
Adiciona o resumo criptográfico SHA-1 do ficheiro.
mime
Adiciona o tipo MIME do ficheiro.
thumbmime
Adiciona o tipo MIME da miniatura (requer URL e o parâmetro viurlwidth).
mediatype
Adiciona o tipo de multimédia do ficheiro.
metadata
Lista os metadados Exif para a versão do ficheiro.
commonmetadata
Lista os metadados genéricos do formato de ficheiro para a versão do ficheiro.
extmetadata
Lista os metadados formatados, combinados de várias fontes. Os resultados estão no formato HTML.
archivename
Adiciona o nome de ficheiro da versão arquivada das versões anteriores à última.
bitdepth
Adiciona a profundidade em bits da versão.
uploadwarning
Usado pela página Special:Upload para obter informação sobre um ficheiro existente. Não se destina a ser usado fora do núcleo central do MediaWiki.
badfile
Indica se o ficheiro está na lista MediaWiki:Bad image list
derivatives
Adiciona uma tabela das versões disponíveis de um ficheiro de áudio ou vídeo, com os diferentes formatos e padrões de qualidade.
timedtext
Adiciona uma tabela das versões disponíveis de um ficheiro de áudio ou vídeo, com os diferentes subtítulos, legendas e descrições.
Valores (separados com | ou alternativas): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, thumbmime, mediatype, metadata, commonmetadata, extmetadata, archivename, bitdepth, uploadwarning, badfile, derivatives, timedtext
Valor por omissão: timestamp|user
vilimit

O número de revisões a serem devolvidas por ficheiro.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 1
vistart

Data e hora a partir da qual será começada a listagem.

Tipo: data e hora (formatos permitidos)
viend

Data e hora na qual será terminada a listagem.

Tipo: data e hora (formatos permitidos)
viurlwidth

Se viprop=url está definido, será devolvido um URL para uma imagem redimensionada com este comprimento. Por razões de desempenho, se esta opção for usada não serão devolvidas mais de 50 imagens redimensionadas.

Tipo: inteiro
Valor por omissão: -1
viurlheight

Semelhante a viurlwidth.

Tipo: inteiro
Valor por omissão: -1
vimetadataversion

Versão de metadados a ser usada. Se for especificado o valor latest, usar a versão mais recente. Por omissão tem o valor 1 para compatibilidade com versões anteriores.

Valor por omissão: 1
viextmetadatalanguage

Em que língua obter extmetadata. Isto afeta tanto a tradução que será obtida, caso existam várias, como a formatação de números e vários outros valores.

Valor por omissão: mwl
viextmetadatamultilang

Se estiverem disponíveis traduções para a propriedade extmetadata, obtê-las todas.

Tipo: booleano (detalhes)
viextmetadatafilter

Se for especificado e não estiver vazio, só serão devolvidas estas chaves para viprop=extmetadata.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
viurlparam

Um parâmetro de texto específico do objeto. Por exemplo, ficheiros PDF podem usar page15-100px. viurlwidth tem de ser usado e ser consistente com viurlparam.

Padrão: (vazio)
vibadfilecontexttitle

Se badfilecontexttitleprop=badfile estiver definido, este é o título da página usado ao calcular a MediaWiki:Bad image list

vicontinue

Quando houver mais resultados disponíveis, usar isto para continuar

vilocalonly

Procurar ficheiros só no repositório local.

list=abusefilters (abf)

  • Este módulo requer direitos de leitura.
  • Fonte: Abuse Filter
  • Licença: GPL-2.0-or-later

Mostrar detalhes dos filtros de abuso.

Parâmetros:
abfstartid

O identificador do filtro onde será iniciada a enumeração.

Tipo: inteiro
abfendid

O identificador do filtro onde será parada a enumeração.

Tipo: inteiro
abfdir

A direção da enumeração:

newer
Listar o mais antigo primeiro. Nota: abfstart tem de estar antes de abfend.
older
Listar o mais recente primeiro (padrão). Nota: abfstart tem de estar depois de abfend.
Um dos seguintes valores: older, newer
Valor por omissão: newer
abfshow

Mostrar só os filtros que preenchem estes critérios.

Valores (separados com | ou alternativas): enabled, !enabled, deleted, !deleted, private, !private
abflimit

O número máximo de filtros que serão listados.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
abfprop

Que propriedades obter.

Valores (separados com | ou alternativas): id, description, pattern, actions, hits, comments, lasteditor, lastedittime, status, private
Valor por omissão: id|description|actions|status

list=abuselog (afl)

  • Este módulo requer direitos de leitura.
  • Fonte: Abuse Filter
  • Licença: GPL-2.0-or-later

Mostrar os eventos que foram detetados por um dos filtros de abuso.

Parâmetros:
aflstart

A data e hora onde começar a enumeração.

Tipo: data e hora (formatos permitidos)
aflend

A data e hora onde parar a enumeração.

Tipo: data e hora (formatos permitidos)
afldir

A direção da enumeração:

newer
Listar o mais antigo primeiro. Nota: aflstart tem de estar antes de aflend.
older
Listar o mais recente primeiro (padrão). Nota: aflstart tem de estar depois de aflend.
Um dos seguintes valores: newer, older
Valor por omissão: older
afluser

Mostrar só as entradas de um determinado utilizador ou endereço IP.

afltitle

Mostrar só as entradas de uma determinada página.

aflfilter

Mostrar só as entradas que foram detetadas por um determinado identificador de filtro.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
afllimit

O número máximo de entradas que serão listadas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
aflprop

Que propriedades obter.

Valores (separados com | ou alternativas): ids, filter, user, ip, title, action, details, result, timestamp, hidden, revid
Valor por omissão: ids|user|title|action|result|timestamp|hidden|revid

list=allcategories (ac)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Enumerar todas as categorias.

Parâmetros:
acfrom

A categoria a partir da qual será começada a enumeração.

accontinue

Quando houver mais resultados disponíveis, usar isto para continuar

acto

A categoria na qual será terminada a enumeração.

acprefix

Procurar todos os títulos de categorias que começam por este valor.

acdir

A direção da ordenação.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
acmin

Só devolver as categorias que tenham no mínimo este número de membros.

Tipo: inteiro
acmax

Só devolver as categorias que tenham no máximo este número de membros.

Tipo: inteiro
aclimit

O número de categorias a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
acprop

As propriedades a serem obtidas:

size
Adiciona o número de páginas na categoria.
hidden
Etiqueta as categorias ocultadas com __HIDDENCAT__.
Valores (separados com | ou alternativas): size, hidden
Padrão: (vazio)
Exemplos:
Lista as categorias com informação sobre o número de páginas em cada uma delas.
api.php?action=query&list=allcategories&acprop=size [abrir na página de testes]
Obter informação sobre a própria página de categoria, para as categorias que começam por List.
api.php?action=query&generator=allcategories&gacprefix=List&prop=info [abrir na página de testes]

list=alldeletedrevisions (adr)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Listar todas as revisões eliminadas por um utilizador ou de um espaço nominal.

Parâmetros:
adrprop

As propriedades a serem obtidas para cada revisão:

ids
O identificador da revisão.
flags
As etiquetas da revisão (menor).
timestamp
A data e hora da revisão.
user
O utilizador que fez a revisão.
userid
O identificador de utilizador do criador da revisão.
size
O tamanho (em bytes) da revisão.
sha1
O resumo criptográfico SHA-1 (na base 16) da revisão.
contentmodel
O identificador do modelo de conteúdo da revisão.
comment
O comentário do utilizador para a revisão.
parsedcomment
O comentário do utilizador para a revisão, após a análise sintática.
content
O texto da revisão.
tags
As etiquetas para a revisão.
parsetree
Descontinuado. Em substituição, use action=expandtemplates ou action=parse. A árvore de análise XML do conteúdo da revisão (requer o modelo de conteúdo wikitext).
Valores (separados com | ou alternativas): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
Valor por omissão: ids|timestamp|flags|comment|user
adrlimit

Limitar o número de revisões que serão devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
adrexpandtemplates
Obsoleto.

Em substituição, use action=expandtemplates. Expandir predefinições no conteúdo da revisão (requer adrprop=content).

Tipo: booleano (detalhes)
adrgeneratexml
Obsoleto.

Em substituição, use action=expandtemplates ou action=parse. Gerar a árvore de análise sintática em XML do conteúdo da revisão (requer adrprop=content).

Tipo: booleano (detalhes)
adrparse
Obsoleto.

Em substituição, use action=parse. Fazer a análise sintática do conteúdo da revisão (requer adrprop=content). Por motivos de desempenho, se esta opção for usada adrlimit é forçado a ser 1.

Tipo: booleano (detalhes)
adrsection

Obter apenas o conteúdo da secção que tem este número.

adrdiffto
Obsoleto.

Em substituição, use action=compare. O identificador da revisão contra a qual será tirada uma lista de diferenças de cada revisão. Usar prev (anterior), next (seguinte) e cur (atual).

adrdifftotext
Obsoleto.

Em substituição, use action=compare. O texto contra o qual será tirada uma lista de diferenças de cada revisão. Só produz as diferenças para um número limitado de revisões. Tem precedência sobre adrdiffto. Se adrsection estiver definido, só o conteúdo dessa secção será comparado contra o texto.

adrdifftotextpst
Obsoleto.

Em substituição, use action=compare. Fazer uma transformação anterior à gravação do texto, antes de calcular as diferenças. Só é válido quando usado com adrdifftotext.

Tipo: booleano (detalhes)
adrcontentformat

O formato de seriação usado para adrdifftotext e esperado para o conteúdo produzido.

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

Listar só as revisões feitas por este utilizador.

Tipo: nome de utilizador
adrnamespace

Listar só as páginas neste espaço nominal.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
adrstart

A data e hora da revisão a partir da qual será começada a enumeração.

Só pode ser usado com adruser.
Tipo: data e hora (formatos permitidos)
adrend

A data e hora na qual será terminada a enumeração.

Só pode ser usado com adruser.
Tipo: data e hora (formatos permitidos)
adrdir

A direção da enumeração:

newer
Listar o mais antigo primeiro. Nota: adrstart tem de estar antes de adrend.
older
Listar o mais recente primeiro (padrão). Nota: adrstart tem de estar depois de adrend.
Um dos seguintes valores: newer, older
Valor por omissão: older
adrfrom

Começar a listagem neste título.

Não pode ser usado com adruser.
adrto

Terminar a listagem neste título.

Não pode ser usado com adruser.
adrprefix

Procurar todos os títulos de página que começam por este valor.

Não pode ser usado com adruser.
adrexcludeuser

Não listar as revisões feitas por este utilizador.

Não pode ser usado com adruser.
Tipo: nome de utilizador
adrtag

Listar só as revisões marcadas com esta etiqueta.

adrcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

adrgeneratetitles

Ao ser usado como gerador, gerar títulos em vez de identificadores de revisões.

Tipo: booleano (detalhes)
Exemplos:
Listar as últimas 50 contribuições eliminadas do utilizador Example.
api.php?action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50 [abrir na página de testes]
Listar as primeiras 50 revisões eliminadas no espaço nominal principal.
api.php?action=query&list=alldeletedrevisions&adrdir=newer&adrnamespace=0&adrlimit=50 [abrir na página de testes]

list=allfileusages (af)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Listar todas as utilizações de ficheiros, incluindo ficheiros que não existam.

Parâmetros:
afcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

affrom

O título do ficheiro a partir do qual será começada a enumeração.

afto

O título do ficheiro no qual será terminada a enumeração.

afprefix

Procurar todos os títulos de ficheiro que começam por este valor.

afunique

Mostrar só nomes de ficheiro únicos. Não pode ser usado com afprop=ids. Ao ser usado como gerador, produz páginas de destino em vez de páginas de origem.

Tipo: booleano (detalhes)
afprop

As informações que devem ser incluídas:

ids
Adiciona os identificadores das páginas que utilizam (não pode ser usado com afunique).
title
Adiciona o título do ficheiro.
Valores (separados com | ou alternativas): ids, title
Valor por omissão: title
aflimit

O número total de elementos a serem devolvidos.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
afdir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
Exemplos:
Listar os títulos de ficheiros, incluindo aqueles em falta, com os identificadores das páginas de onde provêm, começando no B.
api.php?action=query&list=allfileusages&affrom=B&afprop=ids|title [abrir na página de testes]
Listar os títulos de ficheiro únicos.
api.php?action=query&list=allfileusages&afunique=&affrom=B [abrir na página de testes]
Obtém todos os títulos de ficheiros, marcando aqueles em falta.
api.php?action=query&generator=allfileusages&gafunique=&gaffrom=B [abrir na página de testes]
Obtém as páginas que contêm os ficheiros.
api.php?action=query&generator=allfileusages&gaffrom=B [abrir na página de testes]

list=allimages (ai)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Enumerar todas as imagens sequencialmente.

Parâmetros:
aisort

Propriedade pela qual fazer a ordenação.

Um dos seguintes valores: name, timestamp
Valor por omissão: name
aidir

A direção de listagem.

Um dos seguintes valores: ascending, descending, newer, older
Valor por omissão: ascending
aifrom

O título da imagem a partir do qual será começada a enumeração. Só pode ser usado com aisort=name.

aito

O título da imagem no qual será terminada a enumeração. Só pode ser usado com aisort=name.

aicontinue

Quando houver mais resultados disponíveis, usar isto para continuar

aistart

A data e hora da imagem a partir da qual será começada a enumeração. Só pode ser usado com aisort=timestamp.

Tipo: data e hora (formatos permitidos)
aiend

A data e hora da imagem na qual será terminada a enumeração. Só pode ser usado com aisort=timestamp.

Tipo: data e hora (formatos permitidos)
aiprop

As informações do ficheiro que devem ser obtidas:

timestamp
Adiciona a data e hora da versão carregada.
user
Adiciona o utilizador que carregou cada versão de ficheiro.
userid
Adiciona o identificador do utilizador que carregou cada versão de ficheiro.
comment
O comentário da versão.
parsedcomment
Fazer a análise sintática do comentário da versão.
canonicaltitle
Adiciona o título canónico do ficheiro.
url
Devolve URL para o ficheiro e página de descrição.
size
Adiciona o tamanho do ficheiro em bytes e a altura, largura e contagem de páginas (se aplicável).
dimensions
Nome alternativo para size.
sha1
Adiciona o resumo criptográfico SHA-1 do ficheiro.
mime
Adiciona o tipo MIME do ficheiro.
mediatype
Adiciona o tipo de multimédia do ficheiro.
metadata
Lista os metadados Exif para a versão do ficheiro.
commonmetadata
Lista os metadados genéricos do formato de ficheiro para a versão do ficheiro.
extmetadata
Lista os metadados formatados, combinados de várias fontes. Os resultados estão no formato HTML.
bitdepth
Adiciona a profundidade em bits da versão.
badfile
Indica se o ficheiro está na lista MediaWiki:Bad image list
Valores (separados com | ou alternativas): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, mediatype, metadata, commonmetadata, extmetadata, bitdepth, badfile
Valor por omissão: timestamp|url
aiprefix

Procurar todos os títulos de imagem que começam por este valor. Só pode ser usado com aisort=name.

aiminsize

Limitar só às imagens com este número mínimo de bytes.

Tipo: inteiro
aimaxsize

Limitar só às imagens com este número máximo de bytes.

Tipo: inteiro
aisha1

Resumo criptográfico SHA1 da imagem. Tem precedência sobre aisha1base36.

aisha1base36

Resumo criptográfico SHA1 da imagem em base 36 (usado no MediaWiki).

aiuser

Devolver só os ficheiros carregados por este utilizador. Só pode ser usado com aisort=timestamp. Não pode ser usado em conjunto com aifilterbots.

Tipo: nome de utilizador
aifilterbots

Como filtrar os ficheiros carregados por robôs. Só pode ser usado com aisort=timestamp. Não pode ser usado em conjunto com aiuser.

Um dos seguintes valores: all, bots, nobots
Valor por omissão: all
aimime

Tipos MIME a procurar; por exemplo, image/jpeg.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
ailimit

O número total de imagens a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
Exemplos:
Mostrar uma lista dos ficheiros que começam com a letra B.
api.php?action=query&list=allimages&aifrom=B [abrir na página de testes]
Mostrar uma lista dos ficheiros carregados recentemente, semelhante a Special:NewFiles.
api.php?action=query&list=allimages&aiprop=user|timestamp|url&aisort=timestamp&aidir=older [abrir na página de testes]
Mostrar uma lista dos ficheiros com os tipos MIME image/png ou image/gif.
api.php?action=query&list=allimages&aimime=image/png|image/gif [abrir na página de testes]
Mostrar informação sobre 4 ficheiros, começando pela letra T.
api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo [abrir na página de testes]
  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Enumerar todas as hiperligações que apontam para um determinado espaço nominal.

Parâmetros:
alcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

alfrom

O título da hiperligação a partir da qual será começada a enumeração.

alto

O título da hiperligação na qual será terminada a enumeração.

alprefix

Procurar todos os títulos ligados que começam por este valor.

alunique

Mostrar só títulos ligados únicos. Não pode ser usado com alprop=ids. Ao ser usado como gerador, produz páginas de destino em vez de páginas de origem.

Tipo: booleano (detalhes)
alprop

As informações que devem ser incluídas:

ids
Adiciona o identificador da página que contém a hiperligação (não pode ser usado com alunique).
title
Adiciona o título da hiperligação.
Valores (separados com | ou alternativas): ids, title
Valor por omissão: title
alnamespace

O espaço nominal a ser enumerado.

Um dos seguintes valores: -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Valor por omissão: 0
allimit

O número total de entradas a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
aldir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
Exemplos:
Listar os títulos para os quais existem ligações, incluindo títulos em falta, com os identificadores das páginas que contêm as respetivas ligações, começando pela letra B.
api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title [abrir na página de testes]
Listar os títulos únicos para os quais existem hiperligações.
api.php?action=query&list=alllinks&alunique=&alfrom=B [abrir na página de testes]
Obtém todos os títulos para os quais existem hiperligações, marcando aqueles em falta.
api.php?action=query&generator=alllinks&galunique=&galfrom=B [abrir na página de testes]
Obtém as páginas que contêm as hiperligações.
api.php?action=query&generator=alllinks&galfrom=B [abrir na página de testes]

list=allpages (ap)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Enumerar sequencialmente todas as páginas de um determinado espaço nominal.

Parâmetros:
apfrom

O título de página a partir do qual será começada a enumeração.

apcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

apto

O título de página no qual será terminada a enumeração.

apprefix

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

apnamespace

O espaço nominal a ser enumerado.

Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Valor por omissão: 0
apfilterredir

As páginas a serem listadas.

Um dos seguintes valores: all, redirects, nonredirects
Valor por omissão: all
apminsize

Limitar só às páginas com este número mínimo de bytes.

Tipo: inteiro
apmaxsize

Limitar só às páginas com este número máximo de bytes.

Tipo: inteiro
apprtype

Limitar só às páginas protegidas.

Valores (separados com | ou alternativas): edit, move, upload
apprlevel

Filtrar as proteções com base no nível de proteção (tem de ser usado com o parâmetro apprtype=).

Valores (separados com | ou alternativas): Pode estar vazio, ou ser autoconfirmed, sysop
apprfiltercascade

Filtrar as proteções com base na proteção em cascata (ignorado se apprtype não estiver presente).

Um dos seguintes valores: cascading, noncascading, all
Valor por omissão: all
aplimit

O número total de páginas a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
apdir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
apfilterlanglinks

Filtrar dependo de uma página conter hiperligações interlínguas. Note que isto pode não ter em consideração hiperligações interlínguas adicionadas por extensões.

Um dos seguintes valores: withlanglinks, withoutlanglinks, all
Valor por omissão: all
apprexpiry

O tipo de expiração pelo qual as páginas serão filtradas:

indefinite
Obter só páginas com um período de expiração indefinido.
definite
Obter só páginas com um período de expiração definido (específico).
all
Obter páginas com qualquer período de expiração.
Um dos seguintes valores: indefinite, definite, all
Valor por omissão: all
Exemplos:
Mostrar uma lista de páginas, começando na letra B.
api.php?action=query&list=allpages&apfrom=B [abrir na página de testes]
Mostrar informação sobre 4 páginas, começando na letra T.
api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info [abrir na página de testes]
Mostrar o conteúdo das primeiras 2 páginas que não sejam redirecionamentos, começando na página Re.
api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content [abrir na página de testes]

list=allredirects (ar)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Listar todos os redirecionamentos para um espaço nominal.

Parâmetros:
arcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

arfrom

O título do redirecionamento a partir do qual será começada a enumeração.

arto

O título do redirecionamento no qual será terminada a enumeração.

arprefix

Procurar todas as páginas de destino que começam por este valor.

arunique

Mostrar só páginas de destino únicas. Não pode ser usado com arprop=ids|fragment|interwiki. Ao ser usado como gerador, produz páginas de destino em vez de páginas de origem.

Tipo: booleano (detalhes)
arprop

As informações que devem ser incluídas:

ids
Adiciona o identificador da página que contém o redirecionamento (não pode ser usado com arunique).
title
Adiciona o título do redirecionamento.
fragment
Adiciona o fragmento do redirecionamento, se existir (não pode ser usado com arunique).
interwiki
Adiciona o prefixo interwikis do redirecionamento, se existir (não pode ser usado em conjunto com arunique).
Valores (separados com | ou alternativas): ids, title, fragment, interwiki
Valor por omissão: title
arnamespace

O espaço nominal a ser enumerado.

Um dos seguintes valores: -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Valor por omissão: 0
arlimit

O número total de elementos a serem devolvidos.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
ardir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
Exemplos:
Listar as páginas de destino, incluindo aquelas em falta, com os identificadores da página de origem, começando na B.
api.php?action=query&list=allredirects&arfrom=B&arprop=ids|title [abrir na página de testes]
Listar as páginas de destino únicas.
api.php?action=query&list=allredirects&arunique=&arfrom=B [abrir na página de testes]
Obtém todas as páginas de destino, marcando aquelas em falta.
api.php?action=query&generator=allredirects&garunique=&garfrom=B [abrir na página de testes]
Obtém as páginas que contêm os redirecionamentos.
api.php?action=query&generator=allredirects&garfrom=B [abrir na página de testes]

list=allrevisions (arv)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Listar todas as revisões.

Parâmetros:
arvprop

As propriedades a serem obtidas para cada revisão:

ids
O identificador da revisão.
flags
As etiquetas da revisão (menor).
timestamp
A data e hora da revisão.
user
O utilizador que fez a revisão.
userid
O identificador de utilizador do criador da revisão.
size
O tamanho (em bytes) da revisão.
sha1
O resumo criptográfico SHA-1 (na base 16) da revisão.
contentmodel
O identificador do modelo de conteúdo da revisão.
comment
O comentário do utilizador para a revisão.
parsedcomment
O comentário do utilizador para a revisão, após a análise sintática.
content
O texto da revisão.
tags
As etiquetas para a revisão.
parsetree
Descontinuado. Em substituição, use action=expandtemplates ou action=parse. A árvore de análise XML do conteúdo da revisão (requer o modelo de conteúdo wikitext).
Valores (separados com | ou alternativas): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
Valor por omissão: ids|timestamp|flags|comment|user
arvlimit

Limitar o número de revisões que serão devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
arvexpandtemplates
Obsoleto.

Em substituição, use action=expandtemplates. Expandir predefinições no conteúdo da revisão (requer arvprop=content).

Tipo: booleano (detalhes)
arvgeneratexml
Obsoleto.

Em substituição, use action=expandtemplates ou action=parse. Gerar a árvore de análise sintática em XML do conteúdo da revisão (requer arvprop=content).

Tipo: booleano (detalhes)
arvparse
Obsoleto.

Em substituição, use action=parse. Fazer a análise sintática do conteúdo da revisão (requer arvprop=content). Por motivos de desempenho, se esta opção for usada arvlimit é forçado a ser 1.

Tipo: booleano (detalhes)
arvsection

Obter apenas o conteúdo da secção que tem este número.

arvdiffto
Obsoleto.

Em substituição, use action=compare. O identificador da revisão contra a qual será tirada uma lista de diferenças de cada revisão. Usar prev (anterior), next (seguinte) e cur (atual).

arvdifftotext
Obsoleto.

Em substituição, use action=compare. O texto contra o qual será tirada uma lista de diferenças de cada revisão. Só produz as diferenças para um número limitado de revisões. Tem precedência sobre arvdiffto. Se arvsection estiver definido, só o conteúdo dessa secção será comparado contra o texto.

arvdifftotextpst
Obsoleto.

Em substituição, use action=compare. Fazer uma transformação anterior à gravação do texto, antes de calcular as diferenças. Só é válido quando usado com arvdifftotext.

Tipo: booleano (detalhes)
arvcontentformat

O formato de seriação usado para arvdifftotext e esperado para o conteúdo produzido.

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

Listar só as revisões deste utilizador.

Tipo: nome de utilizador
arvnamespace

Listar só as páginas neste espaço nominal.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
arvstart

A data e hora a partir da qual será começada a enumeração.

Tipo: data e hora (formatos permitidos)
arvend

A data e hora na qual será terminada a enumeração.

Tipo: data e hora (formatos permitidos)
arvdir

A direção da enumeração:

newer
Listar o mais antigo primeiro. Nota: arvstart tem de estar antes de arvend.
older
Listar o mais recente primeiro (padrão). Nota: arvstart tem de estar depois de arvend.
Um dos seguintes valores: newer, older
Valor por omissão: older
arvexcludeuser

Não listar as revisões deste utilizador.

Tipo: nome de utilizador
arvcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

arvgeneratetitles

Ao ser usado como gerador, gerar títulos em vez de identificadores de revisões.

Tipo: booleano (detalhes)
Exemplos:
Listar as últimas 50 contribuições do utilizador Example.
api.php?action=query&list=allrevisions&arvuser=Example&arvlimit=50 [abrir na página de testes]
Listar as primeiras 50 revisões no espaço nominal principal.
api.php?action=query&list=allrevisions&arvdir=newer&arvlimit=50 [abrir na página de testes]

list=alltransclusions (at)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Listar todas as transclusões (páginas incorporadas utilizando {{x}}), incluindo as que estejam em falta.

Parâmetros:
atcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

atfrom

O título da transclusão a partir do qual será começada a enumeração.

atto

O título da transclusão no qual será terminada a enumeração.

atprefix

Procurar todos os títulos transcluídos que começam por este valor.

atunique

Mostrar só títulos transcluídos únicos. Não pode ser usado com atprop=ids. Ao ser usado como gerador, produz páginas de destino em vez de páginas de origem.

Tipo: booleano (detalhes)
atprop

As informações que devem ser incluídas:

ids
Adiciona o identificador da página onde é feita a transclusão (não pode ser usado com atunique).
title
Adiciona o título da transclusão.
Valores (separados com | ou alternativas): ids, title
Valor por omissão: title
atnamespace

O espaço nominal a enumerar.

Um dos seguintes valores: -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Valor por omissão: 10
atlimit

O número total de elementos a serem devolvidos.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
atdir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
Exemplos:
Listar os títulos transcluídos, incluindo aqueles em falta, com os identificadores das páginas de origem, começando no B.
api.php?action=query&list=alltransclusions&atfrom=B&atprop=ids|title [abrir na página de testes]
Listar os títulos transcluídos únicos.
api.php?action=query&list=alltransclusions&atunique=&atfrom=B [abrir na página de testes]
Obtém todos os títulos transcluídos, marcando aqueles em falta.
api.php?action=query&generator=alltransclusions&gatunique=&gatfrom=B [abrir na página de testes]
Obtém as páginas que contêm as transclusões.
api.php?action=query&generator=alltransclusions&gatfrom=B [abrir na página de testes]

list=allusers (au)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Enumerar todos os utilizadores registados.

Parâmetros:
aufrom

O nome de utilizador a partir do qual será começada a enumeração.

auto

O nome de utilizador no qual será terminada a enumeração.

auprefix

Procurar todos os nomes de utilizador que começam por este valor.

audir

A direção da ordenação.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
augroup

Incluir só os utilizadores nos grupos indicados.

Valores (separados com | ou alternativas): bot, sysop, bureaucrat, emailconfirmed, rollback, checkuser, staff
auexcludegroup

Excluir os utilizadores nos grupos indicados.

Valores (separados com | ou alternativas): bot, sysop, bureaucrat, emailconfirmed, rollback, checkuser, staff
aurights

Incluir só os utilizadores com as permissões indicadas. Não inclui as permissões atribuídas por grupos implícitos ou de promoção automática como *, utilizador, ou autoconfirmado.

Valores (separados com | ou alternativas): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjson, editmyuserjs, editmywatchlist, editsemiprotected, editusercss, edituserjson, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, patrol, patrolmarks, protect, 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, gadgets-edit, gadgets-definition-edit, oathauth-enable, oathauth-api-all, spamblacklistlog, tboverride, tboverride-account, titleblacklistlog, abusefilter-modify, abusefilter-log-detail, abusefilter-view, abusefilter-log, abusefilter-private, abusefilter-private-log, abusefilter-modify-restricted, abusefilter-revert, abusefilter-view-private, abusefilter-log-private, abusefilter-hidden-log, abusefilter-hide-log, abusefilter-modify-global, checkuser, checkuser-log, welcomeexempt, massmessage, nuke, replacetext, renameuser, refreshspecial, usermerge, dpl_param_update_rules, dpl_param_delete_rules, skipcaptcha, transcode-reset, transcode-status, poll-admin, poll-create, poll-vote, poll-score, interwiki
O número máximo de valores é 50 (500 para robôs).
auprop

As informações que devem ser incluídas:

blockinfo
Adiciona a informação sobre um bloqueio atual do utilizador.
groups
Lista os grupos a que o utilizador pertence. Isto usa mais recursos do servidor e pode devolver menos resultados do que o limite.
implicitgroups
Lista todos os grupos a que o utilizador pertence de forma automática.
rights
Lista as permissões que o utilizador tem.
editcount
Adiciona a contagem de edições do utilizador.
registration
Adiciona a data e hora de registo do utilizador, se estiver disponível (pode estar vazia).
centralids
Adiciona os identificadores centrais e o estado de ligação central (attachment) do utilizador.
Valores (separados com | ou alternativas): blockinfo, groups, implicitgroups, rights, editcount, registration, centralids
aulimit

O número total de nomes de utilizador a serem devolvidos.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
auwitheditsonly

Listar só os utilizadores que realizaram edições.

Tipo: booleano (detalhes)
auactiveusers

Listar só os utilizadores ativos nos últimos 30 dias.

Tipo: booleano (detalhes)
auattachedwiki

Com auprop=centralids, indicar também se o utilizador tem ligação com a wiki designada por este identificador.

Exemplo:
Listar utilizadores, começando pelo Y.
api.php?action=query&list=allusers&aufrom=Y [abrir na página de testes]
  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Encontrar todas as páginas que contêm hiperligações para a página indicada.

Parâmetros:
bltitle

O título a ser procurado. Não pode ser usado em conjunto com blpageid.

blpageid

O identificador do título a ser procurado. Não pode ser usado em conjunto com bltitle.

Tipo: inteiro
blcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

blnamespace

O espaço nominal a ser enumerado.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
bldir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
blfilterredir

Como filtrar os redirecionamentos. Se definido como nonredirects quando blredirect está ativado, isto só é aplicado ao segundo nível.

Um dos seguintes valores: all, redirects, nonredirects
Valor por omissão: all
bllimit

O número total de páginas a serem devolvidas. Se blredirect estiver ativado, o limite aplica-se a cada nível em separado (o que significa que até 2 * bllimit resultados podem ser devolvidos).

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
blredirect

Se a página que contém a hiperligação é um redirecionamento, procurar também todas as páginas que contêm hiperligações para esse redirecionamento. O limite máximo é reduzido para metade.

Tipo: booleano (detalhes)
Exemplos:
Mostrar as hiperligações para Main page.
api.php?action=query&list=backlinks&bltitle=Main%20Page [abrir na página de testes]
Obter informações sobre as páginas com hiperligações para Main page.
api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info [abrir na página de testes]

list=blocks (bk)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Listar todos os utilizadores e endereços IP bloqueados.

Parâmetros:
bkstart

A data e hora a partir da qual será começada a enumeração.

Tipo: data e hora (formatos permitidos)
bkend

A data e hora na qual será terminada a enumeração.

Tipo: data e hora (formatos permitidos)
bkdir

A direção da enumeração:

newer
Listar o mais antigo primeiro. Nota: bkstart tem de estar antes de bkend.
older
Listar o mais recente primeiro (padrão). Nota: bkstart tem de estar depois de bkend.
Um dos seguintes valores: newer, older
Valor por omissão: older
bkids

Lista dos identificadores de bloqueios a serem listados (opcional).

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
bkusers

Lista dos utilizadores a serem procurados (opcional).

Tipo: lista de nomes de utilizadores
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
bkip

Obter todos os bloqueios aplicáveis a este endereço IP ou intervalo CIDR, incluindo bloqueios de intervalos. Não pode ser usado em conjunto com bkusers. Não são aceites intervalos CIDR maiores que IPv4/16 ou IPv6/19.

bklimit

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

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
bkprop

As propriedades a serem obtidas:

id
Adiciona o identificador do bloqueio.
user
Adiciona o nome do utilizador bloqueado.
userid
Adiciona o identificador do utilizador bloqueado.
by
Adiciona o nome do utilizador que fez o bloqueio.
byid
Adiciona o identificador do utilizador que fez o bloqueio.
timestamp
Adiciona a data e hora de realização do bloqueio.
expiry
Adiciona a data e hora de expiração do bloqueio.
reason
Adiciona o motivo apresentado para o bloqueio.
range
Adiciona o intervalo de endereços IP afetado pelo bloqueio.
flags
Etiqueta o bloqueio com (autoblock, anononly, etc.).
Valores (separados com | ou alternativas): id, user, userid, by, byid, timestamp, expiry, reason, range, flags
Valor por omissão: id|user|by|timestamp|expiry|reason|flags
bkshow

Mostrar só os bloqueios que preenchem estes critérios. Por exemplo, para ver só bloqueios indefinidos de endereços IP, defina bkshow=ip|!temp.

Valores (separados com | ou alternativas): account, !account, temp, !temp, ip, !ip, range, !range
bkcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

list=categorymembers (cm)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Listar todas as páginas numa categoria específica.

Parâmetros:
cmtitle

A categoria que será enumerada (obrigatório). Tem de incluir o prefixo Catadorie:. Não pode ser usado em conjunto com cmpageid.

cmpageid

Identificador da categoria a ser enumerada. Não pode ser usado em conjunto com cmtitle.

Tipo: inteiro
cmprop

As informações que devem ser incluídas:

ids
Adiciona o identificador da página.
title
Adiciona o título e o identificador do espaço nominal da página.
sortkey
Adiciona a chave usada para a ordenação da categoria (string hexadecimal).
sortkeyprefix
Adiciona o prefixo da chave usada para a ordenação da categoria (parte legível da chave de ordenação).
type
Adiciona o tipo com que a página foi categorizada (page, subcat ou file).
timestamp
Adiciona a data e hora de inclusão da página.
Valores (separados com | ou alternativas): ids, title, sortkey, sortkeyprefix, type, timestamp
Valor por omissão: ids|title
cmnamespace

Incluir só as páginas destes espaços nominais. Note que pode usar cmtype=subcat ou cmtype=file em vez de cmnamespace=14 ou 6.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
cmtype

O tipo de membros de categoria que devem ser incluídos. Ignorado se cmsort=timestamp estiver definido.

Valores (separados com | ou alternativas): page, subcat, file
Valor por omissão: page|subcat|file
cmcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

cmlimit

O número máximo de páginas a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
cmsort

Propriedade pela qual fazer a ordenação.

Um dos seguintes valores: sortkey, timestamp
Valor por omissão: sortkey
cmdir

A direção da ordenação.

Um dos seguintes valores: asc, desc, ascending, descending, newer, older
Valor por omissão: ascending
cmstart

A data e hora da página a partir da qual será começada a listagem. Só pode ser usado em conjunto com cmsort=timestamp.

Tipo: data e hora (formatos permitidos)
cmend

A data e hora da página na qual será terminada a listagem. Só pode ser usado em conjunto com cmsort=timestamp.

Tipo: data e hora (formatos permitidos)
cmstarthexsortkey

A chave de ordenação a partir da qual a listagem será começada, como devolvida por cmprop=sortkey. Só pode ser usado com cmsort=sortkey.

cmendhexsortkey

A chave de ordenação na qual a listagem será terminada, como devolvida por cmprop=sortkey. só pode ser usado com cmsort=sortkey.

cmstartsortkeyprefix

O prefixo da chave de ordenação a partir do qual a listagem será começada. Só pode ser usado com cmsort=sortkey. Tem precedência sobre cmstarthexsortkey.

cmendsortkeyprefix

O prefixo da chave de ordenação antes do qual a listagem será terminada (não no qual; se este valor ocorrer não será incluído!). Só pode ser usado com cmsort=sortkey. Tem precedência sobre cmstarthexsortkey.

cmstartsortkey
Obsoleto.

Em vez dele, usar cmstarthexsortkey.

cmendsortkey
Obsoleto.

Em vez dele, usar cmendhexsortkey.

Exemplos:
Obter as primeiras 10 páginas na categoria Category:Physics.
api.php?action=query&list=categorymembers&cmtitle=Category:Physics [abrir na página de testes]
Obter informações sobre as primeiras 10 páginas na categoria Category:Physics.
api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info [abrir na página de testes]

list=checkuser (cu)

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: CheckUser
  • Licença: GPL-2.0-or-later

Verificar que endereços IP são usados por determinado nome de utilizador ou que nomes de utilizador são usados por um determinado endereço IP.

Parâmetros:
curequest

Tipo do pedido de verificação de utilizadores:

userips
Obter endereço IP do utilizador alvo.
edits
Obter alterações do endereço IP ou gama IP alvo.
ipusers
Obter utilizadores do endereço IP ou gama IP alvo.
Este parâmetro é obrigatório.
Um dos seguintes valores: userips, edits, ipusers
cutarget

Nome de utilizador, endereço IP, ou gama CIDR a verificar

Este parâmetro é obrigatório.
cureason

Motivo da verificação.

culimit

Limite de linhas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 1000
cutimecond

Limite temporal dos dados de utilizador (como "-2 weeks" ou "2 weeks ago").

Valor por omissão: -2 weeks
cuxff

Usar dados XFF em vez do endereço IP.

cutoken

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

list=checkuserlog (cul)

  • Este módulo requer direitos de leitura.
  • Fonte: CheckUser
  • Licença: GPL-2.0-or-later

Obter entradas do registo de verificação de utilizadores.

Parâmetros:
culuser

Nome de utilizador do pedido de verificação de utilizadores.

cultarget

Utilizador verificado, endereço IP ou gama CIDR.

cullimit

Limite de linhas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
culdir

A direção da enumeração:

newer
Listar o mais antigo primeiro. Nota: culstart tem de estar antes de culend.
older
Listar o mais recente primeiro (padrão). Nota: culstart tem de estar depois de culend.
Um dos seguintes valores: newer, older
Valor por omissão: older
culfrom

A data e hora a partir da qual será começada a enumeração.

Tipo: data e hora (formatos permitidos)
culto

A data e hora na qual será parada a enumeração.

Tipo: data e hora (formatos permitidos)
culcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

list=deletedrevs (dr)

  • Este módulo foi descontinuado.
  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Listar as revisões eliminadas.

Opera em três modos:

  1. Listar as revisões eliminadas dos títulos indicados, ordenadas por data e hora.
  2. Listar as contribuições eliminadas do utilizador indicado, ordenadas por data e hora (sem especificar títulos).
  3. Listar todas as revisões eliminadas no espaço nominal indicado, ordenadas por título e por data e hora (sem especificar títulos, sem definir druser).

Alguns parâmetros só se aplicam a alguns modos e são ignorados noutros.

Parâmetros:
drstart

A data e hora da revisão a partir da qual será começada a enumeração.

Modos: 1, 2
Tipo: data e hora (formatos permitidos)
drend

A data e hora da revisão na qual será terminada a enumeração.

Modos: 1, 2
Tipo: data e hora (formatos permitidos)
drdir

A direção da enumeração:

newer
Listar o mais antigo primeiro. Nota: drstart tem de estar antes de drend.
older
Listar o mais recente primeiro (padrão). Nota: drstart tem de estar depois de drend.
Modos: 1, 3
Um dos seguintes valores: newer, older
Valor por omissão: older
drfrom

Começar a listagem neste título.

Modo: 3
drto

Terminar a listagem neste título.

Modo: 3
drprefix

Procurar todos os títulos de página que começam por este valor.

Modo: 3
drunique

Listar só uma revisão para cada página.

Modo: 3
Tipo: booleano (detalhes)
drnamespace

Listar só 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, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Valor por omissão: 0
drtag

Listar só as revisões marcadas com esta etiqueta.

druser

Listar só as revisões deste utilizador.

Tipo: nome de utilizador
drexcludeuser

Não listar edições deste utilizador.

Tipo: nome de utilizador
drprop

As propriedades a serem obtidas:

revid
Adiciona o identificador da revisão eliminada.
parentid
Adiciona o identificador da revisão anterior da página.
user
Adiciona o utilizador que fez a revisão.
userid
Adiciona o identificador do utilizador que fez a revisão.
comment
Adiciona o comentário da revisão.
parsedcomment
Adiciona o comentário da revisão após passagem pelo analisador sintático.
minor
Etiqueta a revisão como uma revisão menor.
len
Adiciona o comprimento (em bytes) da revisão.
sha1
Adiciona o SHA-1 da revisão (na base 16).
content
Adiciona o conteúdo da revisão.
token
Obsoleto. Fornece a chave da edição.
tags
Etiquetas da revisão.
Valores (separados com | ou alternativas): revid, parentid, user, userid, comment, parsedcomment, minor, len, sha1, content, token, tags
Valor por omissão: user|comment
drlimit

O número máximo de revisões a serem listadas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
drcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

Exemplos:
Listar só as últimas revisões eliminadas das páginas Main Page e Talk:Main Page, com o conteúdo (modo 1).
api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content [abrir na página de testes]
Listar as últimas 50 contribuições eliminadas do utilizador Bob (modo 2).
api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50 [abrir na página de testes]
Listar as primeiras 50 revisões eliminadas no espaço nominal principal (modo 3).
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50 [abrir na página de testes]
Listar as primeiras 50 páginas eliminadas no espaço nominal Cumbersa (modo 3).
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique= [abrir na página de testes]

list=embeddedin (ei)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Encontrar todas as páginas que incorporam (transcluem) o título indicado.

Parâmetros:
eititle

O título a procurar. Não pode ser usado em conjunto com eipageid.

eipageid

O identificador da página a procurar. Não pode ser usado em conjunto com eititle.

Tipo: inteiro
eicontinue

Quando houver mais resultados disponíveis, usar isto para continuar

einamespace

O espaço nominal a ser enumerado.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
eidir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
eifilterredir

Como filtrar os redirecionamentos.

Um dos seguintes valores: all, redirects, nonredirects
Valor por omissão: all
eilimit

O número total de páginas a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
Exemplos:
Mostrar as páginas que transcluem Template:Stub.
api.php?action=query&list=embeddedin&eititle=Template:Stub [abrir na página de testes]
Obter informação sobre as páginas que transcluem Template:Stub.
api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info [abrir na página de testes]

list=exturlusage (eu)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Enumerar as páginas que contêm um determinado URL.

Parâmetros:
euprop

As informações que devem ser incluídas:

ids
Adiciona o identificador da página.
title
Adiciona o título e o identificador do espaço nominal da página.
url
Adiciona o URL usado na página.
Valores (separados com | ou alternativas): ids, title, url
Valor por omissão: ids|title|url
euoffset

Quando houver mais resultados disponíveis, usar isto para continuar

Tipo: inteiro
euprotocol

Protocolo do URL. Se vazio e euquery está definido, o protocolo é http. Deixe este parâmetro e euquery vazios para listar todas as hiperligações externas.

Um dos seguintes valores: Pode estar vazio, ou ser 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

Texto da pesquisa sem um protocolo. Ver Special:LinkSearch. Deixar vazio para listar todas as hiperligações externas.

eunamespace

Os espaços nominais a serem enumerados.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
eulimit

O número de páginas a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
euexpandurl

Expandir os URL relativos a protocolo com o protocolo canónico.

Tipo: booleano (detalhes)

list=filearchive (fa)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Enumerar todos os ficheiros eliminados sequencialmente.

Parâmetros:
fafrom

O título da imagem a partir do qual será começada a enumeração.

fato

O título da imagem no qual será terminada a enumeração.

faprefix

Procurar todos os títulos de imagem que começam por este valor.

fadir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
fasha1

O resumo criptográfico SHA-1 da imagem. Tem precedência sobre fasha1base36.

fasha1base36

O resumo criptográfico da imagem na base 36 (usado no MediaWiki).

faprop

As informações da imagem que devem ser obtidas:

sha1
Adiciona o resumo criptográfico SHA-1 da imagem.
timestamp
Adiciona a data e hora da versão carregada.
user
Adiciona o utilizador que carregou a versão da imagem.
size
Adiciona o tamanho da imagem em bytes e a altura, largura e contagem de páginas (se aplicável).
dimensions
Nome alternativo para size.
description
Adiciona a descrição da versão da imagem.
parseddescription
Fazer a análise sintática da descrição da versão.
mime
Adiciona o tipo MIME da imagem.
mediatype
Adiciona o tipo de multimédia da imagem.
metadata
Lista os metadados Exif para a versão da imagem.
bitdepth
Adiciona a profundidade em bits da versão.
archivename
Adiciona o nome de ficheiro da versão arquivada das versões anteriores à última.
Valores (separados com | ou alternativas): sha1, timestamp, user, size, dimensions, description, parseddescription, mime, mediatype, metadata, bitdepth, archivename
Valor por omissão: timestamp
falimit

O número total de imagens a devolver.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
facontinue

Quando houver mais resultados disponíveis, usar isto para continuar

Exemplo:
Mostrar uma lista de todos os ficheiros eliminados.
api.php?action=query&list=filearchive [abrir na página de testes]

list=gadgetcategories (gc)

  • Este módulo requer direitos de leitura.
  • Fonte: Gadgets
  • Licença: GPL-2.0-or-later

Devolve uma lista de categorias de gadgets.

Parâmetros:
gcprop

A informação de categorias de gadget a obter:

name
Nome interno da categoria.
title
Título da categoria.
members
Número de gadgets na categoria.
Valores (separados com | ou alternativas): name, title, members
Valor por omissão: name
gcnames

Nomes das categorias a obter.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
Exemplos:
Obter uma lista das categorias de gadgets existentes
api.php?action=query&list=gadgetcategories [abrir na página de testes]
Obter todas as informações sobre as categorias de nome "foo" e "bar"
api.php?action=query&list=gadgetcategories&gcnames=foo|bar&gcprop=name|title|members [abrir na página de testes]

list=gadgets (ga)

  • Este módulo requer direitos de leitura.
  • Fonte: Gadgets
  • Licença: GPL-2.0-or-later

Devolve uma lista dos gadgets usados nesta wiki.

Parâmetros:
gaprop

As informações do gadget a obter:

id
Identificador interno do gadget.
metadata
Os metadados do gadget.
desc
Descrição do gadget transformada em HTML (pode ser lento, usar só se absolutamente necessário).
Valores (separados com | ou alternativas): id, metadata, desc
Valor por omissão: id|metadata
gacategories

Categorias dos gadgets a obter.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
gaids

Identificadores dos gadgets a obter.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
gaallowedonly

Listar só os gadgets permitidos para o utilizador atual.

Tipo: booleano (detalhes)
gaenabledonly

Listar só os gadgets ativados pelo utilizador atual.

Tipo: booleano (detalhes)
Exemplos:
Obter uma lista de gadgets e as suas descrições
api.php?action=query&list=gadgets&gaprop=id|desc [abrir na página de testes]
Obter uma lista de gadgets com todas as propriedades possíveis
api.php?action=query&list=gadgets&gaprop=id|metadata|desc [abrir na página de testes]
Obter uma lista de gadgets que pertencem à categoria "foo"
api.php?action=query&list=gadgets&gacategories=foo [abrir na página de testes]
Obter informações sobre os gadgets "foo" e "bar"
api.php?action=query&list=gadgets&gaids=foo|bar&gaprop=id|desc|metadata [abrir na página de testes]
Obter uma lista dos gadgets ativados pelo utilizador atual
api.php?action=query&list=gadgets&gaenabledonly [abrir na página de testes]

list=imageusage (iu)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Encontrar todas as páginas que utilizam o título da imagem indicada.

Parâmetros:
iutitle

O título a procurar. Não pode ser usado em conjunto com iupageid.

iupageid

O identificador da página a procurar. Não pode ser usado em conjunto com iutitle.

Tipo: inteiro
iucontinue

Quando houver mais resultados disponíveis, usar isto para continuar

iunamespace

O espaço nominal a ser enumerado.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
iudir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
iufilterredir

Como filtrar redirecionamentos. Se definido como nonredirects quando iuredirect está ativado, isto só é aplicado ao segundo nível.

Um dos seguintes valores: all, redirects, nonredirects
Valor por omissão: all
iulimit

O número total de páginas a serem devolvidas. Se iuredirect estiver ativado, o nível aplica-se a cada nível em separado (o que significa que até 2 * iulimit resultados podem ser devolvidos).

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
iuredirect

Se a página que contém a hiperligação é um redirecionamento, procurar também todas as páginas que contêm hiperligações para esse redirecionamento. O limite máximo é reduzido para metade.

Tipo: booleano (detalhes)
  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.

Pode ser usado para encontrar todas as hiperligações com um prefixo, ou todas as hiperligações para um título (com um prefixo especificado). Se nenhum dos parâmetros for usado, isso efetivamente significa "todas as hiperligações interwikis".

Parâmetros:
iwblprefix

O prefixo interwikis.

iwbltitle

A hiperligação interwikis a ser procurada. Tem de ser usado em conjunto com iwblblprefix.

iwblcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

iwbllimit

O número total de páginas a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
iwblprop

As propriedades a serem obtidas:

iwprefix
Adiciona o prefixo da hiperligação interwikis.
iwtitle
Adiciona o título da hiperligação interwikis.
Valores (separados com | ou alternativas): iwprefix, iwtitle
Padrão: (vazio)
iwbldir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Encontrar todas as páginas que contêm hiperligações para a hiperligação interlínguas indicada.

Pode ser usado para encontrar todas as hiperligações para um determinado código de língua, ou todas as hiperligações para um determinado título (de uma língua). Se nenhum dos parâmetros for usado, isso efetivamente significa "todas as hiperligações interlínguas".

Note que as hiperligações interlínguas adicionadas por extensões podem não ser consideradas.

Parâmetros:
lbllang

A língua da hiperligação da língua.

lbltitle

Hiperligação interlínguas a ser procurada. Tem de ser usado com lbllang.

lblcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

lbllimit

O número total de páginas a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
lblprop

As propriedades a serem obtidas:

lllang
Adiciona o código de língua da hiperligação interlínguas.
lltitle
Adiciona o título da hiperligação interlínguas.
Valores (separados com | ou alternativas): lllang, lltitle
Padrão: (vazio)
lbldir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending

list=logevents (le)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter eventos dos registos.

Parâmetros:
leprop

As propriedades a serem obtidas:

ids
Adiciona o identificador do evento do registo.
title
Adiciona o título da página do evento do registo.
type
Adiciona o tipo do evento do registo.
user
Adiciona o utilizador responsável pelo evento do registo.
userid
Adiciona o identificador do utilizador responsável pelo evento do registo.
timestamp
Adiciona a data e hora do evento do registo.
comment
Adiciona o comentário do evento do registo.
parsedcomment
Adiciona o comentário do evento do registo, após análise sintática.
details
Lista detalhes adicionais sobre o evento do registo.
tags
Lista as etiquetas do evento do registo.
Valores (separados com | ou alternativas): ids, title, type, user, userid, timestamp, comment, parsedcomment, details, tags
Valor por omissão: ids|title|type|user|timestamp|comment|details
letype

Filtrar as entradas do registo para produzir só as deste tipo.

Um dos seguintes valores: Pode estar vazio, ou ser spamblacklist, titleblacklist, abusefilter, abusefilterprivatedetails, thanks, massmessage, renameuser, usermerge, block, protect, rights, delete, upload, move, import, patrol, merge, suppress, tag, managetags, contentmodel, timedmediahandler, poll, newusers, interwiki
leaction

Filtrar as entradas do registo para produzir só as desta operação. Tem precedência sobre letype. Na lista dos valores possíveis, os valores com o carácter de substituição asterisco action/* podem conter outros valores após a barra (/).

Um dos seguintes valores: suppress/hide-afl, suppress/unhide-afl, usermerge/mergeuser, usermerge/deleteuser, poll/create, poll/change, poll/delete, spamblacklist/*, titleblacklist/*, abusefilter/hit, abusefilter/modify, abusefilter/create, abusefilterprivatedetails/access, thanks/*, massmessage/*, massmessage/send, massmessage/failure, massmessage/skipoptout, massmessage/skipnouser, massmessage/skipbadns, renameuser/renameuser, block/block, block/reblock, block/unblock, contentmodel/change, contentmodel/new, delete/delete, delete/delete_redir, 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, patrol/autopatrol, protect/modify, protect/move_prot, protect/protect, protect/unprotect, rights/autopromote, rights/rights, suppress/block, suppress/delete, suppress/event, suppress/reblock, suppress/revision, tag/update, upload/overwrite, upload/revert, upload/upload, timedmediahandler/resettranscode, newusers/newusers, newusers/create, newusers/create2, newusers/byemail, newusers/autocreate, interwiki/*
lestart

A data e hora a partir da qual será começada a enumeração.

Tipo: data e hora (formatos permitidos)
leend

A data e hora na qual será terminada a enumeração.

Tipo: data e hora (formatos permitidos)
ledir

A direção da enumeração:

newer
Listar o mais antigo primeiro. Nota: lestart tem de estar antes de leend.
older
Listar o mais recente primeiro (padrão). Nota: lestart tem de estar depois de leend.
Um dos seguintes valores: newer, older
Valor por omissão: older
leuser

Filtrar as entradas para produzir só as criadas pelo utilizador indicado.

Tipo: nome de utilizador
letitle

Filtrar as entradas para produzir só as relacionadas com uma página.

lenamespace

Filtrar as entradas para produzir só as que estão no espaço nominal indicado.

Um dos seguintes valores: -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
leprefix

Filtrar as entradas para produzir só as que começam por este prefixo.

letag

Listar só as entradas de eventos marcadas com esta etiqueta.

lelimit

O número total de entradas de eventos a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
lecontinue

Quando houver mais resultados disponíveis, usar isto para continuar

Exemplo:
Listar os eventos recentes do registo.
api.php?action=query&list=logevents [abrir na página de testes]

list=mmsites

  • Este módulo é interno ou instável. O seu funcionamento pode ser alterado sem aviso prévio.
  • Este módulo requer direitos de leitura.
  • Fonte: MassMessage
  • Licença: GPL-2.0-or-later

Atender os pedidos de preenchimento automático para o campo do sítio em MassMessage.

Parâmetro:
term

O prefixo a pesquisar.

Este parâmetro é obrigatório.

list=mystashedfiles (msf)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter uma lista dos ficheiros que estão na área de ficheiros escondidos do utilizador atual.

Parâmetros:
msfprop

As propriedades a serem obtidas para os ficheiros.

size
Obter o tamanho do ficheiro e as dimensões da imagem.
type
Obter o tipo MIME e o tipo de multimédia do ficheiro.
Valores (separados com | ou alternativas): size, type
Padrão: (vazio)
msflimit

Quantos ficheiros a serem obtidos.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
msfcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

Exemplo:
Obter a chave, o tamanho e as dimensões em píxeis dos ficheiros na área de ficheiros escondidos do utilizador.
api.php?action=query&list=mystashedfiles&msfprop=size [abrir na página de testes]

list=pagepropnames (ppn)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Listar todos os nomes de propriedades de páginas em uso nesta wiki.

Parâmetros:
ppncontinue

Quando houver mais resultados disponíveis, usar isto para continuar

ppnlimit

O número máximo de nomes a serem devolvidos.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
Exemplo:
Obter os primeiros 10 nomes de propriedades.
api.php?action=query&list=pagepropnames [abrir na página de testes]

list=pageswithprop (pwp)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Listar todas as páginas que usam uma determinada propriedade.

Parâmetros:
pwppropname

A propriedade de página a partir da qual as páginas serão enumeradas (action=query&list=pagepropnames devolve os nomes das propriedades de página que estão a ser usadas).

Este parâmetro é obrigatório.
pwpprop

As informações que devem ser incluídas:

ids
Adiciona o identificador da página.
title
Adiciona o título e o identificador do espaço nominal da página.
value
Adiciona o valor da propriedade da página.
Valores (separados com | ou alternativas): ids, title, value
Valor por omissão: ids|title
pwpcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

pwplimit

O número máximo de páginas a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
pwpdir

A direção da ordenação.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
Exemplos:
Listar as primeiras 10 páginas que usam a propriedade {{DISPLAYTITLE:}}.
api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value [abrir na página de testes]
Obter informação adicional sobre as primeiras 10 páginas que usam __NOTOC__.
api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info [abrir na página de testes]

list=prefixsearch (ps)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Realizar uma procura de prefixo nos títulos de página.

Apesar da semelhança de nomes, este módulo não pretende ser equivalente a Special:PrefixIndex; para este, consulte action=query&list=allpages com o parâmetro apprefix. O propósito deste módulo é semelhante a action=opensearch: receber dados introduzidos pelo utilizador e devolver os títulos com melhor correspondência. Dependendo do motor de busca do servidor, isto pode incluir correções de erros ortográficos, evitar redirecionamentos, e outras heurísticas.

Parâmetros:
pssearch

O texto a ser pesquisado.

Este parâmetro é obrigatório.
psnamespace

Os espaços nominais onde realizar a pesquisa. Ignorados se pssearch começar com um prefixo de espaço nominal válido.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
Valor por omissão: 0
pslimit

O número máximo de resultados a serem devolvidos.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
psoffset

Quando houver mais resultados disponíveis, usar isto para continuar

Tipo: inteiro
Valor por omissão: 0
Exemplo:
Procurar os títulos de página que começam por meaning.
api.php?action=query&list=prefixsearch&pssearch=meaning [abrir na página de testes]

list=protectedtitles (pt)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Listar todos os títulos cuja criação está impedida.

Parâmetros:
ptnamespace

Listar só os títulos nestes espaços nominais.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
ptlevel

Listar só os títulos com estes níveis de proteção.

Valores (separados com | ou alternativas): autoconfirmed, sysop
ptlimit

O número total de páginas a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
ptdir

A direção da enumeração:

newer
Listar o mais antigo primeiro. Nota: ptstart tem de estar antes de ptend.
older
Listar o mais recente primeiro (padrão). Nota: ptstart tem de estar depois de ptend.
Um dos seguintes valores: newer, older
Valor por omissão: older
ptstart

Começar a listagem pelo título que tem esta data e hora de proteção.

Tipo: data e hora (formatos permitidos)
ptend

Terminar a listagem no título que tem esta data e hora de proteção.

Tipo: data e hora (formatos permitidos)
ptprop

As propriedades a serem obtidas:

timestamp
Adiciona a data e hora a que a proteção foi adicionada.
user
Adiciona o utilizador que fez a proteção.
userid
Adiciona o identificador do utilizador que fez a proteção.
comment
Adiciona o comentário da proteção.
parsedcomment
Adiciona o comentário da proteção após a análise sintática.
expiry
Adiciona a data e hora a que a proteção será removida.
level
Adiciona o nível de proteção.
Valores (separados com | ou alternativas): timestamp, user, userid, comment, parsedcomment, expiry, level
Valor por omissão: timestamp|level
ptcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

Exemplos:
Lista os títulos protegidos.
api.php?action=query&list=protectedtitles [abrir na página de testes]
Encontrar as hiperligações para os títulos protegidos que pertencem ao espaço nominal principal.
api.php?action=query&generator=protectedtitles&gptnamespace=0&prop=linkshere [abrir na página de testes]

list=querypage (qp)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter uma lista fornecida por uma página especial baseada em consultas (QueryPage).

Parâmetros:
qppage

O nome da página especial. Note que este é sensível a maiúsculas e minúsculas.

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, GadgetUsage
qpoffset

Quando houver mais resultados disponíveis, usar isto para continuar

Tipo: inteiro
Valor por omissão: 0
qplimit

O número de resultados a serem devolvidos.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10

list=random (rn)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter um conjunto de páginas aleatórias.

As páginas são listadas em sequência fixa, só o ponto de início da listagem é aleatório. Isto significa, por exemplo, que se a primeira página aleatória na lista é Main Page, a página List of fictional monkeys será sempre a segunda, a página List of people on stamps of Vanuatu a terceira, etc.

Parâmetros:
rnnamespace

Devolver só as páginas que estão nestes espaços nominais.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
rnfilterredir

Como filtrar redirecionamentos.

Um dos seguintes valores: all, redirects, nonredirects
Valor por omissão: nonredirects
rnredirect
Obsoleto.

Em vez dele, usar rnfilterredir=redirects.

Tipo: booleano (detalhes)
rnlimit

Limitar o número de páginas aleatórias que serão devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 1
rncontinue

Quando houver mais resultados disponíveis, usar isto para continuar

Exemplos:
Devolver duas páginas aleatórias do espaço nominal principal.
api.php?action=query&list=random&rnnamespace=0&rnlimit=2 [abrir na página de testes]
Devolver informação de página sobre duas páginas aleatórias do espaço nominal principal.
api.php?action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info [abrir na página de testes]

list=recentchanges (rc)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Enumerar as mudanças recentes.

Parâmetros:
rcstart

A data e hora a partir da qual será começada a enumeração.

Tipo: data e hora (formatos permitidos)
rcend

A data e hora na qual será terminada a enumeração.

Tipo: data e hora (formatos permitidos)
rcdir

A direção da enumeração:

newer
Listar o mais antigo primeiro. Nota: rcstart tem de estar antes de rcend.
older
Listar o mais recente primeiro (padrão). Nota: rcstart tem de estar depois de rcend.
Um dos seguintes valores: newer, older
Valor por omissão: older
rcnamespace

Filtrar as mudanças para produzir só as destes espaços nominais.

Valores (separados com | ou alternativas): -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
rcuser

Listar só as mudanças feitas por este utilizador.

Tipo: nome de utilizador
rcexcludeuser

Não listar as mudanças feitas por este utilizador.

Tipo: nome de utilizador
rctag

Listar só as mudanças marcadas com esta etiqueta.

rcprop

Incluir informações adicionais:

user
Adiciona o utilizador responsável pela edição e marca se o utilizador é um endereço IP.
userid
Adiciona o identificador do utilizador responsável pela edição.
comment
Adiciona o comentário da edição.
parsedcomment
Adiciona o comentário da edição, após análise sintática.
flags
Adiciona as etiquetas da edição.
timestamp
Adiciona a data e hora da edição.
title
Adiciona o título de página da edição.
ids
Adiciona o identificadores da página, das mudanças recentes, e das revisões nova e antiga.
sizes
Adiciona os tamanhos antigo e novo da página em bytes.
redirect
Etiqueta a página se esta for um redirecionamento.
patrolled
Etiqueta as edições que podem ser patrulhadas, marcando-as como patrulhadas ou não patrulhadas.
loginfo
Adiciona informação de registo (identificador do registo, tipo de entrada, etc.) às entradas do registo.
tags
Lista as etiquetas da entrada.
sha1
Adiciona a soma de controlo do conteúdo para as entradas associadas com uma revisão.
Valores (separados com | ou alternativas): user, userid, comment, parsedcomment, flags, timestamp, title, ids, sizes, redirect, patrolled, loginfo, tags, sha1
Valor por omissão: title|timestamp|ids
rctoken
Obsoleto.

Em substituição, usar action=query&meta=tokens.

Valores (separados com | ou alternativas): patrol
rcshow

Mostrar só as entradas que correspondem a estes critérios. Por exemplo, para ver só as edições menores feitas por utilizadores autenticados, defina rcshow=minor|!anon.

Valores (separados com | ou alternativas): minor, !minor, bot, !bot, anon, !anon, redirect, !redirect, patrolled, !patrolled, unpatrolled, autopatrolled, !autopatrolled
rclimit

O número total de mudanças a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
rctype

Os tipos de mudanças a serem mostradas.

Valores (separados com | ou alternativas): edit, new, log, external, categorize
Valor por omissão: edit|new|log|categorize
rctoponly

Listar só as alterações que são a revisão mais recente.

Tipo: booleano (detalhes)
rccontinue

Quando houver mais resultados disponíveis, usar isto para continuar

rcgeneraterevisions

Ao ser usado como gerador, gerar identificadores de revisões em vez de títulos. As entradas das mudanças recentes que não tenham identificadores de revisão associados (por exemplo, a maioria das entradas do registo) não geram nada.

Tipo: booleano (detalhes)
Exemplos:
Listar as mudanças recentes.
api.php?action=query&list=recentchanges [abrir na página de testes]
Obter informação de página acerca das mudanças recentes não patrulhadas.
api.php?action=query&generator=recentchanges&grcshow=!patrolled&prop=info [abrir na página de testes]

list=search (sr)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Efetuar uma pesquisa do texto integral.

Parâmetros:
srsearch

Procurar os títulos de página ou o conteúdo que corresponda a este valor. Pode usar o texto da pesquisa para invocar funcionalidades de pesquisa especiais, dependendo dos meios de pesquisa do servidor da wiki.

Este parâmetro é obrigatório.
srnamespace

Pesquisar só nestes espaços nominais.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
Valor por omissão: 0
srlimit

O número total de páginas a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
sroffset

Quando houver mais resultados disponíveis, usar isto para continuar

Tipo: inteiro
Valor por omissão: 0
srwhat

O tipo de pesquisa a executar.

Um dos seguintes valores: title, text, nearmatch
srinfo

Quais os metadados a serem devolvidos.

Valores (separados com | ou alternativas): totalhits, suggestion, rewrittenquery
Valor por omissão: totalhits|suggestion|rewrittenquery
srprop

As propriedades a serem devolvidas:

size
Adiciona o tamanho da página em bytes.
wordcount
Adiciona o número de palavras da página.
timestamp
Adiciona a data e hora a que a página foi editada pela última vez.
snippet
Adiciona um fragmento de código com a página, após análise sintática.
titlesnippet
Adiciona um fragmento de código com o título da página, após análise sintática.
redirecttitle
Adiciona o título do redirecionamento correspondente.
redirectsnippet
Adiciona um fragmento de código com o título redirecionado, após análise sintática.
sectiontitle
Adiciona o título da secção correspondente.
sectionsnippet
Adiciona um fragmento de código com o título da secção correspondente, após análise sintática.
isfilematch
Adiciona um valor booleano que indica se a pesquisa encontrou correspondência no conteúdo de ficheiros.
categorysnippet
Adiciona um fragmento de código com a categoria correspondente, após análise sintática.
score
Obsoleto. Ignorado.
hasrelated
Obsoleto. Ignorado.
extensiondata
Acrescenta dados adicionais gerados por extensões.
Valores (separados com | ou alternativas): size, wordcount, timestamp, snippet, titlesnippet, redirecttitle, redirectsnippet, sectiontitle, sectionsnippet, isfilematch, categorysnippet, score, hasrelated, extensiondata
Valor por omissão: size|wordcount|timestamp|snippet
srinterwiki

Incluir resultados interwikis na pesquisa, se disponíveis.

Tipo: booleano (detalhes)
srenablerewrites

Ativar a reescrita da pesquisa interna. Alguns motores de pesquisa podem reescrever a pesquisa substituindo-a por outra que consideram que dará melhores resultados, por exemplo, por corrigir erros de ortografia.

Tipo: booleano (detalhes)

list=tags (tg)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Listar as etiquetas de modificação.

Parâmetros:
tgcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

tglimit

O número máximo de etiquetas a serem listadas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
tgprop

As propriedades a serem obtidas:

displayname
Adiciona a mensagem de sistema para a etiqueta.
description
Adiciona a descrição da etiqueta.
hitcount
Adiciona o número de revisões e de entradas no registo que têm esta etiqueta.
defined
Indicar se a etiqueta está definida.
source
Obter as fontes da etiqueta, que podem incluir extension para etiquetas definidas por extensões e manual para etiquetas que podem ser manualmente aplicadas pelos utilizadores.
active
Indica se a etiqueta ainda está a ser aplicada.
Valores (separados com | ou alternativas): displayname, description, hitcount, defined, source, active
Padrão: (vazio)

list=usercontribs (uc)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter todas as edições de um utilizador.

Parâmetros:
uclimit

O número máximo de contribuições a serem devolvidas.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
ucstart

A data e hora da contribuição pela qual será começada a devolução de resultados.

Tipo: data e hora (formatos permitidos)
ucend

A data e hora da contribuição na qual será terminada a devolução de resultados.

Tipo: data e hora (formatos permitidos)
uccontinue

Quando houver mais resultados disponíveis, usar isto para continuar

ucuser

Os utilizadores cujas contribuições serão obtidas. Não pode ser usado em conjunto com ucuserids ou ucuserprefix.

Tipo: lista de nomes de utilizadores
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
ucuserids

Os identificadores dos utilizadores cujas contribuições serão obtidas. Não pode ser usado em conjunto com ucuser ou ucuserprefix.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
ucuserprefix

Obter as contribuições de todos os utilizadores cujos nomes começam por este valor. Não pode ser usado em conjunto com ucuser ou ucuserids.

ucdir

A direção da enumeração:

newer
Listar o mais antigo primeiro. Nota: ucstart tem de estar antes de ucend.
older
Listar o mais recente primeiro (padrão). Nota: ucstart tem de estar depois de ucend.
Um dos seguintes valores: newer, older
Valor por omissão: older
ucnamespace

Listar só as contribuições nestes espaços nominais.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
ucprop

Incluir informações adicionais:

ids
Adiciona os identificadores da página e da revisão.
title
Adiciona o título e o identificador do espaço nominal da página.
timestamp
Adiciona a data e hora da edição.
comment
Adiciona o comentário da edição.
parsedcomment
Adiciona o comentário da edição, após análise sintática.
size
Adiciona o novo tamanho da edição.
sizediff
Adiciona a diferença de tamanho entre a edição e a sua progenitora.
flags
Adiciona as etiquetas da edição.
patrolled
Etiqueta as edições patrulhadas.
tags
Lista as etiquetas da edição.
Valores (separados com | ou alternativas): ids, title, timestamp, comment, parsedcomment, size, sizediff, flags, patrolled, tags
Valor por omissão: ids|title|timestamp|comment|size|flags
ucshow

Mostrar só as contribuições que correspondem a estes critérios; por exemplo, só as edições não menores: ucshow=!minor.

Se um dos valores ucshow=patrolled ou ucshow=!patrolled estiver definido, as revisões feitas há mais de $wgRCMaxAge (7776000 segundos) não serão mostradas.

Valores (separados com | ou alternativas): minor, !minor, patrolled, !patrolled, autopatrolled, !autopatrolled, top, !top, new, !new
uctag

Listar só as revisões marcadas com esta etiqueta.

uctoponly
Obsoleto.

Listar só as alterações que são a revisão mais recente.

Tipo: booleano (detalhes)
Exemplos:
Mostrar as contribuições do utilizador Example.
api.php?action=query&list=usercontribs&ucuser=Example [abrir na página de testes]
Mostrar as contribuições de todos os endereços IP com o prefixo 192.0.2..
api.php?action=query&list=usercontribs&ucuserprefix=192.0.2. [abrir na página de testes]

list=users (us)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter informações sobre uma lista de utilizadores.

Parâmetros:
usprop

As informações que devem ser incluídas:

blockinfo
Etiquetas que indicam se o utilizador está bloqueado, por quem, e qual o motivo.
groups
Lista todos os grupos aos quais cada utilizador pertence.
groupmemberships
Lista os grupos aos quais cada utilizador foi explicitamente atribuído, incluindo a data de expiração da sua pertença a cada grupo.
implicitgroups
Lista todos os grupos aos quais um utilizador pertence automaticamente.
rights
Lista todas as permissões que cada utilizador tem.
editcount
Adiciona a contagem de edições do utilizador.
registration
Adiciona a data e hora de registo do utilizador.
emailable
Etiqueta que indica se o utilizador pode e quer receber correio eletrónico através de Special:Emailuser.
gender
Etiqueta que indica o género do utilizador. Devolve "male" (masculino), "female" (feminino) ou "unknown" (desconhecido).
centralids
Adiciona os identificadores centrais e o estado de ligação central (attachment) do utilizador.
cancreate
Indica se pode ser criada uma conta para os nomes de utilizador não registados, mas válidos.
Valores (separados com | ou alternativas): blockinfo, groups, groupmemberships, implicitgroups, rights, editcount, registration, emailable, gender, centralids, cancreate
usattachedwiki

Com usprop=centralids, indicar se o utilizador tem ligação com a wiki designada por este identificador.

ususers

Uma lista de utilizadores dos quais serão obtidas informações.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
ususerids

Uma lista de identificadores dos utilizadores de que serão obtidas informações.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
ustoken
Obsoleto.

Em substituição, usar action=query&meta=tokens.

Valores (separados com | ou alternativas): userrights

list=watchlist (wl)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter mudanças recentes das páginas vigiadas do utilizador atual.

Parâmetros:
wlallrev

Incluir revisões múltiplas da mesma página dentro do intervalo de tempo indicado.

Tipo: booleano (detalhes)
wlstart

A data e hora da mudança recente a partir da qual será começada a enumeração.

Tipo: data e hora (formatos permitidos)
wlend

A data e hora da mudança recente na qual será terminada a enumeração.

Tipo: data e hora (formatos permitidos)
wlnamespace

Filtrar as mudanças para produzir só as dos espaços nominais indicados.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
wluser

Listar só as mudanças deste utilizador.

Tipo: nome de utilizador
wlexcludeuser

Não listar as mudanças deste utilizador.

Tipo: nome de utilizador
wldir

A direção da enumeração:

newer
Listar o mais antigo primeiro. Nota: wlstart tem de estar antes de wlend.
older
Listar o mais recente primeiro (padrão). Nota: wlstart tem de estar depois de wlend.
Um dos seguintes valores: newer, older
Valor por omissão: older
wllimit

O número total de resultados a serem devolvidos por pedido.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
wlprop

As propriedades adicionais que devem ser obtidas:

ids
Adiciona identificadores de revisões e de páginas.
title
Adiciona o título da página.
flags
Adiciona etiquetas para a edição.
user
Adiciona o utilizador que fez a edição.
userid
Adiciona o identificador do utilizador que realizou a edição.
comment
Adiciona o comentário da edição.
parsedcomment
Adiciona o comentário da edição, após análise sintática.
timestamp
Adiciona a data e hora da edição.
patrol
Etiqueta que indica as edições que são patrulhadas.
sizes
Adiciona o tamanho novo e antigo da página.
notificationtimestamp
Adiciona a data e hora da última vez em que o utilizador foi notificado da edição.
loginfo
Adiciona informação do registo quando apropriado.
tags
Lista as etiquetas da entrada.
Valores (separados com | ou alternativas): ids, title, flags, user, userid, comment, parsedcomment, timestamp, patrol, sizes, notificationtimestamp, loginfo, tags
Valor por omissão: ids|title|flags
wlshow

Mostrar só as entradas que correspondem a estes critérios. Por exemplo, para ver só as edições menores feitas por utilizadores autenticados, definir wlshow=minor|!anon.

Valores (separados com | ou alternativas): minor, !minor, bot, !bot, anon, !anon, patrolled, !patrolled, autopatrolled, !autopatrolled, unread, !unread
wltype

Os tipos de alterações a serem mostradas:

edit
Edições normais.
new
Criações de páginas.
log
Entradas do registo.
external
Mudanças externas.
categorize
Alterações de pertença a categorias.
Valores (separados com | ou alternativas): edit, new, log, external, categorize
Valor por omissão: edit|new|log|categorize
wlowner

Usado com wltoken para aceder à lista de páginas vigiadas de outro utilizador.

Tipo: nome de utilizador
wltoken

Uma chave de segurança (disponível nas preferências do utilizador) para permitir acesso à lista de páginas vigiadas de outro utilizador.

wlcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

Exemplos:
Listar a revisão mais recente das páginas com mudanças recentes na lista de páginas vigiadas do utilizador atual.
api.php?action=query&list=watchlist [abrir na página de testes]
Obter informação adicional sobre a revisão mais recente das páginas vigiadas do utilizador atual que tenham sido alteradas.
api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment [abrir na página de testes]
Obter informações sobre todas as mudanças recentes às páginas vigiadas do utilizador atual.
api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment [abrir na página de testes]
Obter informações das páginas na lista de páginas vigiadas do utilizador atual que tenham sido recentemente alteradas.
api.php?action=query&generator=watchlist&prop=info [abrir na página de testes]
Obter informações de revisão para as mudanças recentes às páginas vigiadas do utilizador atual.
api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user [abrir na página de testes]
Listar a revisão mais recente das páginas na lista de páginas vigiadas do utilizador Example que tenham sido recentemente alteradas.
api.php?action=query&list=watchlist&wlowner=Example&wltoken=123ABC [abrir na página de testes]

list=watchlistraw (wr)

  • Este módulo requer direitos de leitura.
  • Este módulo pode ser usado como gerador.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter todas as páginas na lista de páginas vigiadas do utilizador atual.

Parâmetros:
wrcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

wrnamespace

Listar só as páginas nos espaços nominais indicados.

Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 110, 111, 710, 711, 828, 829, 2300, 2301, 2302, 2303
Para especificar todos os valores, use *.
wrlimit

O número total de resultados a serem devolvidos por pedido.

Não são permitidos mais do que 500 (5 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
wrprop

As propriedades adicionais que devem ser obtidas:

changed
Adiciona a data e hora da última vez em que o utilizador foi notificado da edição.
Valores (separados com | ou alternativas): changed
wrshow

Listar só os elementos que preenchem estes critérios.

Valores (separados com | ou alternativas): changed, !changed
wrowner

Usado em conjunto com o parâmetro wrtoken para aceder à lista de páginas vigiadas de outro utilizador.

Tipo: nome de utilizador
wrtoken

Uma chave de segurança (disponível nas preferências do utilizador) para permitir acesso à lista de páginas vigiadas de outro utilizador.

wrdir

A direção de listagem.

Um dos seguintes valores: ascending, descending
Valor por omissão: ascending
wrfromtitle

O título (com o prefixo do espaço nominal) a partir do qual será começada a enumeração.

wrtotitle

O título (com o prefixo do espaço nominal) no qual será terminada a enumeração.

Exemplos:
Listar as páginas na lista de páginas vigiadas do utilizador atual.
api.php?action=query&list=watchlistraw [abrir na página de testes]
Obter informações das páginas na lista de páginas vigiadas do utilizador atual.
api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=info [abrir na página de testes]

meta=allmessages (am)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolver as mensagens deste sítio.

Parâmetros:
ammessages

Mensagens a serem produzidas no resultado. * (o valor por omissão) significa todas as mensagens.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
Valor por omissão: *
amprop

As propriedades a serem obtidas:

Valores (separados com | ou alternativas): default
amenableparser

Definir para ativar o analisador sintático; irá pré-processar o texto wiki da mensagem (substituir palavras mágicas, processar predefinições, etc.).

Tipo: booleano (detalhes)
amnocontent

Se definido, não incluir o conteúdo das mensagens no resultado de saída.

Tipo: booleano (detalhes)
amincludelocal

Incluir também as mensagens locais, isto é, mensagens que não existem no software mas existem como uma página no espaço nominal Biqui. Isto lista todas as páginas do espaço nominal Biqui, portanto, também irá listar aquelas que não são verdadeiramente mensagens, como Common.js.

Tipo: booleano (detalhes)
amargs

Os argumentos a serem substituídos na mensagem.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
amfilter

Devolver só as mensagens cujos nomes contêm este texto.

amcustomised

Devolver só as mensagens neste estado de personalização.

Um dos seguintes valores: all, modified, unmodified
Valor por omissão: all
amlang

Devolver as mensagens nesta língua.

amfrom

Devolver as mensagens, a partir desta mensagem.

amto

Devolver as mensagens, até esta mensagem.

amtitle

Nome da página a utilizar como contexto ao fazer a análise sintática da mensagem (para a opção amenableparser).

amprefix

Devolver as mensagens com este prefixo.

meta=authmanagerinfo (ami)

Obter informação sobre o atual estado de autenticação.

Parâmetros:
amisecuritysensitiveoperation

Testar se o estado atual de autenticação do utilizador é suficiente para a operação especificada, que exige condições seguras.

amirequestsfor

Obter informação sobre os pedidos de autenticação que são necessários para a operação de autenticação especificada.

Um dos seguintes valores: login, login-continue, create, create-continue, link, link-continue, change, remove, unlink
amimergerequestfields

Combinar a informação de todos os pedidos de autenticação numa única matriz.

Tipo: booleano (detalhes)
amimessageformat

Formato a usar nas mensagens de saída.

Um dos seguintes valores: html, wikitext, raw, none
Valor por omissão: wikitext
Exemplos:
Obter os pedidos que podem ser usados ao iniciar uma sessão.
api.php?action=query&meta=authmanagerinfo&amirequestsfor=login [abrir na página de testes]
Obter os pedidos que podem ser usados ao iniciar uma sessão, com os campos combinados.
api.php?action=query&meta=authmanagerinfo&amirequestsfor=login&amimergerequestfields=1 [abrir na página de testes]
Testar se a autenticação é suficiente para a operação foo.
api.php?action=query&meta=authmanagerinfo&amisecuritysensitiveoperation=foo [abrir na página de testes]

meta=filerepoinfo (fri)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolver meta informação sobre os repositórios de imagens configurados na wiki.

Parâmetro:
friprop

As propriedades do repositório que devem ser obtidas (em algumas wikis poderão haver mais disponíveis):

apiurl
URL para a API do repositório - útil para obter informação de imagens do servidor.
name
A chave para o repositório - usada, por exemplo, em $wgForeignFileRepos e nos valores de retorno de imageinfo.
displayname
O nome legível da wiki repositório.
rooturl
URL de raiz para endereços de imagens.
local
Se o repositório é o local ou não.
Valores (separados com | ou alternativas): name, displayname, rootUrl, local, url, thumbUrl, initialCapital, descBaseUrl, fetchDescription, scriptDirUrl, descriptionCacheExpiry, apiurl, articlepath, server, favicon, canUpload
Valor por omissão: name|displayname|rootUrl|local|url|thumbUrl|initialCapital|descBaseUrl|fetchDescription|scriptDirUrl|descriptionCacheExpiry|apiurl|articlepath|server|favicon|canUpload

meta=notifications (not)

  • Este módulo requer direitos de leitura.
  • Fonte: Echo
  • Licença: MIT

Obter notificações à espera do utilizador atual.

Parâmetros:
notfilter

Filtrar as notificações devolvidas.

Valores (separados com | ou alternativas): read, !read
Valor por omissão: read|!read
notprop

Detalhes a pedir.

Valores (separados com | ou alternativas): list, count, seenTime
Valor por omissão: list
notsections

As secções das notificações a consultar (isto é, uma combinação de 'alert' e 'message')

Valores (separados com | ou alternativas): alert, message
Valor por omissão: alert|message
notgroupbysection

Indica se o resultado deve ser agrupado por secções. Se definida, cada secção é obtida em separado.

Tipo: booleano (detalhes)
notformat

Se especificado, as notificações serão devolvidas neste formato.

model
Dados de notificações em bruto
special
Formatado para a página Special:Notifications (e só para esse efeito!) Não confie no formato HTML porque este pode ser alterado a qualquer altura.
flyout
Obsoleto. Usar notformat=model para os dados em bruto
html
Obsoleto. Usar notformat=model para os dados em bruto
Um dos seguintes valores: model, special, flyout, html
notlimit

O número máximo de notificações a devolver.

Não são permitidos mais do que 50 (500 para robôs).
Tipo: inteiro ou max
Valor por omissão: 20
notcontinue

Quando houver mais resultados disponíveis, usar isto para continuar

notunreadfirst

Indica se as notificações não lidas devem ser mostradas primeiro (só é usado se groupbysection não estiver definido).

Tipo: booleano (detalhes)
nottitles

Devolver só as notificações associadas a estas páginas. Para obter as notificações não associadas a qualquer página, use [] como título.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
notbundle

Indica se as notificações não lidas compatíveis com agrupamentos, devem ser mostradas de acordo com as regras de agrupamento de tipos de notificação.

Tipo: booleano (detalhes)
notalertcontinue

Quando existem mais resultados de alertas disponíveis, usar isto para continuar.

notalertunreadfirst

Indica se as notificações de mensagem não lidas devem ser mostradas primeiro (só é usado se groupbysection estiver definido).

Tipo: booleano (detalhes)
notmessagecontinue

Quando existem mais resultados de mensagens disponíveis, usar isto para continuar.

notmessageunreadfirst

Indica se as notificações de alerta não lidas devem ser mostradas primeiro (só é usado se groupbysection estiver definido).

Tipo: booleano (detalhes)

meta=oath (oath)

  • Este módulo é interno ou instável. O seu funcionamento pode ser alterado sem aviso prévio.
  • Este módulo requer direitos de leitura.
  • Fonte: OATHAuth
  • Licença: GPL-2.0-or-later AND GPL-3.0-or-later

Verificar se a autenticação de dois fatores (OATH) está ativa para um utilizador.

Parâmetro:
oathuser

Utilizador acerca do qual será obtida informação. Por omissão, o utilizador atual.

Tipo: nome de utilizador
Exemplos:
Obter informações sobre o utilizador atual
api.php?action=query&meta=oath [abrir na página de testes]
Obter informação sobre o utilizador Example
api.php?action=query&meta=oath&oathuser=Example [abrir na página de testes]

meta=siteinfo (si)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Devolver informação geral sobre o sítio.

Parâmetros:
siprop

A informação a ser obtida:

general
Informação global do sistema.
namespaces
Uma lista dos espaços nominais registados e dos seus nomes canónicos.
namespacealiases
Uma lista dos nomes alternativos dos espaços nominais registados.
specialpagealiases
Uma lista dos nomes alternativos das páginas especiais.
magicwords
Uma lista das palavras mágicas e dos seus nomes alternativos.
interwikimap
Devolve o mapa de interwikis (opcionalmente filtrado, opcionalmente localizado usando siinlanguagecode).
dbrepllag
Devolve o servidor da base de dados com o maior atraso de replicação.
statistics
Devolve as estatísticas do sítio.
usergroups
Devolve os grupos de utilizadores e as permissões associadas.
libraries
Devolve as bibliotecas instaladas na wiki.
extensions
Devolve as extensões instaladas na wiki.
fileextensions
Devolve uma lista das extensões (tipos) dos ficheiros que podem ser carregados.
rightsinfo
Devolve informação sobre os direitos (a licença) da wiki, se disponível.
restrictions
Devolve informação sobre os tipos de restrição (proteção) disponíveis.
languages
Devolve uma lista das línguas que o MediaWiki suporta (opcionalmente localizada, usando siinlanguagecode).
languagevariants
Devolve uma lista dos códigos de língua para os quais o LanguageConverter está ativado, e as variantes suportadas para cada código.
skins
Devolve uma lista de todos os temas ativados (opcionalmente localizada, usando siinlanguagecode, ou então na língua do conteúdo).
extensiontags
Devolve uma lista dos elementos de extensões do analisador sintático.
functionhooks
Devolve uma lista dos hooks de funções do analisador sintático.
showhooks
Devolve uma lista de todos os hooks subscritos (conteúdo de $wgHooks).
variables
Devolve uma lista de identificadores de variáveis.
protocols
Devolve uma lista dos protocolos permitidos nas hiperligações externas.
defaultoptions
Devolve os valores padrão para as preferências dos utilizadores.
uploaddialog
Devolve a configuração do diálogo de carregamento.
Valores (separados com | ou alternativas): general, namespaces, namespacealiases, specialpagealiases, magicwords, interwikimap, dbrepllag, statistics, usergroups, libraries, extensions, fileextensions, rightsinfo, restrictions, languages, languagevariants, skins, extensiontags, functionhooks, showhooks, variables, protocols, defaultoptions, uploaddialog
Valor por omissão: general
sifilteriw

Devolver só as entradas locais, ou só as não locais, do mapa de interwikis.

Um dos seguintes valores: local, !local
sishowalldb

Listar todos os servidores da base de dados, não só aquele que tem maior atraso.

Tipo: booleano (detalhes)
sinumberingroup

Lista o número de utilizadores nos grupos de utilizadores.

Tipo: booleano (detalhes)
siinlanguagecode

O código de língua dos nomes localizados (o melhor possível) das línguas e dos temas.

meta=tokens

Obtém chaves para operações de modificação de dados.

Parâmetro:
type

Tipos de chave a pedir.

Valores (separados com | ou alternativas): createaccount, csrf, login, patrol, rollback, userrights, watch
Valor por omissão: csrf
Exemplos:
Obter uma chave csfr (padrão).
api.php?action=query&meta=tokens [abrir na página de testes]
Obter uma chave de vigilância e uma chave de patrulha.
api.php?action=query&meta=tokens&type=watch|patrol [abrir na página de testes]

meta=unreadnotificationpages (unp)

  • Este módulo requer direitos de leitura.
  • Fonte: Echo
  • Licença: MIT

Obter as páginas que contêm notificações não lidas para o utilizador atual.

Parâmetros:
unpgrouppages

Agrupar as páginas de discussão com a respetiva página de conteúdo, e agrupar as notificações não associadas a uma página com a página do utilizador atual.

Tipo: booleano (detalhes)
unplimit

O número máximo de páginas a serem devolvidas.

Não são permitidos mais do que 2 000 (2 000 para robôs).
Tipo: inteiro ou max
Valor por omissão: 10
Exemplo:
Listar páginas com notificações não lidas e respetiva quantidade
api.php?action=query&meta=unreadnotificationpages [abrir na página de testes]

meta=userinfo (ui)

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter informações sobre o utilizador atual.

Parâmetros:
uiprop

As informações que devem ser incluídas:

blockinfo
Etiquetas que indicam se o utilizador atual está bloqueado, por quem, e qual o motivo.
hasmsg
Adiciona uma etiqueta messages se o utilizador atual tem mensagens pendentes.
groups
Lista todos os grupos aos quais o utilizador atual pertence.
groupmemberships
Lista os grupos aos quais o utilizador atual foi explicitamente atribuído, incluindo a data de expiração da sua pertença a cada grupo.
implicitgroups
Lista todos os grupos aos quais o utilizador atual pertence automaticamente.
rights
Lista todas as permissões que o utilizador atual tem.
changeablegroups
Lista os grupos aos quais o utilizador atual pode ser adicionado ou de onde pode ser removido.
options
Lista todas as preferências que o utilizador atual definiu.
editcount
Adiciona a contagem de edições do utilizador atual.
ratelimits
Lista todas as frequências limite do utilizador atual.
email
Adicionar o correio eletrónico do utilizador e a data de autenticação do correio eletrónico.
realname
Adiciona o nome real do utilizador.
acceptlang
Faz eco do cabeçalho Accept-Language enviado pelo cliente num formato estruturado.
registrationdate
Adiciona a data de registo do utilizador.
unreadcount
Adiciona a contagem de páginas não lidas da lista de páginas vigiadas do utilizador (máximo 999; devolve 1000+ se forem mais).
centralids
Adiciona os identificadores centrais e o estado de ligação central (attachment) do utilizador.
preferencestoken
Obsoleto. Obter uma chave para alterar as preferências do utilizador atual.
Valores (separados com | ou alternativas): blockinfo, hasmsg, groups, groupmemberships, implicitgroups, rights, changeablegroups, options, editcount, ratelimits, email, realname, acceptlang, registrationdate, unreadcount, centralids, preferencestoken
uiattachedwiki

Com uiprop=centralids, indicar se o utilizador tem ligação com a wiki designada por este identificador.

Exemplos:
Obter informações sobre o utilizador atual.
api.php?action=query&meta=userinfo [abrir na página de testes]
Obter informações adicionais sobre o utilizador atual.
api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg [abrir na página de testes]

action=removeauthenticationdata

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Remover os dados de autenticação do utilizador atual.

Parâmetros:
request

Usar este pedido de autenticação, com o id devolvido por action=query&meta=authmanagerinfo com amirequestsfor=remove.

Este parâmetro é obrigatório.
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplo:
Tentar remover os dados do utilizador atual para o pedido de autenticação FooAuthenticationRequest.
api.php?action=removeauthenticationdata&request=FooAuthenticationRequest&token=123ABC [abrir na página de testes]

action=resetpassword

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Enviar a um utilizador uma mensagem eletrónica de reinício da palavra-passe.

Parâmetros:
user

O utilizar cuja palavra-passe será reiniciada.

Tipo: nome de utilizador
email

O correio eletrónico do utilizador cuja palavra-passe será reiniciada.

token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplos:
Enviar uma mensagem eletrónica para reinício da palavra-passe ao utilizador Example.
api.php?action=resetpassword&user=Example&token=123ABC [abrir na página de testes]
Enviar uma mensagem eletrónica para reinício da palavra-passe a todos os utilizadores com o correio eletrónico [email protected].
api.php?action=resetpassword&[email protected]&token=123ABC [abrir na página de testes]

action=revisiondelete

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Eliminar e restaurar revisões.

Parâmetros:
type

O tipo de eliminação de revisão que está a ser feito.

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

O título de página para a eliminação da revisão, se for necessário para o tipo de eliminação.

ids

Os identificadores das revisões a serem eliminadas.

Este parâmetro é obrigatório.
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
hide

O que deve ser ocultado para cada revisão.

Valores (separados com | ou alternativas): content, comment, user
show

O que deve ser mostrado para cada revisão.

Valores (separados com | ou alternativas): content, comment, user
suppress

Indica se devem ser suprimidos os dados aos administradores como a todos os restantes utilizadores.

Um dos seguintes valores: yes, no, nochange
Valor por omissão: nochange
reason

O motivo da eliminação ou restauro.

tags

Etiquetas a aplicar à entrada no registo de eliminações.

Valores (separados com | ou alternativas):
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=rollback

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Desfazer a última edição da página.

Se o último utilizador que editou a página tiver realizado várias edições consecutivas, elas serão todas revertidas.

Parâmetros:
title

O título da página a reverter. Não pode ser usado em conjunto com pageid.

pageid

O identificador da página a reverter. Não pode ser usado em conjunto com title.

Tipo: inteiro
tags

As etiquetas a aplicar à reversão.

Valores (separados com | ou alternativas):
user

O nome do utilizador cujas edições vão ser revertidas.

Este parâmetro é obrigatório.
Tipo: nome de utilizador
summary

Resumo personalizado da edição. Se estiver vazio, será utilizado o resumo por omissão.

Padrão: (vazio)
markbot

Marcar as edições revertidas e a reversão como edições de robôs.

Tipo: booleano (detalhes)
watchlist

Adicionar ou remover incondicionalmente a página da lista de páginas vigiadas do utilizador atual, usar as preferências ou não alterar o estado de vigilância.

Um dos seguintes valores: watch, unwatch, preferences, nochange
Valor por omissão: preferences
token

Uma chave "rollback" obtida de action=query&meta=tokens

Para efeitos de compatibilidade, a chave usada na interface web também é aceite.

Este parâmetro é obrigatório.
Exemplos:
Reverter as últimas edições da página Main Page pelo utilizador Example.
api.php?action=rollback&title=Main%20Page&user=Example&token=123ABC [abrir na página de testes]
Reverter as últimas edições da página Main Page pelo utilizador IP 192.0.2.5 com o resumo Reverting vandalism, e marcar essas edições e a reversão como edições de robôs.
api.php?action=rollback&title=Main%20Page&user=192.0.2.5&token=123ABC&summary=Reverting%20vandalism&markbot=1 [abrir na página de testes]

action=rsd

(main | rsd)

Exportar um esquema (schema) RSD (Really Simple Discovery).

Exemplo:
Exportar o esquema RSD.
api.php?action=rsd [abrir na página de testes]

action=scribunto-console

  • Este módulo é interno ou instável. O seu funcionamento pode ser alterado sem aviso prévio.
  • Este módulo requer direitos de leitura.
  • Fonte: Scribunto
  • Licença: GPL-2.0-or-later AND MIT

Módulo anterno pa respunder ls pedidos XHR benidos de la cunsuola Scribunto.

Parâmetros:
title

L títalo de l módulo a ser testado.

content

L nuobo cuntenido de l módulo.

session

Chabe de la sesson.

Tipo: inteiro
question

La próssima lhinha a abaluar cumo un quemando.

Este parâmetro é obrigatório.
clear

Defenir pa lhimpar l stado de la sesson atual.

Tipo: booleano (detalhes)

action=setnotificationtimestamp

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Atualizar a data e hora de notificação de alterações às páginas vigiadas.

Isto afeta o realce das páginas alteradas, na lista de páginas vigiadas e no histórico, e o envio de mensagens de correio quando a preferência "Abisar-me por correio eiletrónico quando ua páigina begiada fur altarada" está ativada.

Parâmetros:
entirewatchlist

Trabalhar em todas as páginas vigiadas.

Tipo: booleano (detalhes)
timestamp

A data e hora a definir como data e hora da notificação.

Tipo: data e hora (formatos permitidos)
torevid

A revisão para a qual definir a data e hora de notificação (só uma página).

Tipo: inteiro
newerthanrevid

A revisão da qual definir que a data e hora de notificação é mais recente (só uma página).

Tipo: inteiro
continue

Quando houver mais resultados disponíveis, usar isto para continuar

titles

Uma lista dos títulos a serem trabalhados.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
pageids

Uma lista dos identificadores de página a serem trabalhados.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
revids

Uma lista dos identificadores de revisões a serem trabalhados.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
generator

Obter a lista de páginas nas quais trabalhar, executando o módulo de consulta especificado.

Nota: Os nomes dos parâmetros de geradores têm de ser prefixados com um "g", veja os exemplos.

allcategories
Enumerar todas as categorias.
alldeletedrevisions
Listar todas as revisões eliminadas por um utilizador ou de um espaço nominal.
allfileusages
Listar todas as utilizações de ficheiros, incluindo ficheiros que não existam.
allimages
Enumerar todas as imagens sequencialmente.
alllinks
Enumerar todas as hiperligações que apontam para um determinado espaço nominal.
allpages
Enumerar sequencialmente todas as páginas de um determinado espaço nominal.
allredirects
Listar todos os redirecionamentos para um espaço nominal.
allrevisions
Listar todas as revisões.
alltransclusions
Listar todas as transclusões (páginas incorporadas utilizando {{x}}), incluindo as que estejam em falta.
backlinks
Encontrar todas as páginas que contêm hiperligações para a página indicada.
categories
Listar todas as categorias às quais as páginas pertencem.
categorymembers
Listar todas as páginas numa categoria específica.
deletedrevisions
Obter informações sobre as revisões eliminadas.
duplicatefiles
Listar todos os ficheiros que são duplicados dos ficheiros indicados com base no seu resumo criptográfico.
embeddedin
Encontrar todas as páginas que incorporam (transcluem) o título indicado.
exturlusage
Enumerar as páginas que contêm um determinado URL.
fileusage
Encontrar todas as páginas que usam os ficheiros indicados.
images
Devolve todos os ficheiros contidos nas páginas indicadas.
imageusage
Encontrar todas as páginas que utilizam o título da imagem indicada.
iwbacklinks
Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
langbacklinks
Encontrar todas as páginas que contêm hiperligações para a hiperligação interlínguas indicada.
links
Devolve todas as hiperligações das páginas indicadas.
linkshere
Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
pageswithprop
Listar todas as páginas que usam uma determinada propriedade.
prefixsearch
Realizar uma procura de prefixo nos títulos de página.
protectedtitles
Listar todos os títulos cuja criação está impedida.
querypage
Obter uma lista fornecida por uma página especial baseada em consultas (QueryPage).
random
Obter um conjunto de páginas aleatórias.
recentchanges
Enumerar as mudanças recentes.
redirects
Devolve todos os redirecionamentos para as páginas indicadas.
revisions
Obter informação da revisão.
search
Efetuar uma pesquisa do texto integral.
templates
Devolve todas as páginas que são transcluídas nas páginas indicadas.
transcludedin
Obter todas as páginas que transcluem as páginas indicadas.
watchlist
Obter mudanças recentes das páginas vigiadas do utilizador atual.
watchlistraw
Obter todas as páginas na lista de páginas vigiadas do utilizador atual.
Um dos seguintes valores: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, 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

Resolver automaticamente os redirecionamentos listados nos parâmetros titles, pageids e revids, e nas páginas devolvidas por generator.

Tipo: booleano (detalhes)
converttitles

Converter os títulos noutras variantes de língua, se necessário. Só funciona se a língua de conteúdo da wiki suporta a conversão entre variantes. As línguas que suportam conversão entre variantes incluem en, crh, gan, iu, kk, ku, shi, sr, tg, uz i zh.

Tipo: booleano (detalhes)
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplos:
Reiniciar o estado de notificação de todas as páginas vigiadas.
api.php?action=setnotificationtimestamp&entirewatchlist=&token=123ABC [abrir na página de testes]
Reiniciar o estado de notificação da página Main page.
api.php?action=setnotificationtimestamp&titles=Main_page&token=123ABC [abrir na página de testes]
Definir a data e hora de notificação para a página Main page de forma a que todas as edições desde 1 de janeiro de 2012 passem a ser consideradas não vistas
api.php?action=setnotificationtimestamp&titles=Main_page&timestamp=2012-01-01T00:00:00Z&token=123ABC [abrir na página de testes]
Reiniciar o estado de notificação das páginas no espaço nominal Outelizador(a).
api.php?action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC [abrir na página de testes]

action=setpagelanguage

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Alterar a língua de uma página.

Não é permitido alterar a língua de uma página nesta wiki.

Ativar $wgPageLanguageUseDB para usar esta operação.

Parâmetros:
title

O título da página cuja língua pretende alterar. Não pode ser usado em conjunto com pageid.

pageid

O identificador da página cuja língua pretende alterar. Não pode ser usado em conjunto com title.

Tipo: inteiro
lang

O código de língua, da língua para a qual a página será alterada. Usar default para redefinir a língua da página para a língua padrão de conteúdo da wiki.

Este parâmetro é obrigatório.
Um dos seguintes valores: default, ab, ace, ady, ady-cyrl, aeb, aeb-arab, aeb-latn, af, ak, aln, am, an, ang, anp, ar, arc, arn, arq, ary, arz, as, ase, ast, atj, av, avk, awa, ay, az, azb, ba, ban, bar, bbc, bbc-latn, bcc, bcl, be, be-tarask, bg, bgn, bh, bho, bi, bjn, bm, bn, bo, bpy, bqi, br, brh, bs, bto, bug, bxr, ca, cbk-zam, cdo, ce, ceb, ch, chr, chy, ckb, co, cps, cr, crh, crh-cyrl, crh-latn, cs, csb, cu, cv, cy, da, de, de-at, de-ch, de-formal, din, diq, dsb, dtp, dty, dv, dz, ee, egl, el, eml, en, en-ca, en-gb, eo, es, es-formal, et, eu, ext, fa, ff, fi, fit, fj, fo, fr, frc, frp, frr, fur, fy, ga, gag, gan, gan-hans, gan-hant, gcr, gd, gl, glk, gn, gom, gom-deva, gom-latn, gor, got, grc, gsw, gu, gv, ha, hak, haw, he, hi, hif, hif-latn, hil, hr, hrx, hsb, ht, hu, hu-formal, hy, ia, id, ie, ig, ii, ik, ike-cans, ike-latn, ilo, inh, io, is, it, iu, ja, jam, jbo, jut, jv, ka, kaa, kab, kbd, kbd-cyrl, kbp, kg, khw, ki, kiu, kk, kk-arab, kk-cn, kk-cyrl, kk-kz, kk-latn, kk-tr, kl, km, kn, ko, ko-kp, koi, krc, kri, krj, krl, ks, ks-arab, ks-deva, ksh, ku, ku-arab, ku-latn, kum, kv, kw, ky, la, lad, lb, lbe, lez, lfn, lg, li, lij, liv, lki, lmo, ln, lo, loz, lrc, lt, ltg, lus, luz, lv, lzh, lzz, mai, map-bms, mdf, mg, mhr, mi, min, mk, ml, mn, mo, mr, mrj, ms, mt, mwl, my, myv, mzn, na, nah, nan, nap, nb, nds, nds-nl, ne, new, niu, nl, nl-informal, nn, nov, nrm, nso, nv, ny, nys, oc, olo, om, or, os, pa, pag, pam, pap, pcd, pdc, pdt, pfl, pi, pih, pl, pms, pnb, pnt, prg, ps, pt, pt-br, qu, qug, rgn, rif, rm, rmy, ro, roa-tara, ru, rue, rup, ruq, ruq-cyrl, ruq-latn, rw, sa, sah, sat, sc, scn, sco, sd, sdc, sdh, se, sei, ses, sg, sgs, sh, shi, shn, si, sk, skr, skr-arab, sl, sli, sm, sma, sn, so, sq, sr, sr-ec, sr-el, srn, ss, st, stq, sty, su, sv, sw, szl, ta, tay, tcy, te, tet, tg, tg-cyrl, tg-latn, th, ti, tk, tl, tly, tn, to, tpi, tr, tru, ts, tt, tt-cyrl, tt-latn, tw, ty, tyv, tzm, udm, ug, ug-arab, ug-latn, uk, ur, uz, ve, vec, vep, vi, vls, vmf, vo, vot, vro, wa, war, wo, wuu, xal, xh, xmf, yi, yo, yue, za, zea, zh, zh-cn, zh-hans, zh-hant, zh-hk, zh-mo, zh-my, zh-sg, zh-tw, zu
reason

Motivo da alteração.

tags

As etiquetas de modificação a aplicar à entrada no registo que resultar desta operação.

Valores (separados com | ou alternativas):
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplos:
Alterar a língua da página Main Page para basco.
api.php?action=setpagelanguage&title=Main%20Page&lang=eu&token=123ABC [abrir na página de testes]
Alterar a língua da página com o identificador 123 para a língua padrão de conteúdo da wiki.
api.php?action=setpagelanguage&pageid=123&lang=default&token=123ABC [abrir na página de testes]

action=spamblacklist

  • Este módulo requer direitos de leitura.
  • Fonte: SpamBlacklist
  • Licença: GPL-2.0-or-later

Validar um ou mais URL contra a lista negra de spam.

Parâmetro:
url

Os URL a validar contra a lista negra.

Este parâmetro é obrigatório.
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).

action=stashedit

  • Este módulo é interno ou instável. O seu funcionamento pode ser alterado sem aviso prévio.
  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Preparar uma edição na cache partilhada.

É pretendido que isto seja usado através de AJAX a partir do formulário de edição, para melhorar o desempenho da gravação da página.

Parâmetros:
title

Título da página que está a ser editada.

Este parâmetro é obrigatório.
section

Número da secção. 0 para a secção do topo, new para uma secção nova.

sectiontitle

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

text

O conteúdo da página.

stashedtexthash

O resumo criptográfico do conteúdo da página, resultante de uma colocação anterior na área de ficheiros escondidos, a ser usado em vez de outro.

summary

O resumo da mudança.

contentmodel

O modelo de conteúdo do novo conteúdo.

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

O formato de seriação do conteúdo usado para o texto de entrada.

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

O identificador de revisão da revisão de base.

Este parâmetro é obrigatório.
Tipo: inteiro
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=tag

(main | tag)
  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Adicionar ou remover as etiquetas de modificação aplicadas a revisões individuais ou a entradas do registo.

Parâmetros:
rcid

Um ou mais identificadores de mudanças recentes às quais adicionar ou remover a etiqueta.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
revid

Um ou mais identificadores de revisões às quais adicionar ou remover a etiqueta.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
logid

Um ou mais identificadores de entradas do registo às quais adicionar ou remover a etiqueta.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
add

As etiquetas a serem adicionadas. Só podem ser adicionadas as etiquetas definidas manualmente.

Valores (separados com | ou alternativas):
remove

As etiquetas a serem removidas. Só podem ser removidas as etiquetas definidas manualmente ou completamente indefinidas.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
reason

O motivo da alteração.

Padrão: (vazio)
tags

As etiquetas de modificação a aplicar à entrada no registo que será criada em resultado desta operação.

Valores (separados com | ou alternativas):
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplos:
Adicionar a etiqueta vandalism à revisão com o identificador 123, sem especificar um motivo.
api.php?action=tag&revid=123&add=vandalism&token=123ABC [abrir na página de testes]
Remover a etiqueta spam da entrada do registo com o identificador 123, com o motivo Wrongly applied.
api.php?action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC [abrir na página de testes]

action=thank

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: Thanks
  • Licença: MIT

Enviar uma notificação de agradecimento a um editor.

Parâmetros:
rev

Identificador da revisão a agradecer a alguém. Tem de ser fornecido este identificador, ou 'log'.

O valor não pode ser inferior a 1.
Tipo: inteiro
log

Identificador do registo a agradecer a alguém. Tem de ser fornecido este identificador, ou 'rev'.

O valor não pode ser inferior a 1.
Tipo: inteiro
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.
source

Um texto breve que descreve a origem do pedido. Por exemplo, diff ou history.

Exemplo:
Enviar um agradecimento pela revisão ID 456, com uma página de diferenças como fonte
api.php?action=thank&revid=456&source=diff&token=123ABC [abrir na página de testes]

action=titleblacklist (tb)

  • Este módulo requer direitos de leitura.
  • Fonte: TitleBlacklist
  • Licença: GPL-2.0-or-later

Validar um título de página, nome de ficheiro ou nome de utilizador contra a lista negra.

Parâmetros:
tbtitle

O texto a validar contra a lista negra.

Este parâmetro é obrigatório.
tbaction

A operação a verificar.

Um dos seguintes valores: create, edit, upload, createtalk, createpage, move, new-account
Valor por omissão: edit
tbnooverride

Não tentar contornar a lista negra de títulos.

Tipo: booleano (detalhes)

action=tokens

  • Este módulo foi descontinuado.
  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Obter chaves para operações de modificação de dados.

Este módulo foi descontinuado e substituído por action=query&meta=tokens.

Parâmetro:
type

Tipos de chave a pedir.

Valores (separados com | ou alternativas): block, createaccount, csrf, delete, edit, email, import, login, move, options, patrol, protect, rollback, unblock, userrights, watch
Valor por omissão: edit
Exemplos:
Obter uma chave de edição (padrão).
api.php?action=tokens [abrir na página de testes]
Obter uma chave de correio eletrónico e uma chave de movimentação.
api.php?action=tokens&type=email|move [abrir na página de testes]

action=transcodereset

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: TimedMediaHandler
  • Licença: GPL-2.0-or-later

Os utilizadores com o privilégio 'transcode-reset' podem reiniciar e voltar a executar uma tarefa de transcodificação.

Parâmetros:
title

O título do ficheiro multimédia.

Este parâmetro é obrigatório.
transcodekey

A chave de transcodificação que pretende reiniciar. Obter de action=query&prop=transcodestatus.

token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=unblock

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Desbloquear um utilizador.

Parâmetros:
id

Identificador do bloqueio a desfazer (obtido com list=blocks). Não pode ser usado em conjunto com user ou userid.

Tipo: inteiro
user

O nome de utilizador, endereço IP ou gama de endereços IP a ser desbloqueado. Não pode ser usado em conjunto com id ou userid.

userid

O identificador do utilizador a ser desbloqueado. Não pode ser usado em conjunto com id ou user.

Tipo: inteiro
reason

Motivo para o desbloqueio.

Padrão: (vazio)
tags

As etiquetas de modificação a aplicar à entrada no registo de bloqueios.

Valores (separados com | ou alternativas):
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplos:
Desfazer o bloqueio com o identificador #105.
api.php?action=unblock&id=105 [abrir na página de testes]
Desbloquear o utilizador Bob com o motivo Sorry Bob.
api.php?action=unblock&user=Bob&reason=Sorry%20Bob [abrir na página de testes]

action=undelete

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Restaurar revisões de uma página eliminada.

Pode obter-se uma lista de revisões eliminadas (incluindo as datas e horas de eliminação) com prop=deletedrevisions e uma lista de identificadores de ficheiros eliminados com list=filearchive.

Parâmetros:
title

Título da página a restaurar.

Este parâmetro é obrigatório.
reason

Motivo para restaurar a página.

Padrão: (vazio)
tags

Etiquetas de modificação a aplicar à entrada no registo de eliminações.

Valores (separados com | ou alternativas):
timestamps

As datas e horas das revisões a serem restauradas. Se ambos os parâmetros timestamps e fileids estiverem vazios, serão restauradas todas as revisões.

Tipo: lista de datas e horas (formatos permitidos)
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
fileids

Os identificadores das revisões a serem restauradas. Se ambos os parâmetros timestamps e fileids estiverem vazios, serão restauradas todas as revisões.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
watchlist

Adicionar ou remover incondicionalmente a página da lista de páginas vigiadas do utilizador atual, usar as preferências ou não alterar o estado de vigilância.

Um dos seguintes valores: watch, unwatch, preferences, nochange
Valor por omissão: preferences
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=unlinkaccount

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Remover do utilizador atual uma conta ligada de uma wiki terceira.

Parâmetros:
request

Usar este pedido de autenticação, com o id devolvido por action=query&meta=authmanagerinfo com amirequestsfor=unlink.

Este parâmetro é obrigatório.
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.
Exemplo:
Tentar remover a ligação do utilizador atual ao fornecedor associado com FooAuthenticationRequest.
api.php?action=unlinkaccount&request=FooAuthenticationRequest&token=123ABC [abrir na página de testes]

action=upload

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Carregar um ficheiro, ou obter o estado dos carregamentos pendentes.

Estão disponíveis vários métodos:

  • Carregar diretamente o conteúdo do ficheiro, usando o parâmetro file.
  • Carregar o ficheiro por segmentos, usando os parâmetros filesize, chunk e offset.
  • Instruir o servidor do MediaWiki para obter o ficheiro a partir de um URL, usando o parâmetro url.
  • Terminar um carregamento anterior que falhou devido a avisos, usando o parâmetro filekey.

Note que o POST do HTTP tem de ser feito como um carregamento de ficheiro (isto é, usando multipart/form-data) ao enviar o file.

Parâmetros:
filename

O nome de destino do ficheiro.

comment

O comentário do carregamento. Também é usado como texto da página inicial para ficheiros novos se text não for especificado.

Padrão: (vazio)
tags

Etiquetas de modificação a aplicar à entrada do carregamento no registo e à revisão da página de ficheiro.

Valores (separados com | ou alternativas):
text

Texto inicial da página para ficheiros novos.

watch
Obsoleto.

Vigiar a página.

Tipo: booleano (detalhes)
watchlist

Adicionar ou remover incondicionalmente a página da lista de páginas vigiadas do utilizador atual, usar as preferências ou não alterar o estado de vigilância.

Um dos seguintes valores: watch, preferences, nochange
Valor por omissão: preferences
ignorewarnings

Ignorar todos os avisos.

Tipo: booleano (detalhes)
file

O conteúdo do ficheiro.

Tem ser enviado (posted) como um carregamento de ficheiro usando multipart/form-data.
url

O URL de onde obter o ficheiro.

filekey

Chave que identifica um carregamento prévio que está temporariamente na área de ficheiros escondidos.

sessionkey
Obsoleto.

O mesmo que filekey, mantido para compatibilidade com versões anteriores.

stash

Se definido, o servidor irá colocar temporariamente o ficheiro na área de ficheiros escondidos em vez de o adicionar ao repositório.

Tipo: booleano (detalhes)
filesize

O tamanho do carregamento completo.

O valor tem de estar compreendido entre 0 e 104 857 600.
Tipo: inteiro
offset

Posição do segmento em bytes.

O valor não pode ser inferior a 0.
Tipo: inteiro
chunk

O conteúdo do segmento.

Tem ser enviado (posted) como um carregamento de ficheiro usando multipart/form-data.
async

Tornar assíncronas as operações sobre ficheiros possivelmente grandes, quando possível.

Tipo: booleano (detalhes)
checkstatus

Obter só o estado de carregamento para a chave de ficheiro indicada.

Tipo: booleano (detalhes)
token

Uma chave "csrf" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=userrights

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Alterar os grupos a que um utilizador pertence.

Parâmetros:
user

O nome de utilizador.

Tipo: nome de utilizador
userid

O identificador de utilizador.

Tipo: inteiro
add

Adicionar o utilizador a estes grupos ou, se já for membro de um grupo, atualizar a data de expiração da sua pertença a esse grupo.

Valores (separados com | ou alternativas): bot, sysop, bureaucrat, emailconfirmed, rollback, checkuser, staff
expiry

Datas e horas de expiração. Podem ser relativas (por exemplo, 5 meses ou 2 semanas) ou absolutas (p. ex., 2014-09-18T12:34:56Z). Se só estiver definida uma data e hora, ela será usada para todos os grupos passados ao parâmetro add. Use infinite, indefinite, infinity ou never quando a pertença a um grupo não tem expiração.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
Valor por omissão: infinite
remove

Remover o utilizador destes grupos.

Valores (separados com | ou alternativas): bot, sysop, bureaucrat, emailconfirmed, rollback, checkuser, staff
reason

O motivo da alteração.

Padrão: (vazio)
token

Uma chave "userrights" obtida de action=query&meta=tokens

Para efeitos de compatibilidade, a chave usada na interface web também é aceite.

Este parâmetro é obrigatório.
tags

Etiquetas de modificação a aplicar à entrada no registo de privilégios de utilizadores.

Valores (separados com | ou alternativas):
Exemplos:
Adicionar o utilizador FooBot ao grupo bot e removê-lo dos grupos sysop e bureaucrat.
api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC [abrir na página de testes]
Adicionar o utilizador com o identificador 123 ao grupo bot e removê-lo dos grupos sysop e bureaucrat.
api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC [abrir na página de testes]
Adicionar o utilizador SometimeSysop ao grupo sysop por 1 mês.
api.php?action=userrights&user=SometimeSysop&add=sysop&expiry=1%20month&token=123ABC [abrir na página de testes]

action=validatepassword

  • Este módulo requer direitos de leitura.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Validar uma palavra-passe face às regras para palavras-passe da wiki.

A validade é reportada Good (Boa) se a palavra-passe é aceitável, Change (Alterar) se a palavra-passe pode ser usada para iniciar uma sessão mas terá de ser alterada, ou Invalid (Inválida) se a palavra-passe não é utilizável.

Parâmetros:
password

A palavra-passe a ser validada.

Este parâmetro é obrigatório.
user

O nome de utilizador, para ser usado ao testar a criação de conta. O nome de utilizador não pode existir.

Tipo: nome de utilizador
email

O endereço de correio eletrónico, para ser usado ao testar a criação de conta.

realname

O nome verdadeiro, para ser usado ao testar a criação de conta.

Exemplos:
Validar a palavra-passe foobar para o utilizador atual.
api.php?action=validatepassword&password=foobar [abrir na página de testes]
Validar a palavra-passe qwerty para a criação do utilizador Example.
api.php?action=validatepassword&password=querty&user=Example [abrir na página de testes]

action=watch

  • Este módulo requer direitos de leitura.
  • Este módulo requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Adicionar ou remover páginas da lista de páginas vigiadas do utilizador atual.

Parâmetros:
title
Obsoleto.

A página a vigiar ou deixar de ser vigiada. Em vez disto, usar titles.

unwatch

Se definido, a página deixará de ser vigiada, em vez de o ser.

Tipo: booleano (detalhes)
continue

Quando houver mais resultados disponíveis, usar isto para continuar

titles

Uma lista dos títulos a serem trabalhados.

Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
pageids

Uma lista dos identificadores de página a serem trabalhados.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
revids

Uma lista dos identificadores de revisões a serem trabalhados.

Tipo: lista de números inteiros
Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
generator

Obter a lista de páginas nas quais trabalhar, executando o módulo de consulta especificado.

Nota: Os nomes dos parâmetros de geradores têm de ser prefixados com um "g", veja os exemplos.

allcategories
Enumerar todas as categorias.
alldeletedrevisions
Listar todas as revisões eliminadas por um utilizador ou de um espaço nominal.
allfileusages
Listar todas as utilizações de ficheiros, incluindo ficheiros que não existam.
allimages
Enumerar todas as imagens sequencialmente.
alllinks
Enumerar todas as hiperligações que apontam para um determinado espaço nominal.
allpages
Enumerar sequencialmente todas as páginas de um determinado espaço nominal.
allredirects
Listar todos os redirecionamentos para um espaço nominal.
allrevisions
Listar todas as revisões.
alltransclusions
Listar todas as transclusões (páginas incorporadas utilizando {{x}}), incluindo as que estejam em falta.
backlinks
Encontrar todas as páginas que contêm hiperligações para a página indicada.
categories
Listar todas as categorias às quais as páginas pertencem.
categorymembers
Listar todas as páginas numa categoria específica.
deletedrevisions
Obter informações sobre as revisões eliminadas.
duplicatefiles
Listar todos os ficheiros que são duplicados dos ficheiros indicados com base no seu resumo criptográfico.
embeddedin
Encontrar todas as páginas que incorporam (transcluem) o título indicado.
exturlusage
Enumerar as páginas que contêm um determinado URL.
fileusage
Encontrar todas as páginas que usam os ficheiros indicados.
images
Devolve todos os ficheiros contidos nas páginas indicadas.
imageusage
Encontrar todas as páginas que utilizam o título da imagem indicada.
iwbacklinks
Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
langbacklinks
Encontrar todas as páginas que contêm hiperligações para a hiperligação interlínguas indicada.
links
Devolve todas as hiperligações das páginas indicadas.
linkshere
Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
pageswithprop
Listar todas as páginas que usam uma determinada propriedade.
prefixsearch
Realizar uma procura de prefixo nos títulos de página.
protectedtitles
Listar todos os títulos cuja criação está impedida.
querypage
Obter uma lista fornecida por uma página especial baseada em consultas (QueryPage).
random
Obter um conjunto de páginas aleatórias.
recentchanges
Enumerar as mudanças recentes.
redirects
Devolve todos os redirecionamentos para as páginas indicadas.
revisions
Obter informação da revisão.
search
Efetuar uma pesquisa do texto integral.
templates
Devolve todas as páginas que são transcluídas nas páginas indicadas.
transcludedin
Obter todas as páginas que transcluem as páginas indicadas.
watchlist
Obter mudanças recentes das páginas vigiadas do utilizador atual.
watchlistraw
Obter todas as páginas na lista de páginas vigiadas do utilizador atual.
Um dos seguintes valores: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, 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

Resolver automaticamente os redirecionamentos listados nos parâmetros titles, pageids e revids, e nas páginas devolvidas por generator.

Tipo: booleano (detalhes)
converttitles

Converter os títulos noutras variantes de língua, se necessário. Só funciona se a língua de conteúdo da wiki suporta a conversão entre variantes. As línguas que suportam conversão entre variantes incluem en, crh, gan, iu, kk, ku, shi, sr, tg, uz i zh.

Tipo: booleano (detalhes)
token

Uma chave "watch" obtida de action=query&meta=tokens

Este parâmetro é obrigatório.

action=webapp-manifest

  • Este módulo requer direitos de leitura.
  • Fonte: MobileFrontend
  • Licença: GPL-2.0-or-later

Devolve um manifesto de aplicação web.

format=json

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Produzir os dados de saída no formato JSON.

Parâmetros:
callback

Se especificado, envolve o resultado de saída na forma de uma chamada para uma função. Por segurança, todos os dados específicos do utilizador estarão restringidos.

utf8

Se especificado, codifica a maioria dos caracteres não ASCII (mas não todos) em UTF-8, em vez de substitui-los por sequências de escape hexadecimais. É o comportamento padrão quando formatversion não tem o valor 1.

Tipo: booleano (detalhes)
ascii

Se especificado, codifica todos caracteres não ASCII usando sequências de escape hexadecimais. É o comportamento padrão quando formatversion tem o valor 1.

Tipo: booleano (detalhes)
formatversion

Formatação do resultado de saída:

1
Formato compatível com versões anteriores (booleanos ao estilo XML, * chaves para nodos de conteúdo, etc.).
2
Formato moderno experimental. As especificações podem mudar!
latest
Usar o formato mais recente (atualmente 2), mas pode ser alterado sem aviso prévio.
Um dos seguintes valores: 1, 2, latest
Valor por omissão: 1

format=jsonfm

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Produzir os dados de saída em formato JSON (realce sintático em HTML).

Parâmetros:
wrappedhtml

Devolver o HTML com realce sintático e os módulos ResourceLoader associados, na forma de um objeto JSON.

Tipo: booleano (detalhes)
callback

Se especificado, envolve o resultado de saída na forma de uma chamada para uma função. Por segurança, todos os dados específicos do utilizador estarão restringidos.

utf8

Se especificado, codifica a maioria dos caracteres não ASCII (mas não todos) em UTF-8, em vez de substitui-los por sequências de escape hexadecimais. É o comportamento padrão quando formatversion não tem o valor 1.

Tipo: booleano (detalhes)
ascii

Se especificado, codifica todos caracteres não ASCII usando sequências de escape hexadecimais. É o comportamento padrão quando formatversion tem o valor 1.

Tipo: booleano (detalhes)
formatversion

Formatação do resultado de saída:

1
Formato compatível com versões anteriores (booleanos ao estilo XML, * chaves para nodos de conteúdo, etc.).
2
Formato moderno experimental. As especificações podem mudar!
latest
Usar o formato mais recente (atualmente 2), mas pode ser alterado sem aviso prévio.
Um dos seguintes valores: 1, 2, latest
Valor por omissão: 1

format=none

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Não produzir nada.

format=php

(main | php)
  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Produzir os dados de saída em formato PHP seriado.

Parâmetro:
formatversion

Formatação do resultado de saída:

1
Formato compatível com versões anteriores (booleanos ao estilo XML, * chaves para nodos de conteúdo, etc.).
2
Formato moderno experimental. As especificações podem mudar!
latest
Usar o formato mais recente (atualmente 2), mas pode ser alterado sem aviso prévio.
Um dos seguintes valores: 1, 2, latest
Valor por omissão: 1

format=phpfm

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Produzir os dados de saída em formato PHP seriado (realce sintático em HTML).

Parâmetros:
wrappedhtml

Devolver o HTML com realce sintático e os módulos ResourceLoader associados, na forma de um objeto JSON.

Tipo: booleano (detalhes)
formatversion

Formatação do resultado de saída:

1
Formato compatível com versões anteriores (booleanos ao estilo XML, * chaves para nodos de conteúdo, etc.).
2
Formato moderno experimental. As especificações podem mudar!
latest
Usar o formato mais recente (atualmente 2), mas pode ser alterado sem aviso prévio.
Um dos seguintes valores: 1, 2, latest
Valor por omissão: 1

format=rawfm

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Produzir os dados de saída, incluindo elementos para despiste de erros, em formato JSON (realce sintático em HTML).

Parâmetro:
wrappedhtml

Devolver o HTML com realce sintático e os módulos ResourceLoader associados, na forma de um objeto JSON.

Tipo: booleano (detalhes)

format=xml

(main | xml)
  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Produzir os dados de saída em formato XML.

Parâmetros:
xslt

Se especificado, adiciona a página nomeada como uma folha de estilo XSL. O valor tem de ser um título no espaço nominal Biqui e acabar em .xsl.

includexmlnamespace

Se especificado, adiciona um espaço nominal XML.

Tipo: booleano (detalhes)

format=xmlfm

  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Produzir os dados de saída em formato XML (realce sintático em HTML).

Parâmetros:
wrappedhtml

Devolver o HTML com realce sintático e os módulos ResourceLoader associados, na forma de um objeto JSON.

Tipo: booleano (detalhes)
xslt

Se especificado, adiciona a página nomeada como uma folha de estilo XSL. O valor tem de ser um título no espaço nominal Biqui e acabar em .xsl.

includexmlnamespace

Se especificado, adiciona um espaço nominal XML.

Tipo: booleano (detalhes)

Tipo de dados

O formato de entrada para o MediaWiki deve ser UTF-8, normalizado de acordo com a norma NFC. O MediaWiki pode converter outros tipos de entrada, mas esta conversão pode originar a falha de algumas operações (tais como as edições com verificações MD5).

Alguns tipos de parâmetros nos pedidos à API necessitam de mais explicações:

boolean
Os parâmetros booleanos funcionam como as caixas de seleção HTML: se o parâmetro for especificado, independentemente do seu valor, é considerado verdadeiro. Para um valor falso, omitir o parâmetro completo.
timestamp
As datas e horas podem ser especificadas em vários formatos. É recomendado o formato ISO 8601. Todas as horas estão em UTC, qualquer inclusão do fuso horário é ignorada.
  • Data e hora ISO 8601, 2001-01-15T14:56:00Z (pontuação e Z são opcionais)
  • Data e hora ISO 8601 com segundos fracionários (estes são ignorados), 2001-01-15T14:56:00.00001Z (traços, dois pontos e Z são opcionais)
  • Formato do MediaWiki, 20010115145600
  • Formato numérico genérico, 2001-01-15 14:56:00 (fuso horário opcional GMT, +##, ou -## são ignorados)
  • Formato EXIF, 2001:01:15 14:56:00
  • Formato RFC 2822 (o fuso horário pode ser omitido), Mon, 15 Jan 2001 14:56:00
  • Formato RFC 850 (o fuso horário pode ser omitido), Monday, 15-Jan-2001 14:56:00
  • Formato C ctime, Mon Jan 15 14:56:00 2001
  • Segundos desde 1970-01-01T00:00:00Z como um inteiro de 1 a 13 algarismos (excluindo 0)
  • O texto now
separador alternativo de valores múltiplos
Os parâmetros que aceitam vários valores são normalmente fornecidos com os valores separados por uma barra vertical (pipe), por exemplo parâmetro=valor1|valor2 ou parâmetro=valor1%7Cvalor2. Se um valor contém a barra vertical, use como separador o U+001F (Separador de Unidades) e prefixe o valor com U+001F, isto é, parâmetro=%1Fvalor1%1Fvalor2.

Créditos

Programadores da API:

  • Yuri Astrakhan (criador, programador principal, set 2006–set 2007)
  • Roan Kattouw (programador principal, set 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Brad Jorsch (programador principal, 2013–presente)

Pode enviar os seus comentários, sugestões e perguntas para o endereço [email protected], ou reportar quaisquer defeitos que encontre em https://phabricator.wikimedia.org/.