ver. 1958 (4e4db56)
Introduction
Sign up
Examples
Changelog
services/apiref
issue
method
method_index
services/apisrv
installation
installations
stats
services/attrs
attribute
attribute_index
attributes
services/caches
edit
geocache
geocaches
mark
save_personal_notes
services/caches/formatters
garmin
ggz
gpx
services/caches/map
tile
services/caches/search
all
bbox
by_urls
nearest
save
services/caches/shortcuts
search_and_retrieve
services/logs
capabilities
delete
edit
entries
entry
logs
submit
userlogs
services/logs/images
add
delete
edit
services/oauth
access_token
authorize
request_token
services/replicate
changelog
fulldump
info
services/users
by_internal_id
by_internal_ids
by_username
by_usernames
user
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 - if given - it may be published in various contextx on the Opencaching site, to allow users to find your application more easily. If provided, it must be a "http(s)://" web address. (In case you're wondering, it has nothing to do with OAuth callback.)

Terms of Use

When using data from Opencaching.US you must attribute it to the author and to Opencaching.US in the form specifyed in the Opencaching.US 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.US Data License when reproducing, displaying, copying, formatting, compiling, or otherwise using Geocaching Data acquired through OKAPI.

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

You may not:

  • Copy, publish, compile, print, display, format, assemble, or otherwise use Geocaching Data acquired through OKAPI in a manner contrary to Opencaching.US 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.US account information, when using OKAPI.