OpenCaching.com/api/geocache

POST to create a new Geocache

Create a new geocache.  POST to http://www.opencaching.com/api/geocache.

Special notes for parameters

name - Required

lat - Required

lon - Required

type - Required

terrain - Required

difficulty- Required

description - Required

size - Required if the cache has a physical container aka not a Virtual

status - If no status is provided it will default to Draft

oxcode - Can be used when creating a new geocache

POST to update a Geocache

Create a new geocache.  POST to http://www.opencaching.com/api/geocache/OX1234 where OX1234 is the OX code for the geocache to update.

Special notes for parameters

delete - Can be used to delete a geocache

Parameters

name

String

lat

Should be in decimal degrees.

Use positive numbers for north latitude and negative numbers of south latitude.

lon

Should be in decimal degrees.

Use positive numbers for east longitude and negative numbers of west longitude.

type

Accepted values are: traditional cache, multi-cache, unknown cache and virtual cache

status

Accepted values are: draft, active, archived and inactive

terrain

Decimal number between 1.0 and 5.0 inclusive.

difficulty

Decimal number between 1.0 and 5.0 inclusive.

size

Decimal number between 1.0 and 5.0 inclusive.

hint

String

description

String

tags=tag1,tag2,tag3,...

List of tags separated by a comma.  If the tag does not exist then it will be created and added to the geocache.

oxcode

Use to request a particular OX code. Use this if the geocache being created already has an id in another database and you want it to have the same id in the OpenCaching database.  Can only be used when creating a new geocache.

stage1=lat1,lon1 stage2=lat2,lon2 stage3=lat3,lon3 ...

Additional stages for multi-caches and puzzle caches.

If a cache requires someone to visit multiple places to complete the cache, coordinates for each stage must be uploaded. They will not be visible to people downloading caches, but the will be used to makes sure other caches aren't places too close to a stage in this cache.

Should be in decimal degrees.

Use positive numbers for north latitude and east longitude. Use negative numbers of south latitude and west longitude.

delete

Set this parameter to true to delete the geocache.

code_phrase

String

This can be set for a Virtual Cache.  It is a code phrase that must be entered by anyone that is logging the cache.

chirp_serial

Include a chirp serial for the cache.  Only the owner will be able to see the serial number.  This will enable verified finds for the geocache using the chirp.

verification_number

true/false

Add or remove a verification number for the geocache.  This will enable verified finds for the geocache using a 6 digit number that is generated for the geocache.  Once a number is generated for the geocache it will not change.  False value will remove the number from the cache.

verification_qr

true/false

Add or remove a verification QR code for the geocache.  This will enable verified finds for the geocache using a QR code for the geocache.  A number will be generated and returned (it will match verification_number).  You can use the number to generate a QR code using one of the many QR code generating utilities.  False value will remove the QR verification from the cache.