Introduction
Sign up
Examples
Changelog
|
ver. 1961 (3aab571) 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 caches within specified bounding box
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||
| https://www.opencaching.us/okapi/services/caches/search/bbox | ||||
|
This method is similar to the search/all method, but the results are restricted to the caches situated within a given bounding box (a rectangle on the map). Unless overriden, results are ordered by the distance from the center of the bounding box. This means, that if the number of geocaches in the box exceeds the your limit (provided in the limit parameter), you will receive the ones that are in the middle of your box, and miss the ones on the edges. 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. |
||||
| bbox | required |
The bounding box within to search for caches. The box is defined by a string in "S|W|N|E" format, where:
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. "48.7|15.8|54|24.9"). |
||
| location_source | optional |
Default value: default-coords Same as in the services/caches/search/nearest method. |
||
| 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. | ||||