rev. 1030
services/apiref
services/apisrv
services/attrs
services/caches
services/caches/formatters
services/caches/map
services/caches/search
services/caches/shortcuts
services/logs
services/oauth
services/replicate
services/users

Sign up for an API Key
:: Opencaching API Reference

* - required fields

If you want to test OKAPI only, use your email address as application name. You must provide a valid email address at which we may contact you later.

Application homepage URL is optional and will be used for hyperlinks, to allow users to find your application more easily. If provided, it must be a "http://" web address. (In case you were wondering, it has nothing to do with OAuth callback.)

Terms of Use

When using data from Opencaching.PL you must attribute it to the author and to Opencaching.PL in the form specifyed in the Opencaching.PL Data License. OKAPI supports you in doing so by either appending the proper attribution to geocache descriptions or providing it in a separate data field (if you are not showing cache descriptions you must attribute the data using this separate field). Refer to the geocache method for further advice.

You must comply with the requirements of the Opencaching.PL Data License when reproducing, displaying, copying, formatting, compiling, or otherwise using Geocaching Data acquired through OKAPI.

When possible Opencaching.PL must be a clickable link to Opencaching.PL site and if the information being displayed is about a particular geocache, it should link to that geocache's page on Opencaching.PL.

You may not:

  • Copy, publish, compile, print, display, format, assemble, or otherwise use Geocaching Data acquired through OKAPI in a manner contrary to Opencaching.PL Data License.
  • Delete, obscure, modify, or in any manner alter any warning, notice, attribution, or link that appears in OKAPI or the served content.
  • Hide, modify, or otherwise obscure your identity, your system's identity, or your user's Opencaching.PL account information, when using OKAPI.