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
list=geosearch (gs)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: GeoData
- Licença: WTFPL
Devolve páginas que têm coordenadas que estão localizadas numa certa área.
- gscoord
Coordenada em torno da qual efetuar a pesquisa.
Formato: latitude e longitude separadas por uma barra vertical (|).
- gspage
Título da página em torno da qual efetuar a pesquisa.
- gsbbox
O retângulo limítrofe da pesquisa: coordenadas dos cantos superior esquerdo e inferior direito, separadas por uma barra vertical (|).
- gsradius
Raio da pesquisa, em metros.
- Tipo: inteiro
- O valor tem de estar entre 10 e 10 000.
- Valor por omissão: 500
- gsmaxdim
Restringir a pesquisa a objetos de tamanho inferior a este, em metros.
- Tipo: inteiro
- gssort
Definir o ordenamento dos resultados devolvidos.
- distance
- Classificar as páginas pela sua distância do centro.
- relevance
- Classificar as páginas pela sua relevância de acordo com CirrusSearch, de forma semelhante ao que é feito pela Pesquisa. Atualmente isto só é suportado em wikis que usam o motor de pesquisa ElasticSearch; consulte mw:Extension:GeoData#Search backends.
- Um dos seguintes valores: distance, relevance
- Valor por omissão: distance
- gslimit
O número máximo de páginas a serem devolvidas.
- Tipo: inteiro ou max
- O valor tem de estar entre 1 e 500.
- Valor por omissão: 10
- gsglobe
Globo a pesquisar. Consulte mw:Special:MyLanguage/Extension:GeoData#Glossary para mais detalhes.
- Um dos seguintes valores: earth
- Valor por omissão: earth
- gsnamespace
Espaços nominais a pesquisar.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 828, 829
- Para especificar todos os valores, use *.
- Valor por omissão: 0
- gsprop
As propriedades adicionais de coordenadas a serem devolvidas. (Propriedades que são sempre devolvidas: lat, lon, e uma de entre primary e secondary com valor booliano).
- type
- Tipo do objeto apontado pelas coordenadas. Consulte mw:Special:MyLanguage/Extension:GeoData#Usage para mais detalhes.
- name
- Nome do objeto.
- dim
- Tamanho aproximado do objeto em metros.
- country
- Código do país ISO 3166-1 alpha-2 (por exemplo, US ou RU).
- region
- Código da região ISO 3166-2 (a parte do código ISO 3166-2 após o traço; por exemplo, FL ou MOS).
- globe
- O corpo celestial do qual as coordenadas são relativas (por exemplo, moon ou pluto). Por omissão, tem o valor Terra. Consulte mw:Special:MyLanguage/Extension:GeoData#Glossary para mais detalhes.
- Valores (separados com | ou alternativas): country, dim, globe, name, region, type
- Valor por omissão: globe
- gsprimary
O tipo de coordenadas a serem devolvidas.
- primary
- A localização do assunto do artigo. Existe no máximo uma coordenada primária por título.
- secondary
- A localização de um objeto que é mencionado no artigo. Qualquer número de coordenadas secundárias podem ser associadas a um título.
- all
- Devolver as coordenadas primária e secundária.
- Um dos seguintes valores: all, primary, secondary
- Valor por omissão: primary
- gsdebug
Devolver, ou não, informação para despiste de erros.
- Tipo: booliano (detalhes)
- Pesquisar em torno do ponto com coordenadas 37° 47′ 13.1″ N, 122° 23′ 58.84″ O
- api.php?action=query&list=geosearch&gsradius=10000&gscoord=37.786971|-122.399677 [abrir na página de testes]
- Pesquisar num retângulo limítrofe
- api.php?action=query&list=geosearch&gsbbox=37.8|-122.3|37.7|-122.4 [abrir na página de testes]