ver. 1958 (4e4db56) services/apiref services/apisrv services/attrs services/caches services/caches/formatters services/caches/map services/caches/search services/caches/shortcuts services/logs services/logs/images services/oauth services/replicate services/users |
Search for nearest geocaches
|
|
||||
https://www.opencaching.us/okapi/services/caches/search/nearest | ||||
Find the nearest geocaches. Unless overriden, results are ordered by the distance from the given center point. Usually you will want to use search_and_retrieve method instead of this one. This way, you can get much more data in one request. |
||||
center | required |
The center point (typically - the user's location), in the "lat|lon" format. Use positive numbers for latitudes in the northern hemisphere and longitudes in the eastern hemisphere (and negative for southern and western hemispheres accordingly). These are full degrees with a dot as a decimal point (ex. "54.3|22.3"). |
||
radius | optional |
Maximal distance (from the center point) for the cache to be included in the results. Unlike in most other places, this distance is given in kilometers instead of meters (it may contain a floating point though). |
||
location_source | optional |
Default value: default-coords In general, this parameter should take the same value as in the services/caches/formatters/gpx method, but currently only two values are supported: default-coords and alt_wpt:user-coords. Allows you to search among alternate locations of the geocache, instead of the default one. Particularily useful with alt_wpt:user-coords alternate waypoint. Please note, that if you plan on using this option in conjunction with search_and_retrieve method, then you'd probably want to use the same option in your retr_method too (if available). |
||
type | optional | Inherited from services/caches/search/all method. | ||
status | optional | Inherited from services/caches/search/all method. | ||
owner_uuid | optional | Inherited from services/caches/search/all method. | ||
name | optional | Inherited from services/caches/search/all method. | ||
terrain | optional | Inherited from services/caches/search/all method. | ||
difficulty | optional | Inherited from services/caches/search/all method. | ||
size | optional | Inherited from services/caches/search/all method. | ||
size2 | optional | Inherited from services/caches/search/all method. | ||
rating | optional | Inherited from services/caches/search/all method. | ||
min_rcmds | optional | Inherited from services/caches/search/all method. | ||
min_founds | optional | Inherited from services/caches/search/all method. | ||
max_founds | optional | Inherited from services/caches/search/all method. | ||
modified_since | optional | Inherited from services/caches/search/all method. | ||
found_status | optional | Inherited from services/caches/search/all method. | ||
found_by | optional | Inherited from services/caches/search/all method. | ||
not_found_by | optional | Inherited from services/caches/search/all method. | ||
recommended_only | optional | Inherited from services/caches/search/all method. | ||
recommended_by | optional | Inherited from services/caches/search/all method. | ||
watched_only | optional | Inherited from services/caches/search/all method. | ||
exclude_ignored | optional | Inherited from services/caches/search/all method. | ||
ignored_status | optional | Inherited from services/caches/search/all method. | ||
exclude_my_own | optional | Inherited from services/caches/search/all method. | ||
with_trackables_only | optional | Inherited from services/caches/search/all method. | ||
ftf_hunter | optional | Inherited from services/caches/search/all method. | ||
powertrail_only | optional | Inherited from services/caches/search/all method. | ||
powertrail_ids | optional | Inherited from services/caches/search/all method. | ||
set_and | optional | Inherited from services/caches/search/all method. | ||
limit | optional | Inherited from services/caches/search/all method. | ||
offset | optional | Inherited from services/caches/search/all method. | ||
order_by | optional | Inherited from services/caches/search/all method. | ||
format | optional | Standard common formatting argument. | ||
callback | optional | Standard common formatting argument. | ||
Plus required consumer_key argument, assigned for your application. | ||||
Returned value: Same format as in the search/all method. The more key will be skipped when no radius argument is given. |