MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

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

list=geosearch (gs)

(main | query | geosearch)
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: GeoData
  • License: WTFPL

Returns pages having coordinates that are located in a certain area.

Specific parameters:
Other general parameters are available.
gscoord

Coordinate around which to search.

Format: Latitude and longitude separated by pipe (|).

gspage

Title of page around which to search.

gsbbox

Bounding box to search in: pipe (|) separated coordinates of top left and bottom right corners.

gsradius

Search radius in meters.

Type: integer
The value must be between 10 and 10,000.
Default: 500
gsmaxdim

Restrict search to objects no larger than this, in meters.

Type: integer
gssort

Set the sort order of returned results.

distance
Rank pages by their distance to the center.
relevance
Rank pages by their relevance according to CirrusSearch, similar to how Special:Search does it. Currently only supported on wikis that use the ElasticSearch backend, see mw:Extension:GeoData#Search backends.
One of the following values: distance, relevance
Default: distance
gslimit

Maximum number of pages to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
gsglobe

Globe to search on. See mw:Special:MyLanguage/Extension:GeoData#Glossary for details.

One of the following values: earth
Default: earth
gsnamespace

Namespaces to search.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101, 710, 711, 828, 829, 2600
To specify all values, use *.
Default: 0
gsprop

Which additional coordinate properties to return. (Properties that are always returned: lat, lon, and either primary or secondary as a boolean flag.)

type
Type of the object the coordinates point to. See mw:Special:MyLanguage/Extension:GeoData#Usage for details.
name
Name of the object.
dim
Approximate size of the object in meters.
country
ISO 3166-1 alpha-2 country code (e.g. US or RU).
region
ISO 3166-2 region code (the part of the ISO 3166-2 code after the dash; e.g. FL or MOS).
globe
Which terrestrial body the coordinates are relative to (e.g. moon or pluto). Defaults to Earth. See mw:Special:MyLanguage/Extension:GeoData#Glossary for details.
Values (separate with | or alternative): country, dim, globe, name, region, type
Default: globe
gsprimary

Which kind of coordinates to return.

primary
The location of the subject of the article. There is at most one primary coordinate per title.
secondary
The location of some object that's mentioned in the article. Any number of secondary coordinates can be associated with a title.
all
Return both primary and secondary coordinates.
One of the following values: all, primary, secondary
Default: primary
gsdebug

Whether debug information should be returned.

Type: boolean (details)
Examples:
Search around the point with coordinates 37° 47′ 13.1″ N, 122° 23′ 58.84″ W
api.php?action=query&list=geosearch&gsradius=10000&gscoord=37.786971|-122.399677 [open in sandbox]
Search in a bounding box
api.php?action=query&list=geosearch&gsbbox=37.8|-122.3|37.7|-122.4 [open in sandbox]