Geocaching Australia API: Multiple Geocaches
Retrieve information for multiple geocaches
Geocaching Australia API call: https://geocaching.com.au/api/services/caches/geocaches/
Parameters not explicitly detailed will be silently ignored if passed.
Calling the method
Field | Definition | Description |
consumer_key | Mandatory | The api key associated with your app. |
cache_codes | Mandatory | Codes of the geocaches required separated by | (duplicates permitted, invalid codes permitted). |
lpc | Optional | Log entries per cache. The number of logs returned in the latest_logs field. Default value: 10. Any valid integer or the string 'all' to return all logs. |
my_location | Optional | The reference point for cache distance and bearing calculation (typically the user's location) in the 'lat|lon' format. A default of '0|0' will be used if no value is supplied. |
Validation
Parameter 'consumer_key' has invalid value: Consumer does not exist.
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE
No error, just a blank array returned. This is consistent with OKAPI.
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_codes=
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_codes=
Unknown cache_codes. No error, just a null array for each cache_codes provided. This is consistent with OKAPI.
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_codes=AA1234|BB1234
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_codes=AA1234|BB1234
If more than 500 cache codes provided: Parameter 'cache_codes' has invalid value: Maximum allowed number of referenced caches is 500. You provided 501 cache codes.
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_codes=GA0001|GA0002
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_codes=GA0001|GA0002
Required Parameter 'cache_code' is missing.
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_code_X=GA0001
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_code_X=GA0001
Examples
10 logs centered around 0|0.
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_codes=GA0001|GA0002|GA0003
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_codes=GA0001|GA0002|GA0003
Last two logs and a lat|lon of 0|0
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_codes=GA0001|GA0002|GA0003&lpc=2
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_codes=GA0001|GA0002|GA0003&lpc=2
10 logs (default) and distance and direction from the user current location (Melbourne GPO).
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_codes=GA0001|GA0002|GA0003&my_location=-37.8139|144.9634
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_codes=GA0001|GA0002|GA0003&my_location=-37.8139|144.9634
2 logs and distance and direction from the user current location (Melbourne GPO).
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_codes=GA0001|GA0002|GA0003&lpc=2&my_location=-37.8139|144.9634
https://geocaching.com.au/api/services/caches/geocaches/?consumer_key=YOUR_KEY_HERE&cache_codes=GA0001|GA0002|GA0003&lpc=2&my_location=-37.8139|144.9634
Extension Fields
Geocaching Australia has a History Cache (type='History') which accommodates an order in which to display the questions, the question itself and up to 4 answers. Any field which is '' can be assumed not to be displayed. The JSON response for all caches will include a qanda array which will always exist but will only be populated if there is a question and answer section.
Locale