Difference between revisions of "GCA API"

Revision as of 11:01, 3 September 2011

This page contains information specific to Geocaching Australia.

GCA Cache API

Geocaching Australia has developed a read-only JSON based query system for external applications to access cache data in real time.

This psuedo-API is READ ONLY at the moment until a suitable authentication model is developed.

NOTE: Only Geocaching Australia geocaches and logs are available to be pulled through this API.

Successful requests will receive a HTTP 200 Code, whereas failed requests will receive HTTP 400 with a description of the error in the body text.

Cache Query

The cache query url is: http://geocaching.com.au/caches/gca.json

The data returned is in JSON array format and is pretty simple to figure out.

The following parameters can be used:

center=<lat>,<lon> the center point of the returned caches in ddd.dddddd format

limit=<integer> The number of caches to return. If omitted the default is 50, maximum is 100

cacher=<cachername> If searching using Unfound, Found and Owned this parameter is mandatory

unfound=1 Returns caches that the cacher hasn't found

found=1 Returns caches that the cacher has found

owned=1 Returns caches that the cacher owns

NOTE: unfound, found and owned should not be used in combination, but rather as separate queries

include=<string of cache types> Include only the cache types specified

exclude=<string of cache types> Exclude the cache types specified

eg to include ONLY Multis, Trads and Trigs you would use &include=MTZ

List of cache types:

B - Moveable

C - Cache In Trash Out

D - Beacon

E - Event

H - Burke and Wills

I - Wherigo

L - Locationless

M - Multi-cache

O - Other

P - Podcache

R - Earthcache

T - Traditional

U - Unknown or Mystery

V - Virtual

W - Webcam

X - Letterbox

Y - Mega-Event

Z - TrigPoint

Log Query

This function returns all logs on a particular cache.

The URL is http://gcatest.com.au/cache/<waypoint>.json