Search for geocaches

:: services/caches/search/all method

Pipe-separated list of cache type codes. If given, the results will be limited to the given cache types. For a list of cache type codes, see services/caches/geocache method.

Notice: If you want to include all cache types except given ones, prepend your list with the "-" sign.

Default value: Available

Pipe-separated list of status codes. Only caches matching any of the given statuses will included in the response. For a list of cache status codes, see services/caches/geocache method.

Pipe-separated list of user IDs. If given, the list of returned caches will be limited to those owned by the given users.

Notice: User ID and Username are two different things!

UTF-8 encoded string - the name (or part of the name) of the cache.

Allowed wildcard characters:

• asterisk ("*") will match any string of characters,
• underscore ("_") will match any single character.

Name matching is case-insensitive. Maximum length for the name parameter is 100 characters.

Examples:

• "name=the *" returns caches which name starts with "the " (or "The ", etc.),
• "name=water tower" returns caches which have exactly that name (case insensitive),
• "name=*water tower*" will match caches like "Beautiful Water Tower II",
• "name=*tower_" will match "Water Towers" but will not match "Water Tower".

Notice: Cache code and name are two different things - if you want to find a cache by its code, use the services/caches/geocache method.

Default value: 1-5

A string "X-Y", where X and Y are integers between 1 and 5, and X <= Y. Only caches with terrain rating between these numbers (inclusive) will be returned.

Default value: 1-5

A string "X-Y", where X and Y are integers between 1 and 5, and X <= Y. Only caches with difficulty rating between these numbers (inclusive) will be returned.

A string "X-Y", where X and Y are integers between 1 and 5, and X <= Y. Only caches with size attribute between these numbers (inclusive) will be returned (1 - micro, 5 - very big).

Notice: If you use this parameter, all caches which do not have a container (like Event or Virtual caches) will be excluded from the results.

A string "X-Y", where X and Y are integers between 1 and 5, and X <= Y. Only caches with an overall rating between these numbers (inclusive) will be returned (1 - poor, 5 - excellent).

Notice: If you use this parameter, all caches with less than 4 votes will be excluded from results.

There are two possible value-types for this argument:

• Integer N. If N given, the result will contain only those caches which have at least N recommendations.
• Integer N with a percent sign appended (e.g. "20%"). The result will contain only those caches which have at last N% ratio of recommendations/founds. Please note, that this is useful only with conjunction with min_founds parameter.

Integer N. If N given, the result will contain only those caches which have been found at least N times. Useful if you want to skip "unverified" caches.

Integer N. If N given, the result will contain only those caches which have been found at most N times. Useful for FTF hunters.

A date and time string, in any reasonable format (any acceptable by PHP's strtotime function, ISO 8601 preffered).

If given, the list of returned geocaches will be limited to those which were created or modified since that date. (Note: currently caches do not get "modified" when user makes a log entry.)

Default value: either

Notice: This parameter may be used only for requests signed with an Access Token (you will need to use Level 3 Authentication).

Should be one of the following:

• found_only - only caches found by the user will be returned,
• notfound_only - only caches not found by the user will be returned,
• either - all caches will be returned.

User UUID. If given, the response will only include geocaches found by the given user.

User UUID. If given, the response will only include geocaches not found by the given user.

Default value: false

Notice: This parameter may be used only for requests signed with an Access Token (you will need to use Level 3 Authentication).

Boolean. If set to true, caches which the user is an owner of will not be included in the result.

Default value: 100

Integer in range 1..500. Maximum number of caches codes returned.

Default value: 0

An offset, the amount of items to skip at the beginning of the result. Combined with limit allows pagination of the result set. Please note, that the sum of offset and limit still cannot exceed 500. You MAY NOT use this method to list all the caches, it is for searching only. Have a peek at the replicate module if you need all the caches.

Default value: 0

Pipe separated list of fields to order the results by. Prefix the field name with a '-' sign to indicate a descending order.

Currently, fields which you can order by include: code, name, founds, rcmds, rcmds%.

Examples:

• to order by cache name use "order_by=name" or "order_by=+name",
• to have the largest caches in front, use "order_by=-size",
• multicolumn sorting is also allowed, ex. "order_by=-founds|-size|distance"

Note:It is highly recommended to avoid executing separate OKAPI request every time you want to sort the data which you already have. Consider caching and sorting on client side.