MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
list=geosearch (gs)
- 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.
Parameters:
- 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.
- The value must be between 10 and 10,000.
- Type: integer
- Default: 500
- gsmaxdim
Restrict search to objects no larger than this, in meters.
- Type: integer
- gslimit
Maximum number of pages to return.
- No more than 500 (5,000 for bots) allowed.
- Type: integer or max
- Default: 10
- gsglobe
Globe to search on (by default "earth").
- 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, 102, 103, 106, 107, 108, 109, 460, 461, 828, 829
- To specify all values, use *.
- Default: 0
- gsprop
Which additional coordinate properties to return.
- Values (separate with | or alternative): type, name, dim, country, region, globe
- Default: globe
- gsprimary
Whether to return only primary coordinates ("primary"), secondary ("secondary") or both ("all").
- One of the following values: primary, secondary, all
- Default: primary
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]