Changes to the interface are always backward compatible.
You need not to update your applications after any change.
But there may be new recommendations (indicated by
bold text) on how to use OKAPI methods.
||Added options to geocache and log retrieval methods, which allow
to choose the subfields of owner and user fields.
||The geocaches' alt_wpts field now includes OCPL hidden-coordinate
waypoints. These waypoints are returned with location "0|0".
Developers are recommended to hide those null coordinates or
show a placeholder like "---".
||Fixed: Geocaches' alt_wpts field now fully responds to the
Added new fields country2 and region to
They replace the country and state fields, which have
been deprecated due to some issues (see the method docs).
Also added formal (not geographical!) verification of country
and region data. For some caches with broken data, an empty country
and/or region will now be returned.
||Rewritten the explanations
and advice on differences between Opencaching sites.
||Added the services/caches/capabilities
method, and updated the
||Added the services/logs/capabilities
method. Also added the new fields rcmds_left and rcmd_founds_needed
||Added the GPX options trackables=gc:travelbugs and
||Added new fields to replication: short_descriptions,
oc_team_annotation, needs_maintenance and watchers
for geocaches; images, location, oc_team_entry,
date_created and last_modified for log entries.
||Added the oc_team_annotation option and field to
OC team annotations now are included by default in cache
||Added the search options recommended_only and recommended_by.
||Added the watchers, my_rating and is_recommended fields
||Added the services/logs/edit
||Fixed: Also OCDE owners are not allowed to not recommend their own caches.
||Added the status-changing log types Available
Ready to search,
Temporarily unavailable and Archived to
(Corrected Available => Ready to search on 2018-11-13.)
||Added the date_created and last_modified fields
methods will no longer return true for the is_admin
field in any case, because OC installations no longer provide a
singular admin flag.
||Fixed: Do not mangle protocol-relative links in cache descriptions and logs.
||Enabled the GPX
gc_ocde:attrs option for all OC installations.
The pseudo-GS IDs of OC specific attributes now are also requestable
via the services/attrs methods.
||Added French translation for OKAPI user messages.
rejects 'Attended' logs that are earlier than the event date.
||Added the user_logs_only option the geocache retrieval methods,
and corresponding latest_logs=user option to the GPX download
||Added fields parameter to services/logs/userlogs.
||Added the Opencaching
GPX extension. Use ns_oc=true in
services/caches/formatters/gpx (or /ggz) to enable it.
||OKAPI can now be deployed via PHP composer to OC sites. See the
for a sample implementation.
||services/logs/images/add now returns
the URL of the added image.
for changing geocaches' log passwords.
||Added location field to services/logs/entry.
||Fixed: Submitting OCPL event cache logs now exactly behaves like the native log functions.
||Added options date_created and date_hidden to the
services/caches/search order_by parameter.
||The scheme for the installation URLs
of several Opencaching sites has changed from http to https.
||Added advice on the length of
saved personal notes.
||Documentation tags OCPL and OCDE
have been added, informing about different behaviour of OKAPI methods on the
two Opencaching code branches.
||Found geocaches are now marked properly in services/caches/formatters/garmin
||Added the log_uuids return field to
||Some OKAPI installation can be accessed through multiple URLs. The new
field okapi_base_urls tells you which URLs are available
for this installation.
||Added the Changelog page.
||The is_admin flag for users has
||Improved submitting HTML log entries. The comment_format parameter
of services/logs/submit now
works consistent and deterministic on all OC sites.
||New methods for adding,
deleting log images.
||Consumer keys may be revoked by OC site admins.
will no longer delete Opencaching.DE cookies when called with parameter
||OCDE geocache log entries with and without time are more reasonably
ordered. Developers are recommended to keep the order as returned by
OKAPI instead of ordering by the log date.
||The registration date of users can be retrieved.
||Added the 'needs maintenance' flag to log entries and geocaches.
The needs_maintenance option of
been deprecated; use needs_maintenance2 instead.
||Added Romanian translation.
||For caches with the mark 'listing is outdated' (available only on some
OC sites), a corresponding message is prepended to the description
field. DO NOT rely on this message being there or having a certain
content. It may change in the future.
||The home location of users can be queried, if given in the user's
profile (requires OAuth level 3).
||The URL of the OC site's registration page can be retrieved via
||Fixed: Restored the OpenCaching.com namespace definition for GPX.
||Added an advice to the documentation on how to
submit log entries
||Allowed to search for multiple users that (not) found
||Improved posting plaintext logs on OCPL sites.
||Enabled full 21-bit Unicode for submitting logs on some OC sites.
||Fixed: Solved rare problem when searching by distance or bbox
||Added the new ignored_status search option which allows
to search for caches ignored by the user. This replaces the
exclude_ignored option, which has been deprecated.
||There is a new Opencaching.FR website, which is a local view of
to access it.
||Quicker refreshing of map tiles after geocache name changes.
||Fixed: Return an HTTP 400 when "negative" dates are passed to
||Fixed: Improved uuid creation for submitted logs.
now is available to chosen consumers (closed BETA).
||Fixed: Pipe chars (|) in user names are treated as errors.
||The user's last-login date on the OC site is updated when running
OAuth level 3 methods.
||The OKAPI code repository has moved from Google Code to Github.
||When quering the is_watched state of a geocache or searching
for watched caches, indirect watches via geocache lists are included.
(Geocache lists so far are available only at OCDE and cannot be
directly accessed via OKAPI.)
||Opencaching.org.UK has been removed from the list of OKAPI
installations, because it is too outdated.
||The new powertrail_only option allows to search for caches
that are part of a powertrail (on some OC sites). This is a BETA
feature, i.e. it may be changed or removed.
||Updated the Introduction page,
with additional advices on backward compatibility.
||Interprete intervals of
as greater-side-open instead of closed.
||Fixed: Added missing oauth_token parameter to error redirect.
||Added "stealth required" attribute (A74).
||Fixed: Corrected the attribute assignments of OC.NL 'lost place' (A30 -> A29)
and geodetic point (A2).
||OKAPI has been deployed to Opencaching.RO.
This list shows only changes that are considered to be
relevant for developers and site admins. Please consult the
for a complete history, including older changes.
OKAPI was started in August 2011 at the OCPL code branch,
and it was deployed to the OCDE branch in April 2013.