Project-GC Lua Sandbox API
Loading...
Searching...
No Matches
GetNumCachesInArea

Member Function Documentation

◆ GetNumCachesInArea()

GetNumCachesInArea ( $params)

Gets the number of geocaches in a defined area.

Parameters
[in]array$paramsAn associative array of options for filtering.
  • filter (array): An associative array with filters
  • country (string|array) Required
  • region (string|array)
  • county (string|array) Include a region name filter as well to increase performance.
  • types (array): An array of valid types
  • sizes (array): An array of valid sizes
  • difficulties (array): An array of valid values
  • terrains (array): An array of valid values
  • excludeDisabled (bool): Exclude disabled geocaches, defaults to false
  • excludeArchived (bool): Exclude archived geocaches, defaults to false
  • excludeOwner (int): Exclude geocaches by this ownerId
  • minHiddenDate (string): YYYY-MM-DD, the date will be included, ie: >= date
  • maxHiddenDate (string): YYYY-MM-DD, the date will be included, ie: <= date
Returns
int The number of geocaches found.