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

Member Function Documentation

◆ GetLowestCaches()

GetLowestCaches ( $params = [])

Returns an associative array with cache data for the lowest elevation geocaches according to the filter. Based on Project-GC's elevation data.

Can return more than limit rows. Will first figure out the highest elevation allowed, and then fetch all geocaches matching the filters.

Parameters
array$params(optional) An optional associative array of options for filtering/limit.
  • limit (integer): Max number of rows to return (default=100, max=1000)
  • dontCountArchivedTowardsLimit: (bool) defaults to true
  • dontCountDisabledTowardsLimit: (bool) defaults to false
  • alternativeDBCluster: (bool) defaults to false - Generally faster if processing lots of data, like multiple countries.
  • filter (array): An associative array with filters
  • country (string or array)
  • region (string or array)
  • county (string or array)
  • 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
  • excludeOwner (int): Exclude geocaches by this ownerId
  • excludeDisabled (bool): Exclude disabled geocaches, defaults to false
  • excludeArchived (bool): Exclude archived geocaches, defaults to false
  • requiredFP (int): Required favorite points.
  • minHiddenDate (string): YYYY-MM-DD, the date will be included, ie: >= date.
Returns
array