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

list=prefixsearch (ps)

(main | query | prefixsearch)
  • 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]