API Reference / API Parameters / minimumAroundRadius
Jan. 07, 2019

minimumAroundRadius

Type: integer
Engine default: null
Parameter syntax
'minimumAroundRadius' => radius

Can be used in these methods:

About this parameter

Minimum radius (in meters) used for a geo search when aroundRadius is not set.

When a radius is automatically generated, the area of the circle might be too small to include enough records. This setting allows you to increase the size of the circle, thus ensuring sufficient coverage.

Usage notes:

  • This setting only works within the context of a circular geo search, enabled by aroundLatLng or aroundLatLngViaIP.

  • This parameter is ignored when aroundRadius is set.

Examples

Set minimum geo search radius

1
2
3
$results = $index->search('query', [
  'minimumAroundRadius' => 1000 // 1km
]);

Did you find this page helpful?