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/Special:MyLanguage/API:Main_page
action=query
(main | 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:
Other general parameters are available.
- 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.
- 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.
- Valores (separados com | ou alternativas): categories, categoryinfo, contributors, deletedrevisions, duplicatefiles, extlinks, extracts, fileusage, imageinfo, images, info, iwlinks, langlinks, links, linkshere, pageimages, pageprops, redirects, revisions, stashimageinfo, templates, transcludedin
- list
As listas a serem obtidas.
- 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.
- 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.
- 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.
- 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): allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, allusers, backlinks, blocks, categorymembers, embeddedin, exturlusage, filearchive, imageusage, iwbacklinks, langbacklinks, logevents, 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.
- languageinfo
- Devolver informações sobre as línguas disponíveis.
- siteinfo
- Devolver informação geral sobre o sítio.
- tokens
- Obtém chaves para operações de modificação de dados.
- userinfo
- Obter informações sobre o utilizador atual.
- Valores (separados com | ou alternativas): allmessages, authmanagerinfo, filerepoinfo, languageinfo, siteinfo, tokens, userinfo
- indexpageids
Incluir uma secção adicional de identificadores de página que lista todos os identificadores de página devolvidos.
- Tipo: booliano (detalhes)
- export
Exportar as revisões atuais de todas as páginas fornecidas ou geradas.
- Tipo: booliano (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: booliano (detalhes)
- exportschema
Ao exportar, fazê-lo para a versão fornecida do formato da exportação XML. Só pode ser usado com query+export.
- Um dos seguintes valores: 0.10, 0.11
- Valor por omissão: 0.11
- iwurl
Indica se deve ser obtido o URL completo quando o título é uma hiperligação interwikis.
- Tipo: booliano (detalhes)
- continue
Quando houver mais resultados disponíveis, usar isto para continuar. Podem ser encontradas na wiki mediawiki.org mais informações sobre a aplicação da continuação a consultas.
- rawcontinue
Devolver os dados em bruto de query-continue para continuar.
- Tipo: booliano (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 clientes a quem são permitidos limites mais elevados).
- pageids
Uma lista dos identificadores de página a serem trabalhados.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes a quem são permitidos limites mais elevados).
- revids
Uma lista dos identificadores das revisões a serem trabalhadas. Note que quase todos os módulos de consulta convertem os identificadores de revisões no correspondente identificador de página e trabalham antes sobre a última revisão da página. Só prop=revisions usa revisões exatas para a sua resposta.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes a quem são permitidos limites mais elevados).
- 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: booliano (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 ban, en, crh, gan, iu, kk, ku, shi, sr, tg, uz e zh.
- Tipo: booliano (detalhes)
Exemplos:
- Obter informação do site e as revisões da página Página principal.
- api.php?action=query&prop=revisions&meta=siteinfo&titles=P%C3%A1gina%20principal&rvprop=user|comment&continue= [abrir na página de testes]
- Obter as revisões das páginas que começam por API/.
- api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue= [abrir na página de testes]